78a7990c6d503b368c5f416ec6510332d974e6ca
[platform/core/uifw/libtdm.git] / src / tdm_private.h
1 /**************************************************************************
2
3 libtdm
4
5 Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
6
7 Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8          JinYoung Jeon <jy0.jeon@samsung.com>,
9          Taeheon Kim <th908.kim@samsung.com>,
10          YoungJun Cho <yj44.cho@samsung.com>,
11          SooChan Lim <sc1.lim@samsung.com>,
12          Boram Park <sc1.lim@samsung.com>
13
14 Permission is hereby granted, free of charge, to any person obtaining a
15 copy of this software and associated documentation files (the
16 "Software"), to deal in the Software without restriction, including
17 without limitation the rights to use, copy, modify, merge, publish,
18 distribute, sub license, and/or sell copies of the Software, and to
19 permit persons to whom the Software is furnished to do so, subject to
20 the following conditions:
21
22 The above copyright notice and this permission notice (including the
23 next paragraph) shall be included in all copies or substantial portions
24 of the Software.
25
26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33
34 **************************************************************************/
35
36 #ifndef _TDM_PRIVATE_H_
37 #define _TDM_PRIVATE_H_
38
39 #include <stdio.h>
40 #include <string.h>
41 #include <stdlib.h>
42 #include <pthread.h>
43 #include <errno.h>
44 #include <unistd.h>
45 #include <limits.h>
46 #include <sys/types.h>
47 #include <sys/stat.h>
48 #include <fcntl.h>
49 #include <dlfcn.h>
50 #include <dirent.h>
51
52 #include <tbm_bufmgr.h>
53 #include <tbm_surface_queue.h>
54
55 #include "tdm_backend.h"
56 #include "tdm_log.h"
57 #include "tdm_list.h"
58
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62
63 /**
64  * @file tdm_private.h
65  * @brief The private header file for a frontend library
66  */
67
68 #undef EXTERN
69 #undef DEPRECATED
70 #undef INTERN
71
72 #if defined(__GNUC__) && __GNUC__ >= 4
73 #define EXTERN __attribute__ ((visibility("default")))
74 #else
75 #define EXTERN
76 #endif
77
78 #if defined(__GNUC__) && __GNUC__ >= 4
79 #define INTERN __attribute__ ((visibility("hidden")))
80 #else
81 #define INTERN
82 #endif
83
84 #if defined(__GNUC__) && __GNUC__ >= 4
85 #define DEPRECATED __attribute__ ((deprecated))
86 #else
87 #define DEPRECATED
88 #endif
89
90 /* check condition */
91 #define TDM_RETURN_IF_FAIL(cond) {\
92     if (!(cond)) {\
93         TDM_ERR ("'%s' failed", #cond);\
94         return;\
95     }\
96 }
97 #define TDM_RETURN_VAL_IF_FAIL(cond, val) {\
98     if (!(cond)) {\
99         TDM_ERR ("'%s' failed", #cond);\
100         return val;\
101     }\
102 }
103 #define TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(cond, error_v, val) {\
104     if (!(cond)) {\
105         TDM_ERR ("'%s' failed", #cond);\
106         ret = error_v;\
107         if (error) *error = ret;\
108         return val;\
109     }\
110 }
111
112 #define TDM_WARNING_IF_FAIL(cond)  {\
113     if (!(cond))\
114         TDM_ERR ("'%s' failed", #cond);\
115 }
116 #define TDM_GOTO_IF_FAIL(cond, dst) {\
117     if (!(cond)) {\
118         TDM_ERR ("'%s' failed", #cond);\
119         goto dst;\
120     }\
121 }
122
123 #ifdef HAVE_TTRACE
124 #include <ttrace.h>
125 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
126 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
127 #else
128 #define TDM_TRACE_BEGIN(NAME)
129 #define TDM_TRACE_END()
130 #endif
131
132 #define TDM_NEVER_GET_HERE() TDM_ERR("** NEVER GET HERE **")
133
134 #define TDM_SNPRINTF(p, len, fmt, ARG...)  \
135     do { \
136         if (p && len && *len > 0) \
137         { \
138             int s = snprintf(p, *len, fmt, ##ARG); \
139             p += s; \
140             *len -= s; \
141         } \
142     } while (0)
143
144 #define C(b,m)              (((b) >> (m)) & 0xFF)
145 #define B(c,s)              ((((unsigned int)(c)) & 0xff) << (s))
146 #define FOURCC(a,b,c,d)     (B(d,24) | B(c,16) | B(b,8) | B(a,0))
147 #define FOURCC_STR(id)      C(id,0), C(id,8), C(id,16), C(id,24)
148 #define FOURCC_ID(str)      FOURCC(((char*)str)[0],((char*)str)[1],((char*)str)[2],((char*)str)[3])
149
150 typedef enum
151 {
152     TDM_CAPTURE_TARGET_OUTPUT,
153     TDM_CAPTURE_TARGET_LAYER,
154 } tdm_capture_target;
155
156 typedef struct _tdm_private_display tdm_private_display;
157 typedef struct _tdm_private_output tdm_private_output;
158 typedef struct _tdm_private_layer tdm_private_layer;
159 typedef struct _tdm_private_pp tdm_private_pp;
160 typedef struct _tdm_private_capture tdm_private_capture;
161 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
162 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
163
164 struct _tdm_private_display
165 {
166     pthread_mutex_t lock;
167     unsigned int init_count;
168
169     /* backend module info */
170     void *module;
171     tdm_backend_module *module_data;
172     tdm_backend_data *bdata;
173
174     /* backend function */
175     tdm_display_capability capabilities;
176     tdm_func_display func_display;
177     tdm_func_output func_output;
178     tdm_func_layer func_layer;
179     tdm_func_pp func_pp;
180     tdm_func_capture func_capture;
181
182     /* backend capability */
183     tdm_caps_display caps_display;
184     tdm_caps_pp caps_pp;
185     tdm_caps_capture caps_capture;
186
187     /* output, pp list */
188     struct list_head output_list;
189     struct list_head pp_list;
190
191     void **outputs_ptr;
192
193     tbm_bufmgr bufmgr;
194 };
195
196 struct _tdm_private_output
197 {
198     struct list_head link;
199
200     tdm_private_display *private_display;
201
202     tdm_caps_output caps;
203     tdm_output *output_backend;
204
205     unsigned int pipe;
206
207     int regist_vblank_cb;
208     int regist_commit_cb;
209
210     struct list_head layer_list;
211     struct list_head capture_list;
212     struct list_head vblank_handler_list;
213     struct list_head commit_handler_list;
214
215     void **layers_ptr;
216 };
217
218 struct _tdm_private_layer
219 {
220     struct list_head link;
221
222     tdm_private_display *private_display;
223     tdm_private_output *private_output;
224
225     tdm_caps_layer caps;
226     tdm_layer *layer_backend;
227
228     tbm_surface_h waiting_buffer;
229     tbm_surface_h showing_buffer;
230     tbm_surface_queue_h buffer_queue;
231
232     struct list_head capture_list;
233
234     unsigned int usable;
235 };
236
237 struct _tdm_private_pp
238 {
239     struct list_head link;
240
241     tdm_private_display *private_display;
242
243     tdm_pp *pp_backend;
244 };
245
246 struct _tdm_private_capture
247 {
248     struct list_head link;
249
250     tdm_capture_target target;
251
252     tdm_private_display *private_display;
253     tdm_private_output *private_output;
254     tdm_private_layer *private_layer;
255
256     tdm_capture *capture_backend;
257 };
258
259 struct _tdm_private_vblank_handler
260 {
261     struct list_head link;
262
263     tdm_private_output *private_output;
264     tdm_output_vblank_handler func;
265     void *user_data;
266 };
267
268 struct _tdm_private_commit_handler
269 {
270     struct list_head link;
271
272     tdm_private_output *private_output;
273     tdm_output_commit_handler func;
274     void *user_data;
275 };
276
277 tdm_private_pp* tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
278 void tdm_pp_destroy_internal(tdm_private_pp *private_pp);
279
280 tdm_private_capture* tdm_capture_create_output_internal(tdm_private_output *private_output, tdm_error *error);
281 tdm_private_capture* tdm_capture_create_layer_internal(tdm_private_layer *private_layer, tdm_error *error);
282 void tdm_capture_destroy_internal(tdm_private_capture *private_capture);
283
284 #ifdef __cplusplus
285 }
286 #endif
287
288 #endif /* _TDM_PRIVATE_H_ */