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 Dump a buffer
54 * This function supports only if a buffer has below formats.
55 * - TBM_FORMAT_ARGB8888
56 * - TBM_FORMAT_XRGB8888
63 * The filename extension should be "png" for TBM_FORMAT_ARGB8888 and TBM_FORMAT_XRGB8888
64 * or "yuv" for YUV formats.
65 * @param[in] buffer A TDM buffer
66 * @param[in] file The path of file.
69 tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
72 * @brief fill a buffer with 0.
74 * This function supports only if a buffer has below formats.
75 * - TBM_FORMAT_ARGB8888
76 * - TBM_FORMAT_XRGB8888
83 * @param[in] buffer A TDM buffer
86 tdm_helper_clear_buffer(tbm_surface_h buffer);
89 * @brief Get a fd from the given enviroment variable.
91 * This function will dup the fd of the given enviroment variable. The Caller
92 * @b SHOULD close the fd.
94 * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
95 * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
96 * and "TBM_DRM_MASTER_FD".
97 * @param[in] env The given enviroment variable
98 * @return fd if success. Otherwise, -1.
99 * @see #tdm_helper_set_fd()
101 int tdm_helper_get_fd(const char *env);
104 * @brief Set the given fd to the give enviroment variable.
106 * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
107 * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
108 * and "TBM_DRM_MASTER_FD".
109 * @param[in] env The given enviroment variable
110 * @param[in] fd The given fd
111 * @see #tdm_helper_get_fd()
113 void tdm_helper_set_fd(const char *env, int fd);
116 * @brief Start the dump debugging.
119 * Make dump file when tdm_layer_set_buffer() function is called.
120 * Set the dump count to 1.
121 * @param[in] dumppath The given dump path
122 * @param[in] count The dump count number
123 * @see #tdm_helper_dump_stop()
126 tdm_helper_dump_start(char *dumppath, int *count);
129 * @brief Stop the dump debugging.
132 * Set the dump count to 0.
133 * @see #tdm_helper_dump_start()
136 tdm_helper_dump_stop(void);
139 * @brief The tdm helper capture handler
141 * This handler will be called when composit image produced.
142 * @see #tdm_helper_capture_output() function
144 typedef void (*tdm_helper_capture_handler)(tbm_surface_h buffer, void *user_data);
147 * @brief Make an output's image surface.
148 * @details Composit specific output's all layer's buffer to dst_buffer surface.
149 * After composing, tdm_helper_capture_handler func will be called.
150 * @param[in] output A output object
151 * @param[in] dst_buffer A surface composite image saved
152 * @param[in] x A horizontal position of composite image on dst_buffer
153 * @param[in] y A vertical position of composite image on dst_buffer
154 * @param[in] w A composite image width
155 * @param[in] h A composite image height
156 * @param[in] func A composing done handler
157 * @param[in] user_data The user data
158 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
161 tdm_helper_capture_output(tdm_output *output, tbm_surface_h dst_buffer,
162 int x, int y, int w, int h,
163 tdm_helper_capture_handler func, void *data);
166 * @brief Fill the display information to the reply buffer as string.
167 * @param[in] dpy A display object
168 * @param[out] reply the string buffer to be filled by this function.
169 * @param[out] len the length of the reply buffer
172 tdm_helper_get_display_information(tdm_display *dpy, char *reply, int *len);
178 #endif /* _TDM_HELPER_H_ */