1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
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>
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:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
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.
34 **************************************************************************/
36 #ifndef _TDM_HELPER_H_
37 #define _TDM_HELPER_H_
39 #include <tbm_surface.h>
41 #include "tdm_types.h"
49 * @brief The header file to help tdm backend/frontend user
53 * @brief Get the current time as a floating point value in seconds
54 * @return The number of seconds
57 tdm_helper_get_time(void);
60 * @brief Dump a buffer
62 * This function supports only if a buffer has below formats.
63 * - TBM_FORMAT_ARGB8888
64 * - TBM_FORMAT_XRGB8888
71 * The filename extension should be "png" for TBM_FORMAT_ARGB8888 and TBM_FORMAT_XRGB8888
72 * or "yuv" for YUV formats.
73 * @param[in] buffer A TDM buffer
74 * @param[in] file The path of file.
77 tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
80 * @brief fill a buffer with 0 for given pos.
82 * This function supports only if a buffer has below formats.
83 * - TBM_FORMAT_ARGB8888
84 * - TBM_FORMAT_XRGB8888
85 * @param[in] buffer A TDM buffer
88 tdm_helper_clear_buffer_pos(tbm_surface_h buffer, tdm_pos *pos);
91 * @brief fill a buffer with 0 for given pos.
93 * This function supports only if a buffer has below formats.
94 * - TBM_FORMAT_ARGB8888
95 * - TBM_FORMAT_XRGB8888
96 * @param[in] buffer A TDM buffer
99 tdm_helper_clear_buffer_color(tbm_surface_h buffer, tdm_pos *pos, unsigned int color);
102 * @brief fill a buffer with 0.
104 * This function supports only if a buffer has below formats.
105 * - TBM_FORMAT_ARGB8888
106 * - TBM_FORMAT_XRGB8888
107 * - TBM_FORMAT_YVU420
108 * - TBM_FORMAT_YUV420
113 * @param[in] buffer A TDM buffer
116 tdm_helper_clear_buffer(tbm_surface_h buffer);
119 * @brief Get the buffer full size.
121 * In some hardware, the buffer width or height is aligned with the fixed size.
122 * eg. 8, 16, etc. In this case, the real size of buffer could be bigger than
123 * the buffer size of tbm_surface_info_s.
124 * @param[in] buffer A TDM buffer
127 tdm_helper_get_buffer_full_size(tbm_surface_h buffer, int *buffer_w, int *buffer_h);
130 * @brief convert the source buffer to the destination buffer with given rectangles
133 * This function supports only if buffers have below formats.
134 * - TBM_FORMAT_ARGB8888
135 * - TBM_FORMAT_XRGB8888
136 * @param[in] buffer A TDM buffer
139 tdm_helper_convert_buffer(tbm_surface_h srcbuf, tbm_surface_h dstbuf,
140 tdm_pos *srcpos, tdm_pos *dstpos,
141 tdm_transform transform, int over);
144 * @brief Get a fd from the given enviroment variable.
146 * This function will dup the fd of the given enviroment variable. The Caller
147 * @b SHOULD close the fd.
148 * @param[in] env The given enviroment variable
149 * @return fd if success. Otherwise, -1.
150 * @see #tdm_helper_set_fd()
152 int tdm_helper_get_fd(const char *env);
155 * @brief Set the given fd to the give enviroment variable.
156 * @param[in] env The given enviroment variable
157 * @param[in] fd The given fd
158 * @see #tdm_helper_get_fd()
160 void tdm_helper_set_fd(const char *env, int fd);
163 * @brief Start the dump debugging.
166 * Make dump file when tdm_layer_set_buffer() function is called.
167 * Set the dump count to 1.
168 * @param[in] dumppath The given dump path
169 * @param[in] count The dump count number
170 * @see #tdm_helper_dump_stop()
173 tdm_helper_dump_start(char *dumppath, int *count);
176 * @brief Stop the dump debugging.
179 * Set the dump count to 0.
180 * @see #tdm_helper_dump_start()
183 tdm_helper_dump_stop(void);
186 * @brief The tdm helper capture handler
188 * This handler will be called when composit image produced.
189 * @see #tdm_helper_capture_output() function
191 typedef void (*tdm_helper_capture_handler)(tbm_surface_h buffer, void *user_data);
194 * @brief Make an output's image surface.
195 * @details Composit specific output's all layer's buffer to dst_buffer surface.
196 * After composing, tdm_helper_capture_handler func will be called.
197 * @param[in] output A output object
198 * @param[in] dst_buffer A surface composite image saved
199 * @param[in] x A horizontal position of composite image on dst_buffer
200 * @param[in] y A vertical position of composite image on dst_buffer
201 * @param[in] w A composite image width
202 * @param[in] h A composite image height
203 * @param[in] func A composing done handler
204 * @param[in] user_data The user data
205 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
208 tdm_helper_capture_output(tdm_output *output, tbm_surface_h dst_buffer,
209 int x, int y, int w, int h,
210 tdm_helper_capture_handler func, void *data);
213 * @brief Fill the display information to the reply buffer as string.
214 * @param[in] dpy A display object
215 * @param[out] reply the string buffer to be filled by this function.
216 * @param[out] len the length of the reply buffer
219 tdm_helper_get_display_information(tdm_display *dpy, char *reply, int *len);
222 * @brief Get whether the commit-per-vblank functionality is enabled or not.
223 * @param[in] dpy A display object
224 * @return 1 if enabled. Otherwise, 0.
226 * @deprecated use @c tdm_helper_output_commit_per_vblank_enabled instead
229 tdm_helper_commit_per_vblank_enabled(tdm_display *dpy);
232 * @brief Get whether the commit-per-vblank functionality is enabled or not for the output.
233 * @param[in] output An output the functionality has to be checked for
234 * @return -1 if error occurred, 1 if enabled, 0 if disabled.
237 tdm_helper_output_commit_per_vblank_enabled(tdm_output *output);
243 #endif /* _TDM_HELPER_H_ */