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 "tdm_types.h"
40 #include <tbm_surface.h>
48 * @brief The header file to help tdm backend/frontend user
52 * @brief Get the current time as a floating point value in seconds
53 * @return The number of seconds
56 tdm_helper_get_time(void);
59 * @brief Dump a buffer
61 * This function supports only if a buffer has below formats.
62 * - TBM_FORMAT_ARGB8888
63 * - TBM_FORMAT_XRGB8888
70 * The filename extension should be "png" for TBM_FORMAT_ARGB8888 and TBM_FORMAT_XRGB8888
71 * or "yuv" for YUV formats.
72 * @param[in] buffer A TDM buffer
73 * @param[in] file The path of file.
76 tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
79 * @brief fill a buffer with 0 for given pos.
81 * This function supports only if a buffer has below formats.
82 * - TBM_FORMAT_ARGB8888
83 * - TBM_FORMAT_XRGB8888
90 * @param[in] buffer A TDM buffer
93 tdm_helper_clear_buffer_pos(tbm_surface_h buffer, tdm_pos *pos);
96 * @brief fill a buffer with 0.
98 * This function supports only if a buffer has below formats.
99 * - TBM_FORMAT_ARGB8888
100 * - TBM_FORMAT_XRGB8888
101 * - TBM_FORMAT_YVU420
102 * - TBM_FORMAT_YUV420
107 * @param[in] buffer A TDM buffer
110 tdm_helper_clear_buffer(tbm_surface_h buffer);
113 * @brief convert the source buffer to the destination buffer with given rectangles
116 * This function supports only if buffers have below formats.
117 * - TBM_FORMAT_ARGB8888
118 * - TBM_FORMAT_XRGB8888
119 * @param[in] buffer A TDM buffer
122 tdm_helper_convert_buffer(tbm_surface_h srcbuf, tbm_surface_h dstbuf,
123 tdm_pos *srcpos, tdm_pos *dstpos,
124 tdm_transform transform, int over);
127 * @brief Get a fd from the given enviroment variable.
129 * This function will dup the fd of the given enviroment variable. The Caller
130 * @b SHOULD close the fd.
132 * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
133 * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
134 * and "TBM_DRM_MASTER_FD".
135 * @param[in] env The given enviroment variable
136 * @return fd if success. Otherwise, -1.
137 * @see #tdm_helper_set_fd()
139 int tdm_helper_get_fd(const char *env);
142 * @brief Set the given fd to the give enviroment variable.
144 * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
145 * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
146 * and "TBM_DRM_MASTER_FD".
147 * @param[in] env The given enviroment variable
148 * @param[in] fd The given fd
149 * @see #tdm_helper_get_fd()
151 void tdm_helper_set_fd(const char *env, int fd);
154 * @brief Start the dump debugging.
157 * Make dump file when tdm_layer_set_buffer() function is called.
158 * Set the dump count to 1.
159 * @param[in] dumppath The given dump path
160 * @param[in] count The dump count number
161 * @see #tdm_helper_dump_stop()
164 tdm_helper_dump_start(char *dumppath, int *count);
167 * @brief Stop the dump debugging.
170 * Set the dump count to 0.
171 * @see #tdm_helper_dump_start()
174 tdm_helper_dump_stop(void);
177 * @brief The tdm helper capture handler
179 * This handler will be called when composit image produced.
180 * @see #tdm_helper_capture_output() function
182 typedef void (*tdm_helper_capture_handler)(tbm_surface_h buffer, void *user_data);
185 * @brief Make an output's image surface.
186 * @details Composit specific output's all layer's buffer to dst_buffer surface.
187 * After composing, tdm_helper_capture_handler func will be called.
188 * @param[in] output A output object
189 * @param[in] dst_buffer A surface composite image saved
190 * @param[in] x A horizontal position of composite image on dst_buffer
191 * @param[in] y A vertical position of composite image on dst_buffer
192 * @param[in] w A composite image width
193 * @param[in] h A composite image height
194 * @param[in] func A composing done handler
195 * @param[in] user_data The user data
196 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
199 tdm_helper_capture_output(tdm_output *output, tbm_surface_h dst_buffer,
200 int x, int y, int w, int h,
201 tdm_helper_capture_handler func, void *data);
204 * @brief Fill the display information to the reply buffer as string.
205 * @param[in] dpy A display object
206 * @param[out] reply the string buffer to be filled by this function.
207 * @param[out] len the length of the reply buffer
210 tdm_helper_get_display_information(tdm_display *dpy, char *reply, int *len);
213 * @brief Get whether the commit-per-vblank functionality is enabled or not.
214 * @param[in] dpy A display object
215 * @return 1 if enabled. Otherwise, 0.
218 tdm_helper_commit_per_vblank_enabled(tdm_display *dpy);
224 #endif /* _TDM_HELPER_H_ */