tizen-audio.h

   1 #ifndef footizenaudiofoo
   2 #define footizenaudiofoo
   3
   4 /*
   5  * audio-hal
   6  *
   7  * Copyright (c) 2000 - 2013 Samsung Electronics Co., Ltd. All rights reserved.
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  */
  22
  23 #include <stdint.h>
  24
  25 /* Error code */
  26 #define AUDIO_IS_ERROR(ret)             (ret < 0)
  27 typedef enum audio_return {
  28     AUDIO_RET_OK                        = 0,
  29     AUDIO_ERR_UNDEFINED                 = (int32_t)0x80001000,
  30     AUDIO_ERR_RESOURCE                  = (int32_t)0x80001001,
  31     AUDIO_ERR_PARAMETER                 = (int32_t)0x80001002,
  32     AUDIO_ERR_IOCTL                     = (int32_t)0x80001003,
  33     AUDIO_ERR_NOT_IMPLEMENTED           = (int32_t)0x80001004,
  34 } audio_return_t ;
  35
  36 typedef enum audio_direction {
  37     AUDIO_DIRECTION_IN,                 /**< Capture */
  38     AUDIO_DIRECTION_OUT,                /**< Playback */
  39 } audio_direction_t;
  40
  41 typedef struct device_info {
  42     const char *type;
  43     uint32_t direction;
  44     uint32_t id;
  45 } device_info_t;
  46
  47 typedef struct audio_volume_info {
  48     const char *type;
  49     const char *gain;
  50     uint32_t direction;
  51 } audio_volume_info_t ;
  52
  53 typedef struct audio_route_info {
  54     const char *role;
  55     device_info_t *device_infos;
  56     uint32_t num_of_devices;
  57 } audio_route_info_t;
  58
  59 typedef struct audio_route_option {
  60     const char *role;
  61     const char *name;
  62     int32_t value;
  63 } audio_route_option_t;
  64
  65 typedef struct audio_stream_info {
  66     const char *role;
  67     uint32_t direction;
  68     uint32_t idx;
  69 } audio_stream_info_t ;
  70
  71 /* Overall */
  72 typedef struct audio_interface {
  73     audio_return_t (*init)(void **audio_handle);
  74     audio_return_t (*deinit)(void *audio_handle);
  75     audio_return_t (*get_volume_level_max)(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
  76     audio_return_t (*get_volume_level)(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
  77     audio_return_t (*set_volume_level)(void *audio_handle, audio_volume_info_t *info, uint32_t level);
  78     audio_return_t (*get_volume_value)(void *audio_handle, audio_volume_info_t *info, uint32_t level, double *value);
  79     audio_return_t (*get_volume_mute)(void *audio_handle, audio_volume_info_t *info, uint32_t *mute);
  80     audio_return_t (*set_volume_mute)(void *audio_handle, audio_volume_info_t *info, uint32_t mute);
  81     audio_return_t (*do_route)(void *audio_handle, audio_route_info_t *info);
  82     audio_return_t (*update_route_option)(void *audio_handle, audio_route_option_t *option);
  83     audio_return_t (*update_stream_connection_info) (void *audio_handle, audio_stream_info_t *info, uint32_t is_connected);
  84     audio_return_t (*get_buffer_attr)(void *audio_handle, uint32_t direction, const char *latency, uint32_t samplerate, int format, uint32_t channels,
  85                                       uint32_t *maxlength, uint32_t *tlength, uint32_t *prebuf, uint32_t* minreq, uint32_t *fragsize);
  86     /* Interface of PCM device */
  87     audio_return_t (*pcm_open)(void *audio_handle, void **pcm_handle, uint32_t direction, void *sample_spec, uint32_t period_size, uint32_t periods);
  88     audio_return_t (*pcm_start)(void *audio_handle, void *pcm_handle);
  89     audio_return_t (*pcm_stop)(void *audio_handle, void *pcm_handle);
  90     audio_return_t (*pcm_close)(void *audio_handle, void *pcm_handle);
  91     audio_return_t (*pcm_avail)(void *audio_handle, void *pcm_handle, uint32_t *avail);
  92     audio_return_t (*pcm_write)(void *audio_handle, void *pcm_handle, const void *buffer, uint32_t frames);
  93     audio_return_t (*pcm_read)(void *audio_handle, void *pcm_handle, void *buffer, uint32_t frames);
  94     audio_return_t (*pcm_get_fd)(void *audio_handle, void *pcm_handle, int *fd);
  95     audio_return_t (*pcm_recover)(void *audio_handle, void *pcm_handle, int revents);
  96     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);
  97     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);
  98 } audio_interface_t;
  99
 100 audio_return_t audio_init(void **audio_handle);
 101 audio_return_t audio_deinit(void *audio_handle);
 102 audio_return_t audio_get_volume_level_max(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
 103 audio_return_t audio_get_volume_level(void *audio_handle, audio_volume_info_t *info, uint32_t *level);
 104 audio_return_t audio_set_volume_level(void *audio_handle, audio_volume_info_t *info, uint32_t level);
 105 audio_return_t audio_get_volume_value(void *audio_handle, audio_volume_info_t *info, uint32_t level, double *value);
 106 audio_return_t audio_get_volume_mute(void *audio_handle, audio_volume_info_t *info, uint32_t *mute);
 107 audio_return_t audio_set_volume_mute(void *audio_handle, audio_volume_info_t *info, uint32_t mute);
 108 audio_return_t audio_do_route(void *audio_handle, audio_route_info_t *info);
 109 audio_return_t audio_update_route_option(void *audio_handle, audio_route_option_t *option);
 110 audio_return_t audio_update_stream_connection_info(void *audio_handle, audio_stream_info_t *info, uint32_t is_connected);
 111 audio_return_t audio_get_buffer_attr(void *audio_handle, uint32_t direction, const char *latency, uint32_t samplerate, int format, uint32_t channels,
 112                                      uint32_t *maxlength, uint32_t *tlength, uint32_t *prebuf, uint32_t* minreq, uint32_t *fragsize);
 113 audio_return_t audio_pcm_open(void *audio_handle, void **pcm_handle, uint32_t direction, void *sample_spec, uint32_t period_size, uint32_t periods);
 114 audio_return_t audio_pcm_start(void *audio_handle, void *pcm_handle);
 115 audio_return_t audio_pcm_stop(void *audio_handle, void *pcm_handle);
 116 audio_return_t audio_pcm_close(void *audio_handle, void *pcm_handle);
 117 audio_return_t audio_pcm_avail(void *audio_handle, void *pcm_handle, uint32_t *avail);
 118 audio_return_t audio_pcm_write(void *audio_handle, void *pcm_handle, const void *buffer, uint32_t frames);
 119 audio_return_t audio_pcm_read(void *audio_handle, void *pcm_handle, void *buffer, uint32_t frames);
 120 audio_return_t audio_pcm_get_fd(void *audio_handle, void *pcm_handle, int *fd);
 121 audio_return_t audio_pcm_recover(void *audio_handle, void *pcm_handle, int revents);
 122 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);
 123 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);
 124 #endif