Commit fa7d1673 authored by Kriish Sharma's avatar Kriish Sharma Committed by Takashi Iwai
Browse files

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: 5d36370f ("ALSA: compress: add raw opus codec define and opus decoder structs")
Suggested-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarKriish Sharma <kriish.sharma2006@gmail.com>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 33da2d89

include/uapi/sound/compress_params.h

+8 −10
Original line number Diff line number Diff line
@@ -336,16 +336,14 @@ struct snd_dec_ape { 
 * @mapping_family: Order and meaning of output channels. Only values 0 and 1

 * are expected; values 2..255 are not recommended for playback.

 *

 * Optional channel mapping table. Describes mapping of opus streams to decoded

 * channels.

 * @struct snd_dec_opus_ch_map

 *	@stream_count: Number of streams encoded in each Ogg packet.

 *	@coupled_count: Number of streams whose decoders are used for two

 *		channels.

 *	@channel_map: describes which decoded channel to be used for each one.

 *		See RFC doc for details.

 *		This supports only mapping families 0 and 1, therefore max

 *		number of channels is 8.

 * @chan_map: Optional channel mapping table. Describes mapping of opus streams

 *            to decoded channels. Fields:

 * @chan_map.stream_count: Number of streams encoded in each Ogg packet.

 * @chan_map.coupled_count: Number of streams whose decoders are used

 *                          for two channels.

 * @chan_map.channel_map: Which decoded channel to be used for each one.

 *                        Supports only mapping families 0 and 1,

 *                        max number of channels is 8.

 *

 * These options were extracted from RFC7845 Section 5.

 */