Support VOICE_RECOGNITION_SERVICE stream type
[platform/core/api/audio-io.git] / include / CAudioInfo.h
1 /*
2  * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
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 express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __TIZEN_MEDIA_AUDIO__IO_CAUDIO_INFO_H__
18 #define __TIZEN_MEDIA_AUDIO__IO_CAUDIO_INFO_H__
19
20
21 #ifdef __cplusplus
22
23 #include <type_traits>
24
25 namespace tizen_media_audio {
26
27     template<typename E>
28     constexpr auto to_integral(E e) -> typename std::underlying_type<E>::type {
29         return static_cast<typename std::underlying_type<E>::type>(e);
30     }
31
32     /**
33      * Audio Information
34      */
35     class CAudioInfo {
36     public:
37         enum class EChannel : unsigned int {
38             CHANNEL_MONO = 1,               /**< 1 channel, mono */
39             CHANNEL_STEREO,                 /**< 2 channel, stereo */
40             CHANNEL_MAX
41         };
42
43         enum class ESampleType : unsigned int {
44             SAMPLE_TYPE_U8 = 1,             /**< Unsigned 8-bit audio samples */
45             SAMPLE_TYPE_S16_LE,             /**< Signed 16-bit audio samples */
46             SAMPLE_TYPE_MAX
47         };
48
49         enum class EAudioType : unsigned int {
50             /* Input Type */
51             AUDIO_IN_TYPE_MEDIA = 0,
52             //AUDIO_IN_TYPE_SYSTEM,
53             //AUDIO_IN_TYPE_ALARM,
54             //AUDIO_IN_TYPE_NOTIFICATION,
55             //AUDIO_IN_TYPE_EMERGENCY,
56             //AUDIO_IN_TYPE_VOICE_INFORMATION,
57             AUDIO_IN_TYPE_VOICE_RECOGNITION,
58             //AUDIO_IN_TYPE_RINGTONE_VOIP,
59             AUDIO_IN_TYPE_VOIP,
60             AUDIO_IN_TYPE_MEDIA_EXTERNAL_ONLY,
61             //AUDIO_IN_TYPE_RINGTONE_CALL,
62             //AUDIO_IN_TYPE_VOICE_CALL,
63             //AUDIO_IN_TYPE_VIDEO_CALL,
64             //AUDIO_IN_TYPE_RADIO,
65             AUDIO_IN_TYPE_LOOPBACK,
66             AUDIO_IN_TYPE_VOICE_RECOGNITION_SERVICE,
67
68             /* Output Type */
69             AUDIO_OUT_TYPE_MEDIA,
70             AUDIO_OUT_TYPE_SYSTEM,
71             AUDIO_OUT_TYPE_ALARM,
72             AUDIO_OUT_TYPE_NOTIFICATION,
73             AUDIO_OUT_TYPE_EMERGENCY,
74             AUDIO_OUT_TYPE_VOICE_INFORMATION,
75             //AUDIO_OUT_TYPE_VOICE_RECOGNITION,
76             AUDIO_OUT_TYPE_RINGTONE_VOIP,
77             AUDIO_OUT_TYPE_VOIP,
78             AUDIO_OUT_TYPE_MEDIA_EXTERNAL_ONLY,
79             AUDIO_OUT_TYPE_RINGTONE_CALL,
80             //AUDIO_OUT_TYPE_VOICE_CALL,
81             //AUDIO_OUT_TYPE_VIDEO_CALL,
82             //AUDIO_OUT_TYPE_RADIO,
83             //AUDIO_OUT_TYPE_LOOPBACK,
84             //AUDIO_OUT_TYPE_VOICE_RECOGNITION_SERVICE,
85
86             AUDIO_TYPE_MAX
87         };
88
89         enum class EAudioIOState : unsigned int {
90             AUDIO_IO_STATE_NONE,      /**< Audio-io handle is not created */
91             AUDIO_IO_STATE_IDLE,      /**< Audio-io handle is created, but not prepared */
92             AUDIO_IO_STATE_RUNNING,   /**< Audio-io handle is ready and the stream is running */
93             AUDIO_IO_STATE_PAUSED,    /**< Audio-io handle is ready and the stream is paused */
94             AUDIO_IO_STATE_MAX
95         };
96
97         enum class EAudioDirection : unsigned int {
98             AUDIO_DIRECTION_IN,       /**< Audio direction input */
99             AUDIO_DIRECTION_OUT,      /**< Audio direction output */
100             AUDIO_DIRECTION_MAX
101         };
102
103         const static unsigned int MIN_SYSTEM_SAMPLERATE = 8000;
104         const static unsigned int MAX_SYSTEM_SAMPLERATE = 48000;
105
106         /* Constructors */
107         CAudioInfo();
108         CAudioInfo(unsigned int sampleRate, EChannel channel, ESampleType sampleType, EAudioType audioType, int audioIndex) throw(CAudioError);
109
110         /* Setter & Getter */
111         unsigned int getSampleRate();
112         EChannel getChannel();
113         ESampleType getSampleType();
114         EAudioType getAudioType();
115         void setAudioType(EAudioType audioType);
116         int getAudioIndex();
117         void setAudioIndex(int audioIndex);
118         void convertAudioType2StreamType(CAudioInfo::EAudioType audioType, char **streamType);
119         void convertInputStreamType2AudioType(char *streamType, CAudioInfo::EAudioType *audioType);
120         void convertOutputStreamType2AudioType(char *streamType, CAudioInfo::EAudioType *audioType);
121         int getSampleSize();
122
123     private:
124         const char *__STREAM_TYPE_TABLE[(unsigned int)EAudioType::AUDIO_TYPE_MAX] = {
125             /* Input Type */
126             "media",                  /**< AUDIO_IN_TYPE_MEDIA */
127             //"system",               /**< AUDIO_IN_TYPE_SYSTEM */
128             //"alarm",                /**< AUDIO_IN_TYPE_ALARM */
129             //"notification",         /**< AUDIO_IN_TYPE_NOTIFICATION */
130             //"emergency",            /**< AUDIO_IN_TYPE_EMERGENCY */
131             //"voice-information",    /**< AUDIO_IN_TYPE_VOICE_INFORMATION */
132             "voice-recognition",      /**< AUDIO_IN_TYPE_VOICE_RECOGNITION */
133             //"ringtone-voip",        /**< AUDIO_IN_TYPE_RINGTONE_VOIP */
134             "voip",                   /**< AUDIO_IN_TYPE_VOIP */
135             "ext-media",              /**< AUDIO_IN_TYPE_MEDIA_EXTERNAL_ONLY */
136             //"ringtone-call",        /**< AUDIO_IN_TYPE_RINGTONE_CALL */
137             //"call-voice",           /**< AUDIO_IN_TYPE_VOICE_CALL */
138             //"call-video",           /**< AUDIO_IN_TYPE_VIDEO_CALL */
139             //"radio",                /**< AUDIO_IN_TYPE_RADIO */
140             "loopback-mirroring",     /**< AUDIO_IN_TYPE_LOOPBACK */
141             "voice-recognition-service",     /**< AUDIO_IN_TYPE_VOICE_RECOGNITION_SERVICE */
142
143             /* Output Type */
144             "media",                  /**< AUDIO_OUT_TYPE_MEDIA */
145             "system",                 /**< AUDIO_OUT_TYPE_SYSTEM */
146             "alarm",                  /**< AUDIO_OUT_TYPE_ALARM */
147             "notification",           /**< AUDIO_OUT_TYPE_NOTIFICATION */
148             "emergency",              /**< AUDIO_OUT_TYPE_EMERGENCY */
149             "voice-information",      /**< AUDIO_OUT_TYPE_VOICE_INFORMATION */
150             //"voice-recognition",    /**< AUDIO_OUT_TYPE_VOICE_RECOGNITION */
151             "ringtone-voip",          /**< AUDIO_OUT_TYPE_RINGTONE_VOIP */
152             "voip",                   /**< AUDIO_OUT_TYPE_VOIP */
153             "ext-media",              /**< AUDIO_OUT_TYPE_MEDIA_EXTERNAL_ONLY */
154             "ringtone-call",          /**< AUDIO_OUT_TYPE_RINGTONE_CALL */
155             //"call-voice",           /**< AUDIO_OUT_TYPE_VOICE_CALL */
156             //"call-video",           /**< AUDIO_OUT_TYPE_VIDEO_CALL */
157             //"radio",                /**< AUDIO_OUT_TYPE_RADIO */
158             //"loopback-mirroring",   /**< AUDIO_OUT_TYPE_LOOPBACK */
159             //"voice-recognition-service",/**< AUDIO_OUT_TYPE_VOICE_RECOGNITION_SERVICE */
160         };
161
162         unsigned int __mSampleRate;
163         EChannel     __mChannel;
164         ESampleType  __mSampleType;
165         EAudioType   __mAudioType;
166         int          __mAudioIndex;
167     };
168
169
170 } /* namespace tizen_media_audio */
171
172 #endif
173 #endif /* __TIZEN_MEDIA_AUDIO__IO_CAUDIO_INFO_H__ */