1/*
2 * Copyright (c) 2022-2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @addtogroup HdiAudio
18 *
19 * @brief Provides unified APIs for audio services to access audio drivers.
20 *
21 * An audio service can obtain an audio driver object or agent and then call APIs provided by this object or agent to
22 * access different types of audio devices based on the audio IDs, thereby obtaining audio information,
23 * subscribing to or unsubscribing from audio data, enabling or disabling an audio,
24 * setting the audio data reporting mode, and setting audio options such as the accuracy and measurement range.
25 *
26 * @since 4.0
27 * @version 1.0
28 */
29
30package ohos.hdi.audio.v1_0;
31
32/**
33 * @brief Enumerates the audio port type.
34 */
35enum AudioPortDirection {
36    PORT_OUT    = 1, /**< Output port */
37    PORT_IN     = 2, /**< Input port */
38    PORT_OUT_IN = 3, /**< Input/output port, supporting both audio input and output */
39};
40
41/**
42 * @brief Enumerates the pin of an audio adapter.
43 */
44enum AudioPortPin {
45    PIN_NONE                     = 0,                 /**< Invalid pin */
46    PIN_OUT_SPEAKER              = 1 << 0,            /**< Speaker output pin */
47    PIN_OUT_HEADSET              = 1 << 1,            /**< Wired headset pin for output */
48    PIN_OUT_LINEOUT              = 1 << 2,            /**< Line-out pin */
49    PIN_OUT_HDMI                 = 1 << 3,            /**< HDMI output pin */
50    PIN_OUT_USB                  = 1 << 4,            /**< USB output pin */
51    PIN_OUT_USB_EXT              = 1 << 5,            /**< Extended USB output pin*/
52    PIN_OUT_EARPIECE             = 1 << 5 | 1 << 4,   /**< Earpiece output pin */
53    PIN_OUT_BLUETOOTH_SCO        = 1 << 6,            /**< Bluetooth SCO output pin */
54    PIN_OUT_DAUDIO_DEFAULT       = 1 << 7,            /**< Daudio default output pin */
55    PIN_OUT_HEADPHONE            = 1 << 8,            /**< Wired headphone output pin*/
56    PIN_OUT_USB_HEADSET          = 1 << 9,            /**< ARM USB out pin */
57    PIN_IN_MIC                   = 1 << 27 | 1 << 0,  /**< Microphone input pin */
58    PIN_IN_HS_MIC                = 1 << 27 | 1 << 1,  /**< Wired headset microphone pin for input */
59    PIN_IN_LINEIN                = 1 << 27 | 1 << 2,  /**< Line-in pin */
60    PIN_IN_USB_EXT               = 1 << 27 | 1 << 3,  /**< Extended USB input pin*/
61    PIN_IN_BLUETOOTH_SCO_HEADSET = 1 << 27 | 1 << 4,  /**< Bluetooth SCO headset input pin */
62    PIN_IN_DAUDIO_DEFAULT        = 1 << 27 | 1 << 5,  /**< Daudio default input pin */
63    PIN_IN_USB_HEADSET           = 1 << 27 | 1 << 6,  /**< ARM USB input pin */
64};
65
66/**
67 * @brief Enumerates the audio category.
68 */
69enum AudioCategory {
70    AUDIO_IN_MEDIA         = 0, /**< Media */
71    AUDIO_IN_COMMUNICATION = 1, /**< Communications */
72    AUDIO_IN_RINGTONE      = 2, /**< Ringtone */
73    AUDIO_IN_CALL          = 3, /**< Call */
74    AUDIO_MMAP_NOIRQ       = 4, /**< Mmap mode */
75    AUDIO_OFFLOAD          = 5, /**< Offload */
76};
77
78/**
79 * @brief Enumerates the audio format.
80 */
81enum AudioFormat {
82    AUDIO_FORMAT_TYPE_PCM_8_BIT  = 1 << 0,                      /**< 8-bit PCM */
83    AUDIO_FORMAT_TYPE_PCM_16_BIT = 1 << 1,                      /**< 16-bit PCM */
84    AUDIO_FORMAT_TYPE_PCM_24_BIT = 1 << 1 | 1 << 0,             /**< 24-bit PCM */
85    AUDIO_FORMAT_TYPE_PCM_32_BIT = 1 << 2,                      /**< 32-bit PCM */
86    AUDIO_FORMAT_TYPE_PCM_FLOAT  = 1 << 2 | 1 << 0,             /**< FLOAT PCM */
87    AUDIO_FORMAT_TYPE_MP3        = 1 << 24,                     /**< MP3 */
88    AUDIO_FORMAT_TYPE_AAC_MAIN   = 1 << 24 | 1 << 0,            /**< AAC main */
89    AUDIO_FORMAT_TYPE_AAC_LC     = 1 << 24 | 1 << 1,            /**< AAC LC */
90    AUDIO_FORMAT_TYPE_AAC_LD     = 1 << 24 | 1 << 1 | 1 << 0,   /**< AAC LD */
91    AUDIO_FORMAT_TYPE_AAC_ELD    = 1 << 24 | 1 << 2,            /**< AAC ELD */
92    AUDIO_FORMAT_TYPE_AAC_HE_V1  = 1 << 24 | 1 << 2 | 1 << 0,   /**< AAC HE_V1 */
93    AUDIO_FORMAT_TYPE_AAC_HE_V2  = 1 << 24 | 1 << 2 | 1 << 1,   /**< AAC HE_V2 */
94    AUDIO_FORMAT_TYPE_G711A      = 1 << 25 | 1 << 0,            /**< G711A */
95    AUDIO_FORMAT_TYPE_G711U      = 1 << 25 | 1 << 1,            /**< G711u */
96    AUDIO_FORMAT_TYPE_G726       = 1 << 25 | 1 << 1 | 1 << 0,   /**< G726 */
97};
98
99/**
100 * @brief Enumerates the audio channel mask.
101 *
102 * A mask describes an audio channel position.
103 */
104enum AudioChannelMask {
105    AUDIO_CHANNEL_FRONT_LEFT  = 1,  /**< Front left channel */
106    AUDIO_CHANNEL_FRONT_RIGHT = 2,  /**< Front right channel */
107    AUDIO_CHANNEL_MONO        = 1,  /**< Mono channel */
108    AUDIO_CHANNEL_STEREO      = 3,  /**< Stereo channel, consisting of front left and front right channels */
109};
110
111/**
112 * @brief Enumerates masks of audio sampling rates.
113 */
114enum AudioSampleRatesMask {
115    AUDIO_SAMPLE_RATE_MASK_8000    = 1 << 0,        /**< 8 kHz */
116    AUDIO_SAMPLE_RATE_MASK_12000   = 1 << 1,        /**< 12 kHz */
117    AUDIO_SAMPLE_RATE_MASK_11025   = 1 << 2,        /**< 11.025 kHz */
118    AUDIO_SAMPLE_RATE_MASK_16000   = 1 << 3,        /**< 16 kHz */
119    AUDIO_SAMPLE_RATE_MASK_22050   = 1 << 4,        /**< 22.050 kHz */
120    AUDIO_SAMPLE_RATE_MASK_24000   = 1 << 5,        /**< 24 kHz */
121    AUDIO_SAMPLE_RATE_MASK_32000   = 1 << 6,        /**< 32 kHz */
122    AUDIO_SAMPLE_RATE_MASK_44100   = 1 << 7,        /**< 44.1 kHz */
123    AUDIO_SAMPLE_RATE_MASK_48000   = 1 << 8,        /**< 48 kHz */
124    AUDIO_SAMPLE_RATE_MASK_64000   = 1 << 9,        /**< 64 kHz */
125    AUDIO_SAMPLE_RATE_MASK_96000   = 1 << 10,       /**< 96 kHz */
126    AUDIO_SAMPLE_RATE_MASK_INVALID = 4294967295,    /**< Invalid sampling rate */
127};
128
129/**
130 * @brief Enumerates the passthrough data transmission mode of an audio port.
131 */
132enum AudioPortPassthroughMode {
133    PORT_PASSTHROUGH_LPCM    = 1 << 0, /**< Stereo PCM */
134    PORT_PASSTHROUGH_RAW     = 1 << 1, /**< HDMI passthrough */
135    PORT_PASSTHROUGH_HBR2LBR = 1 << 2, /**< Blu-ray next-generation audio output with reduced specifications */
136    PORT_PASSTHROUGH_AUTO    = 1 << 3, /**< Mode automatically matched based on the HDMI EDID */
137};
138
139/**
140 * @brief Defines formats of raw audio samples.
141 */
142enum AudioSampleFormat {
143    /* 8 bits */
144    AUDIO_SAMPLE_FORMAT_S8   = 0,  /**< signed 8 bit sample */
145    AUDIO_SAMPLE_FORMAT_S8P  = 1,  /**< signed 8 bit planar sample */
146    AUDIO_SAMPLE_FORMAT_U8   = 2,  /**< unsigned 8 bit sample */
147    AUDIO_SAMPLE_FORMAT_U8P  = 3,  /**< unsigned 8 bit planar sample */
148    /* 16 bits */
149    AUDIO_SAMPLE_FORMAT_S16  = 4,  /**< signed 16 bit sample */
150    AUDIO_SAMPLE_FORMAT_S16P = 5,  /**< signed 16 bit planar sample */
151    AUDIO_SAMPLE_FORMAT_U16  = 6,  /**< unsigned 16 bit sample */
152    AUDIO_SAMPLE_FORMAT_U16P = 7,  /**< unsigned 16 bit planar sample */
153    /* 24 bits */
154    AUDIO_SAMPLE_FORMAT_S24  = 8,  /**< signed 24 bit sample */
155    AUDIO_SAMPLE_FORMAT_S24P = 9,  /**< signed 24 bit planar sample */
156    AUDIO_SAMPLE_FORMAT_U24  = 10, /**< unsigned 24 bit sample */
157    AUDIO_SAMPLE_FORMAT_U24P = 11, /**< unsigned 24 bit planar sample */
158    /* 32 bits */
159    AUDIO_SAMPLE_FORMAT_S32  = 12, /**< signed 32 bit sample */
160    AUDIO_SAMPLE_FORMAT_S32P = 13, /**< signed 32 bit planar sample */
161    AUDIO_SAMPLE_FORMAT_U32  = 14, /**< unsigned 32 bit sample */
162    AUDIO_SAMPLE_FORMAT_U32P = 15, /**< unsigned 32 bit planar sample */
163    /* 64 bits */
164    AUDIO_SAMPLE_FORMAT_S64  = 16, /**< signed 64 bit sample */
165    AUDIO_SAMPLE_FORMAT_S64P = 17, /**< signed 64 bit planar sample */
166    AUDIO_SAMPLE_FORMAT_U64  = 18, /**< unsigned 64 bit sample */
167    AUDIO_SAMPLE_FORMAT_U64P = 19, /**< unsigned 64 bit planar sample */
168    /* float double */
169    AUDIO_SAMPLE_FORMAT_F32  = 20, /**< float 32 bit sample */
170    AUDIO_SAMPLE_FORMAT_F32P = 21, /**< float 32 bit planar sample */
171    AUDIO_SAMPLE_FORMAT_F64  = 22, /**< double 64 bit sample */
172    AUDIO_SAMPLE_FORMAT_F64P = 23, /**< double 64 bit planar sample */
173};
174
175/**
176 * @brief Enumerates channel modes for audio rendering.
177 *
178 * @attention The following modes are set for rendering dual-channel audios. Others are not supported.
179 */
180enum AudioChannelMode {
181    AUDIO_CHANNEL_NORMAL     = 0, /**< Normal mode. No processing is required. */
182    AUDIO_CHANNEL_BOTH_LEFT  = 1, /**< Two left channels */
183    AUDIO_CHANNEL_BOTH_RIGHT = 2, /**< Two right channels */
184    AUDIO_CHANNEL_EXCHANGE   = 3, /**< Data exchange between the left and right channels. The left channel takes the audio
185                                   * stream of the right channel, and the right channel takes that of the left channel.
186                                   */
187    AUDIO_CHANNEL_MIX        = 4, /**< Mix of streams of the left and right channels */
188    AUDIO_CHANNEL_LEFT_MUTE  = 5, /**< Left channel muted. The stream of the right channel is output. */
189    AUDIO_CHANNEL_RIGHT_MUTE = 6, /**< Right channel muted. The stream of the left channel is output. */
190    AUDIO_CHANNEL_BOTH_MUTE  = 7, /**< Both left and right channels are muted */
191};
192
193/**
194 * @brief Enumerates the execution types of the <b>DrainBuffer</b> function.
195 */
196enum AudioDrainNotifyType {
197    AUDIO_DRAIN_NORMAL_MODE = 0, /**< The <b>DrainBuffer</b> function returns after all data finishes playback. */
198    AUDIO_DRAIN_EARLY_MODE  = 1, /**< The <b>DrainBuffer</b> function returns before all the data of the current track
199                                  * finishes playback to reserve time for a smooth track switch by the audio service.
200                                  */
201
202};
203
204/**
205 * @brief Enumerates callback notification events.
206 */
207enum AudioCallbackType {
208    AUDIO_NONBLOCK_WRITE_COMPLETED = 0, /**< The non-block write is complete. */
209    AUDIO_DRAIN_COMPLETED          = 1, /**< The draining is complete. */
210    AUDIO_FLUSH_COMPLETED          = 2, /**< The flush is complete. */
211    AUDIO_RENDER_FULL              = 3, /**< The render buffer is full.*/
212    AUDIO_ERROR_OCCUR              = 4, /**< An error occurs.*/
213};
214
215/**
216 * @brief Describes AudioPortRole.
217 */
218enum AudioPortRole {
219    AUDIO_PORT_UNASSIGNED_ROLE = 0, /**< Unassigned port role */
220    AUDIO_PORT_SOURCE_ROLE     = 1, /**< Assigned source role */
221    AUDIO_PORT_SINK_ROLE       = 2, /**< Assigned sink role */
222};
223
224/**
225 * @brief Describes AudioPortType.
226 */
227enum AudioPortType {
228    AUDIO_PORT_UNASSIGNED_TYPE = 0, /**< Unassigned port type */
229    AUDIO_PORT_DEVICE_TYPE     = 1, /**< Assigned device type */
230    AUDIO_PORT_MIX_TYPE        = 2, /**< Assigned mix type */
231    AUDIO_PORT_SESSION_TYPE    = 3, /**< Assigned session type */
232};
233
234/**
235 * @brief Describes AudioSessionType.
236 */
237enum AudioSessionType {
238    AUDIO_OUTPUT_STAGE_SESSION = 0, /**< Assigned output stage session */
239    AUDIO_OUTPUT_MIX_SESSION   = 1, /**< Assigned output mix session */
240    AUDIO_ALLOCATE_SESSION     = 2, /**< Assigned allocate session */
241    AUDIO_INVALID_SESSION      = 3, /**< Assigned invalid session */
242};
243
244/**
245 * @brief Describes AudioDeviceType.
246 */
247enum AudioDeviceType {
248    AUDIO_LINEOUT        = 1 << 0, /**< Assigned lineout device type */
249    AUDIO_HEADPHONE      = 1 << 1, /**< Assigned headphone device type */
250    AUDIO_HEADSET        = 1 << 2, /**< Assigned headset device type */
251    AUDIO_USB_HEADSET    = 1 << 3, /**< Assigned usb headset device type */
252    AUDIO_USB_HEADPHONE  = 1 << 4, /**< Assigned usb headphone device type */
253    AUDIO_USBA_HEADSET   = 1 << 5, /**< Assigned usba headset device type */
254    AUDIO_USBA_HEADPHONE = 1 << 6, /**< Assigned usba headphone device type */
255    AUDIO_PRIMARY_DEVICE = 1 << 7, /**< Assigned primary device type */
256    AUDIO_USB_DEVICE     = 1 << 8, /**< Assigned usb device type */
257    AUDIO_A2DP_DEVICE    = 1 << 9, /**< Assigned a2dp device type */
258    AUDIO_HDMI_DEVICE    = 1 << 10, /**< Assigned hdmi device type */
259    AUDIO_ADAPTER_DEVICE = 1 << 11, /**< Assigned adapter device type */
260    AUDIO_DEVICE_UNKNOWN,          /**< Assigned unknown device type */
261};
262
263/**
264 * @brief Describes AudioEventType.
265 */
266enum AudioEventType {
267    AUDIO_DEVICE_ADD        = 1,  /**< Assigned add device event type */
268    AUDIO_DEVICE_REMOVE     = 2,  /**< Assigned remove device event type */
269    AUDIO_LOAD_SUCCESS      = 3,  /**< Assigned load sucess event type */
270    AUDIO_LOAD_FAILURE      = 4,  /**< Assigned load failure event type */
271    AUDIO_UNLOAD            = 5,  /**< Assigned unload event type */
272    AUDIO_SERVICE_VALID     = 7,  /**< Assigned valid service event type */
273    AUDIO_SERVICE_INVALID   = 8,  /**< Assigned invalid service event type */
274    AUDIO_CAPTURE_THRESHOLD = 9,  /**< Assigned threshold capture event type */
275    AUDIO_EVENT_UNKNOWN     = 10, /**< Assigned unknown event type */
276};
277
278/**
279 * @brief Enumerates the restricted key type of the parameters
280 */
281enum AudioExtParamKey {
282    AUDIO_EXT_PARAM_KEY_NONE     = 0,    /**< Distributed audio extra param key none */
283    AUDIO_EXT_PARAM_KEY_VOLUME   = 1,    /**< Distributed audio extra param key volume event */
284    AUDIO_EXT_PARAM_KEY_FOCUS    = 2,    /**< Distributed audio extra param key focus event */
285    AUDIO_EXT_PARAM_KEY_BUTTON   = 3,    /**< Distributed audio extra param key media button event */
286    AUDIO_EXT_PARAM_KEY_EFFECT   = 4,    /**< Distributed audio extra param key audio effect event */
287    AUDIO_EXT_PARAM_KEY_STATUS   = 5,    /**< Distributed audio extra param key device status event */
288    AUDIO_EXT_PARAM_KEY_USB_DEVICE = 101, /**< Check USB device type ARM or HIFI */
289    AUDIO_EXT_PARAM_KEY_LOWPOWER = 1000, /**< Low power event type */
290};
291
292/**
293 * @brief Describes status of audio deivce.@link enum AudioDeviceType
294 */
295struct AudioDeviceStatus {
296    unsigned int pnpStatus; /**< Audio pnp status */
297};
298
299/**
300 * @brief Describes the audio scene.
301 */
302union SceneDesc {
303    unsigned int id; /**< Audio scene ID */
304};
305
306/**
307 * @brief Defines the audio port.
308 */
309struct AudioPort {
310    enum AudioPortDirection dir; /**< Audio port type. For details, see {@link AudioPortDirection} */
311    unsigned int portId;         /**< Audio port ID */
312    String portName;             /**< Audio port name */
313};
314
315/**
316 * @brief Defines the audio adapter descriptor.
317 *
318 * An audio adapter is a set of port drivers for a sound card, including the output and input ports.
319 * One port corresponds to multiple pins, and each pin belongs to a physical component (such as a
320 * speaker or a wired headset).
321 */
322struct AudioAdapterDescriptor {
323    String adapterName;       /**< Name of the audio adapter */
324    struct AudioPort[] ports; /**< List of ports supported by an audio adapter */
325};
326
327/**
328 * @brief Defines the audio device descriptor.
329 */
330struct AudioDeviceDescriptor {
331    unsigned int portId;    /**< Audio port ID */
332    enum AudioPortPin pins; /**< Pins of audio ports (input and output). For details, see {@link AudioPortPin}. */
333    String desc;            /**< Audio device name */
334};
335
336/**
337 * @brief Defines the audio scene descriptor.
338 */
339struct AudioSceneDescriptor {
340    union SceneDesc scene;             /**< Describes the audio scene */
341    struct AudioDeviceDescriptor desc; /**< Audio device descriptor */
342};
343
344/**
345 * @brief Defines audio input type.
346 */
347enum AudioInputType {
348    AUDIO_INPUT_DEFAULT_TYPE             = 0,      /**< Assigned default input type */
349    AUDIO_INPUT_MIC_TYPE                 = 1 << 0, /**< Assigned mic input type */
350    AUDIO_INPUT_SPEECH_WAKEUP_TYPE       = 1 << 1, /**< Assigned speech wakeup input type */
351    AUDIO_INPUT_VOICE_COMMUNICATION_TYPE = 1 << 2, /**< Assigned voice communication input type */
352    AUDIO_INPUT_VOICE_RECOGNITION_TYPE   = 1 << 3, /**< Assigned voice recognition input type */
353};
354
355/**
356 * @brief Defines audio offload attributes.
357 */
358struct AudioOffloadInfo
359{
360    unsigned int sampleRate;    /**< Audio sampling rate */
361    unsigned int channelCount;  /**< Number of audio channels */
362    unsigned int bitRate;       /**< bitRate of compressed audio data */
363    unsigned int bitWidth;      /**< bitwidth of audio data */
364    enum AudioFormat format;       /**< Audio data format. */
365    unsigned int offloadBufferSize;    /**< buffersize for offload audio data */
366    unsigned long duration;           /** audio duration, unit is nanosecond*/
367};
368
369/**
370 * @brief Defines audio sampling attributes.
371 */
372struct AudioSampleAttributes {
373    enum AudioCategory type;       /**< Audio type. For details, see {@link AudioCategory} */
374    boolean interleaved;           /**< Interleaving flag of audio data */
375    enum AudioFormat format;       /**< Audio data format. For details, see {@link AudioFormat}. */
376    unsigned int sampleRate;       /**< Audio sampling rate */
377    unsigned int channelCount;     /**< Number of audio channels. For example, for the mono channel, the value is 1,
378                                    * and for the stereo channel, the value is 2.
379                                    */
380    unsigned int period;           /**< Audio sampling period */
381    unsigned int frameSize;        /**< Frame size of the audio data */
382    boolean isBigEndian;           /**< Big endian flag of audio data */
383    boolean isSignedData;          /**< Signed or unsigned flag of audio data */
384    unsigned int startThreshold;   /**< Audio render start threshold. */
385    unsigned int stopThreshold;    /**< Audio render stop threshold. */
386    unsigned int silenceThreshold; /**< Audio capture buffer threshold. */
387    int streamId;                  /**< Audio Identifier of render or capture */
388    int sourceType;                /**< Audio sourceType of render or capture */
389    struct AudioOffloadInfo offloadInfo;  /**< offload info for offload stream */
390};
391
392/**
393 * @brief Defines the audio timestamp, which is a substitute for POSIX <b>timespec</b>.
394 */
395struct AudioTimeStamp {
396    long tvSec;  /**< Seconds */
397    long tvNSec; /**< Nanoseconds */
398};
399
400/**
401 * @brief Defines the sub-port capability.
402 */
403struct AudioSubPortCapability {
404    unsigned int portId;                /**< Sub-port ID */
405    String desc;                        /**< Sub-port name */
406    enum AudioPortPassthroughMode mask; /**< Passthrough mode of data transmission. For details,
407                                         * see {@link AudioPortPassthroughMode}.
408                                         */
409};
410
411/**
412 * @brief Defines the audio port capability.
413 */
414struct AudioPortCapability {
415    unsigned int deviceType;                       /**< Device type (output or input) */
416    unsigned int deviceId;                         /**< Device ID used for device binding */
417    boolean hardwareMode;                          /**< Whether to support device binding */
418    unsigned int formatNum;                        /**< Number of the supported audio formats */
419    enum AudioFormat[] formats;                    /**< Supported audio formats. For details, see {@link AudioFormat}. */
420    unsigned int sampleRateMasks;                  /**< Supported audio sampling rates (8 kHz, 16 kHz, 32 kHz, and 48 kHz) */
421    enum AudioChannelMask channelMasks;            /**< Audio channel layout mask of the device. For details,
422                                                    * see {@link AudioChannelMask}.
423                                                    */
424    unsigned int channelCount;                     /**< Supported maximum number of audio channels */
425    struct AudioSubPortCapability[] subPorts;      /**< List of supported sub-ports */
426    enum AudioSampleFormat[] supportSampleFormats; /**< Supported audio sample formats. For details,
427                                                    * see {@link AudioSampleFormat}.
428                                                    */
429};
430
431/**
432 * @brief Describes a mmap buffer.
433 */
434struct AudioMmapBufferDescriptor {
435    byte[] memoryAddress;    /**< Pointer to the mmap buffer */
436    FileDescriptor memoryFd; /**< File descriptor of the mmap buffer */
437    int totalBufferFrames;   /**< Total size of the mmap buffer (unit: frame )*/
438    int transferFrameSize;   /**< Transfer size (unit: frame) */
439    int isShareable;         /**< Whether the mmap buffer can be shared among processes */
440    unsigned int offset;     /**< off set */
441    String filePath;         /**< file path */
442};
443
444/**
445 * @brief Describes AudioDevExtInfo.
446 */
447struct AudioDevExtInfo {
448    int moduleId;           /**< Identifier of the module stream is attached to */
449    enum AudioPortPin type; /**< Device type For details, see {@link AudioPortPin}. */
450    String desc;            /**< Address */
451};
452
453/**
454 * @brief Describes AudioMixInfo.
455 */
456struct AudioMixExtInfo {
457    int moduleId; /**< Identifier of the module stream is attached to */
458    int streamId; /**< Identifier of the capture or render passed by caller */
459};
460
461/**
462 * @brief Describes AudioSessionExtInfo.
463 */
464struct AudioSessionExtInfo {
465    enum AudioSessionType sessionType; /**< Audio session type */
466};
467
468/**
469 * @brief Describes AudioInfo.
470 */
471struct AudioInfo {
472    struct AudioDevExtInfo device;      /* Specific Device Ext info */
473    struct AudioMixExtInfo mix;         /* Specific mix info */
474    struct AudioSessionExtInfo session; /* session specific info */
475};
476
477/**
478 * @brief Describes AudioRouteNode.
479 */
480struct AudioRouteNode {
481    int portId;              /**< Audio port ID */
482    enum AudioPortRole role; /**< Audio port as a sink or a source */
483    enum AudioPortType type; /**< device, mix ... */
484    struct AudioInfo ext;    /**< The <b>ext</b> object */
485};
486
487/**
488 * @brief Describes AudioRoute.
489 */
490struct AudioRoute {
491    struct AudioRouteNode[] sources; /**< List of sources */
492    struct AudioRouteNode[] sinks;   /**< List of sinks */
493};
494
495/**
496 * @brief Describes AudioEvent.
497 */
498struct AudioEvent {
499    unsigned int eventType;  /**< @link enum AudioEventType */
500    unsigned int deviceType; /**< @link enum AudioDeviceType */
501};
502