include/tdm_helper.h

   1 /**************************************************************************
   2  *
   3  * libtdm
   4  *
   5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
   6  *
   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>
  13  *
  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:
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  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.
  33  *
  34 **************************************************************************/
  35
  36 #ifndef _TDM_HELPER_H_
  37 #define _TDM_HELPER_H_
  38
  39 #include "tdm_types.h"
  40 #include <tbm_surface.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /**
  47  * @file tdm_helper.h
  48  * @brief The header file to help tdm backend/frontend user
  49  */
  50
  51 /**
  52  * @brief Get the current time as a floating point value in seconds
  53  * @return The number of seconds
  54  */
  55 double
  56 tdm_helper_get_time(void);
  57
  58 /**
  59  * @brief Dump a buffer
  60  * @details
  61  * This function supports only if a buffer has below formats.
  62  * - TBM_FORMAT_ARGB8888
  63  * - TBM_FORMAT_XRGB8888
  64  * - TBM_FORMAT_YVU420
  65  * - TBM_FORMAT_YUV420
  66  * - TBM_FORMAT_NV12
  67  * - TBM_FORMAT_NV21
  68  * - TBM_FORMAT_YUYV
  69  * - TBM_FORMAT_UYVY
  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.
  74  */
  75 void
  76 tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
  77
  78 /**
  79  * @brief fill a buffer with 0 for given pos.
  80  * @details
  81  * This function supports only if a buffer has below formats.
  82  * - TBM_FORMAT_ARGB8888
  83  * - TBM_FORMAT_XRGB8888
  84  * @param[in] buffer A TDM buffer
  85  */
  86 void
  87 tdm_helper_clear_buffer_pos(tbm_surface_h buffer, tdm_pos *pos);
  88
  89 /**
  90  * @brief fill a buffer with 0 for given pos.
  91  * @details
  92  * This function supports only if a buffer has below formats.
  93  * - TBM_FORMAT_ARGB8888
  94  * - TBM_FORMAT_XRGB8888
  95  * @param[in] buffer A TDM buffer
  96  */
  97 void
  98 tdm_helper_clear_buffer_color(tbm_surface_h buffer, tdm_pos *pos, unsigned int color);
  99
 100 /**
 101  * @brief fill a buffer with 0.
 102  * @details
 103  * This function supports only if a buffer has below formats.
 104  * - TBM_FORMAT_ARGB8888
 105  * - TBM_FORMAT_XRGB8888
 106  * - TBM_FORMAT_YVU420
 107  * - TBM_FORMAT_YUV420
 108  * - TBM_FORMAT_NV12
 109  * - TBM_FORMAT_NV21
 110  * - TBM_FORMAT_YUYV
 111  * - TBM_FORMAT_UYVY
 112  * @param[in] buffer A TDM buffer
 113  */
 114 void
 115 tdm_helper_clear_buffer(tbm_surface_h buffer);
 116
 117 /**
 118  * @brief Get the buffer full size.
 119  * @details
 120  * In some hardware, the buffer width or height is aligned with the fixed size.
 121  * eg. 8, 16, etc. In this case, the real size of buffer could be bigger than
 122  * the buffer size of tbm_surface_info_s.
 123  * @param[in] buffer A TDM buffer
 124  */
 125 void
 126 tdm_helper_get_buffer_full_size(tbm_surface_h buffer, int *buffer_w, int *buffer_h);
 127
 128 /**
 129  * @brief convert the source buffer to the destination buffer with given rectangles
 130  * trannsform
 131  * @details
 132  * This function supports only if buffers have below formats.
 133  * - TBM_FORMAT_ARGB8888
 134  * - TBM_FORMAT_XRGB8888
 135  * @param[in] buffer A TDM buffer
 136  */
 137 tdm_error
 138 tdm_helper_convert_buffer(tbm_surface_h srcbuf, tbm_surface_h dstbuf,
 139                                                   tdm_pos *srcpos, tdm_pos *dstpos,
 140                                                   tdm_transform transform, int over);
 141
 142 /**
 143  * @brief Get a fd from the given enviroment variable.
 144  * @details
 145  * This function will dup the fd of the given enviroment variable. The Caller
 146  * @b SHOULD close the fd.
 147  * @param[in] env The given enviroment variable
 148  * @return fd if success. Otherwise, -1.
 149  * @see #tdm_helper_set_fd()
 150  */
 151 int tdm_helper_get_fd(const char *env);
 152
 153 /**
 154  * @brief Set the given fd to the give enviroment variable.
 155  * @param[in] env The given enviroment variable
 156  * @param[in] fd The given fd
 157  * @see #tdm_helper_get_fd()
 158  */
 159 void tdm_helper_set_fd(const char *env, int fd);
 160
 161 /**
 162  * @brief Start the dump debugging.
 163  * @details
 164  * Start tdm dump.
 165  * Make dump file when tdm_layer_set_buffer() function is called.
 166  * Set the dump count to 1.
 167  * @param[in] dumppath The given dump path
 168  * @param[in] count The dump count number
 169  * @see #tdm_helper_dump_stop()
 170  */
 171 void
 172 tdm_helper_dump_start(char *dumppath, int *count);
 173
 174 /**
 175  * @brief Stop the dump debugging.
 176  * @details
 177  * Stop tdm dump.
 178  * Set the dump count to 0.
 179  * @see #tdm_helper_dump_start()
 180  */
 181 void
 182 tdm_helper_dump_stop(void);
 183
 184 /**
 185  * @brief The tdm helper capture handler
 186  * @details
 187  * This handler will be called when composit image produced.
 188  * @see #tdm_helper_capture_output() function
 189  */
 190 typedef void (*tdm_helper_capture_handler)(tbm_surface_h buffer, void *user_data);
 191
 192 /**
 193  * @brief Make an output's image surface.
 194  * @details Composit specific output's all layer's buffer to dst_buffer surface.
 195  * After composing, tdm_helper_capture_handler func will be called.
 196  * @param[in] output A output object
 197  * @param[in] dst_buffer A surface composite image saved
 198  * @param[in] x A horizontal position of composite image on dst_buffer
 199  * @param[in] y A vertical position of composite image on dst_buffer
 200  * @param[in] w A composite image width
 201  * @param[in] h A composite image height
 202  * @param[in] func A composing done handler
 203  * @param[in] user_data The user data
 204  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 205  */
 206 tdm_error
 207 tdm_helper_capture_output(tdm_output *output, tbm_surface_h dst_buffer,
 208                                                   int x, int y, int w, int h,
 209                                                   tdm_helper_capture_handler func, void *data);
 210
 211 /**
 212  * @brief Fill the display information to the reply buffer as string.
 213  * @param[in] dpy A display object
 214  * @param[out] reply the string buffer to be filled by this function.
 215  * @param[out] len the length of the reply buffer
 216  */
 217 void
 218 tdm_helper_get_display_information(tdm_display *dpy, char *reply, int *len);
 219
 220 /**
 221  * @brief Get whether the commit-per-vblank functionality is enabled or not.
 222  * @param[in] dpy A display object
 223  * @return 1 if enabled. Otherwise, 0.
 224  *
 225  * @deprecated use @c tdm_helper_output_commit_per_vblank_enabled instead
 226  */
 227 int
 228 tdm_helper_commit_per_vblank_enabled(tdm_display *dpy);
 229
 230 /**
 231  * @brief Get whether the commit-per-vblank functionality is enabled or not for the output.
 232  * @param[in] output An output the functionality has to be checked for
 233  * @return -1 if error occurred, 1 if enabled, 0 if disabled.
 234  */
 235 int
 236 tdm_helper_output_commit_per_vblank_enabled(tdm_output *output);
 237
 238 #ifdef __cplusplus
 239 }
 240 #endif
 241
 242 #endif /* _TDM_HELPER_H_ */