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_MULTI_3,                /**< 3 channel */
  41             CHANNEL_MULTI_4,                /**< 4 channel */
  42             CHANNEL_MULTI_5,                /**< 5 channel */
  43             CHANNEL_MULTI_6,                /**< 6 channel */
  44             CHANNEL_MULTI_7,                /**< 7 channel */
  45             CHANNEL_MULTI_8,                /**< 8 channel */
  46             CHANNEL_MULTI_9,                /**< 9 channel */
  47             CHANNEL_MULTI_10,               /**< 10 channel */
  48             CHANNEL_MULTI_11,               /**< 11 channel */
  49             CHANNEL_MULTI_12,               /**< 12 channel */
  50             CHANNEL_MULTI_13,               /**< 13 channel */
  51             CHANNEL_MULTI_14,               /**< 14 channel */
  52             CHANNEL_MULTI_15,               /**< 15 channel */
  53             CHANNEL_MULTI_16,               /**< 16 channel */
  54             CHANNEL_MAX
  55         };
  56
  57         enum class ESampleType : unsigned int {
  58             SAMPLE_TYPE_U8 = 1,             /**< Unsigned 8-bit audio samples */
  59             SAMPLE_TYPE_S16_LE,             /**< Signed 16-bit audio samples */
  60             SAMPLE_TYPE_S24_LE,             /**< Signed 24-bit audio samples */
  61             SAMPLE_TYPE_S24_32_LE,          /**< Signed 24-bit packed in 32-bit audio samples */
  62             SAMPLE_TYPE_S32_LE,             /**< Signed 32-bit audio samples */
  63             SAMPLE_TYPE_MAX
  64         };
  65
  66         enum class EAudioType : unsigned int {
  67             /* Input Type */
  68             AUDIO_IN_TYPE_MEDIA = 0,
  69             //AUDIO_IN_TYPE_SYSTEM,
  70             //AUDIO_IN_TYPE_ALARM,
  71             //AUDIO_IN_TYPE_NOTIFICATION,
  72             //AUDIO_IN_TYPE_EMERGENCY,
  73             //AUDIO_IN_TYPE_VOICE_INFORMATION,
  74             AUDIO_IN_TYPE_VOICE_RECOGNITION,
  75             //AUDIO_IN_TYPE_RINGTONE_VOIP,
  76             AUDIO_IN_TYPE_VOIP,
  77             AUDIO_IN_TYPE_MEDIA_EXTERNAL_ONLY,
  78             //AUDIO_IN_TYPE_RINGTONE_CALL,
  79             //AUDIO_IN_TYPE_VOICE_CALL,
  80             //AUDIO_IN_TYPE_VIDEO_CALL,
  81             //AUDIO_IN_TYPE_RADIO,
  82             AUDIO_IN_TYPE_LOOPBACK,
  83             AUDIO_IN_TYPE_VOICE_RECOGNITION_SERVICE,
  84             //AUDIO_IN_TYPE_MEDIA_NETWORK_SOURCE,
  85
  86             /* Output Type */
  87             AUDIO_OUT_TYPE_MEDIA,
  88             AUDIO_OUT_TYPE_SYSTEM,
  89             AUDIO_OUT_TYPE_ALARM,
  90             AUDIO_OUT_TYPE_NOTIFICATION,
  91             AUDIO_OUT_TYPE_EMERGENCY,
  92             AUDIO_OUT_TYPE_VOICE_INFORMATION,
  93             //AUDIO_OUT_TYPE_VOICE_RECOGNITION,
  94             AUDIO_OUT_TYPE_RINGTONE_VOIP,
  95             AUDIO_OUT_TYPE_VOIP,
  96             AUDIO_OUT_TYPE_MEDIA_EXTERNAL_ONLY,
  97             AUDIO_OUT_TYPE_RINGTONE_CALL,
  98             //AUDIO_OUT_TYPE_VOICE_CALL,
  99             //AUDIO_OUT_TYPE_VIDEO_CALL,
 100             //AUDIO_OUT_TYPE_RADIO,
 101             //AUDIO_OUT_TYPE_LOOPBACK,
 102             //AUDIO_OUT_TYPE_VOICE_RECOGNITION_SERVICE,
 103             AUDIO_OUT_TYPE_MEDIA_NETWORK_SOURCE,
 104
 105             AUDIO_TYPE_MAX
 106         };
 107
 108         enum class EAudioIOState : unsigned int {
 109             AUDIO_IO_STATE_NONE,      /**< Audio-io handle is not created */
 110             AUDIO_IO_STATE_IDLE,      /**< Audio-io handle is created, but not prepared */
 111             AUDIO_IO_STATE_RUNNING,   /**< Audio-io handle is ready and the stream is running */
 112             AUDIO_IO_STATE_PAUSED,    /**< Audio-io handle is ready and the stream is paused */
 113             AUDIO_IO_STATE_MAX
 114         };
 115
 116         enum class EAudioDirection : unsigned int {
 117             AUDIO_DIRECTION_IN,       /**< Audio direction input */
 118             AUDIO_DIRECTION_OUT,      /**< Audio direction output */
 119             AUDIO_DIRECTION_MAX
 120         };
 121
 122         static constexpr auto MIN_SYSTEM_SAMPLERATE = 8000;
 123         static constexpr auto MAX_SYSTEM_SAMPLERATE = 192000;
 124
 125         static constexpr auto MIN_RECORD_VOLUME = 0.0;
 126         static constexpr auto MAX_RECORD_VOLUME = 2.0;
 127         static constexpr auto DEFAULT_RECORD_VOLUME = 1.0;
 128
 129         /* Constructors */
 130         CAudioInfo();
 131         CAudioInfo(unsigned int sampleRate, EChannel channel, ESampleType sampleType, EAudioType audioType, int audioIndex);
 132         virtual ~CAudioInfo() = default;
 133
 134         /* Setter & Getter */
 135         unsigned int getSampleRate() noexcept;
 136         EChannel getChannel() noexcept;
 137         ESampleType getSampleType() noexcept;
 138         EAudioType getAudioType() noexcept;
 139         int getAudioIndex() noexcept;
 140         void setAudioIndex(int audioIndex) noexcept;
 141         int getSampleSize() noexcept;
 142         void bindEchoCancelReferenceDeviceId(int id) noexcept;
 143         int getEchoCancelReferenceDeviceId() noexcept;
 144         void setNoiseSuppression(bool enable) noexcept;
 145         bool getNoiseSuppression() noexcept;
 146
 147         /* Setter & Getter Utilities */
 148         const char* getConvertedStreamType();
 149         void setAudioTypeByInputStreamType(const char* streamType);
 150         void setAudioTypeByOutputStreamType(const char* streamType);
 151
 152     private:
 153         const char *__STREAM_TYPE_TABLE[(unsigned int)EAudioType::AUDIO_TYPE_MAX] = {
 154             /* Input Type */
 155             "media",                  /**< AUDIO_IN_TYPE_MEDIA */
 156             //"system",               /**< AUDIO_IN_TYPE_SYSTEM */
 157             //"alarm",                /**< AUDIO_IN_TYPE_ALARM */
 158             //"notification",         /**< AUDIO_IN_TYPE_NOTIFICATION */
 159             //"emergency",            /**< AUDIO_IN_TYPE_EMERGENCY */
 160             //"voice-information",    /**< AUDIO_IN_TYPE_VOICE_INFORMATION */
 161             "voice-recognition",      /**< AUDIO_IN_TYPE_VOICE_RECOGNITION */
 162             //"ringtone-voip",        /**< AUDIO_IN_TYPE_RINGTONE_VOIP */
 163             "voip",                   /**< AUDIO_IN_TYPE_VOIP */
 164             "ext-media",              /**< AUDIO_IN_TYPE_MEDIA_EXTERNAL_ONLY */
 165             //"ringtone-call",        /**< AUDIO_IN_TYPE_RINGTONE_CALL */
 166             //"call-voice",           /**< AUDIO_IN_TYPE_VOICE_CALL */
 167             //"call-video",           /**< AUDIO_IN_TYPE_VIDEO_CALL */
 168             //"radio",                /**< AUDIO_IN_TYPE_RADIO */
 169             "loopback-mirroring",     /**< AUDIO_IN_TYPE_LOOPBACK */
 170             "voice-recognition-service",     /**< AUDIO_IN_TYPE_VOICE_RECOGNITION_SERVICE */
 171             //"network-source-media", /**< AUDIO_IN_TYPE_MEDIA_NETWORK_SOURCE */
 172
 173             /* Output Type */
 174             "media",                  /**< AUDIO_OUT_TYPE_MEDIA */
 175             "system",                 /**< AUDIO_OUT_TYPE_SYSTEM */
 176             "alarm",                  /**< AUDIO_OUT_TYPE_ALARM */
 177             "notification",           /**< AUDIO_OUT_TYPE_NOTIFICATION */
 178             "emergency",              /**< AUDIO_OUT_TYPE_EMERGENCY */
 179             "voice-information",      /**< AUDIO_OUT_TYPE_VOICE_INFORMATION */
 180             //"voice-recognition",    /**< AUDIO_OUT_TYPE_VOICE_RECOGNITION */
 181             "ringtone-voip",          /**< AUDIO_OUT_TYPE_RINGTONE_VOIP */
 182             "voip",                   /**< AUDIO_OUT_TYPE_VOIP */
 183             "ext-media",              /**< AUDIO_OUT_TYPE_MEDIA_EXTERNAL_ONLY */
 184             "ringtone-call",          /**< AUDIO_OUT_TYPE_RINGTONE_CALL */
 185             //"call-voice",           /**< AUDIO_OUT_TYPE_VOICE_CALL */
 186             //"call-video",           /**< AUDIO_OUT_TYPE_VIDEO_CALL */
 187             //"radio",                /**< AUDIO_OUT_TYPE_RADIO */
 188             //"loopback-mirroring",   /**< AUDIO_OUT_TYPE_LOOPBACK */
 189             //"voice-recognition-service",/**< AUDIO_OUT_TYPE_VOICE_RECOGNITION_SERVICE */
 190             "network-source-media",   /**< AUDIO_OUT_TYPE_MEDIA_NETWORK_SOURCE */
 191         };
 192
 193         EAudioType convertInputStreamTypeToAudioType(const char *streamType);
 194         EAudioType convertOutputStreamTypeToAudioType(const char *streamType);
 195
 196         unsigned int __mSampleRate;
 197         EChannel     __mChannel;
 198         ESampleType  __mSampleType;
 199         EAudioType   __mAudioType;
 200         int          __mAudioIndex;
 201         int          __mReferenceDeviceId;
 202         bool         __mNoiseSuppression;
 203     };
 204
 205
 206 } /* namespace tizen_media_audio */
 207
 208 #endif
 209 #endif /* __TIZEN_MEDIA_AUDIO__IO_CAUDIO_INFO_H__ */