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 **************************************************************************/
33 #ifndef _TBM_SURFACE_INTERNAL_H_
34 #define _TBM_SURFACE_INTERNAL_H_
36 #include <tbm_bufmgr.h>
43 * @brief Queries formats which the system can support.
44 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
45 * @remarks The formats must be released using free().
46 * @param[in] bufmgr : the buffer manager
47 * @param[out] *formats : format array which the system can support. This pointer has to be freed by user.
48 * @param[out] num : the number of formats.
49 * @return a tbm_surface_h if this function succeeds, otherwise NULL
52 #include <tbm_surface.h>
53 #include <tbm_surface_internal.h>
59 bufmgr = tbm_bufmgr_create (-1);
60 ret = tbm_surface_internal_query_surpported_foramts (bufmgr, &formats, &format_num);
65 tbm_surface_bufmgr_deinit (bufmgr);
68 int tbm_surface_internal_query_supported_formats(uint32_t ** formats, uint32_t * num);
71 * @brief Creates the tbm_surface with memory type.
72 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
74 * #TBM_BO_DEFAULT is default memory: it depends on the backend\n
75 * #TBM_BO_SCANOUT is scanout memory\n
76 * #TBM_BO_NONCACHABLE is non-cachable memory\n
77 * #TBM_BO_WC is write-combine memory\n
78 * #TBM_BO_VENDOR vendor specific memory: it depends on the tbm backend\n
79 * @param[in] bufmgr : the buffer manager
80 * @param[in] width : the width of surface
81 * @param[in] height : the height of surface
82 * @param[in] format : the format of surface
83 * @param[in] flags : the flags of memory type
84 * @return a tbm_surface_h if this function succeeds, otherwise NULL
85 * @retval #tbm_surface_h
88 #include <tbm_surface.h>
89 #include <tbm_surface_internal.h>
93 tbm_surface_h surface;
97 bufmgr = tbm_bufmgr_create (bufmgr_fd);
98 surface = tbm_surface_internal_create_with_flags (128, 128, TBM_FORMAT_YUV420, TBM_BO_DEFAULT);
102 tbm_surface_destroy (surface);
103 tbm_surface_bufmgr_deinit (bufmgr);
106 tbm_surface_h tbm_surface_internal_create_with_flags(int width, int height, int format, int flags);
109 * @brief Creates the tbm_surface with buffer objects.
110 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
111 * @param[in] bufmgr : the buffer manager
112 * @param[in] width : the width of surface
113 * @param[in] height : the height of surface
114 * @param[in] format : the format of surface
115 * @param[in] *bos : the array pointer of buffer objects
116 * @param[in] num : the number of buffer objects
117 * @return a tbm_surface_h if this function succeeds, otherwise NULL
118 * @retval #tbm_surface_h
121 #include <tbm_bufmgr.h>
122 #include <tbm_surface.h>
123 #include <tbm_surface_internal.h>
127 tbm_surface_h surface;
128 tbm_surface_info_s info;
133 bufmgr = tbm_bufmgr_init (bufmgr_fd);
134 bo[0] = tbm_bo_alloc (bufmgr, 128 * 128, TBM_BO_DEFAULT);
138 info.format = TBM_FORMAT_ARGB8888;
142 info.planes[0].size = 65536;
143 info.planes[0].offset = 0;
144 info.planes[0].stride = 512;
146 surface = tbm_surface_internal_create_with_bos (&info, bo, 1);
150 tbm_surface_destroy (surface);
151 tbm_surface_bufmgr_deinit (bufmgr);
154 tbm_surface_h tbm_surface_internal_create_with_bos(tbm_surface_info_s * info, tbm_bo * bos, int num);
157 * @brief Destroy the tbm surface
160 void tbm_surface_internal_destroy(tbm_surface_h surface);
163 * @brief reference the tbm surface
166 void tbm_surface_internal_ref(tbm_surface_h surface);
169 * @brief unreference the tbm surface
172 void tbm_surface_internal_unref(tbm_surface_h surface);
175 * @brief Gets the number of buffer objects associated with the tbm_surface.
176 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
177 * @param[in] surface : the tbm_surface_h
178 * @return the number of buffer objects associated with the tbm_surface_h, otherwise -1.
181 #include <tbm_surface.h>
182 #include <tbm_surface_internal.h>
184 tbm_surface_h surface;
187 surface = tbm_surface_create (128, 128, TBM_FORMAT_YUV420);
188 num_bos = tbm_surface_internal_get_num_bos (surface);
192 tbm_surface_destroy (surface);
195 int tbm_surface_internal_get_num_bos(tbm_surface_h surface);
198 * @brief Gets the buffor object by the bo_index.
199 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
200 * @param[in] surface : the tbm_surface_h
201 * @param[in] bo_idx : the bo index in the the tbm_surface
202 * @return the buffer object, otherwise NULL.
206 #include <tbm_surface.h>
207 #include <tbm_surface_internal.h>
209 tbm_surface_h surface;
213 surface = tbm_surface_create (128, 128, TBM_FORMAT_YUV420);
214 num_bos = tbm_surface_internal_get_num_bos (surface);
216 for (i=0 ; i < num_bos ; i++)
218 bo = tbm_surface_internal_get_bo (surface, i);
222 tbm_surface_destroy (surface);
225 tbm_bo tbm_surface_internal_get_bo(tbm_surface_h surface, int bo_idx);
228 * @brief Gets the size of the surface.
229 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
230 * @param[in] surface : the tbm_surface_h
231 * @return the size of tbm_surface, otherwise -1.
234 #include <tbm_surface.h>
235 #include <tbm_surface_internal.h>
237 tbm_surface_h surface;
240 surface = tbm_surface_create (128, 128, TBM_FORMAT_YUV420);
241 size = tbm_surface_internal_get_size (surface);
243 tbm_surface_destroy (surface);
246 int tbm_surface_internal_get_size(tbm_surface_h surface);
249 * @brief Gets size, offset and pitch data of plane by the plane_index.
250 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
251 * @param[in] surface : the tbm_surface_h
252 * @param[in] plane_idx : the bo index in the the tbm_surface
253 * @param[out] size : the size of plane in tbm_surface
254 * @param[out] offset : the offset of plane in tbm_surface
255 * @param[out] pitch : the pitch of plane in tbm_surface
256 * @return 1 if this function succeeds, otherwise 0.
259 #include <tbm_surface.h>
260 #include <tbm_surface_internal.h>
262 tbm_surface_h surface;
263 uint32_t size, offset, pitch;
266 surface = tbm_surface_create (128, 128, TBM_FORMAT_YUV420);
267 ret = tbm_surface_internal_get_plane_data (surface, 1, &size, &offset, &pitch);
271 tbm_surface_destroy (surface);
274 int tbm_surface_internal_get_plane_data(tbm_surface_h surface, int plane_idx, uint32_t * size, uint32_t * offset, uint32_t * pitch);
277 * @brief Gets number of planes by the format.
278 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
279 * @param[in] format : the format of surface
280 * @return number of planes by the format, otherwise 0.
283 #include <tbm_surface.h>
284 #include <tbm_surface_internal.h>
288 num = tbm_surface_internal_get_num_planes (TBM_FORMAT_YUV420);
294 int tbm_surface_internal_get_num_planes(tbm_format format);
297 * @brief Gets bpp by the format.
298 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
299 * @param[in] format : the format of surface
300 * @return bpp by the format, otherwise 0.
303 #include <tbm_surface.h>
304 #include <tbm_surface_internal.h>
308 bpp = tbm_surface_internal_get_bpp (TBM_FORMAT_YUV420);
314 int tbm_surface_internal_get_bpp(tbm_format format);
317 * @brief Gets bo index of plane.
319 * @param[in] surface : the tbm_surface_h
320 * @param[in] plane_idx : the bo index in the tbm_surface
321 * @return bo index of plane, otherwise -1.
324 #include <tbm_surface.h>
325 #include <tbm_surface_internal.h>
328 tbm_surface_h surface;
330 surface = tbm_surface_create (128, 128, TBM_FORMAT_YUV420);
331 bo_idx = tbm_surface_internal_get_plane_bo_idx (surface, 0);
337 int tbm_surface_internal_get_plane_bo_idx(tbm_surface_h surface, int plane_idx);
340 * @brief Set the pid to the tbm_surface for debugging.
342 * @param[in] surface : the tbm_surface_h
343 * @param[in] pid : the pid
345 void tbm_surface_internal_set_debug_pid(tbm_surface_h surface, unsigned int pid);
348 * @brief Adds a user_data to the tbm surface.
350 * @param[in] surface : the tbm surface.
351 * @param[in] key : the key associated with the user_data
352 * @param[in] data_free_func : the function pointer to free the user_data
353 * @return 1 if this function succeeds, otherwise 0.
354 * @post the tbm_surface_data_free() will be called under certain conditions, after calling tbm_surface_internal_delete_user_data().
355 * @see tbm_surface_free()
356 * @see tbm_surface_set_user_data()
357 * @see tbm_surface_get_user_data()
358 * @see tbm_surface_delete_user_data()
360 int tbm_surface_internal_add_user_data(tbm_surface_h surface, unsigned long key, tbm_data_free data_free_func);
363 * @brief Sets a user_date to the tbm surface.
365 * @param[in] surface : the tbm surface.
366 * @param[in] key : the key associated with the user_date
367 * @param[in] data : a pointer of the user_data
368 * @return 1 if this function succeeds, otherwise 0.
370 int tbm_surface_internal_set_user_data(tbm_surface_h surface, unsigned long key, void *data);
373 * @brief Gets a user_data from the tbm surface with the key.
375 * @param[in] surface : the tbm surface.
376 * @param[in] key : the key associated with the user_date
377 * @param[out] data : to get the user data
378 * @return 1 if this function succeeds, otherwise 0.
380 int tbm_surface_internal_get_user_data(tbm_surface_h surface, unsigned long key, void **data);
383 * @brief Deletes the user_data in the tbm surface.
385 * @param[in] surface : the tbm surface.
386 * @param[in] key : the key associated with the user_date
387 * @return 1 if this function succeeds, otherwise 0.
389 int tbm_surface_internal_delete_user_data(tbm_surface_h surface, unsigned long key);
394 #endif /* _TBM_SURFACE_INTERNAL_H_ */