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