tizen-audio.h

   1 /*
   2  * audio-hal
   3  *
   4  * Copyright (c) 2015 - 2016 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 #ifndef footizenaudiofoo
  21 #define footizenaudiofoo
  22
  23 #include <stdint.h>
  24
  25 /**
  26  * @file tizen-audio.h
  27  * @brief This file contains the Audio Hardware Abstraction Layer Interfaces.
  28  */
  29
  30 /**
  31  * @addtogroup TIZEN_AUDIO_HAL_MODULE
  32  * @{
  33  */
  34
  35 /**
  36  * @brief Enumeration for return codes.
  37  * @since_tizen 3.0
  38  */
  39 typedef enum audio_return {
  40     AUDIO_RET_OK                        = 0,
  41     AUDIO_ERR_UNDEFINED                 = (int32_t)0x80001000,
  42     AUDIO_ERR_RESOURCE                  = (int32_t)0x80001001,
  43     AUDIO_ERR_PARAMETER                 = (int32_t)0x80001002,
  44     AUDIO_ERR_IOCTL                     = (int32_t)0x80001003,
  45     AUDIO_ERR_INVALID_STATE             = (int32_t)0x80001004,
  46     AUDIO_ERR_INTERNAL                  = (int32_t)0x80001005,
  47     /* add new enemerator here */
  48     AUDIO_ERR_NOT_IMPLEMENTED           = (int32_t)0x80001100,
  49 } audio_return_t ;
  50
  51 /**
  52  * @brief Enumeration for audio direction.
  53  * @since_tizen 3.0
  54  */
  55 typedef enum audio_direction {
  56     AUDIO_DIRECTION_IN,                 /**< Capture */
  57     AUDIO_DIRECTION_OUT,                /**< Playback */
  58 } audio_direction_t;
  59
  60 /**
  61  * @brief Device information including type, direction and id.
  62  * @since_tizen 3.0
  63  */
  64 typedef struct device_info {
  65     const char *type;
  66     uint32_t direction;
  67     uint32_t id;
  68 } device_info_t;
  69
  70 /**
  71  * @brief Volume information including type, gain and direction.
  72  * @since_tizen 3.0
  73  */
  74 typedef struct audio_volume_info {
  75     const char *type;
  76     const char *gain;
  77     uint32_t direction;
  78 } audio_volume_info_t ;
  79
  80 /**
  81  * @brief Route information including role and device.
  82  * @since_tizen 3.0
  83  */
  84 typedef struct audio_route_info {
  85     const char *role;
  86     device_info_t *device_infos;
  87     uint32_t num_of_devices;
  88 } audio_route_info_t;
  89
  90 /**
  91  * @brief Route option including role, name and value.
  92  * @since_tizen 3.0
  93  */
  94 typedef struct audio_route_option {
  95     const char *role;
  96     const char *name;
  97     int32_t value;
  98 } audio_route_option_t;
  99
 100 /**
 101  * @brief Stream information including role, direction and index.
 102  * @since_tizen 3.0
 103  */
 104 typedef struct audio_stream_info {
 105     const char *role;
 106     uint32_t direction;
 107     uint32_t idx;
 108 } audio_stream_info_t ;
 109
 110 /**
 111  * @brief Called when audio hal implementation needs to send a message.
 112  * @since_tizen 3.0
 113  * @param[in] name The message name
 114  * @param[in] value The message value
 115  * @param[in] user_data The user data passed from the callback registration function
 116  *
 117  * @see audio_add_message_cb()
 118  * @see audio_remove_message_cb()
 119  */
 120 typedef void (*message_cb)(const char *name, int value, void *user_data);
 121
 122 /* Overall */
 123 typedef struct audio_interface {
 124     /* Initialization & de-initialization */
 125     audio_return_t (*init)(void **audio_handle);
 126     audio_return_t (*deinit)(void *audio_handle);
 127     /* Volume */
 128     audio_return_t (*get_volume_level_max)(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
 129     audio_return_t (*get_volume_level)(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
 130     audio_return_t (*set_volume_level)(void *audio_handle, audio_volume_info_t *info, uint32_t level);
 131     audio_return_t (*get_volume_value)(void *audio_handle, audio_volume_info_t *info, uint32_t level, double *value);
 132     audio_return_t (*get_volume_mute)(void *audio_handle, audio_volume_info_t *info, uint32_t *mute);
 133     audio_return_t (*set_volume_mute)(void *audio_handle, audio_volume_info_t *info, uint32_t mute);
 134     /* Routing */
 135     audio_return_t (*update_route)(void *audio_handle, audio_route_info_t *info);
 136     audio_return_t (*update_route_option)(void *audio_handle, audio_route_option_t *option);
 137     /* Stream */
 138     audio_return_t (*notify_stream_connection_changed)(void *audio_handle, audio_stream_info_t *info, uint32_t is_connected);
 139     /* PCM */
 140     audio_return_t (*pcm_open)(void *audio_handle, const char *card, const char *device, uint32_t direction, void *sample_spec, uint32_t period_size, uint32_t periods, void **pcm_handle);
 141     audio_return_t (*pcm_start)(void *audio_handle, void *pcm_handle);
 142     audio_return_t (*pcm_stop)(void *audio_handle, void *pcm_handle);
 143     audio_return_t (*pcm_close)(void *audio_handle, void *pcm_handle);
 144     audio_return_t (*pcm_avail)(void *audio_handle, void *pcm_handle, uint32_t *avail);
 145     audio_return_t (*pcm_write)(void *audio_handle, void *pcm_handle, const void *buffer, uint32_t frames);
 146     audio_return_t (*pcm_read)(void *audio_handle, void *pcm_handle, void *buffer, uint32_t frames);
 147     audio_return_t (*pcm_get_fd)(void *audio_handle, void *pcm_handle, int *fd);
 148     audio_return_t (*pcm_recover)(void *audio_handle, void *pcm_handle, int revents);
 149     audio_return_t (*pcm_get_params)(void *audio_handle, void *pcm_handle, uint32_t direction, void **sample_spec, uint32_t *period_size, uint32_t *periods);
 150     audio_return_t (*pcm_set_params)(void *audio_handle, void *pcm_handle, uint32_t direction, void *sample_spec, uint32_t period_size, uint32_t periods);
 151     /* Message callback */
 152     audio_return_t (*add_message_cb)(void *audio_handle, message_cb callback, void *user_data);
 153     audio_return_t (*remove_message_cb)(void *audio_handle, message_cb callback);
 154 } audio_interface_t;
 155
 156 /**
 157  * @brief Initializes audio hal.
 158  * @since_tizen 3.0
 159  * @param[out] audio_handle The audio hal handle
 160  *
 161  * @return @c 0 on success,
 162  *         otherwise a negative error value
 163  * @retval #AUDIO_RET_OK Success
 164  * @see audio_deinit()
 165  */
 166 audio_return_t audio_init(void **audio_handle);
 167
 168 /**
 169  * @brief De-initializes audio hal.
 170  * @since_tizen 3.0
 171  * @param[in] audio_handle The audio hal handle
 172  *
 173  * @return @c 0 on success,
 174  *         otherwise a negative error value
 175  * @retval #AUDIO_RET_OK Success
 176  * @see audio_init()
 177  */
 178 audio_return_t audio_deinit(void *audio_handle);
 179
 180 /**
 181  * @brief Gets the maximum volume level supported for a particular volume information.
 182  * @since_tizen 3.0
 183  * @param[in] audio_handle The audio hal handle
 184  * @param[in] info The audio volume information
 185  * @param[out] level The maximum volume level
 186  *
 187  * @return @c 0 on success,
 188  *         otherwise a negative error value
 189  * @retval #AUDIO_RET_OK Success
 190  * @see audio_set_volume_level()
 191  * @see audio_get_volume_level()
 192  * @see audio_get_volume_value()
 193  */
 194 audio_return_t audio_get_volume_level_max(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
 195
 196 /**
 197  * @brief Gets the volume level specified for a particular volume information.
 198  * @since_tizen 3.0
 199  * @param[in] audio_handle The audio hal handle
 200  * @param[in] info The audio volume information
 201  * @param[out] level The current volume level
 202  *
 203  * @return @c 0 on success,
 204  *         otherwise a negative error value
 205  * @retval #AUDIO_RET_OK Success
 206  * @see audio_set_volume_level()
 207  * @see audio_get_volume_level_max()
 208  * @see audio_get_volume_value()
 209  */
 210 audio_return_t audio_get_volume_level(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
 211
 212 /**
 213  * @brief Sets the volume level specified for a particular volume information.
 214  * @since_tizen 3.0
 215  * @param[in] audio_handle The audio hal handle
 216  * @param[in] info The audio volume information
 217  * @param[in] level The volume level to be set
 218  *
 219  * @return @c 0 on success,
 220  *         otherwise a negative error value
 221  * @retval #AUDIO_RET_OK Success
 222  * @see audio_get_volume_level()
 223  * @see audio_get_volume_level_max()
 224  * @see audio_get_volume_value()
 225  */
 226 audio_return_t audio_set_volume_level(void *audio_handle, audio_volume_info_t *info, uint32_t level);
 227
 228 /**
 229  * @brief Gets the volume value specified for a particular volume information and level.
 230  * @since_tizen 3.0
 231  * @param[in] audio_handle The audio hal handle
 232  * @param[in] info The audio volume information
 233  * @param[in] level The volume level
 234  * @param[out] value The volume value (range is from 0.0 to 1.0 inclusive, 1.0 = 100%)
 235  *
 236  * @return @c 0 on success,
 237  *         otherwise a negative error value
 238  * @retval #AUDIO_RET_OK Success
 239  * @see audio_set_volume_level()
 240  * @see audio_get_volume_level()
 241  * @see audio_get_volume_level_max()
 242  */
 243 audio_return_t audio_get_volume_value(void *audio_handle, audio_volume_info_t *info, uint32_t level, double *value);
 244
 245 /**
 246  * @brief Gets the volume mute specified for a particular volume information.
 247  * @since_tizen 3.0
 248  * @param[in] audio_handle The audio hal handle
 249  * @param[in] info The audio volume information
 250  * @param[out] mute The volume mute state : (@c 0 = unmute, @c 1 = mute)
 251  *
 252  * @return @c 0 on success,
 253  *         otherwise a negative error value
 254  * @retval #AUDIO_RET_OK Success
 255  * @see audio_set_volume_mute()
 256  */
 257 audio_return_t audio_get_volume_mute(void *audio_handle, audio_volume_info_t *info, uint32_t *mute);
 258
 259 /**
 260  * @brief Sets the volume mute specified for a particular volume information.
 261  * @since_tizen 3.0
 262  * @param[in] audio_handle The audio hal handle
 263  * @param[in] info The audio volume information
 264  * @param[in] mute The volume mute state to be set : (@c 0 = unmute, @c 1 = mute)
 265  *
 266  * @return @c 0 on success,
 267  *         otherwise a negative error value
 268  * @retval #AUDIO_RET_OK Success
 269  * @see audio_get_volume_mute()
 270  */
 271 audio_return_t audio_set_volume_mute(void *audio_handle, audio_volume_info_t *info, uint32_t mute);
 272
 273 /**
 274  * @brief Updates the audio routing according to audio route information.
 275  * @since_tizen 3.0
 276  * @param[in] audio_handle The audio hal handle
 277  * @param[in] info The audio route information including role and devices
 278  *
 279  * @return @c 0 on success,
 280  *         otherwise a negative error value
 281  * @retval #AUDIO_RET_OK Success
 282  * @see audio_update_route_option()
 283  */
 284 audio_return_t audio_update_route(void *audio_handle, audio_route_info_t *info);
 285
 286 /**
 287  * @brief Updates audio routing option according to audio route option.
 288  * @since_tizen 3.0
 289  * @param[in] audio_handle The audio hal handle
 290  * @param[in] option The option that can be used for audio routing including role, name and value
 291  *
 292  * @remarks This option can be used for audio routing.\n
 293  * It is recommended to apply this option for routing per each role.
 294  *
 295  * @return @c 0 on success,
 296  *         otherwise a negative error value
 297  * @retval #AUDIO_RET_OK Success
 298  * @see audio_update_route()
 299  */
 300 audio_return_t audio_update_route_option(void *audio_handle, audio_route_option_t *option);
 301
 302 /**
 303  * @brief Gets notified when a stream is connected and disconnected.
 304  * @since_tizen 3.0
 305  * @param[in] audio_handle The audio hal handle
 306  * @param[in] info The stream information including role, direction, index
 307  * @param[in] is_connected The connection state of this stream (@c true = connected, @c false = disconnected)
 308  *
 309  * @remarks This information can be used for audio routing, volume controls and so on.
 310  *
 311  * @return @c 0 on success,
 312  *         otherwise a negative error value
 313  * @retval #AUDIO_RET_OK Success
 314  */
 315 audio_return_t audio_notify_stream_connection_changed(void *audio_handle, audio_stream_info_t *info, uint32_t is_connected);
 316
 317 /**
 318  * @brief Opens a PCM device.
 319  * @since_tizen 3.0
 320  * @param[in] audio_handle The audio hal handle
 321  * @param[in] card The card of PCM
 322  * @param[in] device The device of PCM
 323  * @param[in] direction The direction of PCM
 324  * @param[in] sample_spec The sample specification
 325  * @param[in] period_size The period size
 326  * @param[in] periods The periods
 327  * @param[out] pcm_handle The PCM handle
 328  *
 329  * @return @c 0 on success,
 330  *         otherwise a negative error value
 331  * @retval #AUDIO_RET_OK Success
 332  * @see audio_pcm_close()
 333  */
 334 audio_return_t audio_pcm_open(void *audio_handle, const char *card, const char *device, uint32_t direction, void *sample_spec, uint32_t period_size, uint32_t periods, void **pcm_handle);
 335
 336 /**
 337  * @brief Starts a PCM device.
 338  * @since_tizen 3.0
 339  * @param[in] audio_handle The audio hal handle
 340  * @param[in] pcm_handle The PCM handle to be started
 341  *
 342  * @return @c 0 on success,
 343  *         otherwise a negative error value
 344  * @retval #AUDIO_RET_OK Success
 345  * @see audio_pcm_avail()
 346  * @see audio_pcm_write()
 347  * @see audio_pcm_read()
 348  * @see audio_pcm_stop()
 349  * @see audio_pcm_recover()
 350  */
 351 audio_return_t audio_pcm_start(void *audio_handle, void *pcm_handle);
 352
 353 /**
 354  * @brief Stops a PCM device.
 355  * @since_tizen 3.0
 356  * @param[in] audio_handle The audio hal handle
 357  * @param[in] pcm_handle The PCM handle to be stopped
 358  *
 359  * @return @c 0 on success,
 360  *         otherwise a negative error value
 361  * @retval #AUDIO_RET_OK Success
 362  * @see audio_pcm_start()
 363  */
 364 audio_return_t audio_pcm_stop(void *audio_handle, void *pcm_handle);
 365
 366 /**
 367  * @brief Closes a PCM device.
 368  * @since_tizen 3.0
 369  * @param[in] audio_handle The audio hal handle
 370  * @param[in] pcm_handle The PCM handle to be closed
 371  *
 372  * @return @c 0 on success,
 373  *         otherwise a negative error value
 374  * @retval #AUDIO_RET_OK Success
 375  * @see audio_pcm_open()
 376  */
 377 audio_return_t audio_pcm_close(void *audio_handle, void *pcm_handle);
 378
 379 /**
 380  * @brief Gets available number of frames.
 381  * @since_tizen 3.0
 382  * @param[in] audio_handle The audio hal handle
 383  * @param[in] pcm_handle The PCM handle
 384  * @param[out] avail The available number of frames
 385  *
 386  * @return @c 0 on success,
 387  *         otherwise a negative error value
 388  * @retval #AUDIO_RET_OK Success
 389  * @see audio_pcm_write()
 390  * @see audio_pcm_read()
 391  */
 392 audio_return_t audio_pcm_avail(void *audio_handle, void *pcm_handle, uint32_t *avail);
 393
 394 /**
 395  * @brief Writes frames to a PCM device.
 396  * @since_tizen 3.0
 397  * @param[in] audio_handle The audio hal handle
 398  * @param[in] pcm_handle The PCM handle
 399  * @param[in] buffer The buffer containing frames
 400  * @param[in] frames The number of frames to be written
 401  *
 402  * @return @c 0 on success,
 403  *         otherwise a negative error value
 404  * @retval #AUDIO_RET_OK Success
 405  * @see audio_pcm_avail()
 406  * @see audio_pcm_recover()
 407  */
 408 audio_return_t audio_pcm_write(void *audio_handle, void *pcm_handle, const void *buffer, uint32_t frames);
 409
 410 /**
 411  * @brief Reads frames from a PCM device.
 412  * @since_tizen 3.0
 413  * @param[in] audio_handle The audio hal handle
 414  * @param[in] pcm_handle The PCM handle
 415  * @param[out] buffer The buffer containing frames
 416  * @param[in] frames The number of frames to be read
 417  *
 418  * @return @c 0 on success,
 419  *         otherwise a negative error value
 420  * @retval #AUDIO_RET_OK Success
 421  * @see audio_pcm_avail()
 422  * @see audio_pcm_recover()
 423  */
 424 audio_return_t audio_pcm_read(void *audio_handle, void *pcm_handle, void *buffer, uint32_t frames);
 425
 426 /**
 427  * @brief Gets poll descriptor for a PCM handle.
 428  * @since_tizen 3.0
 429  * @param[in] audio_handle The audio hal handle
 430  * @param[in] pcm_handle The PCM handle
 431  * @param[out] fd The poll descriptor
 432  *
 433  * @return @c 0 on success,
 434  *         otherwise a negative error value
 435  * @retval #AUDIO_RET_OK Success
 436  * @see audio_pcm_open()
 437  * @see audio_pcm_recover()
 438  */
 439 audio_return_t audio_pcm_get_fd(void *audio_handle, void *pcm_handle, int *fd);
 440
 441 /**
 442  * @brief Recovers the PCM state.
 443  * @since_tizen 3.0
 444  * @param[in] audio_handle The audio hal handle
 445  * @param[in] pcm_handle The PCM handle
 446  * @param[in] revents The returned event from pollfd
 447  *
 448  * @return @c 0 on success,
 449  *         otherwise a negative error value
 450  * @retval #AUDIO_RET_OK Success
 451  * @see audio_pcm_start()
 452  * @see audio_pcm_write()
 453  * @see audio_pcm_read()
 454  * @see audio_pcm_get_fd()
 455  */
 456 audio_return_t audio_pcm_recover(void *audio_handle, void *pcm_handle, int revents);
 457
 458 /**
 459  * @brief Gets parameters of a PCM device.
 460  * @since_tizen 3.0
 461  * @param[in] audio_handle The audio hal handle
 462  * @param[in] pcm_handle The PCM handle
 463  * @param[in] direction The direction of PCM
 464  * @param[out] sample_spec The sample specification
 465  * @param[out] period_size The period size
 466  * @param[out] periods The periods
 467  *
 468  * @return @c 0 on success,
 469  *         otherwise a negative error value
 470  * @retval #AUDIO_RET_OK Success
 471  * @see audio_pcm_set_params()
 472  */
 473 audio_return_t audio_pcm_get_params(void *audio_handle, void *pcm_handle, uint32_t direction, void **sample_spec, uint32_t *period_size, uint32_t *periods);
 474
 475 /**
 476  * @brief Sets hardware and software parameters of a PCM device.
 477  * @since_tizen 3.0
 478  * @param[in] audio_handle The audio hal handle
 479  * @param[in] pcm_handle The PCM handle
 480  * @param[in] direction The direction of PCM
 481  * @param[in] sample_spec The sample specification
 482  * @param[in] period_size The period size
 483  * @param[in] periods The periods
 484  *
 485  * @return @c 0 on success,
 486  *         otherwise a negative error value
 487  * @retval #AUDIO_RET_OK Success
 488  * @see audio_pcm_set_params()
 489  */
 490 audio_return_t audio_pcm_set_params(void *audio_handle, void *pcm_handle, uint32_t direction, void *sample_spec, uint32_t period_size, uint32_t periods);
 491
 492 /**
 493  * @brief Adds the message callback function.
 494  * @since_tizen 3.0
 495  * @param[in] audio_handle The audio hal handle
 496  * @param[in] message_cb The message callback function
 497  * @param[in] user_data The user data passed to the callback function
 498  *
 499  * @see message_cb()
 500  * @see audio_remove_message_cb()
 501  */
 502 audio_return_t audio_add_message_cb(void *audio_handle, message_cb callback, void *user_data);
 503
 504 /**
 505  * @brief Removes the message callback function.
 506  * @since_tizen 3.0
 507  * @param[in] audio_handle The audio hal handle
 508  * @param[in] message_cb The message callback function to be removed
 509  *
 510  * @see message_cb()
 511  * @see audio_add_message_cb()
 512  */
 513 audio_return_t audio_remove_message_cb(void *audio_handle, message_cb callback);
 514
 515 /**
 516 * @}
 517 */
 518
 519 /**
 520 * @}
 521 */
 522
 523 #endif