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@linux.intel.com> 7 * Vinod Koul <vinod.koul@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 /* AUDIO CODECS SUPPORTED */ 55 #define MAX_NUM_CODECS 32 56 #define MAX_NUM_CODEC_DESCRIPTORS 32 57 #define MAX_NUM_BITRATES 32 58 59 /* Codecs are listed linearly to allow for extensibility */ 60 #define SND_AUDIOCODEC_PCM ((__u32) 0x00000001) 61 #define SND_AUDIOCODEC_MP3 ((__u32) 0x00000002) 62 #define SND_AUDIOCODEC_AMR ((__u32) 0x00000003) 63 #define SND_AUDIOCODEC_AMRWB ((__u32) 0x00000004) 64 #define SND_AUDIOCODEC_AMRWBPLUS ((__u32) 0x00000005) 65 #define SND_AUDIOCODEC_AAC ((__u32) 0x00000006) 66 #define SND_AUDIOCODEC_WMA ((__u32) 0x00000007) 67 #define SND_AUDIOCODEC_REAL ((__u32) 0x00000008) 68 #define SND_AUDIOCODEC_VORBIS ((__u32) 0x00000009) 69 #define SND_AUDIOCODEC_FLAC ((__u32) 0x0000000A) 70 #define SND_AUDIOCODEC_IEC61937 ((__u32) 0x0000000B) 71 #define SND_AUDIOCODEC_G723_1 ((__u32) 0x0000000C) 72 #define SND_AUDIOCODEC_G729 ((__u32) 0x0000000D) 73 74 /* 75 * Profile and modes are listed with bit masks. This allows for a 76 * more compact representation of fields that will not evolve 77 * (in contrast to the list of codecs) 78 */ 79 80 #define SND_AUDIOPROFILE_PCM ((__u32) 0x00000001) 81 82 /* MP3 modes are only useful for encoders */ 83 #define SND_AUDIOCHANMODE_MP3_MONO ((__u32) 0x00000001) 84 #define SND_AUDIOCHANMODE_MP3_STEREO ((__u32) 0x00000002) 85 #define SND_AUDIOCHANMODE_MP3_JOINTSTEREO ((__u32) 0x00000004) 86 #define SND_AUDIOCHANMODE_MP3_DUAL ((__u32) 0x00000008) 87 88 #define SND_AUDIOPROFILE_AMR ((__u32) 0x00000001) 89 90 /* AMR modes are only useful for encoders */ 91 #define SND_AUDIOMODE_AMR_DTX_OFF ((__u32) 0x00000001) 92 #define SND_AUDIOMODE_AMR_VAD1 ((__u32) 0x00000002) 93 #define SND_AUDIOMODE_AMR_VAD2 ((__u32) 0x00000004) 94 95 #define SND_AUDIOSTREAMFORMAT_UNDEFINED ((__u32) 0x00000000) 96 #define SND_AUDIOSTREAMFORMAT_CONFORMANCE ((__u32) 0x00000001) 97 #define SND_AUDIOSTREAMFORMAT_IF1 ((__u32) 0x00000002) 98 #define SND_AUDIOSTREAMFORMAT_IF2 ((__u32) 0x00000004) 99 #define SND_AUDIOSTREAMFORMAT_FSF ((__u32) 0x00000008) 100 #define SND_AUDIOSTREAMFORMAT_RTPPAYLOAD ((__u32) 0x00000010) 101 #define SND_AUDIOSTREAMFORMAT_ITU ((__u32) 0x00000020) 102 103 #define SND_AUDIOPROFILE_AMRWB ((__u32) 0x00000001) 104 105 /* AMRWB modes are only useful for encoders */ 106 #define SND_AUDIOMODE_AMRWB_DTX_OFF ((__u32) 0x00000001) 107 #define SND_AUDIOMODE_AMRWB_VAD1 ((__u32) 0x00000002) 108 #define SND_AUDIOMODE_AMRWB_VAD2 ((__u32) 0x00000004) 109 110 #define SND_AUDIOPROFILE_AMRWBPLUS ((__u32) 0x00000001) 111 112 #define SND_AUDIOPROFILE_AAC ((__u32) 0x00000001) 113 114 /* AAC modes are required for encoders and decoders */ 115 #define SND_AUDIOMODE_AAC_MAIN ((__u32) 0x00000001) 116 #define SND_AUDIOMODE_AAC_LC ((__u32) 0x00000002) 117 #define SND_AUDIOMODE_AAC_SSR ((__u32) 0x00000004) 118 #define SND_AUDIOMODE_AAC_LTP ((__u32) 0x00000008) 119 #define SND_AUDIOMODE_AAC_HE ((__u32) 0x00000010) 120 #define SND_AUDIOMODE_AAC_SCALABLE ((__u32) 0x00000020) 121 #define SND_AUDIOMODE_AAC_ERLC ((__u32) 0x00000040) 122 #define SND_AUDIOMODE_AAC_LD ((__u32) 0x00000080) 123 #define SND_AUDIOMODE_AAC_HE_PS ((__u32) 0x00000100) 124 #define SND_AUDIOMODE_AAC_HE_MPS ((__u32) 0x00000200) 125 126 /* AAC formats are required for encoders and decoders */ 127 #define SND_AUDIOSTREAMFORMAT_MP2ADTS ((__u32) 0x00000001) 128 #define SND_AUDIOSTREAMFORMAT_MP4ADTS ((__u32) 0x00000002) 129 #define SND_AUDIOSTREAMFORMAT_MP4LOAS ((__u32) 0x00000004) 130 #define SND_AUDIOSTREAMFORMAT_MP4LATM ((__u32) 0x00000008) 131 #define SND_AUDIOSTREAMFORMAT_ADIF ((__u32) 0x00000010) 132 #define SND_AUDIOSTREAMFORMAT_MP4FF ((__u32) 0x00000020) 133 #define SND_AUDIOSTREAMFORMAT_RAW ((__u32) 0x00000040) 134 135 #define SND_AUDIOPROFILE_WMA7 ((__u32) 0x00000001) 136 #define SND_AUDIOPROFILE_WMA8 ((__u32) 0x00000002) 137 #define SND_AUDIOPROFILE_WMA9 ((__u32) 0x00000004) 138 #define SND_AUDIOPROFILE_WMA10 ((__u32) 0x00000008) 139 140 #define SND_AUDIOMODE_WMA_LEVEL1 ((__u32) 0x00000001) 141 #define SND_AUDIOMODE_WMA_LEVEL2 ((__u32) 0x00000002) 142 #define SND_AUDIOMODE_WMA_LEVEL3 ((__u32) 0x00000004) 143 #define SND_AUDIOMODE_WMA_LEVEL4 ((__u32) 0x00000008) 144 #define SND_AUDIOMODE_WMAPRO_LEVELM0 ((__u32) 0x00000010) 145 #define SND_AUDIOMODE_WMAPRO_LEVELM1 ((__u32) 0x00000020) 146 #define SND_AUDIOMODE_WMAPRO_LEVELM2 ((__u32) 0x00000040) 147 #define SND_AUDIOMODE_WMAPRO_LEVELM3 ((__u32) 0x00000080) 148 149 #define SND_AUDIOSTREAMFORMAT_WMA_ASF ((__u32) 0x00000001) 150 /* 151 * Some implementations strip the ASF header and only send ASF packets 152 * to the DSP 153 */ 154 #define SND_AUDIOSTREAMFORMAT_WMA_NOASF_HDR ((__u32) 0x00000002) 155 156 #define SND_AUDIOPROFILE_REALAUDIO ((__u32) 0x00000001) 157 158 #define SND_AUDIOMODE_REALAUDIO_G2 ((__u32) 0x00000001) 159 #define SND_AUDIOMODE_REALAUDIO_8 ((__u32) 0x00000002) 160 #define SND_AUDIOMODE_REALAUDIO_10 ((__u32) 0x00000004) 161 #define SND_AUDIOMODE_REALAUDIO_SURROUND ((__u32) 0x00000008) 162 163 #define SND_AUDIOPROFILE_VORBIS ((__u32) 0x00000001) 164 165 #define SND_AUDIOMODE_VORBIS ((__u32) 0x00000001) 166 167 #define SND_AUDIOPROFILE_FLAC ((__u32) 0x00000001) 168 169 /* 170 * Define quality levels for FLAC encoders, from LEVEL0 (fast) 171 * to LEVEL8 (best) 172 */ 173 #define SND_AUDIOMODE_FLAC_LEVEL0 ((__u32) 0x00000001) 174 #define SND_AUDIOMODE_FLAC_LEVEL1 ((__u32) 0x00000002) 175 #define SND_AUDIOMODE_FLAC_LEVEL2 ((__u32) 0x00000004) 176 #define SND_AUDIOMODE_FLAC_LEVEL3 ((__u32) 0x00000008) 177 #define SND_AUDIOMODE_FLAC_LEVEL4 ((__u32) 0x00000010) 178 #define SND_AUDIOMODE_FLAC_LEVEL5 ((__u32) 0x00000020) 179 #define SND_AUDIOMODE_FLAC_LEVEL6 ((__u32) 0x00000040) 180 #define SND_AUDIOMODE_FLAC_LEVEL7 ((__u32) 0x00000080) 181 #define SND_AUDIOMODE_FLAC_LEVEL8 ((__u32) 0x00000100) 182 183 #define SND_AUDIOSTREAMFORMAT_FLAC ((__u32) 0x00000001) 184 #define SND_AUDIOSTREAMFORMAT_FLAC_OGG ((__u32) 0x00000002) 185 186 /* IEC61937 payloads without CUVP and preambles */ 187 #define SND_AUDIOPROFILE_IEC61937 ((__u32) 0x00000001) 188 /* IEC61937 with S/PDIF preambles+CUVP bits in 32-bit containers */ 189 #define SND_AUDIOPROFILE_IEC61937_SPDIF ((__u32) 0x00000002) 190 191 /* 192 * IEC modes are mandatory for decoders. Format autodetection 193 * will only happen on the DSP side with mode 0. The PCM mode should 194 * not be used, the PCM codec should be used instead. 195 */ 196 #define SND_AUDIOMODE_IEC_REF_STREAM_HEADER ((__u32) 0x00000000) 197 #define SND_AUDIOMODE_IEC_LPCM ((__u32) 0x00000001) 198 #define SND_AUDIOMODE_IEC_AC3 ((__u32) 0x00000002) 199 #define SND_AUDIOMODE_IEC_MPEG1 ((__u32) 0x00000004) 200 #define SND_AUDIOMODE_IEC_MP3 ((__u32) 0x00000008) 201 #define SND_AUDIOMODE_IEC_MPEG2 ((__u32) 0x00000010) 202 #define SND_AUDIOMODE_IEC_AACLC ((__u32) 0x00000020) 203 #define SND_AUDIOMODE_IEC_DTS ((__u32) 0x00000040) 204 #define SND_AUDIOMODE_IEC_ATRAC ((__u32) 0x00000080) 205 #define SND_AUDIOMODE_IEC_SACD ((__u32) 0x00000100) 206 #define SND_AUDIOMODE_IEC_EAC3 ((__u32) 0x00000200) 207 #define SND_AUDIOMODE_IEC_DTS_HD ((__u32) 0x00000400) 208 #define SND_AUDIOMODE_IEC_MLP ((__u32) 0x00000800) 209 #define SND_AUDIOMODE_IEC_DST ((__u32) 0x00001000) 210 #define SND_AUDIOMODE_IEC_WMAPRO ((__u32) 0x00002000) 211 #define SND_AUDIOMODE_IEC_REF_CXT ((__u32) 0x00004000) 212 #define SND_AUDIOMODE_IEC_HE_AAC ((__u32) 0x00008000) 213 #define SND_AUDIOMODE_IEC_HE_AAC2 ((__u32) 0x00010000) 214 #define SND_AUDIOMODE_IEC_MPEG_SURROUND ((__u32) 0x00020000) 215 216 #define SND_AUDIOPROFILE_G723_1 ((__u32) 0x00000001) 217 218 #define SND_AUDIOMODE_G723_1_ANNEX_A ((__u32) 0x00000001) 219 #define SND_AUDIOMODE_G723_1_ANNEX_B ((__u32) 0x00000002) 220 #define SND_AUDIOMODE_G723_1_ANNEX_C ((__u32) 0x00000004) 221 222 #define SND_AUDIOPROFILE_G729 ((__u32) 0x00000001) 223 224 #define SND_AUDIOMODE_G729_ANNEX_A ((__u32) 0x00000001) 225 #define SND_AUDIOMODE_G729_ANNEX_B ((__u32) 0x00000002) 226 227 /* <FIXME: multichannel encoders aren't supported for now. Would need 228 an additional definition of channel arrangement> */ 229 230 /* VBR/CBR definitions */ 231 #define SND_RATECONTROLMODE_CONSTANTBITRATE ((__u32) 0x00000001) 232 #define SND_RATECONTROLMODE_VARIABLEBITRATE ((__u32) 0x00000002) 233 234 /* Encoder options */ 235 236 struct snd_enc_wma { 237 __u32 super_block_align; /* WMA Type-specific data */ 238 }; 239 240 241 /** 242 * struct snd_enc_vorbis 243 * @quality: Sets encoding quality to n, between -1 (low) and 10 (high). 244 * In the default mode of operation, the quality level is 3. 245 * Normal quality range is 0 - 10. 246 * @managed: Boolean. Set bitrate management mode. This turns off the 247 * normal VBR encoding, but allows hard or soft bitrate constraints to be 248 * enforced by the encoder. This mode can be slower, and may also be 249 * lower quality. It is primarily useful for streaming. 250 * @max_bit_rate: Enabled only if managed is TRUE 251 * @min_bit_rate: Enabled only if managed is TRUE 252 * @downmix: Boolean. Downmix input from stereo to mono (has no effect on 253 * non-stereo streams). Useful for lower-bitrate encoding. 254 * 255 * These options were extracted from the OpenMAX IL spec and Gstreamer vorbisenc 256 * properties 257 * 258 * For best quality users should specify VBR mode and set quality levels. 259 */ 260 261 struct snd_enc_vorbis { 262 __s32 quality; 263 __u32 managed; 264 __u32 max_bit_rate; 265 __u32 min_bit_rate; 266 __u32 downmix; 267 }; 268 269 270 /** 271 * struct snd_enc_real 272 * @quant_bits: number of coupling quantization bits in the stream 273 * @start_region: coupling start region in the stream 274 * @num_regions: number of regions value 275 * 276 * These options were extracted from the OpenMAX IL spec 277 */ 278 279 struct snd_enc_real { 280 __u32 quant_bits; 281 __u32 start_region; 282 __u32 num_regions; 283 }; 284 285 /** 286 * struct snd_enc_flac 287 * @num: serial number, valid only for OGG formats 288 * needs to be set by application 289 * @gain: Add replay gain tags 290 * 291 * These options were extracted from the FLAC online documentation 292 * at http://flac.sourceforge.net/documentation_tools_flac.html 293 * 294 * To make the API simpler, it is assumed that the user will select quality 295 * profiles. Additional options that affect encoding quality and speed can 296 * be added at a later stage if needed. 297 * 298 * By default the Subset format is used by encoders. 299 * 300 * TAGS such as pictures, etc, cannot be handled by an offloaded encoder and are 301 * not supported in this API. 302 */ 303 304 struct snd_enc_flac { 305 __u32 num; 306 __u32 gain; 307 }; 308 309 struct snd_enc_generic { 310 __u32 bw; /* encoder bandwidth */ 311 __s32 reserved[15]; 312 }; 313 314 union snd_codec_options { 315 struct snd_enc_wma wma; 316 struct snd_enc_vorbis vorbis; 317 struct snd_enc_real real; 318 struct snd_enc_flac flac; 319 struct snd_enc_generic generic; 320 }; 321 322 /** struct snd_codec_desc - description of codec capabilities 323 * @max_ch: Maximum number of audio channels 324 * @sample_rates: Sampling rates in Hz, use SNDRV_PCM_RATE_xxx for this 325 * @bit_rate: Indexed array containing supported bit rates 326 * @num_bitrates: Number of valid values in bit_rate array 327 * @rate_control: value is specified by SND_RATECONTROLMODE defines. 328 * @profiles: Supported profiles. See SND_AUDIOPROFILE defines. 329 * @modes: Supported modes. See SND_AUDIOMODE defines 330 * @formats: Supported formats. See SND_AUDIOSTREAMFORMAT defines 331 * @min_buffer: Minimum buffer size handled by codec implementation 332 * @reserved: reserved for future use 333 * 334 * This structure provides a scalar value for profiles, modes and stream 335 * format fields. 336 * If an implementation supports multiple combinations, they will be listed as 337 * codecs with different descriptors, for example there would be 2 descriptors 338 * for AAC-RAW and AAC-ADTS. 339 * This entails some redundancy but makes it easier to avoid invalid 340 * configurations. 341 * 342 */ 343 344 struct snd_codec_desc { 345 __u32 max_ch; 346 __u32 sample_rates; 347 __u32 bit_rate[MAX_NUM_BITRATES]; 348 __u32 num_bitrates; 349 __u32 rate_control; 350 __u32 profiles; 351 __u32 modes; 352 __u32 formats; 353 __u32 min_buffer; 354 __u32 reserved[15]; 355 }; 356 357 /** struct snd_codec 358 * @id: Identifies the supported audio encoder/decoder. 359 * See SND_AUDIOCODEC macros. 360 * @ch_in: Number of input audio channels 361 * @ch_out: Number of output channels. In case of contradiction between 362 * this field and the channelMode field, the channelMode field 363 * overrides. 364 * @sample_rate: Audio sample rate of input data 365 * @bit_rate: Bitrate of encoded data. May be ignored by decoders 366 * @rate_control: Encoding rate control. See SND_RATECONTROLMODE defines. 367 * Encoders may rely on profiles for quality levels. 368 * May be ignored by decoders. 369 * @profile: Mandatory for encoders, can be mandatory for specific 370 * decoders as well. See SND_AUDIOPROFILE defines. 371 * @level: Supported level (Only used by WMA at the moment) 372 * @ch_mode: Channel mode for encoder. See SND_AUDIOCHANMODE defines 373 * @format: Format of encoded bistream. Mandatory when defined. 374 * See SND_AUDIOSTREAMFORMAT defines. 375 * @align: Block alignment in bytes of an audio sample. 376 * Only required for PCM or IEC formats. 377 * @options: encoder-specific settings 378 * @reserved: reserved for future use 379 */ 380 381 struct snd_codec { 382 __u32 id; 383 __u32 ch_in; 384 __u32 ch_out; 385 __u32 sample_rate; 386 __u32 bit_rate; 387 __u32 rate_control; 388 __u32 profile; 389 __u32 level; 390 __u32 ch_mode; 391 __u32 format; 392 __u32 align; 393 union snd_codec_options options; 394 __u32 reserved[3]; 395 }; 396 397 #endif 398