blob: a0cbd3bb990c0ffebe4f06dc7f32e4b4c28cb589 [file] [log] [blame]
James Dong334de522012-03-12 12:47:14 -07001/* ------------------------------------------------------------------
2 * Copyright (C) 1998-2009 PacketVideo
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
13 * express or implied.
14 * See the License for the specific language governing permissions
15 * and limitations under the License.
16 * -------------------------------------------------------------------
17 */
18/*
Lajos Molnara1ae5a42014-11-06 17:05:46 -080019 * Copyright (c) 2008 The Khronos Group Inc.
20 *
James Dong334de522012-03-12 12:47:14 -070021 * Permission is hereby granted, free of charge, to any person obtaining
22 * a copy of this software and associated documentation files (the
23 * "Software"), to deal in the Software without restriction, including
24 * without limitation the rights to use, copy, modify, merge, publish,
25 * distribute, sublicense, and/or sell copies of the Software, and to
26 * permit persons to whom the Software is furnished to do so, subject
Lajos Molnara1ae5a42014-11-06 17:05:46 -080027 * to the following conditions:
James Dong334de522012-03-12 12:47:14 -070028 * The above copyright notice and this permission notice shall be included
Lajos Molnara1ae5a42014-11-06 17:05:46 -080029 * in all copies or substantial portions of the Software.
30 *
James Dong334de522012-03-12 12:47:14 -070031 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
32 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
34 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
35 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
36 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
Lajos Molnara1ae5a42014-11-06 17:05:46 -080037 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
James Dong334de522012-03-12 12:47:14 -070038 *
39 */
40
41/** @file OMX_Audio.h - OpenMax IL version 1.1.2
42 * The structures needed by Audio components to exchange
43 * parameters and configuration data with the componenmilts.
44 */
45
46#ifndef OMX_Audio_h
47#define OMX_Audio_h
48
49#ifdef __cplusplus
50extern "C" {
51#endif /* __cplusplus */
52
James Dong334de522012-03-12 12:47:14 -070053/* Each OMX header must include all required header files to allow the
54 * header to compile without errors. The includes below are required
Lajos Molnara1ae5a42014-11-06 17:05:46 -080055 * for this header file to compile successfully
James Dong334de522012-03-12 12:47:14 -070056 */
57
58#include <OMX_Core.h>
59
60/** @defgroup midi MIDI
61 * @ingroup audio
62 */
Lajos Molnara1ae5a42014-11-06 17:05:46 -080063
James Dong334de522012-03-12 12:47:14 -070064/** @defgroup effects Audio effects
65 * @ingroup audio
66 */
67
68/** @defgroup audio OpenMAX IL Audio Domain
69 * Structures for OpenMAX IL Audio domain
70 * @{
71 */
72
Lajos Molnara1ae5a42014-11-06 17:05:46 -080073/** Enumeration used to define the possible audio codings.
74 * If "OMX_AUDIO_CodingUnused" is selected, the coding selection must
75 * be done in a vendor specific way. Since this is for an audio
76 * processing element this enum is relevant. However, for another
James Dong334de522012-03-12 12:47:14 -070077 * type of component other enums would be in this area.
78 */
79typedef enum OMX_AUDIO_CODINGTYPE {
80 OMX_AUDIO_CodingUnused = 0, /**< Placeholder value when coding is N/A */
81 OMX_AUDIO_CodingAutoDetect, /**< auto detection of audio format */
82 OMX_AUDIO_CodingPCM, /**< Any variant of PCM coding */
83 OMX_AUDIO_CodingADPCM, /**< Any variant of ADPCM encoded data */
84 OMX_AUDIO_CodingAMR, /**< Any variant of AMR encoded data */
85 OMX_AUDIO_CodingGSMFR, /**< Any variant of GSM fullrate (i.e. GSM610) */
86 OMX_AUDIO_CodingGSMEFR, /**< Any variant of GSM Enhanced Fullrate encoded data*/
87 OMX_AUDIO_CodingGSMHR, /**< Any variant of GSM Halfrate encoded data */
88 OMX_AUDIO_CodingPDCFR, /**< Any variant of PDC Fullrate encoded data */
89 OMX_AUDIO_CodingPDCEFR, /**< Any variant of PDC Enhanced Fullrate encoded data */
90 OMX_AUDIO_CodingPDCHR, /**< Any variant of PDC Halfrate encoded data */
91 OMX_AUDIO_CodingTDMAFR, /**< Any variant of TDMA Fullrate encoded data (TIA/EIA-136-420) */
92 OMX_AUDIO_CodingTDMAEFR, /**< Any variant of TDMA Enhanced Fullrate encoded data (TIA/EIA-136-410) */
93 OMX_AUDIO_CodingQCELP8, /**< Any variant of QCELP 8kbps encoded data */
94 OMX_AUDIO_CodingQCELP13, /**< Any variant of QCELP 13kbps encoded data */
95 OMX_AUDIO_CodingEVRC, /**< Any variant of EVRC encoded data */
96 OMX_AUDIO_CodingSMV, /**< Any variant of SMV encoded data */
97 OMX_AUDIO_CodingG711, /**< Any variant of G.711 encoded data */
98 OMX_AUDIO_CodingG723, /**< Any variant of G.723 dot 1 encoded data */
99 OMX_AUDIO_CodingG726, /**< Any variant of G.726 encoded data */
100 OMX_AUDIO_CodingG729, /**< Any variant of G.729 encoded data */
101 OMX_AUDIO_CodingAAC, /**< Any variant of AAC encoded data */
102 OMX_AUDIO_CodingMP3, /**< Any variant of MP3 encoded data */
103 OMX_AUDIO_CodingSBC, /**< Any variant of SBC encoded data */
104 OMX_AUDIO_CodingVORBIS, /**< Any variant of VORBIS encoded data */
105 OMX_AUDIO_CodingWMA, /**< Any variant of WMA encoded data */
106 OMX_AUDIO_CodingRA, /**< Any variant of RA encoded data */
107 OMX_AUDIO_CodingMIDI, /**< Any variant of MIDI encoded data */
Jean-Michel Trivi224c7842012-04-30 10:27:25 -0700108 OMX_AUDIO_CodingFLAC, /**< Any variant of FLAC encoded data */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800109 OMX_AUDIO_CodingKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700110 OMX_AUDIO_CodingVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
111 OMX_AUDIO_CodingMax = 0x7FFFFFFF
112} OMX_AUDIO_CODINGTYPE;
113
114
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800115/** The PortDefinition structure is used to define all of the parameters
116 * necessary for the compliant component to setup an input or an output audio
James Dong334de522012-03-12 12:47:14 -0700117 * path. If additional information is needed to define the parameters of the
118 * port (such as frequency), additional structures must be sent such as the
119 * OMX_AUDIO_PARAM_PCMMODETYPE structure to supply the extra parameters for the port.
120 */
121typedef struct OMX_AUDIO_PORTDEFINITIONTYPE {
122 OMX_STRING cMIMEType; /**< MIME type of data for the port */
123 OMX_NATIVE_DEVICETYPE pNativeRender; /** < platform specific reference
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800124 for an output device,
James Dong334de522012-03-12 12:47:14 -0700125 otherwise this field is 0 */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800126 OMX_BOOL bFlagErrorConcealment; /**< Turns on error concealment if it is
James Dong334de522012-03-12 12:47:14 -0700127 supported by the OMX component */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800128 OMX_AUDIO_CODINGTYPE eEncoding; /**< Type of data expected for this
James Dong334de522012-03-12 12:47:14 -0700129 port (e.g. PCM, AMR, MP3, etc) */
130} OMX_AUDIO_PORTDEFINITIONTYPE;
131
132
133/** Port format parameter. This structure is used to enumerate
134 * the various data input/output format supported by the port.
135 */
136typedef struct OMX_AUDIO_PARAM_PORTFORMATTYPE {
137 OMX_U32 nSize; /**< size of the structure in bytes */
138 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
139 OMX_U32 nPortIndex; /**< Indicates which port to set */
140 OMX_U32 nIndex; /**< Indicates the enumeration index for the format from 0x0 to N-1 */
141 OMX_AUDIO_CODINGTYPE eEncoding; /**< Type of data expected for this port (e.g. PCM, AMR, MP3, etc) */
142} OMX_AUDIO_PARAM_PORTFORMATTYPE;
143
144
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800145/** PCM mode type */
146typedef enum OMX_AUDIO_PCMMODETYPE {
147 OMX_AUDIO_PCMModeLinear = 0, /**< Linear PCM encoded data */
148 OMX_AUDIO_PCMModeALaw, /**< A law PCM encoded data (G.711) */
149 OMX_AUDIO_PCMModeMULaw, /**< Mu law PCM encoded data (G.711) */
150 OMX_AUDIO_PCMModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700151 OMX_AUDIO_PCMModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800152 OMX_AUDIO_PCMModeMax = 0x7FFFFFFF
153} OMX_AUDIO_PCMMODETYPE;
James Dong334de522012-03-12 12:47:14 -0700154
155
156typedef enum OMX_AUDIO_CHANNELTYPE {
157 OMX_AUDIO_ChannelNone = 0x0, /**< Unused or empty */
158 OMX_AUDIO_ChannelLF = 0x1, /**< Left front */
159 OMX_AUDIO_ChannelRF = 0x2, /**< Right front */
160 OMX_AUDIO_ChannelCF = 0x3, /**< Center front */
161 OMX_AUDIO_ChannelLS = 0x4, /**< Left surround */
162 OMX_AUDIO_ChannelRS = 0x5, /**< Right surround */
163 OMX_AUDIO_ChannelLFE = 0x6, /**< Low frequency effects */
164 OMX_AUDIO_ChannelCS = 0x7, /**< Back surround */
165 OMX_AUDIO_ChannelLR = 0x8, /**< Left rear. */
166 OMX_AUDIO_ChannelRR = 0x9, /**< Right rear. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800167 OMX_AUDIO_ChannelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700168 OMX_AUDIO_ChannelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800169 OMX_AUDIO_ChannelMax = 0x7FFFFFFF
James Dong334de522012-03-12 12:47:14 -0700170} OMX_AUDIO_CHANNELTYPE;
171
172#define OMX_AUDIO_MAXCHANNELS 16 /**< maximum number distinct audio channels that a buffer may contain */
173#define OMX_MIN_PCMPAYLOAD_MSEC 5 /**< Minimum audio buffer payload size for uncompressed (PCM) audio */
174
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800175/** PCM format description */
176typedef struct OMX_AUDIO_PARAM_PCMMODETYPE {
177 OMX_U32 nSize; /**< Size of this structure, in Bytes */
178 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
179 OMX_U32 nPortIndex; /**< port that this structure applies to */
180 OMX_U32 nChannels; /**< Number of channels (e.g. 2 for stereo) */
181 OMX_NUMERICALDATATYPE eNumData; /**< indicates PCM data as signed or unsigned */
182 OMX_ENDIANTYPE eEndian; /**< indicates PCM data as little or big endian */
183 OMX_BOOL bInterleaved; /**< True for normal interleaved data; false for
184 non-interleaved data (e.g. block data) */
185 OMX_U32 nBitPerSample; /**< Bit per sample */
186 OMX_U32 nSamplingRate; /**< Sampling rate of the source data. Use 0 for
187 variable or unknown sampling rate. */
188 OMX_AUDIO_PCMMODETYPE ePCMMode; /**< PCM mode enumeration */
James Dong334de522012-03-12 12:47:14 -0700189 OMX_AUDIO_CHANNELTYPE eChannelMapping[OMX_AUDIO_MAXCHANNELS]; /**< Slot i contains channel defined by eChannelMap[i] */
190
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800191} OMX_AUDIO_PARAM_PCMMODETYPE;
James Dong334de522012-03-12 12:47:14 -0700192
193
194/** Audio channel mode. This is used by both AAC and MP3, although the names are more appropriate
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800195 * for the MP3. For example, JointStereo for MP3 is CouplingChannels for AAC.
James Dong334de522012-03-12 12:47:14 -0700196 */
197typedef enum OMX_AUDIO_CHANNELMODETYPE {
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800198 OMX_AUDIO_ChannelModeStereo = 0, /**< 2 channels, the bitrate allocation between those
James Dong334de522012-03-12 12:47:14 -0700199 two channels changes accordingly to each channel information */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800200 OMX_AUDIO_ChannelModeJointStereo, /**< mode that takes advantage of what is common between
James Dong334de522012-03-12 12:47:14 -0700201 2 channels for higher compression gain */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800202 OMX_AUDIO_ChannelModeDual, /**< 2 mono-channels, each channel is encoded with half
James Dong334de522012-03-12 12:47:14 -0700203 the bitrate of the overall bitrate */
204 OMX_AUDIO_ChannelModeMono, /**< Mono channel mode */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800205 OMX_AUDIO_ChannelModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700206 OMX_AUDIO_ChannelModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
207 OMX_AUDIO_ChannelModeMax = 0x7FFFFFFF
208} OMX_AUDIO_CHANNELMODETYPE;
209
210
211typedef enum OMX_AUDIO_MP3STREAMFORMATTYPE {
212 OMX_AUDIO_MP3StreamFormatMP1Layer3 = 0, /**< MP3 Audio MPEG 1 Layer 3 Stream format */
213 OMX_AUDIO_MP3StreamFormatMP2Layer3, /**< MP3 Audio MPEG 2 Layer 3 Stream format */
214 OMX_AUDIO_MP3StreamFormatMP2_5Layer3, /**< MP3 Audio MPEG2.5 Layer 3 Stream format */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800215 OMX_AUDIO_MP3StreamFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700216 OMX_AUDIO_MP3StreamFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
217 OMX_AUDIO_MP3StreamFormatMax = 0x7FFFFFFF
218} OMX_AUDIO_MP3STREAMFORMATTYPE;
219
220/** MP3 params */
221typedef struct OMX_AUDIO_PARAM_MP3TYPE {
222 OMX_U32 nSize; /**< size of the structure in bytes */
223 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
224 OMX_U32 nPortIndex; /**< port that this structure applies to */
225 OMX_U32 nChannels; /**< Number of channels */
226 OMX_U32 nBitRate; /**< Bit rate of the input data. Use 0 for variable
227 rate or unknown bit rates */
228 OMX_U32 nSampleRate; /**< Sampling rate of the source data. Use 0 for
229 variable or unknown sampling rate. */
230 OMX_U32 nAudioBandWidth; /**< Audio band width (in Hz) to which an encoder should
231 limit the audio signal. Use 0 to let encoder decide */
232 OMX_AUDIO_CHANNELMODETYPE eChannelMode; /**< Channel mode enumeration */
233 OMX_AUDIO_MP3STREAMFORMATTYPE eFormat; /**< MP3 stream format */
234} OMX_AUDIO_PARAM_MP3TYPE;
235
236
237typedef enum OMX_AUDIO_AACSTREAMFORMATTYPE {
238 OMX_AUDIO_AACStreamFormatMP2ADTS = 0, /**< AAC Audio Data Transport Stream 2 format */
239 OMX_AUDIO_AACStreamFormatMP4ADTS, /**< AAC Audio Data Transport Stream 4 format */
240 OMX_AUDIO_AACStreamFormatMP4LOAS, /**< AAC Low Overhead Audio Stream format */
241 OMX_AUDIO_AACStreamFormatMP4LATM, /**< AAC Low overhead Audio Transport Multiplex */
242 OMX_AUDIO_AACStreamFormatADIF, /**< AAC Audio Data Interchange Format */
243 OMX_AUDIO_AACStreamFormatMP4FF, /**< AAC inside MPEG-4/ISO File Format */
244 OMX_AUDIO_AACStreamFormatRAW, /**< AAC Raw Format */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800245 OMX_AUDIO_AACStreamFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700246 OMX_AUDIO_AACStreamFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
247 OMX_AUDIO_AACStreamFormatMax = 0x7FFFFFFF
248} OMX_AUDIO_AACSTREAMFORMATTYPE;
249
250
251/** AAC mode type. Note that the term profile is used with the MPEG-2
252 * standard and the term object type and profile is used with MPEG-4 */
253typedef enum OMX_AUDIO_AACPROFILETYPE{
254 OMX_AUDIO_AACObjectNull = 0, /**< Null, not used */
255 OMX_AUDIO_AACObjectMain = 1, /**< AAC Main object */
256 OMX_AUDIO_AACObjectLC, /**< AAC Low Complexity object (AAC profile) */
257 OMX_AUDIO_AACObjectSSR, /**< AAC Scalable Sample Rate object */
258 OMX_AUDIO_AACObjectLTP, /**< AAC Long Term Prediction object */
259 OMX_AUDIO_AACObjectHE, /**< AAC High Efficiency (object type SBR, HE-AAC profile) */
260 OMX_AUDIO_AACObjectScalable, /**< AAC Scalable object */
261 OMX_AUDIO_AACObjectERLC = 17, /**< ER AAC Low Complexity object (Error Resilient AAC-LC) */
262 OMX_AUDIO_AACObjectLD = 23, /**< AAC Low Delay object (Error Resilient) */
263 OMX_AUDIO_AACObjectHE_PS = 29, /**< AAC High Efficiency with Parametric Stereo coding (HE-AAC v2, object type PS) */
Dave Burke8e846fd2012-04-24 16:06:50 -0700264 OMX_AUDIO_AACObjectELD = 39, /** AAC Enhanced Low Delay. NOTE: Pending Khronos standardization **/
265 OMX_AUDIO_AACObjectKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700266 OMX_AUDIO_AACObjectVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
267 OMX_AUDIO_AACObjectMax = 0x7FFFFFFF
268} OMX_AUDIO_AACPROFILETYPE;
269
270
271/** AAC tool usage (for nAACtools in OMX_AUDIO_PARAM_AACPROFILETYPE).
272 * Required for encoder configuration and optional as decoder info output.
273 * For MP3, OMX_AUDIO_CHANNELMODETYPE is sufficient. */
274#define OMX_AUDIO_AACToolNone 0x00000000 /**< no AAC tools allowed (encoder config) or active (decoder info output) */
275#define OMX_AUDIO_AACToolMS 0x00000001 /**< MS: Mid/side joint coding tool allowed or active */
276#define OMX_AUDIO_AACToolIS 0x00000002 /**< IS: Intensity stereo tool allowed or active */
277#define OMX_AUDIO_AACToolTNS 0x00000004 /**< TNS: Temporal Noise Shaping tool allowed or active */
278#define OMX_AUDIO_AACToolPNS 0x00000008 /**< PNS: MPEG-4 Perceptual Noise substitution tool allowed or active */
279#define OMX_AUDIO_AACToolLTP 0x00000010 /**< LTP: MPEG-4 Long Term Prediction tool allowed or active */
Jean-Michel Trivie91cd212014-08-01 22:20:17 -0700280#define OMX_AUDIO_AACToolVendor 0x00010000 /**< NOT A KHRONOS VALUE, offset for vendor-specific additions */
James Dong334de522012-03-12 12:47:14 -0700281#define OMX_AUDIO_AACToolAll 0x7FFFFFFF /**< all AAC tools allowed or active (*/
282
283/** MPEG-4 AAC error resilience (ER) tool usage (for nAACERtools in OMX_AUDIO_PARAM_AACPROFILETYPE).
284 * Required for ER encoder configuration and optional as decoder info output */
285#define OMX_AUDIO_AACERNone 0x00000000 /**< no AAC ER tools allowed/used */
286#define OMX_AUDIO_AACERVCB11 0x00000001 /**< VCB11: Virtual Code Books for AAC section data */
287#define OMX_AUDIO_AACERRVLC 0x00000002 /**< RVLC: Reversible Variable Length Coding */
288#define OMX_AUDIO_AACERHCR 0x00000004 /**< HCR: Huffman Codeword Reordering */
289#define OMX_AUDIO_AACERAll 0x7FFFFFFF /**< all AAC ER tools allowed/used */
290
291
292/** AAC params */
293typedef struct OMX_AUDIO_PARAM_AACPROFILETYPE {
294 OMX_U32 nSize; /**< Size of this structure, in Bytes */
295 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
296 OMX_U32 nPortIndex; /**< Port that this structure applies to */
297 OMX_U32 nChannels; /**< Number of channels */
298 OMX_U32 nSampleRate; /**< Sampling rate of the source data. Use 0 for
299 variable or unknown sampling rate. */
300 OMX_U32 nBitRate; /**< Bit rate of the input data. Use 0 for variable
301 rate or unknown bit rates */
302 OMX_U32 nAudioBandWidth; /**< Audio band width (in Hz) to which an encoder should
303 limit the audio signal. Use 0 to let encoder decide */
304 OMX_U32 nFrameLength; /**< Frame length (in audio samples per channel) of the codec.
305 Can be 1024 or 960 (AAC-LC), 2048 (HE-AAC), 480 or 512 (AAC-LD).
306 Use 0 to let encoder decide */
307 OMX_U32 nAACtools; /**< AAC tool usage */
308 OMX_U32 nAACERtools; /**< MPEG-4 AAC error resilience tool usage */
309 OMX_AUDIO_AACPROFILETYPE eAACProfile; /**< AAC profile enumeration */
310 OMX_AUDIO_AACSTREAMFORMATTYPE eAACStreamFormat; /**< AAC stream format enumeration */
311 OMX_AUDIO_CHANNELMODETYPE eChannelMode; /**< Channel mode enumeration */
312} OMX_AUDIO_PARAM_AACPROFILETYPE;
313
314
315/** VORBIS params */
316typedef struct OMX_AUDIO_PARAM_VORBISTYPE {
317 OMX_U32 nSize; /**< size of the structure in bytes */
318 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
319 OMX_U32 nPortIndex; /**< port that this structure applies to */
320 OMX_U32 nChannels; /**< Number of channels */
321 OMX_U32 nBitRate; /**< Bit rate of the encoded data data. Use 0 for variable
322 rate or unknown bit rates. Encoding is set to the
323 bitrate closest to specified value (in bps) */
324 OMX_U32 nMinBitRate; /**< Sets minimum bitrate (in bps). */
325 OMX_U32 nMaxBitRate; /**< Sets maximum bitrate (in bps). */
326
327 OMX_U32 nSampleRate; /**< Sampling rate of the source data. Use 0 for
328 variable or unknown sampling rate. */
329 OMX_U32 nAudioBandWidth; /**< Audio band width (in Hz) to which an encoder should
330 limit the audio signal. Use 0 to let encoder decide */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800331 OMX_S32 nQuality; /**< Sets encoding quality to n, between -1 (low) and 10 (high).
James Dong334de522012-03-12 12:47:14 -0700332 In the default mode of operation, teh quality level is 3.
333 Normal quality range is 0 - 10. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800334 OMX_BOOL bManaged; /**< Set bitrate management mode. This turns off the
James Dong334de522012-03-12 12:47:14 -0700335 normal VBR encoding, but allows hard or soft bitrate
336 constraints to be enforced by the encoder. This mode can
337 be slower, and may also be lower quality. It is
338 primarily useful for streaming. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800339 OMX_BOOL bDownmix; /**< Downmix input from stereo to mono (has no effect on
340 non-stereo streams). Useful for lower-bitrate encoding. */
James Dong334de522012-03-12 12:47:14 -0700341} OMX_AUDIO_PARAM_VORBISTYPE;
342
343
Jean-Michel Trivi224c7842012-04-30 10:27:25 -0700344/** FLAC params */
345typedef struct OMX_AUDIO_PARAM_FLACTYPE {
346 OMX_U32 nSize; /**< size of the structure in bytes */
347 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
348 OMX_U32 nPortIndex; /**< port that this structure applies to */
349 OMX_U32 nChannels; /**< Number of channels */
350 OMX_U32 nSampleRate; /**< Sampling rate of the source data. Use 0 for
351 unknown sampling rate. */
352 OMX_U32 nCompressionLevel;/**< FLAC compression level, from 0 (fastest compression)
353 to 8 (highest compression */
354} OMX_AUDIO_PARAM_FLACTYPE;
355
356
James Dong334de522012-03-12 12:47:14 -0700357/** WMA Version */
358typedef enum OMX_AUDIO_WMAFORMATTYPE {
359 OMX_AUDIO_WMAFormatUnused = 0, /**< format unused or unknown */
360 OMX_AUDIO_WMAFormat7, /**< Windows Media Audio format 7 */
361 OMX_AUDIO_WMAFormat8, /**< Windows Media Audio format 8 */
362 OMX_AUDIO_WMAFormat9, /**< Windows Media Audio format 9 */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800363 OMX_AUDIO_WMAFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700364 OMX_AUDIO_WMAFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
365 OMX_AUDIO_WMAFormatMax = 0x7FFFFFFF
366} OMX_AUDIO_WMAFORMATTYPE;
367
368
369/** WMA Profile */
370typedef enum OMX_AUDIO_WMAPROFILETYPE {
371 OMX_AUDIO_WMAProfileUnused = 0, /**< profile unused or unknown */
372 OMX_AUDIO_WMAProfileL1, /**< Windows Media audio version 9 profile L1 */
373 OMX_AUDIO_WMAProfileL2, /**< Windows Media audio version 9 profile L2 */
374 OMX_AUDIO_WMAProfileL3, /**< Windows Media audio version 9 profile L3 */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800375 OMX_AUDIO_WMAProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700376 OMX_AUDIO_WMAProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
377 OMX_AUDIO_WMAProfileMax = 0x7FFFFFFF
378} OMX_AUDIO_WMAPROFILETYPE;
379
380
381/** WMA params */
382typedef struct OMX_AUDIO_PARAM_WMATYPE {
383 OMX_U32 nSize; /**< size of the structure in bytes */
384 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
385 OMX_U32 nPortIndex; /**< port that this structure applies to */
386 OMX_U16 nChannels; /**< Number of channels */
387 OMX_U32 nBitRate; /**< Bit rate of the input data. Use 0 for variable
388 rate or unknown bit rates */
389 OMX_AUDIO_WMAFORMATTYPE eFormat; /**< Version of WMA stream / data */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800390 OMX_AUDIO_WMAPROFILETYPE eProfile; /**< Profile of WMA stream / data */
James Dong334de522012-03-12 12:47:14 -0700391 OMX_U32 nSamplingRate; /**< Sampling rate of the source data */
392 OMX_U16 nBlockAlign; /**< is the block alignment, or block size, in bytes of the audio codec */
393 OMX_U16 nEncodeOptions; /**< WMA Type-specific data */
394 OMX_U32 nSuperBlockAlign; /**< WMA Type-specific data */
395} OMX_AUDIO_PARAM_WMATYPE;
396
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800397/**
James Dong334de522012-03-12 12:47:14 -0700398 * RealAudio format
399 */
400typedef enum OMX_AUDIO_RAFORMATTYPE {
401 OMX_AUDIO_RAFormatUnused = 0, /**< Format unused or unknown */
402 OMX_AUDIO_RA8, /**< RealAudio 8 codec */
403 OMX_AUDIO_RA9, /**< RealAudio 9 codec */
404 OMX_AUDIO_RA10_AAC, /**< MPEG-4 AAC codec for bitrates of more than 128kbps */
405 OMX_AUDIO_RA10_CODEC, /**< RealAudio codec for bitrates less than 128 kbps */
406 OMX_AUDIO_RA10_LOSSLESS, /**< RealAudio Lossless */
407 OMX_AUDIO_RA10_MULTICHANNEL, /**< RealAudio Multichannel */
408 OMX_AUDIO_RA10_VOICE, /**< RealAudio Voice for bitrates below 15 kbps */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800409 OMX_AUDIO_RAFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700410 OMX_AUDIO_RAFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
411 OMX_VIDEO_RAFormatMax = 0x7FFFFFFF
412} OMX_AUDIO_RAFORMATTYPE;
413
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800414/** RA (Real Audio) params */
415typedef struct OMX_AUDIO_PARAM_RATYPE {
416 OMX_U32 nSize; /**< Size of this structure, in Bytes */
417 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
418 OMX_U32 nPortIndex; /**< Port that this structure applies to */
419 OMX_U32 nChannels; /**< Number of channels */
420 OMX_U32 nSamplingRate; /**< is the sampling rate of the source data */
421 OMX_U32 nBitsPerFrame; /**< is the value for bits per frame */
422 OMX_U32 nSamplePerFrame; /**< is the value for samples per frame */
423 OMX_U32 nCouplingQuantBits; /**< is the number of coupling quantization bits in the stream */
424 OMX_U32 nCouplingStartRegion; /**< is the coupling start region in the stream */
425 OMX_U32 nNumRegions; /**< is the number of regions value */
James Dong334de522012-03-12 12:47:14 -0700426 OMX_AUDIO_RAFORMATTYPE eFormat; /**< is the RealAudio audio format */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800427} OMX_AUDIO_PARAM_RATYPE;
James Dong334de522012-03-12 12:47:14 -0700428
429
430/** SBC Allocation Method Type */
431typedef enum OMX_AUDIO_SBCALLOCMETHODTYPE {
432 OMX_AUDIO_SBCAllocMethodLoudness, /**< Loudness allocation method */
433 OMX_AUDIO_SBCAllocMethodSNR, /**< SNR allocation method */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800434 OMX_AUDIO_SBCAllocMethodKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700435 OMX_AUDIO_SBCAllocMethodVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
436 OMX_AUDIO_SBCAllocMethodMax = 0x7FFFFFFF
437} OMX_AUDIO_SBCALLOCMETHODTYPE;
438
439
440/** SBC params */
441typedef struct OMX_AUDIO_PARAM_SBCTYPE {
442 OMX_U32 nSize; /**< size of the structure in bytes */
443 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
444 OMX_U32 nPortIndex; /**< port that this structure applies to */
445 OMX_U32 nChannels; /**< Number of channels */
446 OMX_U32 nBitRate; /**< Bit rate of the input data. Use 0 for variable
447 rate or unknown bit rates */
448 OMX_U32 nSampleRate; /**< Sampling rate of the source data. Use 0 for
449 variable or unknown sampling rate. */
450 OMX_U32 nBlocks; /**< Number of blocks */
451 OMX_U32 nSubbands; /**< Number of subbands */
452 OMX_U32 nBitPool; /**< Bitpool value */
453 OMX_BOOL bEnableBitrate; /**< Use bitrate value instead of bitpool */
454 OMX_AUDIO_CHANNELMODETYPE eChannelMode; /**< Channel mode enumeration */
455 OMX_AUDIO_SBCALLOCMETHODTYPE eSBCAllocType; /**< SBC Allocation method type */
456} OMX_AUDIO_PARAM_SBCTYPE;
457
458
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800459/** ADPCM stream format parameters */
460typedef struct OMX_AUDIO_PARAM_ADPCMTYPE {
461 OMX_U32 nSize; /**< size of the structure in bytes */
462 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
463 OMX_U32 nPortIndex; /**< port that this structure applies to */
464 OMX_U32 nChannels; /**< Number of channels in the data stream (not
465 necessarily the same as the number of channels
466 to be rendered. */
467 OMX_U32 nBitsPerSample; /**< Number of bits in each sample */
468 OMX_U32 nSampleRate; /**< Sampling rate of the source data. Use 0 for
469 variable or unknown sampling rate. */
470} OMX_AUDIO_PARAM_ADPCMTYPE;
James Dong334de522012-03-12 12:47:14 -0700471
472
473/** G723 rate */
474typedef enum OMX_AUDIO_G723RATE {
475 OMX_AUDIO_G723ModeUnused = 0, /**< AMRNB Mode unused / unknown */
476 OMX_AUDIO_G723ModeLow, /**< 5300 bps */
477 OMX_AUDIO_G723ModeHigh, /**< 6300 bps */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800478 OMX_AUDIO_G723ModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700479 OMX_AUDIO_G723ModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
480 OMX_AUDIO_G723ModeMax = 0x7FFFFFFF
481} OMX_AUDIO_G723RATE;
482
483
484/** G723 - Sample rate must be 8 KHz */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800485typedef struct OMX_AUDIO_PARAM_G723TYPE {
486 OMX_U32 nSize; /**< size of the structure in bytes */
487 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
488 OMX_U32 nPortIndex; /**< port that this structure applies to */
489 OMX_U32 nChannels; /**< Number of channels in the data stream (not
490 necessarily the same as the number of channels
491 to be rendered. */
492 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
James Dong334de522012-03-12 12:47:14 -0700493 OMX_AUDIO_G723RATE eBitRate; /**< todo: Should this be moved to a config? */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800494 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
495 OMX_BOOL bPostFilter; /**< Enable Post Filter */
496} OMX_AUDIO_PARAM_G723TYPE;
James Dong334de522012-03-12 12:47:14 -0700497
498
499/** ITU G726 (ADPCM) rate */
500typedef enum OMX_AUDIO_G726MODE {
501 OMX_AUDIO_G726ModeUnused = 0, /**< G726 Mode unused / unknown */
502 OMX_AUDIO_G726Mode16, /**< 16 kbps */
503 OMX_AUDIO_G726Mode24, /**< 24 kbps */
504 OMX_AUDIO_G726Mode32, /**< 32 kbps, most common rate, also G721 */
505 OMX_AUDIO_G726Mode40, /**< 40 kbps */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800506 OMX_AUDIO_G726ModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700507 OMX_AUDIO_G726ModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
508 OMX_AUDIO_G726ModeMax = 0x7FFFFFFF
509} OMX_AUDIO_G726MODE;
510
511
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800512/** G.726 stream format parameters - must be at 8KHz */
513typedef struct OMX_AUDIO_PARAM_G726TYPE {
514 OMX_U32 nSize; /**< size of the structure in bytes */
515 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
516 OMX_U32 nPortIndex; /**< port that this structure applies to */
517 OMX_U32 nChannels; /**< Number of channels in the data stream (not
518 necessarily the same as the number of channels
519 to be rendered. */
James Dong334de522012-03-12 12:47:14 -0700520 OMX_AUDIO_G726MODE eG726Mode;
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800521} OMX_AUDIO_PARAM_G726TYPE;
James Dong334de522012-03-12 12:47:14 -0700522
523
524/** G729 coder type */
525typedef enum OMX_AUDIO_G729TYPE {
526 OMX_AUDIO_G729 = 0, /**< ITU G.729 encoded data */
527 OMX_AUDIO_G729A, /**< ITU G.729 annex A encoded data */
528 OMX_AUDIO_G729B, /**< ITU G.729 with annex B encoded data */
529 OMX_AUDIO_G729AB, /**< ITU G.729 annexes A and B encoded data */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800530 OMX_AUDIO_G729KhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700531 OMX_AUDIO_G729VendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
532 OMX_AUDIO_G729Max = 0x7FFFFFFF
533} OMX_AUDIO_G729TYPE;
534
535
536/** G729 stream format parameters - fixed 6KHz sample rate */
537typedef struct OMX_AUDIO_PARAM_G729TYPE {
538 OMX_U32 nSize; /**< size of the structure in bytes */
539 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
540 OMX_U32 nPortIndex; /**< port that this structure applies to */
541 OMX_U32 nChannels; /**< Number of channels in the data stream (not
542 necessarily the same as the number of channels
543 to be rendered. */
544 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
545 OMX_AUDIO_G729TYPE eBitType;
546} OMX_AUDIO_PARAM_G729TYPE;
547
548
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800549/** AMR Frame format */
550typedef enum OMX_AUDIO_AMRFRAMEFORMATTYPE {
551 OMX_AUDIO_AMRFrameFormatConformance = 0, /**< Frame Format is AMR Conformance
552 (Standard) Format */
553 OMX_AUDIO_AMRFrameFormatIF1, /**< Frame Format is AMR Interface
554 Format 1 */
555 OMX_AUDIO_AMRFrameFormatIF2, /**< Frame Format is AMR Interface
556 Format 2*/
557 OMX_AUDIO_AMRFrameFormatFSF, /**< Frame Format is AMR File Storage
558 Format */
559 OMX_AUDIO_AMRFrameFormatRTPPayload, /**< Frame Format is AMR Real-Time
560 Transport Protocol Payload Format */
561 OMX_AUDIO_AMRFrameFormatITU, /**< Frame Format is ITU Format (added at Motorola request) */
562 OMX_AUDIO_AMRFrameFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700563 OMX_AUDIO_AMRFrameFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800564 OMX_AUDIO_AMRFrameFormatMax = 0x7FFFFFFF
565} OMX_AUDIO_AMRFRAMEFORMATTYPE;
James Dong334de522012-03-12 12:47:14 -0700566
567
568/** AMR band mode */
569typedef enum OMX_AUDIO_AMRBANDMODETYPE {
570 OMX_AUDIO_AMRBandModeUnused = 0, /**< AMRNB Mode unused / unknown */
571 OMX_AUDIO_AMRBandModeNB0, /**< AMRNB Mode 0 = 4750 bps */
572 OMX_AUDIO_AMRBandModeNB1, /**< AMRNB Mode 1 = 5150 bps */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800573 OMX_AUDIO_AMRBandModeNB2, /**< AMRNB Mode 2 = 5900 bps */
James Dong334de522012-03-12 12:47:14 -0700574 OMX_AUDIO_AMRBandModeNB3, /**< AMRNB Mode 3 = 6700 bps */
575 OMX_AUDIO_AMRBandModeNB4, /**< AMRNB Mode 4 = 7400 bps */
576 OMX_AUDIO_AMRBandModeNB5, /**< AMRNB Mode 5 = 7950 bps */
577 OMX_AUDIO_AMRBandModeNB6, /**< AMRNB Mode 6 = 10200 bps */
578 OMX_AUDIO_AMRBandModeNB7, /**< AMRNB Mode 7 = 12200 bps */
579 OMX_AUDIO_AMRBandModeWB0, /**< AMRWB Mode 0 = 6600 bps */
580 OMX_AUDIO_AMRBandModeWB1, /**< AMRWB Mode 1 = 8850 bps */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800581 OMX_AUDIO_AMRBandModeWB2, /**< AMRWB Mode 2 = 12650 bps */
582 OMX_AUDIO_AMRBandModeWB3, /**< AMRWB Mode 3 = 14250 bps */
James Dong334de522012-03-12 12:47:14 -0700583 OMX_AUDIO_AMRBandModeWB4, /**< AMRWB Mode 4 = 15850 bps */
584 OMX_AUDIO_AMRBandModeWB5, /**< AMRWB Mode 5 = 18250 bps */
585 OMX_AUDIO_AMRBandModeWB6, /**< AMRWB Mode 6 = 19850 bps */
586 OMX_AUDIO_AMRBandModeWB7, /**< AMRWB Mode 7 = 23050 bps */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800587 OMX_AUDIO_AMRBandModeWB8, /**< AMRWB Mode 8 = 23850 bps */
588 OMX_AUDIO_AMRBandModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700589 OMX_AUDIO_AMRBandModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
590 OMX_AUDIO_AMRBandModeMax = 0x7FFFFFFF
591} OMX_AUDIO_AMRBANDMODETYPE;
James Dong334de522012-03-12 12:47:14 -0700592
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800593
594/** AMR Discontinuous Transmission mode */
595typedef enum OMX_AUDIO_AMRDTXMODETYPE {
596 OMX_AUDIO_AMRDTXModeOff = 0, /**< AMR Discontinuous Transmission Mode is disabled */
597 OMX_AUDIO_AMRDTXModeOnVAD1, /**< AMR Discontinuous Transmission Mode using
598 Voice Activity Detector 1 (VAD1) is enabled */
599 OMX_AUDIO_AMRDTXModeOnVAD2, /**< AMR Discontinuous Transmission Mode using
600 Voice Activity Detector 2 (VAD2) is enabled */
601 OMX_AUDIO_AMRDTXModeOnAuto, /**< The codec will automatically select between
602 Off, VAD1 or VAD2 modes */
James Dong334de522012-03-12 12:47:14 -0700603
604 OMX_AUDIO_AMRDTXasEFR, /**< DTX as EFR instead of AMR standard (3GPP 26.101, frame type =8,9,10) */
605
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800606 OMX_AUDIO_AMRDTXModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700607 OMX_AUDIO_AMRDTXModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800608 OMX_AUDIO_AMRDTXModeMax = 0x7FFFFFFF
609} OMX_AUDIO_AMRDTXMODETYPE;
610
James Dong334de522012-03-12 12:47:14 -0700611
612/** AMR params */
613typedef struct OMX_AUDIO_PARAM_AMRTYPE {
614 OMX_U32 nSize; /**< size of the structure in bytes */
615 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
616 OMX_U32 nPortIndex; /**< port that this structure applies to */
617 OMX_U32 nChannels; /**< Number of channels */
618 OMX_U32 nBitRate; /**< Bit rate read only field */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800619 OMX_AUDIO_AMRBANDMODETYPE eAMRBandMode; /**< AMR Band Mode enumeration */
James Dong334de522012-03-12 12:47:14 -0700620 OMX_AUDIO_AMRDTXMODETYPE eAMRDTXMode; /**< AMR DTX Mode enumeration */
621 OMX_AUDIO_AMRFRAMEFORMATTYPE eAMRFrameFormat; /**< AMR frame format enumeration */
622} OMX_AUDIO_PARAM_AMRTYPE;
623
624
625/** GSM_FR (ETSI 06.10, 3GPP 46.010) stream format parameters */
626typedef struct OMX_AUDIO_PARAM_GSMFRTYPE {
627 OMX_U32 nSize; /**< size of the structure in bytes */
628 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
629 OMX_U32 nPortIndex; /**< port that this structure applies to */
630 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
631 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
632} OMX_AUDIO_PARAM_GSMFRTYPE;
633
634
635/** GSM-HR (ETSI 06.20, 3GPP 46.020) stream format parameters */
636typedef struct OMX_AUDIO_PARAM_GSMHRTYPE {
637 OMX_U32 nSize; /**< size of the structure in bytes */
638 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
639 OMX_U32 nPortIndex; /**< port that this structure applies to */
640 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
641 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
642} OMX_AUDIO_PARAM_GSMHRTYPE;
643
644
645/** GSM-EFR (ETSI 06.60, 3GPP 46.060) stream format parameters */
646typedef struct OMX_AUDIO_PARAM_GSMEFRTYPE {
647 OMX_U32 nSize; /**< size of the structure in bytes */
648 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
649 OMX_U32 nPortIndex; /**< port that this structure applies to */
650 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
651 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
652} OMX_AUDIO_PARAM_GSMEFRTYPE;
653
654
655/** TDMA FR (TIA/EIA-136-420, VSELP 7.95kbps coder) stream format parameters */
656typedef struct OMX_AUDIO_PARAM_TDMAFRTYPE {
657 OMX_U32 nSize; /**< size of the structure in bytes */
658 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
659 OMX_U32 nPortIndex; /**< port that this structure applies to */
660 OMX_U32 nChannels; /**< Number of channels in the data stream (not
661 necessarily the same as the number of channels
662 to be rendered. */
663 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
664 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
665} OMX_AUDIO_PARAM_TDMAFRTYPE;
666
667
668/** TDMA EFR (TIA/EIA-136-410, ACELP 7.4kbps coder) stream format parameters */
669typedef struct OMX_AUDIO_PARAM_TDMAEFRTYPE {
670 OMX_U32 nSize; /**< size of the structure in bytes */
671 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
672 OMX_U32 nPortIndex; /**< port that this structure applies to */
673 OMX_U32 nChannels; /**< Number of channels in the data stream (not
674 necessarily the same as the number of channels
675 to be rendered. */
676 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
677 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
678} OMX_AUDIO_PARAM_TDMAEFRTYPE;
679
680
681/** PDC FR ( RCR-27, VSELP 6.7kbps coder) stream format parameters */
682typedef struct OMX_AUDIO_PARAM_PDCFRTYPE {
683 OMX_U32 nSize; /**< size of the structure in bytes */
684 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
685 OMX_U32 nPortIndex; /**< port that this structure applies to */
686 OMX_U32 nChannels; /**< Number of channels in the data stream (not
687 necessarily the same as the number of channels
688 to be rendered. */
689 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
690 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
691} OMX_AUDIO_PARAM_PDCFRTYPE;
692
693
694/** PDC EFR ( RCR-27, ACELP 6.7kbps coder) stream format parameters */
695typedef struct OMX_AUDIO_PARAM_PDCEFRTYPE {
696 OMX_U32 nSize; /**< size of the structure in bytes */
697 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
698 OMX_U32 nPortIndex; /**< port that this structure applies to */
699 OMX_U32 nChannels; /**< Number of channels in the data stream (not
700 necessarily the same as the number of channels
701 to be rendered. */
702 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
703 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
704} OMX_AUDIO_PARAM_PDCEFRTYPE;
705
706/** PDC HR ( RCR-27, PSI-CELP 3.45kbps coder) stream format parameters */
707typedef struct OMX_AUDIO_PARAM_PDCHRTYPE {
708 OMX_U32 nSize; /**< size of the structure in bytes */
709 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
710 OMX_U32 nPortIndex; /**< port that this structure applies to */
711 OMX_U32 nChannels; /**< Number of channels in the data stream (not
712 necessarily the same as the number of channels
713 to be rendered. */
714 OMX_BOOL bDTX; /**< Enable Discontinuous Transmisssion */
715 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */
716} OMX_AUDIO_PARAM_PDCHRTYPE;
717
718
719/** CDMA Rate types */
720typedef enum OMX_AUDIO_CDMARATETYPE {
721 OMX_AUDIO_CDMARateBlank = 0, /**< CDMA encoded frame is blank */
722 OMX_AUDIO_CDMARateFull, /**< CDMA encoded frame in full rate */
723 OMX_AUDIO_CDMARateHalf, /**< CDMA encoded frame in half rate */
724 OMX_AUDIO_CDMARateQuarter, /**< CDMA encoded frame in quarter rate */
725 OMX_AUDIO_CDMARateEighth, /**< CDMA encoded frame in eighth rate (DTX)*/
726 OMX_AUDIO_CDMARateErasure, /**< CDMA erasure frame */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800727 OMX_AUDIO_CDMARateKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700728 OMX_AUDIO_CDMARateVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
729 OMX_AUDIO_CDMARateMax = 0x7FFFFFFF
730} OMX_AUDIO_CDMARATETYPE;
731
732
733/** QCELP8 (TIA/EIA-96, up to 8kbps coder) stream format parameters */
734typedef struct OMX_AUDIO_PARAM_QCELP8TYPE {
735 OMX_U32 nSize; /**< size of the structure in bytes */
736 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
737 OMX_U32 nPortIndex; /**< port that this structure applies to */
738 OMX_U32 nChannels; /**< Number of channels in the data stream (not
739 necessarily the same as the number of channels
740 to be rendered. */
741 OMX_U32 nBitRate; /**< Bit rate of the input data. Use 0 for variable
742 rate or unknown bit rates */
743 OMX_AUDIO_CDMARATETYPE eCDMARate; /**< Frame rate */
744 OMX_U32 nMinBitRate; /**< minmal rate for the encoder = 1,2,3,4, default = 1 */
745 OMX_U32 nMaxBitRate; /**< maximal rate for the encoder = 1,2,3,4, default = 4 */
746} OMX_AUDIO_PARAM_QCELP8TYPE;
747
748
749/** QCELP13 ( CDMA, EIA/TIA-733, 13.3kbps coder) stream format parameters */
750typedef struct OMX_AUDIO_PARAM_QCELP13TYPE {
751 OMX_U32 nSize; /**< size of the structure in bytes */
752 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
753 OMX_U32 nPortIndex; /**< port that this structure applies to */
754 OMX_U32 nChannels; /**< Number of channels in the data stream (not
755 necessarily the same as the number of channels
756 to be rendered. */
757 OMX_AUDIO_CDMARATETYPE eCDMARate; /**< Frame rate */
758 OMX_U32 nMinBitRate; /**< minmal rate for the encoder = 1,2,3,4, default = 1 */
759 OMX_U32 nMaxBitRate; /**< maximal rate for the encoder = 1,2,3,4, default = 4 */
760} OMX_AUDIO_PARAM_QCELP13TYPE;
761
762
763/** EVRC ( CDMA, EIA/TIA-127, RCELP up to 8.55kbps coder) stream format parameters */
764typedef struct OMX_AUDIO_PARAM_EVRCTYPE {
765 OMX_U32 nSize; /**< size of the structure in bytes */
766 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
767 OMX_U32 nPortIndex; /**< port that this structure applies to */
768 OMX_U32 nChannels; /**< Number of channels in the data stream (not
769 necessarily the same as the number of channels
770 to be rendered. */
771 OMX_AUDIO_CDMARATETYPE eCDMARate; /**< actual Frame rate */
772 OMX_BOOL bRATE_REDUCon; /**< RATE_REDUCtion is requested for this frame */
773 OMX_U32 nMinBitRate; /**< minmal rate for the encoder = 1,2,3,4, default = 1 */
774 OMX_U32 nMaxBitRate; /**< maximal rate for the encoder = 1,2,3,4, default = 4 */
775 OMX_BOOL bHiPassFilter; /**< Enable encoder's High Pass Filter */
776 OMX_BOOL bNoiseSuppressor; /**< Enable encoder's noise suppressor pre-processing */
777 OMX_BOOL bPostFilter; /**< Enable decoder's post Filter */
778} OMX_AUDIO_PARAM_EVRCTYPE;
779
780
781/** SMV ( up to 8.55kbps coder) stream format parameters */
782typedef struct OMX_AUDIO_PARAM_SMVTYPE {
783 OMX_U32 nSize; /**< size of the structure in bytes */
784 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
785 OMX_U32 nPortIndex; /**< port that this structure applies to */
786 OMX_U32 nChannels; /**< Number of channels in the data stream (not
787 necessarily the same as the number of channels
788 to be rendered. */
789 OMX_AUDIO_CDMARATETYPE eCDMARate; /**< Frame rate */
790 OMX_BOOL bRATE_REDUCon; /**< RATE_REDUCtion is requested for this frame */
791 OMX_U32 nMinBitRate; /**< minmal rate for the encoder = 1,2,3,4, default = 1 ??*/
792 OMX_U32 nMaxBitRate; /**< maximal rate for the encoder = 1,2,3,4, default = 4 ??*/
793 OMX_BOOL bHiPassFilter; /**< Enable encoder's High Pass Filter ??*/
794 OMX_BOOL bNoiseSuppressor; /**< Enable encoder's noise suppressor pre-processing */
795 OMX_BOOL bPostFilter; /**< Enable decoder's post Filter ??*/
796} OMX_AUDIO_PARAM_SMVTYPE;
797
798
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800799/** MIDI Format
James Dong334de522012-03-12 12:47:14 -0700800 * @ingroup midi
801 */
802typedef enum OMX_AUDIO_MIDIFORMATTYPE
803{
804 OMX_AUDIO_MIDIFormatUnknown = 0, /**< MIDI Format unknown or don't care */
805 OMX_AUDIO_MIDIFormatSMF0, /**< Standard MIDI File Type 0 */
806 OMX_AUDIO_MIDIFormatSMF1, /**< Standard MIDI File Type 1 */
807 OMX_AUDIO_MIDIFormatSMF2, /**< Standard MIDI File Type 2 */
808 OMX_AUDIO_MIDIFormatSPMIDI, /**< SP-MIDI */
809 OMX_AUDIO_MIDIFormatXMF0, /**< eXtensible Music Format type 0 */
810 OMX_AUDIO_MIDIFormatXMF1, /**< eXtensible Music Format type 1 */
811 OMX_AUDIO_MIDIFormatMobileXMF, /**< Mobile XMF (eXtensible Music Format type 2) */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800812 OMX_AUDIO_MIDIFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700813 OMX_AUDIO_MIDIFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
814 OMX_AUDIO_MIDIFormatMax = 0x7FFFFFFF
815} OMX_AUDIO_MIDIFORMATTYPE;
816
817
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800818/** MIDI params
James Dong334de522012-03-12 12:47:14 -0700819 * @ingroup midi
820 */
821typedef struct OMX_AUDIO_PARAM_MIDITYPE {
822 OMX_U32 nSize; /**< size of the structure in bytes */
823 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
824 OMX_U32 nPortIndex; /**< port that this structure applies to */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800825 OMX_U32 nFileSize; /**< size of the MIDI file in bytes, where the entire
826 MIDI file passed in, otherwise if 0x0, the MIDI data
827 is merged and streamed (instead of passed as an
James Dong334de522012-03-12 12:47:14 -0700828 entire MIDI file) */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800829 OMX_BU32 sMaxPolyphony; /**< Specifies the maximum simultaneous polyphonic
830 voices. A value of zero indicates that the default
831 polyphony of the device is used */
832 OMX_BOOL bLoadDefaultSound; /**< Whether to load default sound
James Dong334de522012-03-12 12:47:14 -0700833 bank at initialization */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800834 OMX_AUDIO_MIDIFORMATTYPE eMidiFormat; /**< Version of the MIDI file */
James Dong334de522012-03-12 12:47:14 -0700835} OMX_AUDIO_PARAM_MIDITYPE;
836
837
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800838/** Type of the MIDI sound bank
James Dong334de522012-03-12 12:47:14 -0700839 * @ingroup midi
840 */
841typedef enum OMX_AUDIO_MIDISOUNDBANKTYPE {
842 OMX_AUDIO_MIDISoundBankUnused = 0, /**< unused/unknown soundbank type */
843 OMX_AUDIO_MIDISoundBankDLS1, /**< DLS version 1 */
844 OMX_AUDIO_MIDISoundBankDLS2, /**< DLS version 2 */
845 OMX_AUDIO_MIDISoundBankMobileDLSBase, /**< Mobile DLS, using the base functionality */
846 OMX_AUDIO_MIDISoundBankMobileDLSPlusOptions, /**< Mobile DLS, using the specification-defined optional feature set */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800847 OMX_AUDIO_MIDISoundBankKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700848 OMX_AUDIO_MIDISoundBankVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
849 OMX_AUDIO_MIDISoundBankMax = 0x7FFFFFFF
850} OMX_AUDIO_MIDISOUNDBANKTYPE;
851
852
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800853/** Bank Layout describes how bank MSB & LSB are used in the DLS instrument definitions sound bank
James Dong334de522012-03-12 12:47:14 -0700854 * @ingroup midi
855 */
856typedef enum OMX_AUDIO_MIDISOUNDBANKLAYOUTTYPE {
857 OMX_AUDIO_MIDISoundBankLayoutUnused = 0, /**< unused/unknown soundbank type */
858 OMX_AUDIO_MIDISoundBankLayoutGM, /**< GS layout (based on bank MSB 0x00) */
859 OMX_AUDIO_MIDISoundBankLayoutGM2, /**< General MIDI 2 layout (using MSB 0x78/0x79, LSB 0x00) */
860 OMX_AUDIO_MIDISoundBankLayoutUser, /**< Does not conform to any bank numbering standards */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800861 OMX_AUDIO_MIDISoundBankLayoutKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700862 OMX_AUDIO_MIDISoundBankLayoutVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
863 OMX_AUDIO_MIDISoundBankLayoutMax = 0x7FFFFFFF
864} OMX_AUDIO_MIDISOUNDBANKLAYOUTTYPE;
865
866
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800867/** MIDI params to load/unload user soundbank
James Dong334de522012-03-12 12:47:14 -0700868 * @ingroup midi
869 */
870typedef struct OMX_AUDIO_PARAM_MIDILOADUSERSOUNDTYPE {
871 OMX_U32 nSize; /**< size of the structure in bytes */
872 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
873 OMX_U32 nPortIndex; /**< port that this structure applies to */
874 OMX_U32 nDLSIndex; /**< DLS file index to be loaded */
875 OMX_U32 nDLSSize; /**< Size in bytes */
876 OMX_PTR pDLSData; /**< Pointer to DLS file data */
877 OMX_AUDIO_MIDISOUNDBANKTYPE eMidiSoundBank; /**< Midi sound bank type enumeration */
878 OMX_AUDIO_MIDISOUNDBANKLAYOUTTYPE eMidiSoundBankLayout; /**< Midi sound bank layout enumeration */
879} OMX_AUDIO_PARAM_MIDILOADUSERSOUNDTYPE;
880
881
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800882/** Structure for Live MIDI events and MIP messages.
883 * (MIP = Maximum Instantaneous Polyphony; part of the SP-MIDI standard.)
James Dong334de522012-03-12 12:47:14 -0700884 * @ingroup midi
885 */
886typedef struct OMX_AUDIO_CONFIG_MIDIIMMEDIATEEVENTTYPE {
887 OMX_U32 nSize; /**< size of the structure in bytes */
888 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
889 OMX_U32 nPortIndex; /**< Port that this structure applies to */
890 OMX_U32 nMidiEventSize; /**< Size of immediate MIDI events or MIP message in bytes */
891 OMX_U8 nMidiEvents[1]; /**< MIDI event array to be rendered immediately, or an
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800892 array for the MIP message buffer, where the size is
James Dong334de522012-03-12 12:47:14 -0700893 indicated by nMidiEventSize */
894} OMX_AUDIO_CONFIG_MIDIIMMEDIATEEVENTTYPE;
895
896
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800897/** MIDI sound bank/ program pair in a given channel
James Dong334de522012-03-12 12:47:14 -0700898 * @ingroup midi
899 */
900typedef struct OMX_AUDIO_CONFIG_MIDISOUNDBANKPROGRAMTYPE {
901 OMX_U32 nSize; /**< size of the structure in bytes */
902 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
903 OMX_U32 nPortIndex; /**< Port that this structure applies to */
904 OMX_U32 nChannel; /**< Valid channel values range from 1 to 16 */
905 OMX_U16 nIDProgram; /**< Valid program ID range is 1 to 128 */
906 OMX_U16 nIDSoundBank; /**< Sound bank ID */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800907 OMX_U32 nUserSoundBankIndex;/**< User soundbank index, easier to access soundbanks
James Dong334de522012-03-12 12:47:14 -0700908 by index if multiple banks are present */
909} OMX_AUDIO_CONFIG_MIDISOUNDBANKPROGRAMTYPE;
910
911
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800912/** MIDI control
James Dong334de522012-03-12 12:47:14 -0700913 * @ingroup midi
914 */
915typedef struct OMX_AUDIO_CONFIG_MIDICONTROLTYPE {
916 OMX_U32 nSize; /**< size of the structure in bytes */
917 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
918 OMX_U32 nPortIndex; /**< port that this structure applies to */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800919 OMX_BS32 sPitchTransposition; /**< Pitch transposition in semitones, stored as Q22.10
James Dong334de522012-03-12 12:47:14 -0700920 format based on JAVA MMAPI (JSR-135) requirement */
921 OMX_BU32 sPlayBackRate; /**< Relative playback rate, stored as Q14.17 fixed-point
922 number based on JSR-135 requirement */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800923 OMX_BU32 sTempo ; /**< Tempo in beats per minute (BPM), stored as Q22.10
James Dong334de522012-03-12 12:47:14 -0700924 fixed-point number based on JSR-135 requirement */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800925 OMX_U32 nMaxPolyphony; /**< Specifies the maximum simultaneous polyphonic
926 voices. A value of zero indicates that the default
James Dong334de522012-03-12 12:47:14 -0700927 polyphony of the device is used */
928 OMX_U32 nNumRepeat; /**< Number of times to repeat playback */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800929 OMX_U32 nStopTime; /**< Time in milliseconds to indicate when playback
James Dong334de522012-03-12 12:47:14 -0700930 will stop automatically. Set to zero if not used */
931 OMX_U16 nChannelMuteMask; /**< 16 bit mask for channel mute status */
932 OMX_U16 nChannelSoloMask; /**< 16 bit mask for channel solo status */
933 OMX_U32 nTrack0031MuteMask; /**< 32 bit mask for track mute status. Note: This is for tracks 0-31 */
934 OMX_U32 nTrack3263MuteMask; /**< 32 bit mask for track mute status. Note: This is for tracks 32-63 */
935 OMX_U32 nTrack0031SoloMask; /**< 32 bit mask for track solo status. Note: This is for tracks 0-31 */
936 OMX_U32 nTrack3263SoloMask; /**< 32 bit mask for track solo status. Note: This is for tracks 32-63 */
937
938} OMX_AUDIO_CONFIG_MIDICONTROLTYPE;
939
940
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800941/** MIDI Playback States
James Dong334de522012-03-12 12:47:14 -0700942 * @ingroup midi
943 */
944typedef enum OMX_AUDIO_MIDIPLAYBACKSTATETYPE {
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800945 OMX_AUDIO_MIDIPlayBackStateUnknown = 0, /**< Unknown state or state does not map to
946 other defined states */
947 OMX_AUDIO_MIDIPlayBackStateClosedEngaged, /**< No MIDI resource is currently open.
948 The MIDI engine is currently processing
James Dong334de522012-03-12 12:47:14 -0700949 MIDI events. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800950 OMX_AUDIO_MIDIPlayBackStateParsing, /**< A MIDI resource is open and is being
951 primed. The MIDI engine is currently
James Dong334de522012-03-12 12:47:14 -0700952 processing MIDI events. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800953 OMX_AUDIO_MIDIPlayBackStateOpenEngaged, /**< A MIDI resource is open and primed but
James Dong334de522012-03-12 12:47:14 -0700954 not playing. The MIDI engine is currently
955 processing MIDI events. The transition to
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800956 this state is only possible from the
James Dong334de522012-03-12 12:47:14 -0700957 OMX_AUDIO_MIDIPlayBackStatePlaying state,
958 when the 'playback head' reaches the end
959 of media data or the playback stops due
960 to stop time set.*/
961 OMX_AUDIO_MIDIPlayBackStatePlaying, /**< A MIDI resource is open and currently
962 playing. The MIDI engine is currently
963 processing MIDI events.*/
964 OMX_AUDIO_MIDIPlayBackStatePlayingPartially, /**< Best-effort playback due to SP-MIDI/DLS
965 resource constraints */
966 OMX_AUDIO_MIDIPlayBackStatePlayingSilently, /**< Due to system resource constraints and
967 SP-MIDI content constraints, there is
968 no audible MIDI content during playback
969 currently. The situation may change if
970 resources are freed later.*/
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800971 OMX_AUDIO_MIDIPlayBackStateKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -0700972 OMX_AUDIO_MIDIPlayBackStateVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
973 OMX_AUDIO_MIDIPlayBackStateMax = 0x7FFFFFFF
974} OMX_AUDIO_MIDIPLAYBACKSTATETYPE;
975
976
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800977/** MIDI status
James Dong334de522012-03-12 12:47:14 -0700978 * @ingroup midi
979 */
980typedef struct OMX_AUDIO_CONFIG_MIDISTATUSTYPE {
981 OMX_U32 nSize; /**< size of the structure in bytes */
982 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
983 OMX_U32 nPortIndex; /**< port that this structure applies to */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800984 OMX_U16 nNumTracks; /**< Number of MIDI tracks in the file, read only field.
985 NOTE: May not return a meaningful value until the entire
James Dong334de522012-03-12 12:47:14 -0700986 file is parsed and buffered. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800987 OMX_U32 nDuration; /**< The length of the currently open MIDI resource
988 in milliseconds. NOTE: May not return a meaningful value
James Dong334de522012-03-12 12:47:14 -0700989 until the entire file is parsed and buffered. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -0800990 OMX_U32 nPosition; /**< Current Position of the MIDI resource being played
991 in milliseconds */
992 OMX_BOOL bVibra; /**< Does Vibra track exist? NOTE: May not return a meaningful
993 value until the entire file is parsed and buffered. */
994 OMX_U32 nNumMetaEvents; /**< Total number of MIDI Meta Events in the currently
995 open MIDI resource. NOTE: May not return a meaningful value
996 until the entire file is parsed and buffered. */
997 OMX_U32 nNumActiveVoices; /**< Number of active voices in the currently playing
998 MIDI resource. NOTE: May not return a meaningful value until
James Dong334de522012-03-12 12:47:14 -0700999 the entire file is parsed and buffered. */
1000 OMX_AUDIO_MIDIPLAYBACKSTATETYPE eMIDIPlayBackState; /**< MIDI playback state enumeration, read only field */
1001} OMX_AUDIO_CONFIG_MIDISTATUSTYPE;
1002
1003
1004/** MIDI Meta Event structure one per Meta Event.
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001005 * MIDI Meta Events are like audio metadata, except that they are interspersed
1006 * with the MIDI content throughout the file and are not localized in the header.
1007 * As such, it is necessary to retrieve information about these Meta Events from
1008 * the engine, as it encounters these Meta Events within the MIDI content.
1009 * For example, SMF files can have up to 14 types of MIDI Meta Events (copyright,
1010 * author, default tempo, etc.) scattered throughout the file.
James Dong334de522012-03-12 12:47:14 -07001011 * @ingroup midi
1012 */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001013typedef struct OMX_AUDIO_CONFIG_MIDIMETAEVENTTYPE{
1014 OMX_U32 nSize; /**< size of the structure in bytes */
1015 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1016 OMX_U32 nPortIndex; /**< port that this structure applies to */
1017 OMX_U32 nIndex; /**< Index of Meta Event */
1018 OMX_U8 nMetaEventType; /**< Meta Event Type, 7bits (i.e. 0 - 127) */
1019 OMX_U32 nMetaEventSize; /**< size of the Meta Event in bytes */
James Dong334de522012-03-12 12:47:14 -07001020 OMX_U32 nTrack; /**< track number for the meta event */
1021 OMX_U32 nPosition; /**< Position of the meta-event in milliseconds */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001022} OMX_AUDIO_CONFIG_MIDIMETAEVENTTYPE;
James Dong334de522012-03-12 12:47:14 -07001023
1024
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001025/** MIDI Meta Event Data structure - one per Meta Event.
James Dong334de522012-03-12 12:47:14 -07001026 * @ingroup midi
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001027 */
1028typedef struct OMX_AUDIO_CONFIG_MIDIMETAEVENTDATATYPE{
1029 OMX_U32 nSize; /**< size of the structure in bytes */
1030 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1031 OMX_U32 nPortIndex; /**< port that this structure applies to */
1032 OMX_U32 nIndex; /**< Index of Meta Event */
1033 OMX_U32 nMetaEventSize; /**< size of the Meta Event in bytes */
1034 OMX_U8 nData[1]; /**< array of one or more bytes of meta data
1035 as indicated by the nMetaEventSize field */
1036} OMX_AUDIO_CONFIG__MIDIMETAEVENTDATATYPE;
James Dong334de522012-03-12 12:47:14 -07001037
1038
1039/** Audio Volume adjustment for a port */
1040typedef struct OMX_AUDIO_CONFIG_VOLUMETYPE {
1041 OMX_U32 nSize; /**< size of the structure in bytes */
1042 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001043 OMX_U32 nPortIndex; /**< Port index indicating which port to
1044 set. Select the input port to set
1045 just that port's volume. Select the
1046 output port to adjust the master
James Dong334de522012-03-12 12:47:14 -07001047 volume. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001048 OMX_BOOL bLinear; /**< Is the volume to be set in linear (0.100)
James Dong334de522012-03-12 12:47:14 -07001049 or logarithmic scale (mB) */
1050 OMX_BS32 sVolume; /**< Volume linear setting in the 0..100 range, OR
1051 Volume logarithmic setting for this port. The values
1052 for volume are in mB (millibels = 1/100 dB) relative
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001053 to a gain of 1 (e.g. the output is the same as the
1054 input level). Values are in mB from nMax
James Dong334de522012-03-12 12:47:14 -07001055 (maximum volume) to nMin mB (typically negative).
1056 Since the volume is "voltage"
1057 and not a "power", it takes a setting of
1058 -600 mB to decrease the volume by 1/2. If
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001059 a component cannot accurately set the
James Dong334de522012-03-12 12:47:14 -07001060 volume to the requested value, it must
1061 set the volume to the closest value BELOW
1062 the requested value. When getting the
1063 volume setting, the current actual volume
1064 must be returned. */
1065} OMX_AUDIO_CONFIG_VOLUMETYPE;
1066
1067
1068/** Audio Volume adjustment for a channel */
1069typedef struct OMX_AUDIO_CONFIG_CHANNELVOLUMETYPE {
1070 OMX_U32 nSize; /**< size of the structure in bytes */
1071 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001072 OMX_U32 nPortIndex; /**< Port index indicating which port to
1073 set. Select the input port to set
1074 just that port's volume. Select the
1075 output port to adjust the master
James Dong334de522012-03-12 12:47:14 -07001076 volume. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001077 OMX_U32 nChannel; /**< channel to select from 0 to N-1,
James Dong334de522012-03-12 12:47:14 -07001078 using OMX_ALL to apply volume settings
1079 to all channels */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001080 OMX_BOOL bLinear; /**< Is the volume to be set in linear (0.100) or
James Dong334de522012-03-12 12:47:14 -07001081 logarithmic scale (mB) */
1082 OMX_BS32 sVolume; /**< Volume linear setting in the 0..100 range, OR
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001083 Volume logarithmic setting for this port.
1084 The values for volume are in mB
James Dong334de522012-03-12 12:47:14 -07001085 (millibels = 1/100 dB) relative to a gain
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001086 of 1 (e.g. the output is the same as the
1087 input level). Values are in mB from nMax
1088 (maximum volume) to nMin mB (typically negative).
James Dong334de522012-03-12 12:47:14 -07001089 Since the volume is "voltage"
1090 and not a "power", it takes a setting of
1091 -600 mB to decrease the volume by 1/2. If
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001092 a component cannot accurately set the
James Dong334de522012-03-12 12:47:14 -07001093 volume to the requested value, it must
1094 set the volume to the closest value BELOW
1095 the requested value. When getting the
1096 volume setting, the current actual volume
1097 must be returned. */
1098 OMX_BOOL bIsMIDI; /**< TRUE if nChannel refers to a MIDI channel,
1099 FALSE otherwise */
1100} OMX_AUDIO_CONFIG_CHANNELVOLUMETYPE;
1101
1102
1103/** Audio balance setting */
1104typedef struct OMX_AUDIO_CONFIG_BALANCETYPE {
1105 OMX_U32 nSize; /**< size of the structure in bytes */
1106 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001107 OMX_U32 nPortIndex; /**< Port index indicating which port to
1108 set. Select the input port to set
1109 just that port's balance. Select the
1110 output port to adjust the master
James Dong334de522012-03-12 12:47:14 -07001111 balance. */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001112 OMX_S32 nBalance; /**< balance setting for this port
James Dong334de522012-03-12 12:47:14 -07001113 (-100 to 100, where -100 indicates
1114 all left, and no right */
1115} OMX_AUDIO_CONFIG_BALANCETYPE;
1116
1117
1118/** Audio Port mute */
1119typedef struct OMX_AUDIO_CONFIG_MUTETYPE {
1120 OMX_U32 nSize; /**< size of the structure in bytes */
1121 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001122 OMX_U32 nPortIndex; /**< Port index indicating which port to
1123 set. Select the input port to set
1124 just that port's mute. Select the
1125 output port to adjust the master
James Dong334de522012-03-12 12:47:14 -07001126 mute. */
1127 OMX_BOOL bMute; /**< Mute setting for this port */
1128} OMX_AUDIO_CONFIG_MUTETYPE;
1129
1130
1131/** Audio Channel mute */
1132typedef struct OMX_AUDIO_CONFIG_CHANNELMUTETYPE {
1133 OMX_U32 nSize; /**< size of the structure in bytes */
1134 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1135 OMX_U32 nPortIndex; /**< port that this structure applies to */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001136 OMX_U32 nChannel; /**< channel to select from 0 to N-1,
James Dong334de522012-03-12 12:47:14 -07001137 using OMX_ALL to apply mute settings
1138 to all channels */
1139 OMX_BOOL bMute; /**< Mute setting for this channel */
1140 OMX_BOOL bIsMIDI; /**< TRUE if nChannel refers to a MIDI channel,
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001141 FALSE otherwise */
James Dong334de522012-03-12 12:47:14 -07001142} OMX_AUDIO_CONFIG_CHANNELMUTETYPE;
1143
1144
1145
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001146/** Enable / Disable for loudness control, which boosts bass and to a
James Dong334de522012-03-12 12:47:14 -07001147 * smaller extent high end frequencies to compensate for hearing
1148 * ability at the extreme ends of the audio spectrum
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001149 */
James Dong334de522012-03-12 12:47:14 -07001150typedef struct OMX_AUDIO_CONFIG_LOUDNESSTYPE {
1151 OMX_U32 nSize; /**< size of the structure in bytes */
1152 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1153 OMX_U32 nPortIndex; /**< port that this structure applies to */
1154 OMX_BOOL bLoudness; /**< Enable/disable for loudness */
1155} OMX_AUDIO_CONFIG_LOUDNESSTYPE;
1156
1157
1158/** Enable / Disable for bass, which controls low frequencies
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001159 */
James Dong334de522012-03-12 12:47:14 -07001160typedef struct OMX_AUDIO_CONFIG_BASSTYPE {
1161 OMX_U32 nSize; /**< size of the structure in bytes */
1162 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1163 OMX_U32 nPortIndex; /**< port that this structure applies to */
1164 OMX_BOOL bEnable; /**< Enable/disable for bass control */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001165 OMX_S32 nBass; /**< bass setting for the port, as a
1166 continuous value from -100 to 100
James Dong334de522012-03-12 12:47:14 -07001167 (0 means no change in bass level)*/
1168} OMX_AUDIO_CONFIG_BASSTYPE;
1169
1170
1171/** Enable / Disable for treble, which controls high frequencies tones
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001172 */
James Dong334de522012-03-12 12:47:14 -07001173typedef struct OMX_AUDIO_CONFIG_TREBLETYPE {
1174 OMX_U32 nSize; /**< size of the structure in bytes */
1175 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1176 OMX_U32 nPortIndex; /**< port that this structure applies to */
1177 OMX_BOOL bEnable; /**< Enable/disable for treble control */
1178 OMX_S32 nTreble; /**< treble setting for the port, as a
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001179 continuous value from -100 to 100
James Dong334de522012-03-12 12:47:14 -07001180 (0 means no change in treble level) */
1181} OMX_AUDIO_CONFIG_TREBLETYPE;
1182
1183
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001184/** An equalizer is typically used for two reasons: to compensate for an
1185 * sub-optimal frequency response of a system to make it sound more natural
James Dong334de522012-03-12 12:47:14 -07001186 * or to create intentionally some unnatural coloring to the sound to create
1187 * an effect.
1188 * @ingroup effects
1189 */
1190typedef struct OMX_AUDIO_CONFIG_EQUALIZERTYPE {
1191 OMX_U32 nSize; /**< size of the structure in bytes */
1192 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1193 OMX_U32 nPortIndex; /**< port that this structure applies to */
1194 OMX_BOOL bEnable; /**< Enable/disable for equalizer */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001195 OMX_BU32 sBandIndex; /**< Band number to be set. Upper Limit is
James Dong334de522012-03-12 12:47:14 -07001196 N-1, where N is the number of bands, lower limit is 0 */
1197 OMX_BU32 sCenterFreq; /**< Center frequecies in Hz. This is a
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001198 read only element and is used to determine
1199 the lower, center and upper frequency of
James Dong334de522012-03-12 12:47:14 -07001200 this band. */
1201 OMX_BS32 sBandLevel; /**< band level in millibels */
1202} OMX_AUDIO_CONFIG_EQUALIZERTYPE;
1203
1204
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001205/** Stereo widening mode type
James Dong334de522012-03-12 12:47:14 -07001206 * @ingroup effects
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001207 */
James Dong334de522012-03-12 12:47:14 -07001208typedef enum OMX_AUDIO_STEREOWIDENINGTYPE {
1209 OMX_AUDIO_StereoWideningHeadphones, /**< Stereo widening for loudspeakers */
1210 OMX_AUDIO_StereoWideningLoudspeakers, /**< Stereo widening for closely spaced loudspeakers */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001211 OMX_AUDIO_StereoWideningKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -07001212 OMX_AUDIO_StereoWideningVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
1213 OMX_AUDIO_StereoWideningMax = 0x7FFFFFFF
1214} OMX_AUDIO_STEREOWIDENINGTYPE;
1215
1216
1217/** Control for stereo widening, which is a special 2-channel
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001218 * case of the audio virtualizer effect. For example, for 5.1-channel
1219 * output, it translates to virtual surround sound.
James Dong334de522012-03-12 12:47:14 -07001220 * @ingroup effects
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001221 */
James Dong334de522012-03-12 12:47:14 -07001222typedef struct OMX_AUDIO_CONFIG_STEREOWIDENINGTYPE {
1223 OMX_U32 nSize; /**< size of the structure in bytes */
1224 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1225 OMX_U32 nPortIndex; /**< port that this structure applies to */
1226 OMX_BOOL bEnable; /**< Enable/disable for stereo widening control */
1227 OMX_AUDIO_STEREOWIDENINGTYPE eWideningType; /**< Stereo widening algorithm type */
1228 OMX_U32 nStereoWidening; /**< stereo widening setting for the port,
1229 as a continuous value from 0 to 100 */
1230} OMX_AUDIO_CONFIG_STEREOWIDENINGTYPE;
1231
1232
1233/** The chorus effect (or ``choralizer'') is any signal processor which makes
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001234 * one sound source (such as a voice) sound like many such sources singing
1235 * (or playing) in unison. Since performance in unison is never exact, chorus
1236 * effects simulate this by making independently modified copies of the input
1237 * signal. Modifications may include (1) delay, (2) frequency shift, and
James Dong334de522012-03-12 12:47:14 -07001238 * (3) amplitude modulation.
1239 * @ingroup effects
1240 */
1241typedef struct OMX_AUDIO_CONFIG_CHORUSTYPE {
1242 OMX_U32 nSize; /**< size of the structure in bytes */
1243 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1244 OMX_U32 nPortIndex; /**< port that this structure applies to */
1245 OMX_BOOL bEnable; /**< Enable/disable for chorus */
1246 OMX_BU32 sDelay; /**< average delay in milliseconds */
1247 OMX_BU32 sModulationRate; /**< rate of modulation in millihertz */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001248 OMX_U32 nModulationDepth; /**< depth of modulation as a percentage of
James Dong334de522012-03-12 12:47:14 -07001249 delay (i.e. 0 to 100) */
1250 OMX_BU32 nFeedback; /**< Feedback from chorus output to input in percentage */
1251} OMX_AUDIO_CONFIG_CHORUSTYPE;
1252
1253
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001254/** Reverberation is part of the reflected sound that follows the early
1255 * reflections. In a typical room, this consists of a dense succession of
1256 * echoes whose energy decays exponentially. The reverberation effect structure
1257 * as defined here includes both (early) reflections as well as (late) reverberations.
James Dong334de522012-03-12 12:47:14 -07001258 * @ingroup effects
1259 */
1260typedef struct OMX_AUDIO_CONFIG_REVERBERATIONTYPE {
1261 OMX_U32 nSize; /**< size of the structure in bytes */
1262 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1263 OMX_U32 nPortIndex; /**< port that this structure applies to */
1264 OMX_BOOL bEnable; /**< Enable/disable for reverberation control */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001265 OMX_BS32 sRoomLevel; /**< Intensity level for the whole room effect
1266 (i.e. both early reflections and late
James Dong334de522012-03-12 12:47:14 -07001267 reverberation) in millibels */
1268 OMX_BS32 sRoomHighFreqLevel; /**< Attenuation at high frequencies
1269 relative to the intensity at low
1270 frequencies in millibels */
1271 OMX_BS32 sReflectionsLevel; /**< Intensity level of early reflections
1272 (relative to room value), in millibels */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001273 OMX_BU32 sReflectionsDelay; /**< Delay time of the first reflection relative
James Dong334de522012-03-12 12:47:14 -07001274 to the direct path, in milliseconds */
1275 OMX_BS32 sReverbLevel; /**< Intensity level of late reverberation
1276 relative to room level, in millibels */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001277 OMX_BU32 sReverbDelay; /**< Time delay from the first early reflection
1278 to the beginning of the late reverberation
James Dong334de522012-03-12 12:47:14 -07001279 section, in milliseconds */
1280 OMX_BU32 sDecayTime; /**< Late reverberation decay time at low
1281 frequencies, in milliseconds */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001282 OMX_BU32 nDecayHighFreqRatio; /**< Ratio of high frequency decay time relative
James Dong334de522012-03-12 12:47:14 -07001283 to low frequency decay time in percent */
1284 OMX_U32 nDensity; /**< Modal density in the late reverberation decay,
1285 in percent (i.e. 0 - 100) */
1286 OMX_U32 nDiffusion; /**< Echo density in the late reverberation decay,
1287 in percent (i.e. 0 - 100) */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001288 OMX_BU32 sReferenceHighFreq; /**< Reference high frequency in Hertz. This is
1289 the frequency used as the reference for all
James Dong334de522012-03-12 12:47:14 -07001290 the high-frequency settings above */
1291
1292} OMX_AUDIO_CONFIG_REVERBERATIONTYPE;
1293
1294
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001295/** Possible settings for the Echo Cancelation structure to use
James Dong334de522012-03-12 12:47:14 -07001296 * @ingroup effects
1297 */
1298typedef enum OMX_AUDIO_ECHOCANTYPE {
1299 OMX_AUDIO_EchoCanOff = 0, /**< Echo Cancellation is disabled */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001300 OMX_AUDIO_EchoCanNormal, /**< Echo Cancellation normal operation -
James Dong334de522012-03-12 12:47:14 -07001301 echo from plastics and face */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001302 OMX_AUDIO_EchoCanHFree, /**< Echo Cancellation optimized for
James Dong334de522012-03-12 12:47:14 -07001303 Hands Free operation */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001304 OMX_AUDIO_EchoCanCarKit, /**< Echo Cancellation optimized for
James Dong334de522012-03-12 12:47:14 -07001305 Car Kit (longer echo) */
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001306 OMX_AUDIO_EchoCanKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
James Dong334de522012-03-12 12:47:14 -07001307 OMX_AUDIO_EchoCanVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
1308 OMX_AUDIO_EchoCanMax = 0x7FFFFFFF
1309} OMX_AUDIO_ECHOCANTYPE;
1310
1311
1312/** Enable / Disable for echo cancelation, which removes undesired echo's
1313 * from the audio
1314 * @ingroup effects
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001315 */
James Dong334de522012-03-12 12:47:14 -07001316typedef struct OMX_AUDIO_CONFIG_ECHOCANCELATIONTYPE {
1317 OMX_U32 nSize; /**< size of the structure in bytes */
1318 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1319 OMX_U32 nPortIndex; /**< port that this structure applies to */
1320 OMX_AUDIO_ECHOCANTYPE eEchoCancelation; /**< Echo cancelation settings */
1321} OMX_AUDIO_CONFIG_ECHOCANCELATIONTYPE;
1322
1323
1324/** Enable / Disable for noise reduction, which undesired noise from
1325 * the audio
1326 * @ingroup effects
Lajos Molnara1ae5a42014-11-06 17:05:46 -08001327 */
James Dong334de522012-03-12 12:47:14 -07001328typedef struct OMX_AUDIO_CONFIG_NOISEREDUCTIONTYPE {
1329 OMX_U32 nSize; /**< size of the structure in bytes */
1330 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */
1331 OMX_U32 nPortIndex; /**< port that this structure applies to */
1332 OMX_BOOL bNoiseReduction; /**< Enable/disable for noise reduction */
1333} OMX_AUDIO_CONFIG_NOISEREDUCTIONTYPE;
1334
1335/** @} */
1336
1337#ifdef __cplusplus
1338}
1339#endif /* __cplusplus */
1340
1341#endif
1342/* File EOF */