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 a vendor to implement a backend module
  49  * @remark
  50  * tdm_helper_drm_fd is external drm_fd which is opened by ecore_drm.
  51  * This is very @b TRICKY!! But we have no choice at this time because ecore_drm
  52  * doesn't use tdm yet. When we make ecore_drm use tdm, tdm_helper_drm_fd will
  53  * be removed.
  54  * @warning
  55  * If tdm_helper_drm_fd is more than -1, a tdm backend module @b SHOULDN't call
  56  * drmWaitVBlank by itself because a DRM vblank event will be handled in ecore_drm
  57  * internally. In this case, a tdm backend module NEVER get a DRM vblank event.
  58  * If a tdm backend module need to handle a vendor specific DRM event,
  59  * drmAddUserHandler() of libdrm makes possible that a tdm backend module handle
  60  * it.
  61  * @par Example
  62  * @code
  63     static int
  64     _tdm_drm_user_handler(struct drm_event *event)
  65     {
  66         if (event->type != DRM_VENDOR_XXX_EVENT)
  67             return -1;
  68
  69         //handling a vendor event
  70
  71         return 0;
  72     }
  73
  74     ...
  75
  76     drm_data->drm_fd = -1;
  77     if (tdm_helper_drm_fd >= 0)
  78     {
  79         drm_data->drm_fd = tdm_helper_drm_fd;
  80         drmAddUserHandler(tdm_helper_drm_fd, _tdm_drm_user_handler);
  81     }
  82
  83     if (drm_data->drm_fd < 0)
  84         drm_data->drm_fd = _tdm_drm_open_drm();
  85
  86     ...
  87
  88     drmRemoveUserHandler(tdm_helper_drm_fd, _tdm_drm_user_handler);
  89  * @endcode
  90  * @code
  91     if (tdm_helper_drm_fd == -1)
  92     {
  93         ...
  94         if (drmWaitVBlank(fd, &vbl))
  95             return TDM_ERROR_OPERATION_FAILED;
  96         ...
  97     }
  98  * @endcode
  99  * @endcode
 100  * @todo
 101  */
 102 extern int tdm_helper_drm_fd;
 103
 104 /**
 105  * @brief Dump a buffer
 106  * @details
 107  * This function supports only if a buffer has below formats.
 108  * - TBM_FORMAT_ARGB8888
 109  * - TBM_FORMAT_XRGB8888
 110  * - TBM_FORMAT_YVU420
 111  * - TBM_FORMAT_YUV420
 112  * - TBM_FORMAT_NV12
 113  * - TBM_FORMAT_NV21
 114  * - TBM_FORMAT_YUYV
 115  * - TBM_FORMAT_UYVY
 116  * The filename extension should be "png" for TBM_FORMAT_ARGB8888 and TBM_FORMAT_XRGB8888
 117  * or "yuv" for YUV formats.
 118  * @param[in] buffer A TDM buffer
 119  * @param[in] file The path of file.
 120  */
 121 void tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
 122
 123 #ifdef __cplusplus
 124 }
 125 #endif
 126
 127 #endif /* _TDM_HELPER_H_ */