1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) AND MIT) */
2 /*
3  *  compress_params.h - codec types and parameters for compressed data
4  *  streaming interface
5  *
6  *  Copyright (C) 2011 Intel Corporation
7  *  Authors:	Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
8  *              Vinod Koul <vinod.koul@linux.intel.com>
9  *
10  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; version 2 of the License.
15  *
16  *  This program is distributed in the hope that it will be useful, but
17  *  WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  *  General Public License for more details.
20  *
21  *  You should have received a copy of the GNU General Public License along
22  *  with this program; if not, write to the Free Software Foundation, Inc.,
23  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
24  *
25  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26  *
27  * The definitions in this file are derived from the OpenMAX AL version 1.1
28  * and OpenMAX IL v 1.1.2 header files which contain the copyright notice below.
29  *
30  * Copyright (c) 2007-2010 The Khronos Group Inc.
31  *
32  * Permission is hereby granted, free of charge, to any person obtaining
33  * a copy of this software and/or associated documentation files (the
34  * "Materials "), to deal in the Materials without restriction, including
35  * without limitation the rights to use, copy, modify, merge, publish,
36  * distribute, sublicense, and/or sell copies of the Materials, and to
37  * permit persons to whom the Materials are furnished to do so, subject to
38  * the following conditions:
39  *
40  * The above copyright notice and this permission notice shall be included
41  * in all copies or substantial portions of the Materials.
42  *
43  * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
44  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
45  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
46  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
47  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
48  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
49  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
50  *
51  */
52 #ifndef __SND_COMPRESS_PARAMS_H
53 #define __SND_COMPRESS_PARAMS_H
54 
55 #include <linux/types.h>
56 
57 /* Maximum PCM channels */
58 #define MAX_PCM_DECODE_CHANNELS 32
59 
60 /* AUDIO CODECS SUPPORTED */
61 #define MAX_NUM_CODECS 32
62 #define MAX_NUM_CODEC_DESCRIPTORS 32
63 #define MAX_NUM_BITRATES 32
64 #define MAX_NUM_SAMPLE_RATES 32
65 
66 /* compressed TX */
67 #define MAX_NUM_FRAMES_PER_BUFFER 1
68 #define COMPRESSED_META_DATA_MODE 0x10
69 #define META_DATA_LEN_BYTES 36
70 #define Q6_AC3_DECODER	0x00010BF6
71 #define Q6_EAC3_DECODER 0x00010C3C
72 #define Q6_DTS		0x00010D88
73 #define Q6_DTS_LBR	0x00010DBB
74 
75 /* Timestamp flsg */
76 /* Bit-0 - 1 : Enable Timestamp mode */
77 /* Bit-0 - 0 : Disable Timestamp mode */
78 #define COMPRESSED_TIMESTAMP_FLAG 0x0001
79 
80 /* Perf mode flag */
81 /* Bit-1 - 1 : Enable perf mode */
82 /* Bit-1 - 0 : Disable perf mode */
83 #define COMPRESSED_PERF_MODE_FLAG 0x0002
84 
85 /* Codecs are listed linearly to allow for extensibility */
86 #define SND_AUDIOCODEC_PCM                   ((__u32) 0x00000001)
87 #define SND_AUDIOCODEC_MP3                   ((__u32) 0x00000002)
88 #define SND_AUDIOCODEC_AMR                   ((__u32) 0x00000003)
89 #define SND_AUDIOCODEC_AMRWB                 ((__u32) 0x00000004)
90 #define SND_AUDIOCODEC_AMRWBPLUS             ((__u32) 0x00000005)
91 #define SND_AUDIOCODEC_AAC                   ((__u32) 0x00000006)
92 #define SND_AUDIOCODEC_WMA                   ((__u32) 0x00000007)
93 #define SND_AUDIOCODEC_REAL                  ((__u32) 0x00000008)
94 #define SND_AUDIOCODEC_VORBIS                ((__u32) 0x00000009)
95 #define SND_AUDIOCODEC_FLAC                  ((__u32) 0x0000000A)
96 #define SND_AUDIOCODEC_IEC61937              ((__u32) 0x0000000B)
97 #define SND_AUDIOCODEC_G723_1                ((__u32) 0x0000000C)
98 #define SND_AUDIOCODEC_G729                  ((__u32) 0x0000000D)
99 #define SND_AUDIOCODEC_BESPOKE               ((__u32) 0x0000000E)
100 #define SND_AUDIOCODEC_DTS_PASS_THROUGH      ((__u32) 0x0000000F)
101 #define SND_AUDIOCODEC_DTS_LBR               ((__u32) 0x00000010)
102 #define SND_AUDIOCODEC_DTS_TRANSCODE_LOOPBACK ((__u32) 0x00000011)
103 #define SND_AUDIOCODEC_PASS_THROUGH          ((__u32) 0x00000012)
104 #define SND_AUDIOCODEC_MP2                   ((__u32) 0x00000013)
105 #define SND_AUDIOCODEC_DTS_LBR_PASS_THROUGH  ((__u32) 0x00000014)
106 #define SND_AUDIOCODEC_AC3                   ((__u32) 0x00000015)
107 #define SND_AUDIOCODEC_AC3_PASS_THROUGH      ((__u32) 0x00000016)
108 #define SND_AUDIOCODEC_WMA_PRO               ((__u32) 0x00000017)
109 #define SND_AUDIOCODEC_DTS                   ((__u32) 0x00000018)
110 #define SND_AUDIOCODEC_EAC3                  ((__u32) 0x00000019)
111 #define SND_AUDIOCODEC_ALAC                  ((__u32) 0x00000020)
112 #define SND_AUDIOCODEC_APE                   ((__u32) 0x00000021)
113 #define SND_AUDIOCODEC_DSD                   ((__u32) 0x00000022)
114 #define SND_AUDIOCODEC_APTX                  ((__u32) 0x00000023)
115 #define SND_AUDIOCODEC_TRUEHD                ((__u32) 0x00000024)
116 #define SND_AUDIOCODEC_MAT                   ((__u32) 0x00000025)
117 #define SND_AUDIOCODEC_THD                   ((__u32) 0x00000026)
118 #define SND_AUDIOCODEC_MAX                   SND_AUDIOCODEC_THD
119 
120 /*
121  * Profile and modes are listed with bit masks. This allows for a
122  * more compact representation of fields that will not evolve
123  * (in contrast to the list of codecs)
124  */
125 
126 #define SND_AUDIOPROFILE_PCM                 ((__u32) 0x00000001)
127 
128 /* MP3 modes are only useful for encoders */
129 #define SND_AUDIOCHANMODE_MP3_MONO           ((__u32) 0x00000001)
130 #define SND_AUDIOCHANMODE_MP3_STEREO         ((__u32) 0x00000002)
131 #define SND_AUDIOCHANMODE_MP3_JOINTSTEREO    ((__u32) 0x00000004)
132 #define SND_AUDIOCHANMODE_MP3_DUAL           ((__u32) 0x00000008)
133 
134 #define SND_AUDIOPROFILE_AMR                 ((__u32) 0x00000001)
135 
136 /* AMR modes are only useful for encoders */
137 #define SND_AUDIOMODE_AMR_DTX_OFF            ((__u32) 0x00000001)
138 #define SND_AUDIOMODE_AMR_VAD1               ((__u32) 0x00000002)
139 #define SND_AUDIOMODE_AMR_VAD2               ((__u32) 0x00000004)
140 
141 #define SND_AUDIOSTREAMFORMAT_UNDEFINED	     ((__u32) 0x00000000)
142 #define SND_AUDIOSTREAMFORMAT_CONFORMANCE    ((__u32) 0x00000001)
143 #define SND_AUDIOSTREAMFORMAT_IF1            ((__u32) 0x00000002)
144 #define SND_AUDIOSTREAMFORMAT_IF2            ((__u32) 0x00000004)
145 #define SND_AUDIOSTREAMFORMAT_FSF            ((__u32) 0x00000008)
146 #define SND_AUDIOSTREAMFORMAT_RTPPAYLOAD     ((__u32) 0x00000010)
147 #define SND_AUDIOSTREAMFORMAT_ITU            ((__u32) 0x00000020)
148 
149 #define SND_AUDIOPROFILE_AMRWB               ((__u32) 0x00000001)
150 
151 /* AMRWB modes are only useful for encoders */
152 #define SND_AUDIOMODE_AMRWB_DTX_OFF          ((__u32) 0x00000001)
153 #define SND_AUDIOMODE_AMRWB_VAD1             ((__u32) 0x00000002)
154 #define SND_AUDIOMODE_AMRWB_VAD2             ((__u32) 0x00000004)
155 
156 #define SND_AUDIOPROFILE_AMRWBPLUS           ((__u32) 0x00000001)
157 
158 #define SND_AUDIOPROFILE_AAC                 ((__u32) 0x00000001)
159 
160 /* AAC modes are required for encoders and decoders */
161 #define SND_AUDIOMODE_AAC_MAIN               ((__u32) 0x00000001)
162 #define SND_AUDIOMODE_AAC_LC                 ((__u32) 0x00000002)
163 #define SND_AUDIOMODE_AAC_SSR                ((__u32) 0x00000004)
164 #define SND_AUDIOMODE_AAC_LTP                ((__u32) 0x00000008)
165 #define SND_AUDIOMODE_AAC_HE                 ((__u32) 0x00000010)
166 #define SND_AUDIOMODE_AAC_SCALABLE           ((__u32) 0x00000020)
167 #define SND_AUDIOMODE_AAC_ERLC               ((__u32) 0x00000040)
168 #define SND_AUDIOMODE_AAC_LD                 ((__u32) 0x00000080)
169 #define SND_AUDIOMODE_AAC_HE_PS              ((__u32) 0x00000100)
170 #define SND_AUDIOMODE_AAC_HE_MPS             ((__u32) 0x00000200)
171 
172 /* AAC formats are required for encoders and decoders */
173 #define SND_AUDIOSTREAMFORMAT_MP2ADTS        ((__u32) 0x00000001)
174 #define SND_AUDIOSTREAMFORMAT_MP4ADTS        ((__u32) 0x00000002)
175 #define SND_AUDIOSTREAMFORMAT_MP4LOAS        ((__u32) 0x00000004)
176 #define SND_AUDIOSTREAMFORMAT_MP4LATM        ((__u32) 0x00000008)
177 #define SND_AUDIOSTREAMFORMAT_ADIF           ((__u32) 0x00000010)
178 #define SND_AUDIOSTREAMFORMAT_MP4FF          ((__u32) 0x00000020)
179 #define SND_AUDIOSTREAMFORMAT_RAW            ((__u32) 0x00000040)
180 
181 #define SND_AUDIOPROFILE_WMA7                ((__u32) 0x00000001)
182 #define SND_AUDIOPROFILE_WMA8                ((__u32) 0x00000002)
183 #define SND_AUDIOPROFILE_WMA9                ((__u32) 0x00000004)
184 #define SND_AUDIOPROFILE_WMA10               ((__u32) 0x00000008)
185 
186 #define SND_AUDIOMODE_WMA_LEVEL1             ((__u32) 0x00000001)
187 #define SND_AUDIOMODE_WMA_LEVEL2             ((__u32) 0x00000002)
188 #define SND_AUDIOMODE_WMA_LEVEL3             ((__u32) 0x00000004)
189 #define SND_AUDIOMODE_WMA_LEVEL4             ((__u32) 0x00000008)
190 #define SND_AUDIOMODE_WMAPRO_LEVELM0         ((__u32) 0x00000010)
191 #define SND_AUDIOMODE_WMAPRO_LEVELM1         ((__u32) 0x00000020)
192 #define SND_AUDIOMODE_WMAPRO_LEVELM2         ((__u32) 0x00000040)
193 #define SND_AUDIOMODE_WMAPRO_LEVELM3         ((__u32) 0x00000080)
194 
195 #define SND_AUDIOSTREAMFORMAT_WMA_ASF        ((__u32) 0x00000001)
196 /*
197  * Some implementations strip the ASF header and only send ASF packets
198  * to the DSP
199  */
200 #define SND_AUDIOSTREAMFORMAT_WMA_NOASF_HDR  ((__u32) 0x00000002)
201 
202 #define SND_AUDIOPROFILE_REALAUDIO           ((__u32) 0x00000001)
203 
204 #define SND_AUDIOMODE_REALAUDIO_G2           ((__u32) 0x00000001)
205 #define SND_AUDIOMODE_REALAUDIO_8            ((__u32) 0x00000002)
206 #define SND_AUDIOMODE_REALAUDIO_10           ((__u32) 0x00000004)
207 #define SND_AUDIOMODE_REALAUDIO_SURROUND     ((__u32) 0x00000008)
208 
209 #define SND_AUDIOPROFILE_VORBIS              ((__u32) 0x00000001)
210 
211 #define SND_AUDIOMODE_VORBIS                 ((__u32) 0x00000001)
212 
213 #define SND_AUDIOPROFILE_FLAC                ((__u32) 0x00000001)
214 
215 /*
216  * Define quality levels for FLAC encoders, from LEVEL0 (fast)
217  * to LEVEL8 (best)
218  */
219 #define SND_AUDIOMODE_FLAC_LEVEL0            ((__u32) 0x00000001)
220 #define SND_AUDIOMODE_FLAC_LEVEL1            ((__u32) 0x00000002)
221 #define SND_AUDIOMODE_FLAC_LEVEL2            ((__u32) 0x00000004)
222 #define SND_AUDIOMODE_FLAC_LEVEL3            ((__u32) 0x00000008)
223 #define SND_AUDIOMODE_FLAC_LEVEL4            ((__u32) 0x00000010)
224 #define SND_AUDIOMODE_FLAC_LEVEL5            ((__u32) 0x00000020)
225 #define SND_AUDIOMODE_FLAC_LEVEL6            ((__u32) 0x00000040)
226 #define SND_AUDIOMODE_FLAC_LEVEL7            ((__u32) 0x00000080)
227 #define SND_AUDIOMODE_FLAC_LEVEL8            ((__u32) 0x00000100)
228 
229 #define SND_AUDIOSTREAMFORMAT_FLAC           ((__u32) 0x00000001)
230 #define SND_AUDIOSTREAMFORMAT_FLAC_OGG       ((__u32) 0x00000002)
231 
232 /* IEC61937 payloads without CUVP and preambles */
233 #define SND_AUDIOPROFILE_IEC61937            ((__u32) 0x00000001)
234 /* IEC61937 with S/PDIF preambles+CUVP bits in 32-bit containers */
235 #define SND_AUDIOPROFILE_IEC61937_SPDIF      ((__u32) 0x00000002)
236 
237 /*
238  * IEC modes are mandatory for decoders. Format autodetection
239  * will only happen on the DSP side with mode 0. The PCM mode should
240  * not be used, the PCM codec should be used instead.
241  */
242 #define SND_AUDIOMODE_IEC_REF_STREAM_HEADER  ((__u32) 0x00000000)
243 #define SND_AUDIOMODE_IEC_LPCM		     ((__u32) 0x00000001)
244 #define SND_AUDIOMODE_IEC_AC3		     ((__u32) 0x00000002)
245 #define SND_AUDIOMODE_IEC_MPEG1		     ((__u32) 0x00000004)
246 #define SND_AUDIOMODE_IEC_MP3		     ((__u32) 0x00000008)
247 #define SND_AUDIOMODE_IEC_MPEG2		     ((__u32) 0x00000010)
248 #define SND_AUDIOMODE_IEC_AACLC		     ((__u32) 0x00000020)
249 #define SND_AUDIOMODE_IEC_DTS		     ((__u32) 0x00000040)
250 #define SND_AUDIOMODE_IEC_ATRAC		     ((__u32) 0x00000080)
251 #define SND_AUDIOMODE_IEC_SACD		     ((__u32) 0x00000100)
252 #define SND_AUDIOMODE_IEC_EAC3		     ((__u32) 0x00000200)
253 #define SND_AUDIOMODE_IEC_DTS_HD	     ((__u32) 0x00000400)
254 #define SND_AUDIOMODE_IEC_MLP		     ((__u32) 0x00000800)
255 #define SND_AUDIOMODE_IEC_DST		     ((__u32) 0x00001000)
256 #define SND_AUDIOMODE_IEC_WMAPRO	     ((__u32) 0x00002000)
257 #define SND_AUDIOMODE_IEC_REF_CXT            ((__u32) 0x00004000)
258 #define SND_AUDIOMODE_IEC_HE_AAC	     ((__u32) 0x00008000)
259 #define SND_AUDIOMODE_IEC_HE_AAC2	     ((__u32) 0x00010000)
260 #define SND_AUDIOMODE_IEC_MPEG_SURROUND	     ((__u32) 0x00020000)
261 
262 #define SND_AUDIOPROFILE_G723_1              ((__u32) 0x00000001)
263 
264 #define SND_AUDIOMODE_G723_1_ANNEX_A         ((__u32) 0x00000001)
265 #define SND_AUDIOMODE_G723_1_ANNEX_B         ((__u32) 0x00000002)
266 #define SND_AUDIOMODE_G723_1_ANNEX_C         ((__u32) 0x00000004)
267 
268 #define SND_AUDIOPROFILE_G729                ((__u32) 0x00000001)
269 
270 #define SND_AUDIOMODE_G729_ANNEX_A           ((__u32) 0x00000001)
271 #define SND_AUDIOMODE_G729_ANNEX_B           ((__u32) 0x00000002)
272 
273 /* <FIXME: multichannel encoders aren't supported for now. Would need
274    an additional definition of channel arrangement> */
275 
276 /* VBR/CBR definitions */
277 #define SND_RATECONTROLMODE_CONSTANTBITRATE  ((__u32) 0x00000001)
278 #define SND_RATECONTROLMODE_VARIABLEBITRATE  ((__u32) 0x00000002)
279 
280 /* Encoder options */
281 
282 struct snd_enc_wma {
283 	__u32 super_block_align; /* WMA Type-specific data */
284 	__u32 bits_per_sample;
285 	__u32 channelmask;
286 	__u32 encodeopt;
287 	__u32 encodeopt1;
288 	__u32 encodeopt2;
289 	__u32 avg_bit_rate;
290 };
291 
292 #define SND_ENC_WMA_EXTENTED_SUPPORT
293 
294 /**
295  * struct snd_enc_vorbis
296  * @quality: Sets encoding quality to n, between -1 (low) and 10 (high).
297  * In the default mode of operation, the quality level is 3.
298  * Normal quality range is 0 - 10.
299  * @managed: Boolean. Set  bitrate  management  mode. This turns off the
300  * normal VBR encoding, but allows hard or soft bitrate constraints to be
301  * enforced by the encoder. This mode can be slower, and may also be
302  * lower quality. It is primarily useful for streaming.
303  * @max_bit_rate: Enabled only if managed is TRUE
304  * @min_bit_rate: Enabled only if managed is TRUE
305  * @downmix: Boolean. Downmix input from stereo to mono (has no effect on
306  * non-stereo streams). Useful for lower-bitrate encoding.
307  *
308  * These options were extracted from the OpenMAX IL spec and Gstreamer vorbisenc
309  * properties
310  *
311  * For best quality users should specify VBR mode and set quality levels.
312  */
313 
314 struct snd_enc_vorbis {
315 	__s32 quality;
316 	__u32 managed;
317 	__u32 max_bit_rate;
318 	__u32 min_bit_rate;
319 	__u32 downmix;
320 } __attribute__((packed, aligned(4)));
321 
322 
323 /**
324  * struct snd_enc_real
325  * @quant_bits: number of coupling quantization bits in the stream
326  * @start_region: coupling start region in the stream
327  * @num_regions: number of regions value
328  *
329  * These options were extracted from the OpenMAX IL spec
330  */
331 
332 struct snd_enc_real {
333 	__u32 quant_bits;
334 	__u32 start_region;
335 	__u32 num_regions;
336 } __attribute__((packed, aligned(4)));
337 
338 /**
339  * struct snd_enc_flac
340  * @num: serial number, valid only for OGG formats
341  *	needs to be set by application
342  * @gain: Add replay gain tags
343  *
344  * These options were extracted from the FLAC online documentation
345  * at http://flac.sourceforge.net/documentation_tools_flac.html
346  *
347  * To make the API simpler, it is assumed that the user will select quality
348  * profiles. Additional options that affect encoding quality and speed can
349  * be added at a later stage if needed.
350  *
351  * By default the Subset format is used by encoders.
352  *
353  * TAGS such as pictures, etc, cannot be handled by an offloaded encoder and are
354  * not supported in this API.
355  */
356 
357 struct snd_enc_flac {
358 	__u32 num;
359 	__u32 gain;
360 } __attribute__((packed, aligned(4)));
361 
362 struct snd_enc_generic {
363 	__u32 bw;	/* encoder bandwidth */
364 	__s32 reserved[15];	/* Can be used for SND_AUDIOCODEC_BESPOKE */
365 } __attribute__((packed, aligned(4)));
366 
367 #define SND_DEC_THD_MAX_PARAMS 8
368 struct snd_dec_thd {
369 	__u32 params_length;
370 	__u32 params_id[SND_DEC_THD_MAX_PARAMS];
371 	__u32 params_value[SND_DEC_THD_MAX_PARAMS];
372 } __attribute__((packed, aligned(4)));
373 
374 struct snd_dec_flac {
375 	__u16 sample_size;
376 	__u16 min_blk_size;
377 	__u16 max_blk_size;
378 	__u16 min_frame_size;
379 	__u16 max_frame_size;
380 } __attribute__((packed, aligned(4)));
381 
382 #define SND_DEC_FLAC_SUPPORTED
383 
384 struct snd_dec_vorbis {
385 	__u32 bit_stream_fmt;
386 };
387 
388 struct snd_dec_alac {
389 	__u32 frame_length;
390 	__u8 compatible_version;
391 	__u8 bit_depth;
392 	__u8 pb;
393 	__u8 mb;
394 	__u8 kb;
395 	__u8 num_channels;
396 	__u16 max_run;
397 	__u32 max_frame_bytes;
398 	__u32 avg_bit_rate;
399 	__u32 sample_rate;
400 	__u32 channel_layout_tag;
401 };
402 
403 struct snd_dec_ape {
404 	__u16 compatible_version;
405 	__u16 compression_level;
406 	__u32 format_flags;
407 	__u32 blocks_per_frame;
408 	__u32 final_frame_blocks;
409 	__u32 total_frames;
410 	__u16 bits_per_sample;
411 	__u16 num_channels;
412 	__u32 sample_rate;
413 	__u32 seek_table_present;
414 };
415 
416 struct snd_dec_aptx {
417 	__u32 lap;
418 	__u32 uap;
419 	__u32 nap;
420 };
421 
422 /** struct snd_dec_dsd - codec for DSD format
423  * @blk_size - dsd channel block size
424  */
425 struct snd_dec_dsd {
426 	__u32 blk_size;
427 };
428 
429 /** struct snd_dec_pcm - codec options for PCM format
430  * @num_channels: Number of channels
431  * @ch_map: Channel map for the above corresponding channels
432  */
433 struct snd_dec_pcm {
434 	__u32 num_channels;
435 	__u8 ch_map[MAX_PCM_DECODE_CHANNELS];
436 } __attribute__((packed, aligned(4)));
437 
438 struct snd_dec_amrwb_plus {
439 	__u32 bit_stream_fmt;
440 };
441 union snd_codec_options {
442 	struct snd_enc_wma wma;
443 	struct snd_enc_vorbis vorbis;
444 	struct snd_enc_real real;
445 	struct snd_enc_flac flac;
446 	struct snd_enc_generic generic;
447 	struct snd_dec_flac flac_dec;
448 	struct snd_dec_vorbis vorbis_dec;
449 	struct snd_dec_alac alac;
450 	struct snd_dec_ape ape;
451 	struct snd_dec_aptx aptx_dec;
452 	struct snd_dec_thd truehd;
453 	struct snd_dec_pcm pcm_dec;
454 	struct snd_dec_amrwb_plus amrwbplus;
455 	struct snd_dec_dsd dsd_dec;
456 };
457 
458 /** struct snd_codec_desc - description of codec capabilities
459  * @max_ch: Maximum number of audio channels
460  * @sample_rates: Sampling rates in Hz, use values like 48000 for this
461  * @num_sample_rates: Number of valid values in sample_rates array
462  * @bit_rate: Indexed array containing supported bit rates
463  * @num_bitrates: Number of valid values in bit_rate array
464  * @rate_control: value is specified by SND_RATECONTROLMODE defines.
465  * @profiles: Supported profiles. See SND_AUDIOPROFILE defines.
466  * @modes: Supported modes. See SND_AUDIOMODE defines
467  * @formats: Supported formats. See SND_AUDIOSTREAMFORMAT defines
468  * @min_buffer: Minimum buffer size handled by codec implementation
469  * @reserved: reserved for future use
470  *
471  * This structure provides a scalar value for profiles, modes and stream
472  * format fields.
473  * If an implementation supports multiple combinations, they will be listed as
474  * codecs with different descriptors, for example there would be 2 descriptors
475  * for AAC-RAW and AAC-ADTS.
476  * This entails some redundancy but makes it easier to avoid invalid
477  * configurations.
478  *
479  */
480 
481 struct snd_codec_desc {
482 	__u32 max_ch;
483 	__u32 sample_rates[MAX_NUM_SAMPLE_RATES];
484 	__u32 num_sample_rates;
485 	__u32 bit_rate[MAX_NUM_BITRATES];
486 	__u32 num_bitrates;
487 	__u32 rate_control;
488 	__u32 profiles;
489 	__u32 modes;
490 	__u32 formats;
491 	__u32 min_buffer;
492 	__u32 reserved[15];
493 } __attribute__((packed, aligned(4)));
494 
495 /** struct snd_codec
496  * @id: Identifies the supported audio encoder/decoder.
497  *		See SND_AUDIOCODEC macros.
498  * @ch_in: Number of input audio channels
499  * @ch_out: Number of output channels. In case of contradiction between
500  *		this field and the channelMode field, the channelMode field
501  *		overrides.
502  * @sample_rate: Audio sample rate of input data in Hz, use values like 48000
503  *		for this.
504  * @bit_rate: Bitrate of encoded data. May be ignored by decoders
505  * @rate_control: Encoding rate control. See SND_RATECONTROLMODE defines.
506  *               Encoders may rely on profiles for quality levels.
507  *		 May be ignored by decoders.
508  * @profile: Mandatory for encoders, can be mandatory for specific
509  *		decoders as well. See SND_AUDIOPROFILE defines.
510  * @level: Supported level (Only used by WMA at the moment)
511  * @ch_mode: Channel mode for encoder. See SND_AUDIOCHANMODE defines
512  * @format: Format of encoded bistream. Mandatory when defined.
513  *		See SND_AUDIOSTREAMFORMAT defines.
514  * @align: Block alignment in bytes of an audio sample.
515  *		Only required for PCM or IEC formats.
516  * @options: encoder-specific settings
517  * @compr_passthr: compressed bitstream passthrough
518  * @reserved: reserved for future use
519  */
520 
521 struct snd_codec {
522 	__u32 id;
523 	__u32 ch_in;
524 	__u32 ch_out;
525 	__u32 sample_rate;
526 	__u32 bit_rate;
527 	__u32 rate_control;
528 	__u32 profile;
529 	__u32 level;
530 	__u32 ch_mode;
531 	__u32 format;
532 	__u32 align;
533 	union snd_codec_options options;
534 	__u32 compr_passthr;
535 	__u32 flags;
536 	__u32 reserved[1];
537 } __attribute__((packed, aligned(4)));
538 
539 #define SND_CODEC_COMPRESS_PASSTHROUGH
540 
541 /** struct snd_codec_metadata
542  * @length: Length of the encoded buffer.
543  * @offset: Offset from the buffer address to the first byte of the first
544  *		encoded frame. All encoded frames are consecutive starting
545  *		from this offset.
546  * @timestamp: Session time in microseconds of the first sample in the buffer.
547  * @reserved: Reserved for future use.
548  */
549 struct snd_codec_metadata {
550 	__u32 length;
551 	__u32 offset;
552 	__u64 timestamp;
553 	__u32 reserved[4];
554 };
555 
556 #endif
557