Apply tizen coding convention for C++ and header
[platform/core/api/audio-io.git] / include / CPulseStreamSpec.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_CPULSESTREAM_SPEC_H__
18 #define __TIZEN_MEDIA_AUDIO_IO_CPULSESTREAM_SPEC_H__
19
20
21 #ifdef __cplusplus
22
23
24 #include <pulse/pulseaudio.h>
25
26
27 namespace tizen_media_audio {
28
29
30     /**
31      * class CPulseStreamSpec
32      */
33     class CPulseStreamSpec {
34     public:
35         /* Enums */
36         enum class EStreamLatency : unsigned int {
37             STREAM_LATENCY_INPUT_LOW,
38             STREAM_LATENCY_INPUT_MID,
39             STREAM_LATENCY_INPUT_HIGH,
40             STREAM_LATENCY_INPUT_VOIP,
41             STREAM_LATENCY_OUTPUT_LOW,
42             STREAM_LATENCY_OUTPUT_MID,
43             STREAM_LATENCY_OUTPUT_HIGH,
44             STREAM_LATENCY_OUTPUT_VOIP,
45             STREAM_LATENCY_MAX
46         };
47
48         /* Constructor & Destructor */
49         CPulseStreamSpec() throw(CAudioError);
50         CPulseStreamSpec(EStreamLatency latency, CAudioInfo& audioInfo) throw(CAudioError);
51         CPulseStreamSpec(EStreamLatency latency, CAudioInfo& audioInfo, int customLatency) throw(CAudioError);
52         ~CPulseStreamSpec();
53
54         /* Setter & Getter */
55         EStreamLatency getStreamLatency();
56         const char*    getStreamLatencyToString();
57         CAudioInfo&    getAudioInfo();
58         pa_sample_spec getSampleSpec();
59         pa_channel_map getChannelMap();
60         const char*    getStreamName();
61
62     private:
63         /* Private Methods */
64         void __adjustSpec() throw(CAudioError);
65
66         /* Members */
67         EStreamLatency __mLatency;
68         CAudioInfo     __mAudioInfo;
69         pa_sample_spec __mSampleSpec;
70         pa_channel_map __mChannelMap;
71         const char*    __mStreamName;
72     };
73
74
75 } /* namespace tizen_media_audio */
76
77 #endif
78 #endif /* __TIZEN_MEDIA_AUDIO_IO_CPULSESTREAM_SPEC_H__ */