include/uapi/sound/compress_params.h

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