Home | History | Annotate | Download | only in sound
      1 /*
      2  *  compress_params.h - codec types and parameters for compressed data
      3  *  streaming interface
      4  *
      5  *  Copyright (C) 2011 Intel Corporation
      6  *  Authors:	Pierre-Louis Bossart <pierre-louis.bossart (at) linux.intel.com>
      7  *              Vinod Koul <vinod.koul (at) linux.intel.com>
      8  *
      9  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     10  *
     11  *  This program is free software; you can redistribute it and/or modify
     12  *  it under the terms of the GNU General Public License as published by
     13  *  the Free Software Foundation; version 2 of the License.
     14  *
     15  *  This program is distributed in the hope that it will be useful, but
     16  *  WITHOUT ANY WARRANTY; without even the implied warranty of
     17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     18  *  General Public License for more details.
     19  *
     20  *  You should have received a copy of the GNU General Public License along
     21  *  with this program; if not, write to the Free Software Foundation, Inc.,
     22  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
     23  *
     24  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     25  *
     26  * The definitions in this file are derived from the OpenMAX AL version 1.1
     27  * and OpenMAX IL v 1.1.2 header files which contain the copyright notice below.
     28  *
     29  * Copyright (c) 2007-2010 The Khronos Group Inc.
     30  *
     31  * Permission is hereby granted, free of charge, to any person obtaining
     32  * a copy of this software and/or associated documentation files (the
     33  * "Materials "), to deal in the Materials without restriction, including
     34  * without limitation the rights to use, copy, modify, merge, publish,
     35  * distribute, sublicense, and/or sell copies of the Materials, and to
     36  * permit persons to whom the Materials are furnished to do so, subject to
     37  * the following conditions:
     38  *
     39  * The above copyright notice and this permission notice shall be included
     40  * in all copies or substantial portions of the Materials.
     41  *
     42  * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
     43  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     44  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
     45  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
     46  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
     47  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
     48  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
     49  *
     50  */
     51 #ifndef __SND_COMPRESS_PARAMS_H
     52 #define __SND_COMPRESS_PARAMS_H
     53 
     54 #include <linux/types.h>
     55 
     56 #define SND_DEC_DDP_MAX_PARAMS 18
     57 
     58 /* AUDIO CODECS SUPPORTED */
     59 #define MAX_NUM_CODECS 32
     60 #define MAX_NUM_CODEC_DESCRIPTORS 32
     61 #define MAX_NUM_BITRATES 32
     62 #define MAX_NUM_SAMPLE_RATES 32
     63 
     64 /* compressed TX */
     65 #define MAX_NUM_FRAMES_PER_BUFFER 1
     66 #define COMPRESSED_META_DATA_MODE 0x10
     67 #define META_DATA_LEN_BYTES 36
     68 #define Q6_AC3_DECODER	0x00010BF6
     69 #define Q6_EAC3_DECODER 0x00010C3C
     70 #define Q6_DTS		0x00010D88
     71 #define Q6_DTS_LBR	0x00010DBB
     72 
     73 /* Timestamp flsg */
     74 /* Bit-0 - 1 : Enable Timestamp mode */
     75 /* Bit-0 - 0 : Disable Timestamp mode */
     76 #define COMPRESSED_TIMESTAMP_FLAG 0x0001
     77 
     78 /* Codecs are listed linearly to allow for extensibility */
     79 #define SND_AUDIOCODEC_PCM                   ((__u32) 0x00000001)
     80 #define SND_AUDIOCODEC_MP3                   ((__u32) 0x00000002)
     81 #define SND_AUDIOCODEC_AMR                   ((__u32) 0x00000003)
     82 #define SND_AUDIOCODEC_AMRWB                 ((__u32) 0x00000004)
     83 #define SND_AUDIOCODEC_AMRWBPLUS             ((__u32) 0x00000005)
     84 #define SND_AUDIOCODEC_AAC                   ((__u32) 0x00000006)
     85 #define SND_AUDIOCODEC_WMA                   ((__u32) 0x00000007)
     86 #define SND_AUDIOCODEC_REAL                  ((__u32) 0x00000008)
     87 #define SND_AUDIOCODEC_VORBIS                ((__u32) 0x00000009)
     88 #define SND_AUDIOCODEC_FLAC                  ((__u32) 0x0000000A)
     89 #define SND_AUDIOCODEC_IEC61937              ((__u32) 0x0000000B)
     90 #define SND_AUDIOCODEC_G723_1                ((__u32) 0x0000000C)
     91 #define SND_AUDIOCODEC_G729                  ((__u32) 0x0000000D)
     92 #define SND_AUDIOCODEC_DTS_PASS_THROUGH      ((__u32) 0x0000000E)
     93 #define SND_AUDIOCODEC_DTS_LBR               ((__u32) 0x0000000F)
     94 #define SND_AUDIOCODEC_DTS_TRANSCODE_LOOPBACK ((__u32) 0x00000010)
     95 #define SND_AUDIOCODEC_PASS_THROUGH          ((__u32) 0x00000011)
     96 #define SND_AUDIOCODEC_MP2                   ((__u32) 0x00000012)
     97 #define SND_AUDIOCODEC_DTS_LBR_PASS_THROUGH  ((__u32) 0x00000013)
     98 #define SND_AUDIOCODEC_AC3                   ((__u32) 0x00000014)
     99 #define SND_AUDIOCODEC_AC3_PASS_THROUGH      ((__u32) 0x00000015)
    100 #define SND_AUDIOCODEC_WMA_PRO               ((__u32) 0x00000016)
    101 #define SND_AUDIOCODEC_DTS             	     ((__u32) 0x00000017)
    102 #define SND_AUDIOCODEC_EAC3                  ((__u32) 0x00000018)
    103 #define SND_AUDIOCODEC_ALAC                  ((__u32) 0x00000019)
    104 #define SND_AUDIOCODEC_APE                   ((__u32) 0x00000020)
    105 #define SND_AUDIOCODEC_DSD                   ((__u32) 0x00000021)
    106 #define SND_AUDIOCODEC_APTX                  ((__u32) 0x00000022)
    107 #define SND_AUDIOCODEC_MAX                   SND_AUDIOCODEC_APTX
    108 /*
    109  * Profile and modes are listed with bit masks. This allows for a
    110  * more compact representation of fields that will not evolve
    111  * (in contrast to the list of codecs)
    112  */
    113 
    114 #define SND_AUDIOPROFILE_PCM                 ((__u32) 0x00000001)
    115 
    116 /* MP3 modes are only useful for encoders */
    117 #define SND_AUDIOCHANMODE_MP3_MONO           ((__u32) 0x00000001)
    118 #define SND_AUDIOCHANMODE_MP3_STEREO         ((__u32) 0x00000002)
    119 #define SND_AUDIOCHANMODE_MP3_JOINTSTEREO    ((__u32) 0x00000004)
    120 #define SND_AUDIOCHANMODE_MP3_DUAL           ((__u32) 0x00000008)
    121 
    122 #define SND_AUDIOPROFILE_AMR                 ((__u32) 0x00000001)
    123 
    124 /* AMR modes are only useful for encoders */
    125 #define SND_AUDIOMODE_AMR_DTX_OFF            ((__u32) 0x00000001)
    126 #define SND_AUDIOMODE_AMR_VAD1               ((__u32) 0x00000002)
    127 #define SND_AUDIOMODE_AMR_VAD2               ((__u32) 0x00000004)
    128 
    129 #define SND_AUDIOSTREAMFORMAT_UNDEFINED	     ((__u32) 0x00000000)
    130 #define SND_AUDIOSTREAMFORMAT_CONFORMANCE    ((__u32) 0x00000001)
    131 #define SND_AUDIOSTREAMFORMAT_IF1            ((__u32) 0x00000002)
    132 #define SND_AUDIOSTREAMFORMAT_IF2            ((__u32) 0x00000004)
    133 #define SND_AUDIOSTREAMFORMAT_FSF            ((__u32) 0x00000008)
    134 #define SND_AUDIOSTREAMFORMAT_RTPPAYLOAD     ((__u32) 0x00000010)
    135 #define SND_AUDIOSTREAMFORMAT_ITU            ((__u32) 0x00000020)
    136 
    137 #define SND_AUDIOPROFILE_AMRWB               ((__u32) 0x00000001)
    138 
    139 /* AMRWB modes are only useful for encoders */
    140 #define SND_AUDIOMODE_AMRWB_DTX_OFF          ((__u32) 0x00000001)
    141 #define SND_AUDIOMODE_AMRWB_VAD1             ((__u32) 0x00000002)
    142 #define SND_AUDIOMODE_AMRWB_VAD2             ((__u32) 0x00000004)
    143 
    144 #define SND_AUDIOPROFILE_AMRWBPLUS           ((__u32) 0x00000001)
    145 
    146 #define SND_AUDIOPROFILE_AAC                 ((__u32) 0x00000001)
    147 
    148 /* AAC modes are required for encoders and decoders */
    149 #define SND_AUDIOMODE_AAC_MAIN               ((__u32) 0x00000001)
    150 #define SND_AUDIOMODE_AAC_LC                 ((__u32) 0x00000002)
    151 #define SND_AUDIOMODE_AAC_SSR                ((__u32) 0x00000004)
    152 #define SND_AUDIOMODE_AAC_LTP                ((__u32) 0x00000008)
    153 #define SND_AUDIOMODE_AAC_HE                 ((__u32) 0x00000010)
    154 #define SND_AUDIOMODE_AAC_SCALABLE           ((__u32) 0x00000020)
    155 #define SND_AUDIOMODE_AAC_ERLC               ((__u32) 0x00000040)
    156 #define SND_AUDIOMODE_AAC_LD                 ((__u32) 0x00000080)
    157 #define SND_AUDIOMODE_AAC_HE_PS              ((__u32) 0x00000100)
    158 #define SND_AUDIOMODE_AAC_HE_MPS             ((__u32) 0x00000200)
    159 
    160 /* AAC formats are required for encoders and decoders */
    161 #define SND_AUDIOSTREAMFORMAT_MP2ADTS        ((__u32) 0x00000001)
    162 #define SND_AUDIOSTREAMFORMAT_MP4ADTS        ((__u32) 0x00000002)
    163 #define SND_AUDIOSTREAMFORMAT_MP4LOAS        ((__u32) 0x00000004)
    164 #define SND_AUDIOSTREAMFORMAT_MP4LATM        ((__u32) 0x00000008)
    165 #define SND_AUDIOSTREAMFORMAT_ADIF           ((__u32) 0x00000010)
    166 #define SND_AUDIOSTREAMFORMAT_MP4FF          ((__u32) 0x00000020)
    167 #define SND_AUDIOSTREAMFORMAT_RAW            ((__u32) 0x00000040)
    168 
    169 #define SND_AUDIOPROFILE_WMA7                ((__u32) 0x00000001)
    170 #define SND_AUDIOPROFILE_WMA8                ((__u32) 0x00000002)
    171 #define SND_AUDIOPROFILE_WMA9                ((__u32) 0x00000004)
    172 #define SND_AUDIOPROFILE_WMA10               ((__u32) 0x00000008)
    173 
    174 #define SND_AUDIOMODE_WMA_LEVEL1             ((__u32) 0x00000001)
    175 #define SND_AUDIOMODE_WMA_LEVEL2             ((__u32) 0x00000002)
    176 #define SND_AUDIOMODE_WMA_LEVEL3             ((__u32) 0x00000004)
    177 #define SND_AUDIOMODE_WMA_LEVEL4             ((__u32) 0x00000008)
    178 #define SND_AUDIOMODE_WMAPRO_LEVELM0         ((__u32) 0x00000010)
    179 #define SND_AUDIOMODE_WMAPRO_LEVELM1         ((__u32) 0x00000020)
    180 #define SND_AUDIOMODE_WMAPRO_LEVELM2         ((__u32) 0x00000040)
    181 #define SND_AUDIOMODE_WMAPRO_LEVELM3         ((__u32) 0x00000080)
    182 
    183 #define SND_AUDIOSTREAMFORMAT_WMA_ASF        ((__u32) 0x00000001)
    184 /*
    185  * Some implementations strip the ASF header and only send ASF packets
    186  * to the DSP
    187  */
    188 #define SND_AUDIOSTREAMFORMAT_WMA_NOASF_HDR  ((__u32) 0x00000002)
    189 
    190 #define SND_AUDIOPROFILE_REALAUDIO           ((__u32) 0x00000001)
    191 
    192 #define SND_AUDIOMODE_REALAUDIO_G2           ((__u32) 0x00000001)
    193 #define SND_AUDIOMODE_REALAUDIO_8            ((__u32) 0x00000002)
    194 #define SND_AUDIOMODE_REALAUDIO_10           ((__u32) 0x00000004)
    195 #define SND_AUDIOMODE_REALAUDIO_SURROUND     ((__u32) 0x00000008)
    196 
    197 #define SND_AUDIOPROFILE_VORBIS              ((__u32) 0x00000001)
    198 
    199 #define SND_AUDIOMODE_VORBIS                 ((__u32) 0x00000001)
    200 
    201 #define SND_AUDIOPROFILE_FLAC                ((__u32) 0x00000001)
    202 
    203 /*
    204  * Define quality levels for FLAC encoders, from LEVEL0 (fast)
    205  * to LEVEL8 (best)
    206  */
    207 #define SND_AUDIOMODE_FLAC_LEVEL0            ((__u32) 0x00000001)
    208 #define SND_AUDIOMODE_FLAC_LEVEL1            ((__u32) 0x00000002)
    209 #define SND_AUDIOMODE_FLAC_LEVEL2            ((__u32) 0x00000004)
    210 #define SND_AUDIOMODE_FLAC_LEVEL3            ((__u32) 0x00000008)
    211 #define SND_AUDIOMODE_FLAC_LEVEL4            ((__u32) 0x00000010)
    212 #define SND_AUDIOMODE_FLAC_LEVEL5            ((__u32) 0x00000020)
    213 #define SND_AUDIOMODE_FLAC_LEVEL6            ((__u32) 0x00000040)
    214 #define SND_AUDIOMODE_FLAC_LEVEL7            ((__u32) 0x00000080)
    215 #define SND_AUDIOMODE_FLAC_LEVEL8            ((__u32) 0x00000100)
    216 
    217 #define SND_AUDIOSTREAMFORMAT_FLAC           ((__u32) 0x00000001)
    218 #define SND_AUDIOSTREAMFORMAT_FLAC_OGG       ((__u32) 0x00000002)
    219 
    220 /* IEC61937 payloads without CUVP and preambles */
    221 #define SND_AUDIOPROFILE_IEC61937            ((__u32) 0x00000001)
    222 /* IEC61937 with S/PDIF preambles+CUVP bits in 32-bit containers */
    223 #define SND_AUDIOPROFILE_IEC61937_SPDIF      ((__u32) 0x00000002)
    224 
    225 /*
    226  * IEC modes are mandatory for decoders. Format autodetection
    227  * will only happen on the DSP side with mode 0. The PCM mode should
    228  * not be used, the PCM codec should be used instead.
    229  */
    230 #define SND_AUDIOMODE_IEC_REF_STREAM_HEADER  ((__u32) 0x00000000)
    231 #define SND_AUDIOMODE_IEC_LPCM		     ((__u32) 0x00000001)
    232 #define SND_AUDIOMODE_IEC_AC3		     ((__u32) 0x00000002)
    233 #define SND_AUDIOMODE_IEC_MPEG1		     ((__u32) 0x00000004)
    234 #define SND_AUDIOMODE_IEC_MP3		     ((__u32) 0x00000008)
    235 #define SND_AUDIOMODE_IEC_MPEG2		     ((__u32) 0x00000010)
    236 #define SND_AUDIOMODE_IEC_AACLC		     ((__u32) 0x00000020)
    237 #define SND_AUDIOMODE_IEC_DTS		     ((__u32) 0x00000040)
    238 #define SND_AUDIOMODE_IEC_ATRAC		     ((__u32) 0x00000080)
    239 #define SND_AUDIOMODE_IEC_SACD		     ((__u32) 0x00000100)
    240 #define SND_AUDIOMODE_IEC_EAC3		     ((__u32) 0x00000200)
    241 #define SND_AUDIOMODE_IEC_DTS_HD	     ((__u32) 0x00000400)
    242 #define SND_AUDIOMODE_IEC_MLP		     ((__u32) 0x00000800)
    243 #define SND_AUDIOMODE_IEC_DST		     ((__u32) 0x00001000)
    244 #define SND_AUDIOMODE_IEC_WMAPRO	     ((__u32) 0x00002000)
    245 #define SND_AUDIOMODE_IEC_REF_CXT            ((__u32) 0x00004000)
    246 #define SND_AUDIOMODE_IEC_HE_AAC	     ((__u32) 0x00008000)
    247 #define SND_AUDIOMODE_IEC_HE_AAC2	     ((__u32) 0x00010000)
    248 #define SND_AUDIOMODE_IEC_MPEG_SURROUND	     ((__u32) 0x00020000)
    249 
    250 #define SND_AUDIOPROFILE_G723_1              ((__u32) 0x00000001)
    251 
    252 #define SND_AUDIOMODE_G723_1_ANNEX_A         ((__u32) 0x00000001)
    253 #define SND_AUDIOMODE_G723_1_ANNEX_B         ((__u32) 0x00000002)
    254 #define SND_AUDIOMODE_G723_1_ANNEX_C         ((__u32) 0x00000004)
    255 
    256 #define SND_AUDIOPROFILE_G729                ((__u32) 0x00000001)
    257 
    258 #define SND_AUDIOMODE_G729_ANNEX_A           ((__u32) 0x00000001)
    259 #define SND_AUDIOMODE_G729_ANNEX_B           ((__u32) 0x00000002)
    260 
    261 /* <FIXME: multichannel encoders aren't supported for now. Would need
    262    an additional definition of channel arrangement> */
    263 
    264 /* VBR/CBR definitions */
    265 #define SND_RATECONTROLMODE_CONSTANTBITRATE  ((__u32) 0x00000001)
    266 #define SND_RATECONTROLMODE_VARIABLEBITRATE  ((__u32) 0x00000002)
    267 
    268 /* Encoder options */
    269 
    270 struct snd_enc_wma {
    271 	__u32 super_block_align; /* WMA Type-specific data */
    272 	__u32 bits_per_sample;
    273 	__u32 channelmask;
    274 	__u32 encodeopt;
    275 	__u32 encodeopt1;
    276 	__u32 encodeopt2;
    277 	__u32 avg_bit_rate;
    278 };
    279 
    280 
    281 /**
    282  * struct snd_enc_vorbis
    283  * @quality: Sets encoding quality to n, between -1 (low) and 10 (high).
    284  * In the default mode of operation, the quality level is 3.
    285  * Normal quality range is 0 - 10.
    286  * @managed: Boolean. Set  bitrate  management  mode. This turns off the
    287  * normal VBR encoding, but allows hard or soft bitrate constraints to be
    288  * enforced by the encoder. This mode can be slower, and may also be
    289  * lower quality. It is primarily useful for streaming.
    290  * @max_bit_rate: Enabled only if managed is TRUE
    291  * @min_bit_rate: Enabled only if managed is TRUE
    292  * @downmix: Boolean. Downmix input from stereo to mono (has no effect on
    293  * non-stereo streams). Useful for lower-bitrate encoding.
    294  *
    295  * These options were extracted from the OpenMAX IL spec and Gstreamer vorbisenc
    296  * properties
    297  *
    298  * For best quality users should specify VBR mode and set quality levels.
    299  */
    300 
    301 struct snd_enc_vorbis {
    302 	__s32 quality;
    303 	__u32 managed;
    304 	__u32 max_bit_rate;
    305 	__u32 min_bit_rate;
    306 	__u32 downmix;
    307 } __attribute__((packed, aligned(4)));
    308 
    309 
    310 /**
    311  * struct snd_enc_real
    312  * @quant_bits: number of coupling quantization bits in the stream
    313  * @start_region: coupling start region in the stream
    314  * @num_regions: number of regions value
    315  *
    316  * These options were extracted from the OpenMAX IL spec
    317  */
    318 
    319 struct snd_enc_real {
    320 	__u32 quant_bits;
    321 	__u32 start_region;
    322 	__u32 num_regions;
    323 } __attribute__((packed, aligned(4)));
    324 
    325 /**
    326  * struct snd_enc_flac
    327  * @num: serial number, valid only for OGG formats
    328  *	needs to be set by application
    329  * @gain: Add replay gain tags
    330  *
    331  * These options were extracted from the FLAC online documentation
    332  * at http://flac.sourceforge.net/documentation_tools_flac.html
    333  *
    334  * To make the API simpler, it is assumed that the user will select quality
    335  * profiles. Additional options that affect encoding quality and speed can
    336  * be added at a later stage if needed.
    337  *
    338  * By default the Subset format is used by encoders.
    339  *
    340  * TAGS such as pictures, etc, cannot be handled by an offloaded encoder and are
    341  * not supported in this API.
    342  */
    343 
    344 struct snd_enc_flac {
    345 	__u32 num;
    346 	__u32 gain;
    347 } __attribute__((packed, aligned(4)));
    348 
    349 struct snd_enc_generic {
    350 	__u32 bw;	/* encoder bandwidth */
    351 	__s32 reserved[15];
    352 } __attribute__((packed, aligned(4)));
    353 
    354 struct snd_dec_ddp {
    355 	__u32 params_length;
    356 	__u32 params_id[SND_DEC_DDP_MAX_PARAMS];
    357 	__u32 params_value[SND_DEC_DDP_MAX_PARAMS];
    358 } __attribute__((packed, aligned(4)));
    359 
    360 struct snd_dec_flac {
    361 	__u16 sample_size;
    362 	__u16 min_blk_size;
    363 	__u16 max_blk_size;
    364 	__u16 min_frame_size;
    365 	__u16 max_frame_size;
    366 } __attribute__((packed, aligned(4)));
    367 
    368 struct snd_dec_vorbis {
    369 	__u32 bit_stream_fmt;
    370 };
    371 
    372 struct snd_dec_alac {
    373 	__u32 frame_length;
    374 	__u8 compatible_version;
    375 	__u8 bit_depth;
    376 	__u8 pb;
    377 	__u8 mb;
    378 	__u8 kb;
    379 	__u8 num_channels;
    380 	__u16 max_run;
    381 	__u32 max_frame_bytes;
    382 	__u32 avg_bit_rate;
    383 	__u32 sample_rate;
    384 	__u32 channel_layout_tag;
    385 };
    386 
    387 struct snd_dec_ape {
    388 	__u16 compatible_version;
    389 	__u16 compression_level;
    390 	__u32 format_flags;
    391 	__u32 blocks_per_frame;
    392 	__u32 final_frame_blocks;
    393 	__u32 total_frames;
    394 	__u16 bits_per_sample;
    395 	__u16 num_channels;
    396 	__u32 sample_rate;
    397 	__u32 seek_table_present;
    398 };
    399 
    400 struct snd_dec_aptx {
    401 	__u32 lap;
    402 	__u32 uap;
    403 	__u32 nap;
    404 };
    405 
    406 union snd_codec_options {
    407 	struct snd_enc_wma wma;
    408 	struct snd_enc_vorbis vorbis;
    409 	struct snd_enc_real real;
    410 	struct snd_enc_flac flac;
    411 	struct snd_enc_generic generic;
    412 	struct snd_dec_ddp ddp;
    413 	struct snd_dec_flac flac_dec;
    414 	struct snd_dec_vorbis vorbis_dec;
    415 	struct snd_dec_alac alac;
    416 	struct snd_dec_ape ape;
    417 	struct snd_dec_aptx aptx_dec;
    418 };
    419 
    420 /** struct snd_codec_desc - description of codec capabilities
    421  * @max_ch: Maximum number of audio channels
    422  * @sample_rates: Sampling rates in Hz, use values like 48000 for this
    423  * @num_sample_rates: Number of valid values in sample_rates array
    424  * @bit_rate: Indexed array containing supported bit rates
    425  * @num_bitrates: Number of valid values in bit_rate array
    426  * @rate_control: value is specified by SND_RATECONTROLMODE defines.
    427  * @profiles: Supported profiles. See SND_AUDIOPROFILE defines.
    428  * @modes: Supported modes. See SND_AUDIOMODE defines
    429  * @formats: Supported formats. See SND_AUDIOSTREAMFORMAT defines
    430  * @min_buffer: Minimum buffer size handled by codec implementation
    431  * @reserved: reserved for future use
    432  *
    433  * This structure provides a scalar value for profiles, modes and stream
    434  * format fields.
    435  * If an implementation supports multiple combinations, they will be listed as
    436  * codecs with different descriptors, for example there would be 2 descriptors
    437  * for AAC-RAW and AAC-ADTS.
    438  * This entails some redundancy but makes it easier to avoid invalid
    439  * configurations.
    440  *
    441  */
    442 
    443 struct snd_codec_desc {
    444 	__u32 max_ch;
    445 	__u32 sample_rates[MAX_NUM_SAMPLE_RATES];
    446 	__u32 num_sample_rates;
    447 	__u32 bit_rate[MAX_NUM_BITRATES];
    448 	__u32 num_bitrates;
    449 	__u32 rate_control;
    450 	__u32 profiles;
    451 	__u32 modes;
    452 	__u32 formats;
    453 	__u32 min_buffer;
    454 	__u32 reserved[15];
    455 } __attribute__((packed, aligned(4)));
    456 
    457 /** struct snd_codec
    458  * @id: Identifies the supported audio encoder/decoder.
    459  *		See SND_AUDIOCODEC macros.
    460  * @ch_in: Number of input audio channels
    461  * @ch_out: Number of output channels. In case of contradiction between
    462  *		this field and the channelMode field, the channelMode field
    463  *		overrides.
    464  * @sample_rate: Audio sample rate of input data in Hz, use values like 48000
    465  *		for this.
    466  * @bit_rate: Bitrate of encoded data. May be ignored by decoders
    467  * @rate_control: Encoding rate control. See SND_RATECONTROLMODE defines.
    468  *               Encoders may rely on profiles for quality levels.
    469  *		 May be ignored by decoders.
    470  * @profile: Mandatory for encoders, can be mandatory for specific
    471  *		decoders as well. See SND_AUDIOPROFILE defines.
    472  * @level: Supported level (Only used by WMA at the moment)
    473  * @ch_mode: Channel mode for encoder. See SND_AUDIOCHANMODE defines
    474  * @format: Format of encoded bistream. Mandatory when defined.
    475  *		See SND_AUDIOSTREAMFORMAT defines.
    476  * @align: Block alignment in bytes of an audio sample.
    477  *		Only required for PCM or IEC formats.
    478  * @options: encoder-specific settings
    479  * @reserved: reserved for future use
    480  */
    481 
    482 struct snd_codec {
    483 	__u32 id;
    484 	__u32 ch_in;
    485 	__u32 ch_out;
    486 	__u32 sample_rate;
    487 	__u32 bit_rate;
    488 	__u32 rate_control;
    489 	__u32 profile;
    490 	__u32 level;
    491 	__u32 ch_mode;
    492 	__u32 format;
    493 	__u32 align;
    494 	__u32 compr_passthr;
    495 	union snd_codec_options options;
    496 	__u32 flags;
    497 	__u32 reserved[2];
    498 } __attribute__((packed, aligned(4)));
    499 
    500 
    501 /** struct snd_codec_metadata
    502  * @length: Length of the encoded buffer.
    503  * @offset: Offset from the buffer address to the first byte of the first
    504  *		encoded frame. All encoded frames are consecutive starting
    505  *		from this offset.
    506  * @timestamp: Session time in microseconds of the first sample in the buffer.
    507  * @reserved: Reserved for future use.
    508  */
    509 struct snd_codec_metadata {
    510 	__u32 length;
    511 	__u32 offset;
    512 	__u64 timestamp;
    513 	__u32 reserved[4];
    514 };
    515 
    516 #endif
    517