Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ALSA: compress: document 'chan_map' member in snd_dec_opus

When building kernel docs, the following warning appeared:

WARNING: ./include/uapi/sound/compress_params.h:364
struct member 'chan_map' not described in 'snd_dec_opus'

The inline struct 'snd_dec_opus_ch_map' inside 'snd_dec_opus' was not
properly documented. This patch documents the 'chan_map' member and its
fields (stream_count, coupled_count, channel_map), resolving the warning.

Fixes: 5d36370f3431 ("ALSA: compress: add raw opus codec define and opus decoder structs")
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>

authored by

Kriish Sharma and committed by
Takashi Iwai
fa7d1673 33da2d89

+8 -10
+8 -10
include/uapi/sound/compress_params.h
··· 336 336 * @mapping_family: Order and meaning of output channels. Only values 0 and 1 337 337 * are expected; values 2..255 are not recommended for playback. 338 338 * 339 - * Optional channel mapping table. Describes mapping of opus streams to decoded 340 - * channels. 341 - * @struct snd_dec_opus_ch_map 342 - * @stream_count: Number of streams encoded in each Ogg packet. 343 - * @coupled_count: Number of streams whose decoders are used for two 344 - * channels. 345 - * @channel_map: describes which decoded channel to be used for each one. 346 - * See RFC doc for details. 347 - * This supports only mapping families 0 and 1, therefore max 348 - * number of channels is 8. 339 + * @chan_map: Optional channel mapping table. Describes mapping of opus streams 340 + * to decoded channels. Fields: 341 + * @chan_map.stream_count: Number of streams encoded in each Ogg packet. 342 + * @chan_map.coupled_count: Number of streams whose decoders are used 343 + * for two channels. 344 + * @chan_map.channel_map: Which decoded channel to be used for each one. 345 + * Supports only mapping families 0 and 1, 346 + * max number of channels is 8. 349 347 * 350 348 * These options were extracted from RFC7845 Section 5. 351 349 */