1 /* ------------------------------------------------------------------ 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 /* 19 * Copyright (c) 2008 The Khronos Group Inc. 20 * 21 * 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 27 * to the following conditions: 28 * The above copyright notice and this permission notice shall be included 29 * in all copies or substantial portions of the Software. 30 * 31 * 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 37 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 38 * 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 50 extern "C" { 51 #endif /* __cplusplus */ 52 53 /* Each OMX header must include all required header files to allow the 54 * header to compile without errors. The includes below are required 55 * for this header file to compile successfully 56 */ 57 58 #include <OMX_Core.h> 59 60 /** @defgroup midi MIDI 61 * @ingroup audio 62 */ 63 64 /** @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 73 /** 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 77 * type of component other enums would be in this area. 78 */ 79 typedef 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 */ 108 OMX_AUDIO_CodingFLAC, /**< Any variant of FLAC encoded data */ 109 OMX_AUDIO_CodingKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 110 OMX_AUDIO_CodingVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 111 OMX_AUDIO_CodingMax = 0x7FFFFFFF 112 } OMX_AUDIO_CODINGTYPE; 113 114 115 /** 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 117 * 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 */ 121 typedef struct OMX_AUDIO_PORTDEFINITIONTYPE { 122 OMX_STRING cMIMEType; /**< MIME type of data for the port */ 123 OMX_NATIVE_DEVICETYPE pNativeRender; /** < platform specific reference 124 for an output device, 125 otherwise this field is 0 */ 126 OMX_BOOL bFlagErrorConcealment; /**< Turns on error concealment if it is 127 supported by the OMX component */ 128 OMX_AUDIO_CODINGTYPE eEncoding; /**< Type of data expected for this 129 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 */ 136 typedef 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 145 /** PCM mode type */ 146 typedef 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 */ 151 OMX_AUDIO_PCMModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 152 OMX_AUDIO_PCMModeMax = 0x7FFFFFFF 153 } OMX_AUDIO_PCMMODETYPE; 154 155 156 typedef 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. */ 167 OMX_AUDIO_ChannelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 168 OMX_AUDIO_ChannelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 169 OMX_AUDIO_ChannelMax = 0x7FFFFFFF 170 } 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 175 /** PCM format description */ 176 typedef 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 */ 189 OMX_AUDIO_CHANNELTYPE eChannelMapping[OMX_AUDIO_MAXCHANNELS]; /**< Slot i contains channel defined by eChannelMap[i] */ 190 191 } OMX_AUDIO_PARAM_PCMMODETYPE; 192 193 194 /** Audio channel mode. This is used by both AAC and MP3, although the names are more appropriate 195 * for the MP3. For example, JointStereo for MP3 is CouplingChannels for AAC. 196 */ 197 typedef enum OMX_AUDIO_CHANNELMODETYPE { 198 OMX_AUDIO_ChannelModeStereo = 0, /**< 2 channels, the bitrate allocation between those 199 two channels changes accordingly to each channel information */ 200 OMX_AUDIO_ChannelModeJointStereo, /**< mode that takes advantage of what is common between 201 2 channels for higher compression gain */ 202 OMX_AUDIO_ChannelModeDual, /**< 2 mono-channels, each channel is encoded with half 203 the bitrate of the overall bitrate */ 204 OMX_AUDIO_ChannelModeMono, /**< Mono channel mode */ 205 OMX_AUDIO_ChannelModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 206 OMX_AUDIO_ChannelModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 207 OMX_AUDIO_ChannelModeMax = 0x7FFFFFFF 208 } OMX_AUDIO_CHANNELMODETYPE; 209 210 211 typedef 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 */ 215 OMX_AUDIO_MP3StreamFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 216 OMX_AUDIO_MP3StreamFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 217 OMX_AUDIO_MP3StreamFormatMax = 0x7FFFFFFF 218 } OMX_AUDIO_MP3STREAMFORMATTYPE; 219 220 /** MP3 params */ 221 typedef 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 237 typedef 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 */ 245 OMX_AUDIO_AACStreamFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 246 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 */ 253 typedef 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) */ 264 OMX_AUDIO_AACObjectELD = 39, /** AAC Enhanced Low Delay. NOTE: Pending Khronos standardization **/ 265 OMX_AUDIO_AACObjectKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 266 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 */ 280 #define OMX_AUDIO_AACToolVendor 0x00010000 /**< NOT A KHRONOS VALUE, offset for vendor-specific additions */ 281 #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 */ 293 typedef 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 */ 316 typedef 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 */ 331 OMX_S32 nQuality; /**< Sets encoding quality to n, between -1 (low) and 10 (high). 332 In the default mode of operation, teh quality level is 3. 333 Normal quality range is 0 - 10. */ 334 OMX_BOOL bManaged; /**< Set bitrate management mode. This turns off the 335 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. */ 339 OMX_BOOL bDownmix; /**< Downmix input from stereo to mono (has no effect on 340 non-stereo streams). Useful for lower-bitrate encoding. */ 341 } OMX_AUDIO_PARAM_VORBISTYPE; 342 343 344 /** FLAC params */ 345 typedef 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 357 /** WMA Version */ 358 typedef 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 */ 363 OMX_AUDIO_WMAFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 364 OMX_AUDIO_WMAFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 365 OMX_AUDIO_WMAFormatMax = 0x7FFFFFFF 366 } OMX_AUDIO_WMAFORMATTYPE; 367 368 369 /** WMA Profile */ 370 typedef 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 */ 375 OMX_AUDIO_WMAProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 376 OMX_AUDIO_WMAProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 377 OMX_AUDIO_WMAProfileMax = 0x7FFFFFFF 378 } OMX_AUDIO_WMAPROFILETYPE; 379 380 381 /** WMA params */ 382 typedef 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 */ 390 OMX_AUDIO_WMAPROFILETYPE eProfile; /**< Profile of WMA stream / data */ 391 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 397 /** 398 * RealAudio format 399 */ 400 typedef 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 */ 409 OMX_AUDIO_RAFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 410 OMX_AUDIO_RAFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 411 OMX_VIDEO_RAFormatMax = 0x7FFFFFFF 412 } OMX_AUDIO_RAFORMATTYPE; 413 414 /** RA (Real Audio) params */ 415 typedef 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 */ 426 OMX_AUDIO_RAFORMATTYPE eFormat; /**< is the RealAudio audio format */ 427 } OMX_AUDIO_PARAM_RATYPE; 428 429 430 /** SBC Allocation Method Type */ 431 typedef enum OMX_AUDIO_SBCALLOCMETHODTYPE { 432 OMX_AUDIO_SBCAllocMethodLoudness, /**< Loudness allocation method */ 433 OMX_AUDIO_SBCAllocMethodSNR, /**< SNR allocation method */ 434 OMX_AUDIO_SBCAllocMethodKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 435 OMX_AUDIO_SBCAllocMethodVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 436 OMX_AUDIO_SBCAllocMethodMax = 0x7FFFFFFF 437 } OMX_AUDIO_SBCALLOCMETHODTYPE; 438 439 440 /** SBC params */ 441 typedef 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 459 /** ADPCM stream format parameters */ 460 typedef 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; 471 472 473 /** G723 rate */ 474 typedef 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 */ 478 OMX_AUDIO_G723ModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 479 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 */ 485 typedef 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 */ 493 OMX_AUDIO_G723RATE eBitRate; /**< todo: Should this be moved to a config? */ 494 OMX_BOOL bHiPassFilter; /**< Enable High Pass Filter */ 495 OMX_BOOL bPostFilter; /**< Enable Post Filter */ 496 } OMX_AUDIO_PARAM_G723TYPE; 497 498 499 /** ITU G726 (ADPCM) rate */ 500 typedef 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 */ 506 OMX_AUDIO_G726ModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 507 OMX_AUDIO_G726ModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 508 OMX_AUDIO_G726ModeMax = 0x7FFFFFFF 509 } OMX_AUDIO_G726MODE; 510 511 512 /** G.726 stream format parameters - must be at 8KHz */ 513 typedef 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. */ 520 OMX_AUDIO_G726MODE eG726Mode; 521 } OMX_AUDIO_PARAM_G726TYPE; 522 523 524 /** G729 coder type */ 525 typedef 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 */ 530 OMX_AUDIO_G729KhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 531 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 */ 537 typedef 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 549 /** AMR Frame format */ 550 typedef 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 */ 563 OMX_AUDIO_AMRFrameFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 564 OMX_AUDIO_AMRFrameFormatMax = 0x7FFFFFFF 565 } OMX_AUDIO_AMRFRAMEFORMATTYPE; 566 567 568 /** AMR band mode */ 569 typedef 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 */ 573 OMX_AUDIO_AMRBandModeNB2, /**< AMRNB Mode 2 = 5900 bps */ 574 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 */ 581 OMX_AUDIO_AMRBandModeWB2, /**< AMRWB Mode 2 = 12650 bps */ 582 OMX_AUDIO_AMRBandModeWB3, /**< AMRWB Mode 3 = 14250 bps */ 583 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 */ 587 OMX_AUDIO_AMRBandModeWB8, /**< AMRWB Mode 8 = 23850 bps */ 588 OMX_AUDIO_AMRBandModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 589 OMX_AUDIO_AMRBandModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 590 OMX_AUDIO_AMRBandModeMax = 0x7FFFFFFF 591 } OMX_AUDIO_AMRBANDMODETYPE; 592 593 594 /** AMR Discontinuous Transmission mode */ 595 typedef 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 */ 603 604 OMX_AUDIO_AMRDTXasEFR, /**< DTX as EFR instead of AMR standard (3GPP 26.101, frame type =8,9,10) */ 605 606 OMX_AUDIO_AMRDTXModeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 607 OMX_AUDIO_AMRDTXModeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 608 OMX_AUDIO_AMRDTXModeMax = 0x7FFFFFFF 609 } OMX_AUDIO_AMRDTXMODETYPE; 610 611 612 /** AMR params */ 613 typedef 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 */ 619 OMX_AUDIO_AMRBANDMODETYPE eAMRBandMode; /**< AMR Band Mode enumeration */ 620 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 */ 626 typedef 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 */ 636 typedef 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 */ 646 typedef 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 */ 656 typedef 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 */ 669 typedef 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 */ 682 typedef 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 */ 695 typedef 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 */ 707 typedef 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 */ 720 typedef 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 */ 727 OMX_AUDIO_CDMARateKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 728 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 */ 734 typedef 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 */ 750 typedef 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 */ 764 typedef 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 */ 782 typedef 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 799 /** MIDI Format 800 * @ingroup midi 801 */ 802 typedef 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) */ 812 OMX_AUDIO_MIDIFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 813 OMX_AUDIO_MIDIFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 814 OMX_AUDIO_MIDIFormatMax = 0x7FFFFFFF 815 } OMX_AUDIO_MIDIFORMATTYPE; 816 817 818 /** MIDI params 819 * @ingroup midi 820 */ 821 typedef 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 */ 825 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 828 entire MIDI file) */ 829 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 833 bank at initialization */ 834 OMX_AUDIO_MIDIFORMATTYPE eMidiFormat; /**< Version of the MIDI file */ 835 } OMX_AUDIO_PARAM_MIDITYPE; 836 837 838 /** Type of the MIDI sound bank 839 * @ingroup midi 840 */ 841 typedef 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 */ 847 OMX_AUDIO_MIDISoundBankKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 848 OMX_AUDIO_MIDISoundBankVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 849 OMX_AUDIO_MIDISoundBankMax = 0x7FFFFFFF 850 } OMX_AUDIO_MIDISOUNDBANKTYPE; 851 852 853 /** Bank Layout describes how bank MSB & LSB are used in the DLS instrument definitions sound bank 854 * @ingroup midi 855 */ 856 typedef 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 */ 861 OMX_AUDIO_MIDISoundBankLayoutKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 862 OMX_AUDIO_MIDISoundBankLayoutVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 863 OMX_AUDIO_MIDISoundBankLayoutMax = 0x7FFFFFFF 864 } OMX_AUDIO_MIDISOUNDBANKLAYOUTTYPE; 865 866 867 /** MIDI params to load/unload user soundbank 868 * @ingroup midi 869 */ 870 typedef 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 882 /** Structure for Live MIDI events and MIP messages. 883 * (MIP = Maximum Instantaneous Polyphony; part of the SP-MIDI standard.) 884 * @ingroup midi 885 */ 886 typedef 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 892 array for the MIP message buffer, where the size is 893 indicated by nMidiEventSize */ 894 } OMX_AUDIO_CONFIG_MIDIIMMEDIATEEVENTTYPE; 895 896 897 /** MIDI sound bank/ program pair in a given channel 898 * @ingroup midi 899 */ 900 typedef 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 */ 907 OMX_U32 nUserSoundBankIndex;/**< User soundbank index, easier to access soundbanks 908 by index if multiple banks are present */ 909 } OMX_AUDIO_CONFIG_MIDISOUNDBANKPROGRAMTYPE; 910 911 912 /** MIDI control 913 * @ingroup midi 914 */ 915 typedef 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 */ 919 OMX_BS32 sPitchTransposition; /**< Pitch transposition in semitones, stored as Q22.10 920 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 */ 923 OMX_BU32 sTempo ; /**< Tempo in beats per minute (BPM), stored as Q22.10 924 fixed-point number based on JSR-135 requirement */ 925 OMX_U32 nMaxPolyphony; /**< Specifies the maximum simultaneous polyphonic 926 voices. A value of zero indicates that the default 927 polyphony of the device is used */ 928 OMX_U32 nNumRepeat; /**< Number of times to repeat playback */ 929 OMX_U32 nStopTime; /**< Time in milliseconds to indicate when playback 930 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 941 /** MIDI Playback States 942 * @ingroup midi 943 */ 944 typedef enum OMX_AUDIO_MIDIPLAYBACKSTATETYPE { 945 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 949 MIDI events. */ 950 OMX_AUDIO_MIDIPlayBackStateParsing, /**< A MIDI resource is open and is being 951 primed. The MIDI engine is currently 952 processing MIDI events. */ 953 OMX_AUDIO_MIDIPlayBackStateOpenEngaged, /**< A MIDI resource is open and primed but 954 not playing. The MIDI engine is currently 955 processing MIDI events. The transition to 956 this state is only possible from the 957 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.*/ 971 OMX_AUDIO_MIDIPlayBackStateKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 972 OMX_AUDIO_MIDIPlayBackStateVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */ 973 OMX_AUDIO_MIDIPlayBackStateMax = 0x7FFFFFFF 974 } OMX_AUDIO_MIDIPLAYBACKSTATETYPE; 975 976 977 /** MIDI status 978 * @ingroup midi 979 */ 980 typedef 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 */ 984 OMX_U16 nNumTracks; /**< Number of MIDI tracks in the file, read only field. 985 NOTE: May not return a meaningful value until the entire 986 file is parsed and buffered. */ 987 OMX_U32 nDuration; /**< The length of the currently open MIDI resource 988 in milliseconds. NOTE: May not return a meaningful value 989 until the entire file is parsed and buffered. */ 990 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 999 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. 1005 * 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. 1011 * @ingroup midi 1012 */ 1013 typedef 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 */ 1020 OMX_U32 nTrack; /**< track number for the meta event */ 1021 OMX_U32 nPosition; /**< Position of the meta-event in milliseconds */ 1022 } OMX_AUDIO_CONFIG_MIDIMETAEVENTTYPE; 1023 1024 1025 /** MIDI Meta Event Data structure - one per Meta Event. 1026 * @ingroup midi 1027 */ 1028 typedef 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; 1037 1038 1039 /** Audio Volume adjustment for a port */ 1040 typedef struct OMX_AUDIO_CONFIG_VOLUMETYPE { 1041 OMX_U32 nSize; /**< size of the structure in bytes */ 1042 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */ 1043 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 1047 volume. */ 1048 OMX_BOOL bLinear; /**< Is the volume to be set in linear (0.100) 1049 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 1053 to a gain of 1 (e.g. the output is the same as the 1054 input level). Values are in mB from nMax 1055 (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 1059 a component cannot accurately set the 1060 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 */ 1069 typedef struct OMX_AUDIO_CONFIG_CHANNELVOLUMETYPE { 1070 OMX_U32 nSize; /**< size of the structure in bytes */ 1071 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */ 1072 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 1076 volume. */ 1077 OMX_U32 nChannel; /**< channel to select from 0 to N-1, 1078 using OMX_ALL to apply volume settings 1079 to all channels */ 1080 OMX_BOOL bLinear; /**< Is the volume to be set in linear (0.100) or 1081 logarithmic scale (mB) */ 1082 OMX_BS32 sVolume; /**< Volume linear setting in the 0..100 range, OR 1083 Volume logarithmic setting for this port. 1084 The values for volume are in mB 1085 (millibels = 1/100 dB) relative to a gain 1086 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). 1089 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 1092 a component cannot accurately set the 1093 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 */ 1104 typedef struct OMX_AUDIO_CONFIG_BALANCETYPE { 1105 OMX_U32 nSize; /**< size of the structure in bytes */ 1106 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */ 1107 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 1111 balance. */ 1112 OMX_S32 nBalance; /**< balance setting for this port 1113 (-100 to 100, where -100 indicates 1114 all left, and no right */ 1115 } OMX_AUDIO_CONFIG_BALANCETYPE; 1116 1117 1118 /** Audio Port mute */ 1119 typedef struct OMX_AUDIO_CONFIG_MUTETYPE { 1120 OMX_U32 nSize; /**< size of the structure in bytes */ 1121 OMX_VERSIONTYPE nVersion; /**< OMX specification version information */ 1122 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 1126 mute. */ 1127 OMX_BOOL bMute; /**< Mute setting for this port */ 1128 } OMX_AUDIO_CONFIG_MUTETYPE; 1129 1130 1131 /** Audio Channel mute */ 1132 typedef 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 */ 1136 OMX_U32 nChannel; /**< channel to select from 0 to N-1, 1137 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, 1141 FALSE otherwise */ 1142 } OMX_AUDIO_CONFIG_CHANNELMUTETYPE; 1143 1144 1145 1146 /** Enable / Disable for loudness control, which boosts bass and to a 1147 * smaller extent high end frequencies to compensate for hearing 1148 * ability at the extreme ends of the audio spectrum 1149 */ 1150 typedef 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 1159 */ 1160 typedef 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 */ 1165 OMX_S32 nBass; /**< bass setting for the port, as a 1166 continuous value from -100 to 100 1167 (0 means no change in bass level)*/ 1168 } OMX_AUDIO_CONFIG_BASSTYPE; 1169 1170 1171 /** Enable / Disable for treble, which controls high frequencies tones 1172 */ 1173 typedef 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 1179 continuous value from -100 to 100 1180 (0 means no change in treble level) */ 1181 } OMX_AUDIO_CONFIG_TREBLETYPE; 1182 1183 1184 /** 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 1186 * or to create intentionally some unnatural coloring to the sound to create 1187 * an effect. 1188 * @ingroup effects 1189 */ 1190 typedef 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 */ 1195 OMX_BU32 sBandIndex; /**< Band number to be set. Upper Limit is 1196 N-1, where N is the number of bands, lower limit is 0 */ 1197 OMX_BU32 sCenterFreq; /**< Center frequecies in Hz. This is a 1198 read only element and is used to determine 1199 the lower, center and upper frequency of 1200 this band. */ 1201 OMX_BS32 sBandLevel; /**< band level in millibels */ 1202 } OMX_AUDIO_CONFIG_EQUALIZERTYPE; 1203 1204 1205 /** Stereo widening mode type 1206 * @ingroup effects 1207 */ 1208 typedef enum OMX_AUDIO_STEREOWIDENINGTYPE { 1209 OMX_AUDIO_StereoWideningHeadphones, /**< Stereo widening for loudspeakers */ 1210 OMX_AUDIO_StereoWideningLoudspeakers, /**< Stereo widening for closely spaced loudspeakers */ 1211 OMX_AUDIO_StereoWideningKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 1212 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 1218 * case of the audio virtualizer effect. For example, for 5.1-channel 1219 * output, it translates to virtual surround sound. 1220 * @ingroup effects 1221 */ 1222 typedef 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 1234 * 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 1238 * (3) amplitude modulation. 1239 * @ingroup effects 1240 */ 1241 typedef 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 */ 1248 OMX_U32 nModulationDepth; /**< depth of modulation as a percentage of 1249 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 1254 /** 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. 1258 * @ingroup effects 1259 */ 1260 typedef 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 */ 1265 OMX_BS32 sRoomLevel; /**< Intensity level for the whole room effect 1266 (i.e. both early reflections and late 1267 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 */ 1273 OMX_BU32 sReflectionsDelay; /**< Delay time of the first reflection relative 1274 to the direct path, in milliseconds */ 1275 OMX_BS32 sReverbLevel; /**< Intensity level of late reverberation 1276 relative to room level, in millibels */ 1277 OMX_BU32 sReverbDelay; /**< Time delay from the first early reflection 1278 to the beginning of the late reverberation 1279 section, in milliseconds */ 1280 OMX_BU32 sDecayTime; /**< Late reverberation decay time at low 1281 frequencies, in milliseconds */ 1282 OMX_BU32 nDecayHighFreqRatio; /**< Ratio of high frequency decay time relative 1283 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) */ 1288 OMX_BU32 sReferenceHighFreq; /**< Reference high frequency in Hertz. This is 1289 the frequency used as the reference for all 1290 the high-frequency settings above */ 1291 1292 } OMX_AUDIO_CONFIG_REVERBERATIONTYPE; 1293 1294 1295 /** Possible settings for the Echo Cancelation structure to use 1296 * @ingroup effects 1297 */ 1298 typedef enum OMX_AUDIO_ECHOCANTYPE { 1299 OMX_AUDIO_EchoCanOff = 0, /**< Echo Cancellation is disabled */ 1300 OMX_AUDIO_EchoCanNormal, /**< Echo Cancellation normal operation - 1301 echo from plastics and face */ 1302 OMX_AUDIO_EchoCanHFree, /**< Echo Cancellation optimized for 1303 Hands Free operation */ 1304 OMX_AUDIO_EchoCanCarKit, /**< Echo Cancellation optimized for 1305 Car Kit (longer echo) */ 1306 OMX_AUDIO_EchoCanKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */ 1307 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 1315 */ 1316 typedef 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 1327 */ 1328 typedef 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 */ 1343
