Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 1 | /* $Id$ */ |
| 2 | /* |
| 3 | * Copyright (C) 2008-2009 Teluu Inc. (http://www.teluu.com) |
| 4 | * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 20 | #ifndef __PJMEDIA_AUDIODEV_AUDIODEV_H__ |
| 21 | #define __PJMEDIA_AUDIODEV_AUDIODEV_H__ |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * @file audiodev.h |
| 25 | * @brief Audio device API. |
| 26 | */ |
Benny Prijono | 2058f47 | 2009-02-22 17:15:34 +0000 | [diff] [blame] | 27 | #include <pjmedia-audiodev/config.h> |
Benny Prijono | 8eeab0b | 2009-03-04 19:00:28 +0000 | [diff] [blame] | 28 | #include <pjmedia-audiodev/errno.h> |
Benny Prijono | 64f9138 | 2009-03-05 18:02:28 +0000 | [diff] [blame] | 29 | #include <pjmedia/types.h> |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 30 | #include <pj/pool.h> |
| 31 | |
| 32 | |
| 33 | PJ_BEGIN_DECL |
| 34 | |
| 35 | /** |
Benny Prijono | 2058f47 | 2009-02-22 17:15:34 +0000 | [diff] [blame] | 36 | * @defgroup s2_audio_device_reference Audio Device API Reference |
| 37 | * @ingroup audio_device_api |
| 38 | * @brief API Reference |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 39 | * @{ |
| 40 | */ |
| 41 | |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 42 | /** |
| 43 | * Type for device index. |
| 44 | */ |
| 45 | typedef pj_int32_t pjmedia_aud_dev_index; |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 46 | |
Benny Prijono | 96e74f3 | 2009-02-22 12:00:12 +0000 | [diff] [blame] | 47 | /** |
| 48 | * Device index constants. |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 49 | */ |
Benny Prijono | 96e74f3 | 2009-02-22 12:00:12 +0000 | [diff] [blame] | 50 | enum |
| 51 | { |
| 52 | /** |
| 53 | * Constant to denote default capture device |
| 54 | */ |
| 55 | PJMEDIA_AUD_DEFAULT_CAPTURE_DEV = -1, |
| 56 | |
| 57 | /** |
| 58 | * Constant to denote default playback device |
| 59 | */ |
| 60 | PJMEDIA_AUD_DEFAULT_PLAYBACK_DEV = -2, |
| 61 | |
| 62 | /** |
| 63 | * Constant to denote invalid device index. |
| 64 | */ |
| 65 | PJMEDIA_AUD_INVALID_DEV = -3 |
| 66 | }; |
| 67 | |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 68 | |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 69 | /** |
| 70 | * This enumeration identifies various audio device capabilities. These audio |
| 71 | * capabilities indicates what features are supported by the underlying |
| 72 | * audio device implementation. |
| 73 | * |
| 74 | * Applications get these capabilities in the #pjmedia_aud_dev_info structure. |
| 75 | * |
| 76 | * Application can also set the specific features/capabilities when opening |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 77 | * the audio stream by setting the \a flags member of #pjmedia_aud_param |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 78 | * structure. |
| 79 | * |
| 80 | * Once audio stream is running, application can also retrieve or set some |
| 81 | * specific audio capability, by using #pjmedia_aud_stream_get_cap() and |
| 82 | * #pjmedia_aud_stream_set_cap() and specifying the desired capability. The |
| 83 | * value of the capability is specified as pointer, and application needs to |
| 84 | * supply the pointer with the correct value, according to the documentation |
| 85 | * of each of the capability. |
| 86 | */ |
| 87 | typedef enum pjmedia_aud_dev_cap |
| 88 | { |
| 89 | /** |
| 90 | * Support for audio formats other than PCM. The value of this capability |
| 91 | * is represented by #pjmedia_format structure. |
| 92 | */ |
| 93 | PJMEDIA_AUD_DEV_CAP_EXT_FORMAT = 1, |
| 94 | |
| 95 | /** |
| 96 | * Support for audio input latency control or query. The value of this |
| 97 | * capability is an unsigned integer containing milliseconds value of |
| 98 | * the latency. |
| 99 | */ |
| 100 | PJMEDIA_AUD_DEV_CAP_INPUT_LATENCY = 2, |
| 101 | |
| 102 | /** |
| 103 | * Support for audio output latency control or query. The value of this |
| 104 | * capability is an unsigned integer containing milliseconds value of |
| 105 | * the latency. |
| 106 | */ |
| 107 | PJMEDIA_AUD_DEV_CAP_OUTPUT_LATENCY = 4, |
| 108 | |
| 109 | /** |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 110 | * Support for setting/retrieving the audio input device volume level. |
| 111 | * The value of this capability is an unsigned integer representing |
| 112 | * the input audio volume setting in percent. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 113 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 114 | PJMEDIA_AUD_DEV_CAP_INPUT_VOLUME_SETTING = 8, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 115 | |
| 116 | /** |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 117 | * Support for setting/retrieving the audio output device volume level. |
| 118 | * The value of this capability is an unsigned integer representing |
| 119 | * the output audio volume setting in percent. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 120 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 121 | PJMEDIA_AUD_DEV_CAP_OUTPUT_VOLUME_SETTING = 16, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 122 | |
| 123 | /** |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 124 | * Support for monitoring the current audio input signal volume. |
| 125 | * The value of this capability is an unsigned integer representing |
| 126 | * the audio volume in percent. |
| 127 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 128 | PJMEDIA_AUD_DEV_CAP_INPUT_SIGNAL_METER = 32, |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 129 | |
| 130 | /** |
| 131 | * Support for monitoring the current audio output signal volume. |
| 132 | * The value of this capability is an unsigned integer representing |
| 133 | * the audio volume in percent. |
| 134 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 135 | PJMEDIA_AUD_DEV_CAP_OUTPUT_SIGNAL_METER = 64, |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 136 | |
| 137 | /** |
| 138 | * Support for audio input routing. The value of this capability is an |
| 139 | * integer containing #pjmedia_aud_dev_route enumeration. |
| 140 | */ |
| 141 | PJMEDIA_AUD_DEV_CAP_INPUT_ROUTE = 128, |
| 142 | |
| 143 | /** |
| 144 | * Support for audio output routing (e.g. loudspeaker vs earpiece). The |
| 145 | * value of this capability is an integer containing #pjmedia_aud_dev_route |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 146 | * enumeration. |
| 147 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 148 | PJMEDIA_AUD_DEV_CAP_OUTPUT_ROUTE = 256, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 149 | |
| 150 | /** |
| 151 | * The audio device has echo cancellation feature. The value of this |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 152 | * capability is a pj_bool_t containing boolean PJ_TRUE or PJ_FALSE. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 153 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 154 | PJMEDIA_AUD_DEV_CAP_EC = 512, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 155 | |
| 156 | /** |
| 157 | * The audio device supports setting echo cancellation fail length. The |
| 158 | * value of this capability is an unsigned integer representing the |
| 159 | * echo tail in milliseconds. |
| 160 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 161 | PJMEDIA_AUD_DEV_CAP_EC_TAIL = 1024, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 162 | |
| 163 | /** |
| 164 | * The audio device has voice activity detection feature. The value |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 165 | * of this capability is a pj_bool_t containing boolean PJ_TRUE or |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 166 | * PJ_FALSE. |
| 167 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 168 | PJMEDIA_AUD_DEV_CAP_VAD = 2048, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 169 | |
| 170 | /** |
| 171 | * The audio device has comfort noise generation feature. The value |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 172 | * of this capability is a pj_bool_t containing boolean PJ_TRUE or |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 173 | * PJ_FALSE. |
| 174 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 175 | PJMEDIA_AUD_DEV_CAP_CNG = 4096, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 176 | |
| 177 | /** |
| 178 | * The audio device has packet loss concealment feature. The value |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 179 | * of this capability is a pj_bool_t containing boolean PJ_TRUE or |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 180 | * PJ_FALSE. |
| 181 | */ |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 182 | PJMEDIA_AUD_DEV_CAP_PLC = 8192, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 183 | |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 184 | /** |
| 185 | * End of capability |
| 186 | */ |
| 187 | PJMEDIA_AUD_DEV_CAP_MAX = 16384 |
| 188 | |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 189 | } pjmedia_aud_dev_cap; |
| 190 | |
| 191 | |
| 192 | /** |
| 193 | * This enumeration describes audio routing setting. |
| 194 | */ |
| 195 | typedef enum pjmedia_aud_dev_route |
| 196 | { |
| 197 | /** Default route. */ |
| 198 | PJMEDIA_AUD_DEV_ROUTE_DEFAULT = 0, |
| 199 | |
| 200 | /** Route to loudspeaker */ |
| 201 | PJMEDIA_AUD_DEV_ROUTE_LOUDSPEAKER = 1, |
| 202 | |
| 203 | /** Route to earpiece */ |
| 204 | PJMEDIA_AUD_DEV_ROUTE_EARPIECE = 2 |
| 205 | |
| 206 | } pjmedia_aud_dev_route; |
| 207 | |
| 208 | |
| 209 | /** |
Benny Prijono | 2058f47 | 2009-02-22 17:15:34 +0000 | [diff] [blame] | 210 | * Device information structure returned by #pjmedia_aud_dev_get_info(). |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 211 | */ |
| 212 | typedef struct pjmedia_aud_dev_info |
| 213 | { |
| 214 | /** |
| 215 | * The device name |
| 216 | */ |
| 217 | char name[64]; |
| 218 | |
| 219 | /** |
| 220 | * Maximum number of input channels supported by this device. If the |
| 221 | * value is zero, the device does not support input operation (i.e. |
| 222 | * it is a playback only device). |
| 223 | */ |
| 224 | unsigned input_count; |
| 225 | |
| 226 | /** |
| 227 | * Maximum number of output channels supported by this device. If the |
| 228 | * value is zero, the device does not support output operation (i.e. |
| 229 | * it is an input only device). |
| 230 | */ |
| 231 | unsigned output_count; |
| 232 | |
| 233 | /** |
| 234 | * Default sampling rate. |
| 235 | */ |
| 236 | unsigned default_samples_per_sec; |
| 237 | |
| 238 | /** |
| 239 | * The underlying driver name |
| 240 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 241 | char driver[32]; |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 242 | |
| 243 | /** |
| 244 | * Device capabilities, as bitmask combination of #pjmedia_aud_dev_cap. |
| 245 | */ |
| 246 | unsigned caps; |
| 247 | |
| 248 | /** |
| 249 | * Supported audio device routes, as bitmask combination of |
| 250 | * #pjmedia_aud_dev_route. The value may be zero if the device |
| 251 | * does not support audio routing. |
| 252 | */ |
| 253 | unsigned routes; |
| 254 | |
| 255 | /** |
| 256 | * Number of audio formats supported by this device. The value may be |
| 257 | * zero if the device does not support non-PCM format. |
| 258 | */ |
| 259 | unsigned ext_fmt_cnt; |
| 260 | |
| 261 | /** |
| 262 | * Array of supported extended audio formats |
| 263 | */ |
| 264 | pjmedia_format ext_fmt[8]; |
| 265 | |
| 266 | |
| 267 | } pjmedia_aud_dev_info; |
| 268 | |
| 269 | |
| 270 | /** |
| 271 | * This callback is called by player stream when it needs additional data |
| 272 | * to be played by the device. Application must fill in the whole of output |
| 273 | * buffer with audio samples. |
| 274 | * |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 275 | * The frame argument contains the following values: |
| 276 | * - timestamp Playback timestamp, in samples. |
| 277 | * - buf Buffer to be filled out by application. |
| 278 | * - size The size requested in bytes, which will be equal to |
| 279 | * the size of one whole packet. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 280 | * |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 281 | * @param user_data User data associated with the stream. |
| 282 | * @param frame Audio frame, which buffer is to be filled in by |
| 283 | * the application. |
| 284 | * |
| 285 | * @return Returning non-PJ_SUCCESS will cause the audio stream |
| 286 | * to stop |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 287 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 288 | typedef pj_status_t (*pjmedia_aud_play_cb)(void *user_data, |
| 289 | pjmedia_frame *frame); |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 290 | |
| 291 | /** |
| 292 | * This callback is called by recorder stream when it has captured the whole |
| 293 | * packet worth of audio samples. |
| 294 | * |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 295 | * @param user_data User data associated with the stream. |
| 296 | * @param frame Captured frame. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 297 | * |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 298 | * @return Returning non-PJ_SUCCESS will cause the audio stream |
| 299 | * to stop |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 300 | */ |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 301 | typedef pj_status_t (*pjmedia_aud_rec_cb)(void *user_data, |
| 302 | pjmedia_frame *frame); |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 303 | |
| 304 | /** |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 305 | * This structure specifies the parameters to open the audio stream. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 306 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 307 | typedef struct pjmedia_aud_param |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 308 | { |
| 309 | /** |
| 310 | * The audio direction. This setting is mandatory. |
| 311 | */ |
| 312 | pjmedia_dir dir; |
| 313 | |
| 314 | /** |
| 315 | * The audio recorder device ID. This setting is mandatory if the audio |
| 316 | * direction includes input/capture direction. |
| 317 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 318 | pjmedia_aud_dev_index rec_id; |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 319 | |
| 320 | /** |
| 321 | * The audio playback device ID. This setting is mandatory if the audio |
| 322 | * direction includes output/playback direction. |
| 323 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 324 | pjmedia_aud_dev_index play_id; |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 325 | |
| 326 | /** |
| 327 | * Clock rate/sampling rate. This setting is mandatory. |
| 328 | */ |
| 329 | unsigned clock_rate; |
| 330 | |
| 331 | /** |
| 332 | * Number of channels. This setting is mandatory. |
| 333 | */ |
| 334 | unsigned channel_count; |
| 335 | |
| 336 | /** |
| 337 | * Number of samples per frame. This setting is mandatory. |
| 338 | */ |
| 339 | unsigned samples_per_frame; |
| 340 | |
| 341 | /** |
| 342 | * Number of bits per sample. This setting is mandatory. |
| 343 | */ |
| 344 | unsigned bits_per_sample; |
| 345 | |
| 346 | /** |
| 347 | * This flags specifies which of the optional settings are valid in this |
| 348 | * structure. The flags is bitmask combination of pjmedia_aud_dev_cap. |
| 349 | */ |
| 350 | unsigned flags; |
| 351 | |
| 352 | /** |
| 353 | * Set the audio format. This setting is optional, and will only be used |
| 354 | * if PJMEDIA_AUD_DEV_CAP_EXT_FORMAT is set in the flags. |
| 355 | */ |
| 356 | pjmedia_format ext_fmt; |
| 357 | |
| 358 | /** |
| 359 | * Input latency, in milliseconds. This setting is optional, and will |
| 360 | * only be used if PJMEDIA_AUD_DEV_CAP_INPUT_LATENCY is set in the flags. |
| 361 | */ |
| 362 | unsigned input_latency_ms; |
| 363 | |
| 364 | /** |
| 365 | * Input latency, in milliseconds. This setting is optional, and will |
| 366 | * only be used if PJMEDIA_AUD_DEV_CAP_OUTPUT_LATENCY is set in the flags. |
| 367 | */ |
| 368 | unsigned output_latency_ms; |
| 369 | |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 370 | /** |
| 371 | * Input volume setting, in percent. This setting is optional, and will |
| 372 | * only be used if PJMEDIA_AUD_DEV_CAP_INPUT_VOLUME_SETTING is set in |
| 373 | * the flags. |
| 374 | */ |
| 375 | unsigned input_vol; |
| 376 | |
| 377 | /** |
| 378 | * Output volume setting, in percent. This setting is optional, and will |
| 379 | * only be used if PJMEDIA_AUD_DEV_CAP_OUTPUT_VOLUME_SETTING is set in |
| 380 | * the flags. |
| 381 | */ |
| 382 | unsigned output_vol; |
| 383 | |
| 384 | /** |
| 385 | * Set the audio input route. This setting is optional, and will only be |
| 386 | * used if PJMEDIA_AUD_DEV_CAP_INPUT_ROUTE is set in the flags. |
| 387 | */ |
| 388 | pjmedia_aud_dev_route input_route; |
| 389 | |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 390 | /** |
Benny Prijono | 598b01d | 2009-02-18 13:55:03 +0000 | [diff] [blame] | 391 | * Set the audio output route. This setting is optional, and will only be |
| 392 | * used if PJMEDIA_AUD_DEV_CAP_OUTPUT_ROUTE is set in the flags. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 393 | */ |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 394 | pjmedia_aud_dev_route output_route; |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 395 | |
| 396 | /** |
| 397 | * Enable/disable echo canceller, if the device supports it. This setting |
| 398 | * is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_EC is set in |
| 399 | * the flags. |
| 400 | */ |
| 401 | pj_bool_t ec_enabled; |
| 402 | |
| 403 | /** |
| 404 | * Set echo canceller tail length in milliseconds, if the device supports |
| 405 | * it. This setting is optional, and will only be used if |
| 406 | * PJMEDIA_AUD_DEV_CAP_EC_TAIL is set in the flags. |
| 407 | */ |
| 408 | unsigned ec_tail_ms; |
| 409 | |
| 410 | /** |
| 411 | * Enable/disable PLC. This setting is optional, and will only be used |
| 412 | * if PJMEDIA_AUD_DEV_CAP_PLC is set in the flags. |
| 413 | */ |
| 414 | pj_bool_t plc_enabled; |
| 415 | |
| 416 | /** |
| 417 | * Enable/disable CNG. This setting is optional, and will only be used |
| 418 | * if PJMEDIA_AUD_DEV_CAP_CNG is set in the flags. |
| 419 | */ |
| 420 | pj_bool_t cng_enabled; |
| 421 | |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 422 | } pjmedia_aud_param; |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 423 | |
| 424 | |
| 425 | /** Forward declaration for pjmedia_aud_stream */ |
| 426 | typedef struct pjmedia_aud_stream pjmedia_aud_stream; |
| 427 | |
| 428 | /** Forward declaration for audio device factory */ |
| 429 | typedef struct pjmedia_aud_dev_factory pjmedia_aud_dev_factory; |
| 430 | |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 431 | /** |
| 432 | * Get string info for the specified capability. |
| 433 | * |
| 434 | * @param cap The capability ID. |
| 435 | * @param p_desc Optional pointer which will be filled with longer |
| 436 | * description about the capability. |
| 437 | * |
| 438 | * @return Capability name. |
| 439 | */ |
| 440 | PJ_DECL(const char*) pjmedia_aud_dev_cap_name(pjmedia_aud_dev_cap cap, |
| 441 | const char **p_desc); |
| 442 | |
| 443 | |
| 444 | /** |
| 445 | * Set a capability field value in #pjmedia_aud_param structure. This will |
| 446 | * also set the flags field for the specified capability in the structure. |
| 447 | * |
| 448 | * @param param The structure. |
| 449 | * @param cap The audio capability which value is to be set. |
| 450 | * @param value Pointer to value. Please see the type of value to |
| 451 | * be supplied in the pjmedia_aud_dev_cap documentation. |
| 452 | * |
| 453 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 454 | * error code. |
| 455 | */ |
| 456 | PJ_DECL(pj_status_t) pjmedia_aud_param_set_cap(pjmedia_aud_param *param, |
| 457 | pjmedia_aud_dev_cap cap, |
| 458 | const void *pval); |
| 459 | |
| 460 | |
| 461 | /** |
| 462 | * Get a capability field value from #pjmedia_aud_param structure. This |
| 463 | * function will return PJMEDIA_EAUD_INVCAP error if the flag for that |
| 464 | * capability is not set in the flags field in the structure. |
| 465 | * |
| 466 | * @param param The structure. |
| 467 | * @param cap The audio capability which value is to be retrieved. |
| 468 | * @param value Pointer to value. Please see the type of value to |
| 469 | * be supplied in the pjmedia_aud_dev_cap documentation. |
| 470 | * |
| 471 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 472 | * error code. |
| 473 | */ |
| 474 | PJ_DECL(pj_status_t) pjmedia_aud_param_get_cap(const pjmedia_aud_param *param, |
| 475 | pjmedia_aud_dev_cap cap, |
| 476 | void *pval); |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 477 | |
| 478 | /** |
| 479 | * Initialize the audio subsystem. This will register all supported audio |
| 480 | * device factories to the audio subsystem. This function may be called |
| 481 | * more than once, but each call to this function must have the |
| 482 | * corresponding #pjmedia_aud_subsys_shutdown() call. |
| 483 | * |
| 484 | * @param pf The pool factory. |
| 485 | * |
| 486 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 487 | * error code. |
| 488 | */ |
| 489 | PJ_DECL(pj_status_t) pjmedia_aud_subsys_init(pj_pool_factory *pf); |
| 490 | |
| 491 | |
| 492 | /** |
Benny Prijono | e3ebd55 | 2009-02-18 20:14:15 +0000 | [diff] [blame] | 493 | * Get the pool factory registered to the audio subsystem. |
| 494 | * |
| 495 | * @return The pool factory. |
| 496 | */ |
| 497 | PJ_DECL(pj_pool_factory*) pjmedia_aud_subsys_get_pool_factory(void); |
| 498 | |
| 499 | |
| 500 | /** |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 501 | * Shutdown the audio subsystem. This will destroy all audio device factories |
| 502 | * registered in the audio subsystem. Note that currently opened audio streams |
| 503 | * may or may not be closed, depending on the implementation of the audio |
| 504 | * device factories. |
| 505 | * |
| 506 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 507 | * error code. |
| 508 | */ |
| 509 | PJ_DECL(pj_status_t) pjmedia_aud_subsys_shutdown(void); |
| 510 | |
| 511 | |
| 512 | /** |
| 513 | * Get the number of sound devices installed in the system. |
| 514 | * |
| 515 | * @return The number of sound devices installed in the system. |
| 516 | */ |
| 517 | PJ_DECL(unsigned) pjmedia_aud_dev_count(void); |
| 518 | |
| 519 | |
| 520 | /** |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 521 | * Get device information. |
| 522 | * |
| 523 | * @param id The audio device ID. |
| 524 | * @param info The device information which will be filled in by this |
| 525 | * function once it returns successfully. |
| 526 | * |
| 527 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 528 | * error code. |
| 529 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 530 | PJ_DECL(pj_status_t) pjmedia_aud_dev_get_info(pjmedia_aud_dev_index id, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 531 | pjmedia_aud_dev_info *info); |
| 532 | |
| 533 | |
| 534 | /** |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 535 | * Lookup device index based on the driver and device name. |
| 536 | * |
| 537 | * @param drv_name The driver name. |
| 538 | * @param dev_name The device name. |
Benny Prijono | 2058f47 | 2009-02-22 17:15:34 +0000 | [diff] [blame] | 539 | * @param id Pointer to store the returned device ID. |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 540 | * |
| 541 | * @return PJ_SUCCESS if the device can be found. |
| 542 | */ |
| 543 | PJ_DECL(pj_status_t) pjmedia_aud_dev_lookup(const char *drv_name, |
| 544 | const char *dev_name, |
| 545 | pjmedia_aud_dev_index *id); |
| 546 | |
| 547 | |
| 548 | /** |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 549 | * Initialize the audio device parameters with default values for the |
| 550 | * specified device. |
| 551 | * |
| 552 | * @param id The audio device ID. |
| 553 | * @param param The audio device parameters which will be initialized |
| 554 | * by this function once it returns successfully. |
| 555 | * |
| 556 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 557 | * error code. |
| 558 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 559 | PJ_DECL(pj_status_t) pjmedia_aud_dev_default_param(pjmedia_aud_dev_index id, |
| 560 | pjmedia_aud_param *param); |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 561 | |
| 562 | |
| 563 | /** |
| 564 | * Open audio stream object using the specified parameters. |
| 565 | * |
| 566 | * @param param Sound device parameters to be used for the stream. |
| 567 | * @param rec_cb Callback to be called on every input frame captured. |
| 568 | * @param play_cb Callback to be called everytime the sound device needs |
| 569 | * audio frames to be played back. |
| 570 | * @param user_data Arbitrary user data, which will be given back in the |
| 571 | * callbacks. |
Benny Prijono | 2058f47 | 2009-02-22 17:15:34 +0000 | [diff] [blame] | 572 | * @param p_strm Pointer to receive the audio stream. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 573 | * |
| 574 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 575 | * error code. |
| 576 | */ |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 577 | PJ_DECL(pj_status_t) pjmedia_aud_stream_create(const pjmedia_aud_param *param, |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 578 | pjmedia_aud_rec_cb rec_cb, |
| 579 | pjmedia_aud_play_cb play_cb, |
| 580 | void *user_data, |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 581 | pjmedia_aud_stream **p_strm); |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 582 | |
| 583 | /** |
| 584 | * Get the running parameters for the specified audio stream. |
| 585 | * |
| 586 | * @param strm The audio stream. |
| 587 | * @param param Audio stream parameters to be filled in by this |
| 588 | * function once it returns successfully. |
| 589 | * |
| 590 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 591 | * error code. |
| 592 | */ |
| 593 | PJ_DECL(pj_status_t) pjmedia_aud_stream_get_param(pjmedia_aud_stream *strm, |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 594 | pjmedia_aud_param *param); |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 595 | |
| 596 | /** |
| 597 | * Get the value of a specific capability of the audio stream. |
| 598 | * |
| 599 | * @param strm The audio stream. |
| 600 | * @param cap The audio capability which value is to be retrieved. |
| 601 | * @param value Pointer to value to be filled in by this function |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 602 | * once it returns successfully. Please see the type |
| 603 | * of value to be supplied in the pjmedia_aud_dev_cap |
| 604 | * documentation. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 605 | * |
| 606 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 607 | * error code. |
| 608 | */ |
| 609 | PJ_DECL(pj_status_t) pjmedia_aud_stream_get_cap(pjmedia_aud_stream *strm, |
| 610 | pjmedia_aud_dev_cap cap, |
| 611 | void *value); |
| 612 | |
| 613 | /** |
| 614 | * Set the value of a specific capability of the audio stream. |
| 615 | * |
| 616 | * @param strm The audio stream. |
| 617 | * @param cap The audio capability which value is to be set. |
Benny Prijono | 7a38000 | 2009-03-09 12:55:29 +0000 | [diff] [blame] | 618 | * @param value Pointer to value. Please see the type of value to |
| 619 | * be supplied in the pjmedia_aud_dev_cap documentation. |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 620 | * |
| 621 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 622 | * error code. |
| 623 | */ |
| 624 | PJ_DECL(pj_status_t) pjmedia_aud_stream_set_cap(pjmedia_aud_stream *strm, |
| 625 | pjmedia_aud_dev_cap cap, |
| 626 | const void *value); |
| 627 | |
| 628 | /** |
| 629 | * Start the stream. |
| 630 | * |
| 631 | * @param strm The audio stream. |
| 632 | * |
| 633 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 634 | * error code. |
| 635 | */ |
| 636 | PJ_DECL(pj_status_t) pjmedia_aud_stream_start(pjmedia_aud_stream *strm); |
| 637 | |
| 638 | /** |
| 639 | * Stop the stream. |
| 640 | * |
| 641 | * @param strm The audio stream. |
| 642 | * |
| 643 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 644 | * error code. |
| 645 | */ |
| 646 | PJ_DECL(pj_status_t) pjmedia_aud_stream_stop(pjmedia_aud_stream *strm); |
| 647 | |
| 648 | /** |
| 649 | * Destroy the stream. |
| 650 | * |
| 651 | * @param strm The audio stream. |
| 652 | * |
| 653 | * @return PJ_SUCCESS on successful operation or the appropriate |
| 654 | * error code. |
| 655 | */ |
| 656 | PJ_DECL(pj_status_t) pjmedia_aud_stream_destroy(pjmedia_aud_stream *strm); |
| 657 | |
| 658 | |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 659 | /** |
Benny Prijono | 2058f47 | 2009-02-22 17:15:34 +0000 | [diff] [blame] | 660 | * @} |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 661 | */ |
| 662 | |
| 663 | PJ_END_DECL |
| 664 | |
| 665 | |
Benny Prijono | 10454dc | 2009-02-21 14:21:59 +0000 | [diff] [blame] | 666 | #endif /* __PJMEDIA_AUDIODEV_AUDIODEV_H__ */ |
Benny Prijono | 2cd64f8 | 2009-02-17 19:57:48 +0000 | [diff] [blame] | 667 | |