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