Merge branch 'tizen_3.0' into tizen
[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
67             /* Output Type */
68             AUDIO_OUT_TYPE_MEDIA,
69             AUDIO_OUT_TYPE_SYSTEM,
70             AUDIO_OUT_TYPE_ALARM,
71             AUDIO_OUT_TYPE_NOTIFICATION,
72             AUDIO_OUT_TYPE_EMERGENCY,
73             AUDIO_OUT_TYPE_VOICE_INFORMATION,
74             //AUDIO_OUT_TYPE_VOICE_RECOGNITION,
75             AUDIO_OUT_TYPE_RINGTONE_VOIP,
76             AUDIO_OUT_TYPE_VOIP,
77             AUDIO_OUT_TYPE_MEDIA_EXTERNAL_ONLY,
78             AUDIO_OUT_TYPE_RINGTONE_CALL,
79             //AUDIO_OUT_TYPE_VOICE_CALL,
80             //AUDIO_OUT_TYPE_VIDEO_CALL,
81             //AUDIO_OUT_TYPE_RADIO,
82             //AUDIO_OUT_TYPE_LOOPBACK,
83
84             AUDIO_TYPE_MAX
85         };
86
87         enum class EAudioIOState : unsigned int {
88             AUDIO_IO_STATE_NONE,      /**< Audio-io handle is not created */
89             AUDIO_IO_STATE_IDLE,      /**< Audio-io handle is created, but not prepared */
90             AUDIO_IO_STATE_RUNNING,   /**< Audio-io handle is ready and the stream is running */
91             AUDIO_IO_STATE_PAUSED,    /**< Audio-io handle is ready and the stream is paused */
92             AUDIO_IO_STATE_MAX
93         };
94
95         enum class EAudioDirection : unsigned int {
96             AUDIO_DIRECTION_IN,       /**< Audio direction input */
97             AUDIO_DIRECTION_OUT,      /**< Audio direction output */
98             AUDIO_DIRECTION_MAX
99         };
100
101         const static unsigned int MIN_SYSTEM_SAMPLERATE = 8000;
102         const static unsigned int MAX_SYSTEM_SAMPLERATE = 48000;
103
104         /* Constructors */
105         CAudioInfo();
106         CAudioInfo(unsigned int sampleRate, EChannel channel, ESampleType sampleType, EAudioType audioType, int audioIndex) throw(CAudioError);
107
108         /* Setter & Getter */
109         unsigned int getSampleRate();
110         EChannel getChannel();
111         ESampleType getSampleType();
112         EAudioType getAudioType();
113         void setAudioType(EAudioType audioType);
114         int getAudioIndex();
115         void setAudioIndex(int audioIndex);
116         void convertAudioType2StreamType(CAudioInfo::EAudioType audioType, char **streamType);
117         void convertInputStreamType2AudioType(char *streamType, CAudioInfo::EAudioType *audioType);
118         void convertOutputStreamType2AudioType(char *streamType, CAudioInfo::EAudioType *audioType);
119         int getSampleSize();
120
121     private:
122         const char *__STREAM_TYPE_TABLE[(unsigned int)EAudioType::AUDIO_TYPE_MAX] = {
123             /* Input Type */
124             "media",                  /**< AUDIO_IN_TYPE_MEDIA */
125             //"system",               /**< AUDIO_IN_TYPE_SYSTEM */
126             //"alarm",                /**< AUDIO_IN_TYPE_ALARM */
127             //"notification",         /**< AUDIO_IN_TYPE_NOTIFICATION */
128             //"emergency",            /**< AUDIO_IN_TYPE_EMERGENCY */
129             //"voice-information",    /**< AUDIO_IN_TYPE_VOICE_INFORMATION */
130             "voice-recognition",      /**< AUDIO_IN_TYPE_VOICE_RECOGNITION */
131             //"ringtone-voip",        /**< AUDIO_IN_TYPE_RINGTONE_VOIP */
132             "voip",                   /**< AUDIO_IN_TYPE_VOIP */
133             "ext-media",              /**< AUDIO_IN_TYPE_MEDIA_EXTERNAL_ONLY */
134             //"ringtone-call",        /**< AUDIO_IN_TYPE_RINGTONE_CALL */
135             //"call-voice",           /**< AUDIO_IN_TYPE_VOICE_CALL */
136             //"call-video",           /**< AUDIO_IN_TYPE_VIDEO_CALL */
137             //"radio",                /**< AUDIO_IN_TYPE_RADIO */
138             "loopback-mirroring",     /**< AUDIO_IN_TYPE_LOOPBACK */
139
140             /* Output Type */
141             "media",                  /**< AUDIO_OUT_TYPE_MEDIA */
142             "system",                 /**< AUDIO_OUT_TYPE_SYSTEM */
143             "alarm",                  /**< AUDIO_OUT_TYPE_ALARM */
144             "notification",           /**< AUDIO_OUT_TYPE_NOTIFICATION */
145             "emergency",              /**< AUDIO_OUT_TYPE_EMERGENCY */
146             "voice-information",      /**< AUDIO_OUT_TYPE_VOICE_INFORMATION */
147             //"voice-recognition",    /**< AUDIO_OUT_TYPE_VOICE_RECOGNITION */
148             "ringtone-voip",          /**< AUDIO_OUT_TYPE_RINGTONE_VOIP */
149             "voip",                   /**< AUDIO_OUT_TYPE_VOIP */
150             "ext-media",              /**< AUDIO_OUT_TYPE_MEDIA_EXTERNAL_ONLY */
151             "ringtone-call",          /**< AUDIO_OUT_TYPE_RINGTONE_CALL */
152             //"call-voice",           /**< AUDIO_OUT_TYPE_VOICE_CALL */
153             //"call-video",           /**< AUDIO_OUT_TYPE_VIDEO_CALL */
154             //"radio",                /**< AUDIO_OUT_TYPE_RADIO */
155             //"loopback-mirroring",   /**< AUDIO_OUT_TYPE_LOOPBACK */
156         };
157
158         unsigned int __mSampleRate;
159         EChannel     __mChannel;
160         ESampleType  __mSampleType;
161         EAudioType   __mAudioType;
162         int          __mAudioIndex;
163     };
164
165
166 } /* namespace tizen_media_audio */
167
168 #endif
169 #endif /* __TIZEN_MEDIA_AUDIO__IO_CAUDIO_INFO_H__ */