Update coverage exception macros
[platform/core/api/audio-io.git] / include / CAudioIO.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_IO_H__
18 #define __TIZEN_MEDIA_AUDIO_IO_CAUDIO_IO_H__
19
20 #include <sound_manager.h>
21
22 #ifdef __cplusplus
23
24
25 namespace tizen_media_audio {
26
27
28     /**
29      *  Abstract Class
30      *  You can't take this object directly.
31      */
32     class IPulseStreamListener;
33     class CAudioIO : public IPulseStreamListener {
34     public:
35         struct SStreamCallback {
36             void* mUserData;
37             void (*onStream)(size_t nbytes, void* user_data);
38
39             SStreamCallback() : mUserData(nullptr), onStream(nullptr) {
40                 /* Empty Body */
41             }
42
43             void set(void (*callback)(size_t, void*), void* userdata) {
44                 onStream = callback;
45                 mUserData = userdata;
46             }
47
48             void unset() {
49                 onStream = nullptr;
50                 mUserData = nullptr;
51             }
52         };
53
54         struct SStateChangedCallback {
55             void* mUserData;
56             void (*onStateChanged)(CAudioInfo::EAudioIOState state, CAudioInfo::EAudioIOState statePrev, bool byPolicy, void* user_data);
57
58             SStateChangedCallback() : mUserData(nullptr), onStateChanged(nullptr) {
59                 /* Empty Body */
60             }
61
62             void set(void (*callback)(CAudioInfo::EAudioIOState, CAudioInfo::EAudioIOState, bool, void*), void* userdata) {
63                 onStateChanged = callback;
64                 mUserData = userdata;
65             }
66
67             void unset() {
68                 onStateChanged = nullptr;
69                 mUserData = nullptr;
70             }
71         };
72
73         /* Constructor & Destructor */
74         CAudioIO();
75         explicit CAudioIO(CAudioInfo& audioInfo);
76         virtual ~CAudioIO() = default;
77
78         /* Pure Virtual Methods */
79         virtual void initialize() = 0;
80         virtual void finalize() = 0;
81
82         virtual void prepare() = 0;
83         virtual void unprepare() = 0;
84
85         virtual void pause() = 0;
86         virtual void resume() = 0;
87
88         /* FIXME : drain needed to be moved to sub-class */
89         virtual void drain();
90         virtual void flush() = 0;
91
92         virtual int  getBufferSize() = 0;
93
94         /* Implemented Handlers */
95         virtual void onStream(CPulseAudioClient* pClient, size_t length);
96         virtual void onStateChanged(CAudioInfo::EAudioIOState state, bool byPolicy);
97         virtual void onStateChanged(CAudioInfo::EAudioIOState state);
98
99         /* Methods */
100         CAudioInfo& getAudioInfo();
101
102         virtual void setStreamCallback(SStreamCallback callback);
103         SStreamCallback getStreamCallback();
104
105         virtual void setStateChangedCallback(SStateChangedCallback callback);
106         SStateChangedCallback getStateChangedCallback();
107
108         void setStreamInfo(sound_stream_info_h stream_info);
109
110         CAudioInfo::EAudioIOState getState() noexcept;
111
112     protected:
113         /* Protected Methods */
114         virtual void setInit(bool flag);
115         virtual bool isInit();
116         virtual bool IsReady();
117
118         void internalLock();
119         void internalUnlock();
120         void internalWait();
121         void internalSignal();
122
123         CPulseAudioClient*    mpPulseAudioClient;
124         CAudioInfo            mAudioInfo;
125
126         SStreamCallback       mStreamCallback;
127         SStateChangedCallback mStateChangedCallback;
128
129         CAudioInfo::EAudioDirection mDirection;
130         CAudioInfo::EAudioIOState mState;
131         CAudioInfo::EAudioIOState mStatePrev;
132         bool                  mByPolicy;
133
134     private:
135         pthread_mutex_t       __mMutex;
136         pthread_mutex_t       __mCondMutex;
137         pthread_cond_t        __mCond;
138         bool                  __mIsInit;
139     };
140
141
142 } /* namespace tizen_media_audio */
143
144 #endif
145 #endif /* __TIZEN_MEDIA_AUDIO_IO_CAUDIO_IO_H__ */