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.
  80  * @details
  81  * This function supports only if a buffer has below formats.
  82  * - TBM_FORMAT_ARGB8888
  83  * - TBM_FORMAT_XRGB8888
  84  * - TBM_FORMAT_YVU420
  85  * - TBM_FORMAT_YUV420
  86  * - TBM_FORMAT_NV12
  87  * - TBM_FORMAT_NV21
  88  * - TBM_FORMAT_YUYV
  89  * - TBM_FORMAT_UYVY
  90  * @param[in] buffer A TDM buffer
  91  */
  92 void
  93 tdm_helper_clear_buffer(tbm_surface_h buffer);
  94
  95 /**
  96  * @brief Get a fd from the given enviroment variable.
  97  * @details
  98  * This function will dup the fd of the given enviroment variable. The Caller
  99  * @b SHOULD close the fd.
 100  * \n
 101  * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
 102  * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
 103  * and "TBM_DRM_MASTER_FD".
 104  * @param[in] env The given enviroment variable
 105  * @return fd if success. Otherwise, -1.
 106  * @see #tdm_helper_set_fd()
 107  */
 108 int tdm_helper_get_fd(const char *env);
 109
 110 /**
 111  * @brief Set the given fd to the give enviroment variable.
 112  * @details
 113  * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
 114  * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
 115  * and "TBM_DRM_MASTER_FD".
 116  * @param[in] env The given enviroment variable
 117  * @param[in] fd The given fd
 118  * @see #tdm_helper_get_fd()
 119  */
 120 void tdm_helper_set_fd(const char *env, int fd);
 121
 122 /**
 123  * @brief Fill the display information to the reply buffer as string.
 124  * @param[in] dpy A display object
 125  * @param[out] reply the string buffer to be filled by this function.
 126  * @param[out] len the length of the reply buffer
 127  */
 128 void
 129 tdm_helper_get_display_information(tdm_display *dpy, char *reply, int *len);
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif /* _TDM_HELPER_H_ */