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 Dump a buffer
  53  * @details
  54  * This function supports only if a buffer has below formats.
  55  * - TBM_FORMAT_ARGB8888
  56  * - TBM_FORMAT_XRGB8888
  57  * - TBM_FORMAT_YVU420
  58  * - TBM_FORMAT_YUV420
  59  * - TBM_FORMAT_NV12
  60  * - TBM_FORMAT_NV21
  61  * - TBM_FORMAT_YUYV
  62  * - TBM_FORMAT_UYVY
  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.
  67  */
  68 void
  69 tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
  70
  71 /**
  72  * @brief Get a fd from the given enviroment variable.
  73  * @details
  74  * This function will dup the fd of the given enviroment variable. The Caller
  75  * @b SHOULD close the fd.
  76  * \n
  77  * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
  78  * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
  79  * and "TBM_DRM_MASTER_FD".
  80  * @param[in] env The given enviroment variable
  81  * @return fd if success. Otherwise, -1.
  82  * @see #tdm_helper_set_fd()
  83  */
  84 int tdm_helper_get_fd(const char *env);
  85
  86 /**
  87  * @brief Set the given fd to the give enviroment variable.
  88  * @details
  89  * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
  90  * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
  91  * and "TBM_DRM_MASTER_FD".
  92  * @param[in] env The given enviroment variable
  93  * @param[in] fd The given fd
  94  * @see #tdm_helper_get_fd()
  95  */
  96 void tdm_helper_set_fd(const char *env, int fd);
  97
  98 /**
  99  * @brief Start the dump debugging.
 100  * @details
 101  * Start tdm dump.
 102  * Make dump file when tdm_layer_set_buffer() function is called.
 103  * Set the dump count to 1.
 104  * @param[in] dumppath The given dump path
 105  * @param[in] count The dump count number
 106  * @see #tdm_helper_dump_stop()
 107  */
 108 void
 109 tdm_helper_dump_start(char *dumppath, int *count);
 110
 111 /**
 112  * @brief Stop the dump debugging.
 113  * @details
 114  * Stop tdm dump.
 115  * Set the dump count to 0.
 116  * @see #tdm_helper_dump_start()
 117  */
 118 void
 119 tdm_helper_dump_stop(void);
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124
 125 #endif /* _TDM_HELPER_H_ */