|
1 /* |
|
2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef XATHREADSAFETY_H_ |
|
19 #define XATHREADSAFETY_H_ |
|
20 |
|
21 #include "openmaxalwrapper.h" |
|
22 #include "xaplatform.h" |
|
23 #include "xadebug.h" |
|
24 |
|
25 #ifdef _DEBUG |
|
26 /*parse media object names for debug prints*/ |
|
27 |
|
28 static const char* mediaobjectnames[9] = |
|
29 { |
|
30 "XATSMediaPlayer", |
|
31 "XATSMediaRecorder", |
|
32 "XATSEngine", |
|
33 "XATSRadio", |
|
34 "XATSCamera", |
|
35 "XATSOutputMix", |
|
36 "XATSVibra", |
|
37 "XATSLEDArray", |
|
38 "XATSMetaDataExtractor" |
|
39 }; |
|
40 #define MEDIAOBJECTNAME(i) ((i<XATSCount)?mediaobjectnames[i]:"INVALID") |
|
41 #endif /*_DEBUG*/ |
|
42 |
|
43 /* MACROS */ |
|
44 /* |
|
45 * XA_IMPL_THREAD_SAFETY_ENTRY( mediaObject ) |
|
46 * Description: Tries to lock media object specified by parameter. If object is already locked |
|
47 * returns error value. |
|
48 * @param mediaObject - Index of media object where check is to be done |
|
49 * @return: XA_RESULT_PRECONDITIONS_VIOLATED - If shared data mutex is already in use |
|
50 * @return: XA_RESULT_INTERNAL_ERROR - If there is problem when reserving mutex |
|
51 * @return: In success cases doesn't return |
|
52 */ |
|
53 #define XA_IMPL_THREAD_SAFETY_ENTRY( mediaObject ) \ |
|
54 { \ |
|
55 XAresult mutexRet = XA_RESULT_SUCCESS; \ |
|
56 if ( mediaObject > XATSCount ) \ |
|
57 { \ |
|
58 DEBUG_INFO("Thread safety - invalid mutex reference index"); \ |
|
59 return XA_RESULT_PARAMETER_INVALID; \ |
|
60 } \ |
|
61 DEBUG_INFO_A1("Thread safety entry for %s",MEDIAOBJECTNAME(mediaObject)); \ |
|
62 mutexRet = XAThreadSafety_TryLock( mediaObject ); \ |
|
63 if ( mutexRet == XA_RESULT_PERMISSION_DENIED ) \ |
|
64 { \ |
|
65 DEBUG_INFO("Media object already locked!"); \ |
|
66 return XA_RESULT_PRECONDITIONS_VIOLATED; \ |
|
67 } \ |
|
68 else if ( mutexRet != XA_RESULT_SUCCESS ) \ |
|
69 { \ |
|
70 DEBUG_INFO("Media object lock error!"); \ |
|
71 return XA_RESULT_INTERNAL_ERROR; \ |
|
72 } \ |
|
73 /* Fall through if XA_RESULT_SUCCESS */ \ |
|
74 } \ |
|
75 |
|
76 #define XA_IMPL_THREAD_SAFETY_ENTRY_FOR_VOID_FUNCTIONS( mediaObject ) \ |
|
77 { \ |
|
78 XAresult mutexRet = XA_RESULT_SUCCESS; \ |
|
79 if ( mediaObject > XATSCount ) \ |
|
80 { \ |
|
81 DEBUG_INFO("Thread safety - invalid mutex reference index"); \ |
|
82 return; \ |
|
83 } \ |
|
84 DEBUG_INFO_A1("Thread safety entry for %s",MEDIAOBJECTNAME(mediaObject)); \ |
|
85 mutexRet = XAThreadSafety_TryLock( mediaObject ); \ |
|
86 if ( mutexRet == XA_RESULT_PERMISSION_DENIED ) \ |
|
87 { \ |
|
88 DEBUG_INFO("Media object already locked!"); \ |
|
89 return; \ |
|
90 } \ |
|
91 else if ( mutexRet != XA_RESULT_SUCCESS ) \ |
|
92 { \ |
|
93 DEBUG_INFO("Media object lock error!"); \ |
|
94 return; \ |
|
95 } \ |
|
96 /* Fall through if XA_RESULT_SUCCESS */ \ |
|
97 } \ |
|
98 /* |
|
99 * XA_IMPL_THREAD_SAFETY_EXIT( mediaObject ) |
|
100 * Description: Frees reserved lock for shared data related specified by parameter. |
|
101 * @param mediaObject - Index of media object where check is to be done |
|
102 * @return: XA_RESULT_PRECONDITIONS_VIOLATED if lock is not reserved |
|
103 * @return: XA_RESULT_INTERNAL_ERROR if freeing of lock cannot be done |
|
104 * @return: In success cases doesn't return anything |
|
105 */ |
|
106 #define XA_IMPL_THREAD_SAFETY_EXIT( mediaObject ) \ |
|
107 { \ |
|
108 XAresult mutexRet = XA_RESULT_SUCCESS; \ |
|
109 if ( mediaObject > XATSCount ) \ |
|
110 { \ |
|
111 DEBUG_INFO("Thread safety - invalid mutex reference index"); \ |
|
112 return XA_RESULT_PARAMETER_INVALID; \ |
|
113 } \ |
|
114 DEBUG_INFO_A1("Thread safety exit for %s",MEDIAOBJECTNAME(mediaObject)); \ |
|
115 mutexRet = XAThreadSafety_Unlock( mediaObject ); \ |
|
116 if ( mutexRet != XA_RESULT_SUCCESS) \ |
|
117 { \ |
|
118 DEBUG_INFO("Unable to unlock media object!") \ |
|
119 return XA_RESULT_INTERNAL_ERROR; \ |
|
120 } \ |
|
121 } \ |
|
122 |
|
123 #define XA_IMPL_THREAD_SAFETY_EXIT_FOR_VOID_FUNCTIONS( mediaObject ) \ |
|
124 { \ |
|
125 XAresult mutexRet = XA_RESULT_SUCCESS; \ |
|
126 if ( mediaObject > XATSCount ) \ |
|
127 { \ |
|
128 DEBUG_INFO("Thread safety - invalid mutex reference index"); \ |
|
129 return; \ |
|
130 } \ |
|
131 DEBUG_INFO_A1("Thread safety exit for %s",MEDIAOBJECTNAME(mediaObject)); \ |
|
132 mutexRet = XAThreadSafety_Unlock( mediaObject ); \ |
|
133 if ( mutexRet != XA_RESULT_SUCCESS) \ |
|
134 { \ |
|
135 DEBUG_INFO("Unable to unlock media object!") \ |
|
136 return; \ |
|
137 } \ |
|
138 } \ |
|
139 /* ENUMERATIONS */ |
|
140 |
|
141 typedef enum |
|
142 { |
|
143 XATSMediaPlayer = 0, |
|
144 XATSMediaRecorder, |
|
145 XATSEngine, |
|
146 XATSRadio, |
|
147 XATSCamera, |
|
148 XATSOutputMix, |
|
149 XATSVibra, |
|
150 XATSLEDArray, |
|
151 XATSMetaDataExtractor, |
|
152 XATSCount |
|
153 }XAThreadSafetyMediaObjects; |
|
154 |
|
155 /* FUNCTIONS */ |
|
156 XAresult XAThreadSafety_Init( XAboolean tsEnable); |
|
157 XAresult XAThreadSafety_Destroy(void); |
|
158 XAresult XAThreadSafety_Unlock( XAThreadSafetyMediaObjects mediaObject ); |
|
159 XAresult XAThreadSafety_TryLock( XAThreadSafetyMediaObjects mediaObject ); |
|
160 |
|
161 #endif /* XATHREADSAFETY_H_ */ |