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