1 /**************************************************************************
5 Copyright 2014 Samsung Electronics co., Ltd. All Rights Reserved.
7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
8 Inpyo Kang <mantiger@samsung.com>, Dongyeon Kim <dy5.kim@samsung.com>
9 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
11 Permission is hereby granted, free of charge, to any person obtaining a
12 copy of this software and associated documentation files (the
13 "Software"), to deal in the Software without restriction, including
14 without limitation the rights to use, copy, modify, merge, publish,
15 distribute, sub license, and/or sell copies of the Software, and to
16 permit persons to whom the Software is furnished to do so, subject to
17 the following conditions:
19 The above copyright notice and this permission notice (including the
20 next paragraph) shall be included in all copies or substantial portions
23 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
26 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
27 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
28 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
29 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 **************************************************************************/
37 * @addtogroup CAPI_UI_TBM_SURFACE_MODULE
44 * @brief Definition for the Tizen buffer surface.
45 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
47 typedef struct _tbm_surface *tbm_surface_h;
49 * @brief Definition for the Tizen buffer surface format.
50 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
52 typedef uint32_t tbm_format;
54 #define __tbm_fourcc_code(a, b, c, d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \
55 ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
59 * @brief Definition for the TBM surface format C8 ([7:0] C).
60 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
62 #define TBM_FORMAT_C8 __tbm_fourcc_code('C', '8', ' ', ' ')
66 * @brief Definition for the TBM surface format RGB322 ([7:0] R:G:B 3:3:2).
67 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
69 #define TBM_FORMAT_RGB332 __tbm_fourcc_code('R', 'G', 'B', '8')
71 * @brief Definition for the TBM surface format RGB233 ([7:0] B:G:R 2:3:3).
72 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
74 #define TBM_FORMAT_BGR233 __tbm_fourcc_code('B', 'G', 'R', '8')
78 * @brief Definition for the TBM surface format XRGB4444 ([15:0] x:R:G:B 4:4:4:4 little endian).
79 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
81 #define TBM_FORMAT_XRGB4444 __tbm_fourcc_code('X', 'R', '1', '2')
83 * @brief Definition for the TBM surface format XBRG4444 ([15:0] x:B:G:R 4:4:4:4 little endian).
84 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
86 #define TBM_FORMAT_XBGR4444 __tbm_fourcc_code('X', 'B', '1', '2')
88 * @brief Definition for the TBM surface format RGBX4444 ([15:0] R:G:B:x 4:4:4:4 little endian).
89 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
91 #define TBM_FORMAT_RGBX4444 __tbm_fourcc_code('R', 'X', '1', '2')
93 * @brief Definition for the TBM surface format BGRX4444 ([15:0] B:G:R:x 4:4:4:4 little endian).
94 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
96 #define TBM_FORMAT_BGRX4444 __tbm_fourcc_code('B', 'X', '1', '2')
99 * @brief Definition for the TBM surface format ARGB4444 ([15:0] A:R:G:B 4:4:4:4 little endian).
100 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
102 #define TBM_FORMAT_ARGB4444 __tbm_fourcc_code('A', 'R', '1', '2')
104 * @brief Definition for the TBM surface format ABGR4444 ([15:0] A:B:G:R 4:4:4:4 little endian).
105 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
107 #define TBM_FORMAT_ABGR4444 __tbm_fourcc_code('A', 'B', '1', '2')
109 * @brief Definition for the TBM surface format RGBA4444 ([15:0] R:G:B:A 4:4:4:4 little endian).
110 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
112 #define TBM_FORMAT_RGBA4444 __tbm_fourcc_code('R', 'A', '1', '2')
114 * @brief Definition for the TBM surface format BGRA4444 ([15:0] B:G:R:A 4:4:4:4 little endian).
115 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
117 #define TBM_FORMAT_BGRA4444 __tbm_fourcc_code('B', 'A', '1', '2')
120 * @brief Definition for the TBM surface format XRGB1555 ([15:0] x:R:G:B 1:5:5:5 little endian).
121 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
123 #define TBM_FORMAT_XRGB1555 __tbm_fourcc_code('X', 'R', '1', '5')
125 * @brief Definition for the TBM surface format XBGR1555 ([15:0] x:B:G:R 1:5:5:5 little endian).
126 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
128 #define TBM_FORMAT_XBGR1555 __tbm_fourcc_code('X', 'B', '1', '5')
130 * @brief Definition for the TBM surface format RGBX5551 ([15:0] R:G:B:x 5:5:5:1 little endian).
131 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
133 #define TBM_FORMAT_RGBX5551 __tbm_fourcc_code('R', 'X', '1', '5')
135 * @brief Definition for the TBM surface format BGRX5551 ([15:0] B:G:R:x 5:5:5:1 little endian).
136 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
138 #define TBM_FORMAT_BGRX5551 __tbm_fourcc_code('B', 'X', '1', '5')
141 * @brief Definition for the TBM surface format ARGB1555 ([15:0] A:R:G:B 1:5:5:5 little endian).
142 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
144 #define TBM_FORMAT_ARGB1555 __tbm_fourcc_code('A', 'R', '1', '5')
146 * @brief Definition for the TBM surface format ABGR1555 ([15:0] A:B:G:R 1:5:5:5 little endian).
147 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
149 #define TBM_FORMAT_ABGR1555 __tbm_fourcc_code('A', 'B', '1', '5')
151 * @brief Definition for the TBM surface format RGBA5551 ([15:0] R:G:B:A 5:5:5:1 little endian).
152 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
154 #define TBM_FORMAT_RGBA5551 __tbm_fourcc_code('R', 'A', '1', '5')
156 * @brief Definition for the TBM surface format BGRA5551 ([15:0] B:G:R:A 5:5:5:1 little endian).
157 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
159 #define TBM_FORMAT_BGRA5551 __tbm_fourcc_code('B', 'A', '1', '5')
162 * @brief Definition for the TBM surface format RGB565 ([15:0] R:G:B 5:6:5 little endian).
163 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
165 #define TBM_FORMAT_RGB565 __tbm_fourcc_code('R', 'G', '1', '6')
167 * @brief Definition for the TBM surface format BGR565 ([15:0] B:G:R 5:6:5 little endian).
168 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
170 #define TBM_FORMAT_BGR565 __tbm_fourcc_code('B', 'G', '1', '6')
174 * @brief Definition for the TBM surface format RGB888 ([23:0] R:G:B little endian).
175 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
177 #define TBM_FORMAT_RGB888 __tbm_fourcc_code('R', 'G', '2', '4')
179 * @brief Definition for the TBM surface format BGR888 ([23:0] B:G:R little endian).
180 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
182 #define TBM_FORMAT_BGR888 __tbm_fourcc_code('B', 'G', '2', '4')
186 * @brief Definition for the TBM surface format XRGB8888 ([31:0] x:R:G:B 8:8:8:8 little endian).
187 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
189 #define TBM_FORMAT_XRGB8888 __tbm_fourcc_code('X', 'R', '2', '4')
191 * @brief Definition for the TBM surface format XBGR8888 ([31:0] x:B:G:R 8:8:8:8 little endian).
192 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
194 #define TBM_FORMAT_XBGR8888 __tbm_fourcc_code('X', 'B', '2', '4')
196 * @brief Definition for the TBM surface format RGBX8888 ([31:0] R:G:B:x 8:8:8:8 little endian).
197 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
199 #define TBM_FORMAT_RGBX8888 __tbm_fourcc_code('R', 'X', '2', '4')
201 * @brief Definition for the TBM surface format BGRX8888 ([31:0] B:G:R:x 8:8:8:8 little endian).
202 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
204 #define TBM_FORMAT_BGRX8888 __tbm_fourcc_code('B', 'X', '2', '4')
207 * @brief Definition for the TBM surface format ARGB8888 ([31:0] A:R:G:B 8:8:8:8 little endian).
208 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
210 #define TBM_FORMAT_ARGB8888 __tbm_fourcc_code('A', 'R', '2', '4')
212 * @brief Definition for the TBM surface format ABGR8888 ([31:0] [31:0] A:B:G:R 8:8:8:8 little endian).
213 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
215 #define TBM_FORMAT_ABGR8888 __tbm_fourcc_code('A', 'B', '2', '4')
217 * @brief Definition for the TBM surface format RGBA8888 ([31:0] R:G:B:A 8:8:8:8 little endian).
218 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
220 #define TBM_FORMAT_RGBA8888 __tbm_fourcc_code('R', 'A', '2', '4')
222 * @brief Definition for the TBM surface format BGRA8888 ([31:0] B:G:R:A 8:8:8:8 little endian).
223 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
225 #define TBM_FORMAT_BGRA8888 __tbm_fourcc_code('B', 'A', '2', '4')
228 * @brief Definition for the TBM surface format XRGB2101010 ([31:0] x:R:G:B 2:10:10:10 little endian).
229 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
231 #define TBM_FORMAT_XRGB2101010 __tbm_fourcc_code('X', 'R', '3', '0')
233 * @brief Definition for the TBM surface format XBGR2101010 ([31:0] x:B:G:R 2:10:10:10 little endian).
234 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
236 #define TBM_FORMAT_XBGR2101010 __tbm_fourcc_code('X', 'B', '3', '0')
238 * @brief Definition for the TBM surface format RGBX1010102 ([31:0] R:G:B:x 10:10:10:2 little endian).
239 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
241 #define TBM_FORMAT_RGBX1010102 __tbm_fourcc_code('R', 'X', '3', '0')
243 * @brief Definition for the TBM surface format BGRX1010102 ([31:0] B:G:R:x 10:10:10:2 little endian).
244 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
246 #define TBM_FORMAT_BGRX1010102 __tbm_fourcc_code('B', 'X', '3', '0')
249 * @brief Definition for the TBM surface format ARGB2101010 ([31:0] A:R:G:B 2:10:10:10 little endian).
250 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
252 #define TBM_FORMAT_ARGB2101010 __tbm_fourcc_code('A', 'R', '3', '0')
254 * @brief Definition for the TBM surface format ABGR2101010 ([31:0] A:B:G:R 2:10:10:10 little endian).
255 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
257 #define TBM_FORMAT_ABGR2101010 __tbm_fourcc_code('A', 'B', '3', '0')
259 * @brief Definition for the TBM surface format RGBA1010102 ([31:0] R:G:B:A 10:10:10:2 little endian).
260 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
262 #define TBM_FORMAT_RGBA1010102 __tbm_fourcc_code('R', 'A', '3', '0')
264 * @brief Definition for the TBM surface format BGRA1010102 ([31:0] B:G:R:A 10:10:10:2 little endian).
265 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
267 #define TBM_FORMAT_BGRA1010102 __tbm_fourcc_code('B', 'A', '3', '0') /* */
271 * @brief Definition for the TBM surface format YUYV ([31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian).
272 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
274 #define TBM_FORMAT_YUYV __tbm_fourcc_code('Y', 'U', 'Y', 'V')
276 * @brief Definition for the TBM surface format YVYU ([31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian).
277 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
279 #define TBM_FORMAT_YVYU __tbm_fourcc_code('Y', 'V', 'Y', 'U') /* */
281 * @brief Definition for the TBM surface format UYVY ([31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian).
282 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
284 #define TBM_FORMAT_UYVY __tbm_fourcc_code('U', 'Y', 'V', 'Y')
286 * @brief Definition for the TBM surface format VYUY ([31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian).
287 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
289 #define TBM_FORMAT_VYUY __tbm_fourcc_code('V', 'Y', 'U', 'Y')
292 * @brief Definition for the TBM surface format AYUV ([31:0] A:Y:Cb:Cr 8:8:8:8 little endian).
293 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
295 #define TBM_FORMAT_AYUV __tbm_fourcc_code('A', 'Y', 'U', 'V')
299 * index 0 = Y plane, [7:0] Y
300 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
302 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
305 * @brief Definition for the TBM surface format NV12 (2x2 subsampled Cr:Cb plane).
306 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
308 #define TBM_FORMAT_NV12 __tbm_fourcc_code('N', 'V', '1', '2')
310 * @brief Definition for the TBM surface format NV21 (2x2 subsampled Cb:Cr plane).
311 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
313 #define TBM_FORMAT_NV21 __tbm_fourcc_code('N', 'V', '2', '1') /* */
315 * @brief Definition for the TBM surface format NV16 (2x1 subsampled Cr:Cb plane).
316 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
318 #define TBM_FORMAT_NV16 __tbm_fourcc_code('N', 'V', '1', '6')
320 * @brief Definition for the TBM surface format NV61 (2x1 subsampled Cb:Cr plane).
321 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
323 #define TBM_FORMAT_NV61 __tbm_fourcc_code('N', 'V', '6', '1')
327 * index 0: Y plane, [7:0] Y
328 * index 1: Cb plane, [7:0] Cb
329 * index 2: Cr plane, [7:0] Cr
331 * index 1: Cr plane, [7:0] Cr
332 * index 2: Cb plane, [7:0] Cb
335 * @brief Definition for the TBM surface format YUV410 (4x4 subsampled Cb (1) and Cr (2) planes).
337 #define TBM_FORMAT_YUV410 __tbm_fourcc_code('Y', 'U', 'V', '9')
339 * @brief Definition for the TBM surface format YVU410 (4x4 subsampled Cr (1) and Cb (2) planes).
340 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
342 #define TBM_FORMAT_YVU410 __tbm_fourcc_code('Y', 'V', 'U', '9')
344 * @brief Definition for the TBM surface format YUV411 (4x1 subsampled Cb (1) and Cr (2) planes).
345 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
347 #define TBM_FORMAT_YUV411 __tbm_fourcc_code('Y', 'U', '1', '1')
349 * @brief Definition for the TBM surface format YVU411 (4x1 subsampled Cr (1) and Cb (2) planes).
350 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
352 #define TBM_FORMAT_YVU411 __tbm_fourcc_code('Y', 'V', '1', '1')
354 * @brief Definition for the TBM surface format YUV420 (2x2 subsampled Cb (1) and Cr (2) planes).
355 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
357 #define TBM_FORMAT_YUV420 __tbm_fourcc_code('Y', 'U', '1', '2')
359 * @brief Definition for the TBM surface format YVU420 (2x2 subsampled Cr (1) and Cb (2) planes).
360 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
362 #define TBM_FORMAT_YVU420 __tbm_fourcc_code('Y', 'V', '1', '2')
364 * @brief Definition for the TBM surface format YUV422 (2x1 subsampled Cb (1) and Cr (2) planes).
365 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
367 #define TBM_FORMAT_YUV422 __tbm_fourcc_code('Y', 'U', '1', '6')
369 * @brief Definition for the TBM surface format YVU422 (2x1 subsampled Cr (1) and Cb (2) planes).
370 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
372 #define TBM_FORMAT_YVU422 __tbm_fourcc_code('Y', 'V', '1', '6')
374 * @brief Definition for the TBM surface format YUV444 (non-subsampled Cb (1) and Cr (2) planes).
375 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
377 #define TBM_FORMAT_YUV444 __tbm_fourcc_code('Y', 'U', '2', '4')
379 * @brief Definition for the TBM surface format YVU444 (non-subsampled Cr (1) and Cb (2) planes).
380 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
382 #define TBM_FORMAT_YVU444 __tbm_fourcc_code('Y', 'V', '2', '4')
386 * @brief Definition for the TBM surface format NV12MT (tiled '64x32' & multi-plane version of NV12).
389 #define TBM_FORMAT_NV12MT __tbm_fourcc_code('T', 'M', '1', '2')
395 #endif /* _TBM_TYPE_H_ */