client/tdm_client_types.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 <boram1288.park@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_CLIENT_TYPES_H_
  37 #define _TDM_CLIENT_TYPES_H_
  38
  39 #include "tdm_common.h"
  40
  41 #include <tbm_surface.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * @file tdm_client_types.h
  49  * @brief The header file which defines Enumerations and Structures for client.
  50  */
  51
  52 /**
  53  * @deprecated
  54  */
  55 typedef tdm_error tdm_client_error;
  56
  57 /**
  58  * @brief The client error enumeration
  59  * @deprecated
  60  */
  61 enum {
  62         TDM_CLIENT_ERROR_NONE                  = 0,  /**< none */
  63         TDM_CLIENT_ERROR_OPERATION_FAILED      = -1, /**< operaion failed */
  64         TDM_CLIENT_ERROR_INVALID_PARAMETER     = -2, /**< wrong input parameter */
  65         TDM_CLIENT_ERROR_PERMISSION_DENIED     = -3, /**< access denied */
  66         TDM_CLIENT_ERROR_OUT_OF_MEMORY         = -4, /**< no free memory */
  67         TDM_CLIENT_ERROR_DPMS_OFF              = -5, /**< dpms off */
  68 };
  69
  70 /**
  71  * @deprecated
  72  */
  73 typedef void
  74 (*tdm_client_vblank_handler2)(unsigned int sequence, unsigned int tv_sec,
  75                                                           unsigned int tv_usec, void *user_data);
  76
  77 /**
  78  * @brief The TDM client object
  79  */
  80 typedef void tdm_client;
  81
  82 /**
  83  * @brief The TDM client output object
  84  */
  85 typedef void tdm_client_output;
  86
  87 /**
  88  * @brief The TDM client vblank object
  89  */
  90 typedef void tdm_client_vblank;
  91
  92 /**
  93  * @brief The client output handler
  94  * @see #tdm_client_output_add_change_handler, #tdm_client_output_remove_change_handler
  95  */
  96 typedef void
  97 (*tdm_client_output_change_handler)(tdm_client_output *output,
  98                                                                         tdm_output_change_type type,
  99                                                                         tdm_value value,
 100                                                                         void *user_data);
 101
 102 /**
 103  * @brief The client vblank handler
 104  * @see #tdm_client_vblank_wait
 105  */
 106 typedef void
 107 (*tdm_client_vblank_handler)(tdm_client_vblank *vblank,
 108                                                          tdm_error error,
 109                                                          unsigned int sequence,
 110                                                          unsigned int tv_sec,
 111                                                          unsigned int tv_usec,
 112                                                          void *user_data);
 113
 114 /* Virtual Output */
 115 /* this is a copy of server side's tdm_output_mode */
 116 typedef struct _tdm_client_output_mode {
 117         unsigned int clock;
 118         unsigned int hdisplay, hsync_start, hsync_end, htotal, hskew;
 119         unsigned int vdisplay, vsync_start, vsync_end, vtotal, vscan;
 120         unsigned int vrefresh;
 121         unsigned int flags;
 122         unsigned int type;
 123         char name[TDM_NAME_LEN];
 124 } tdm_client_output_mode;
 125
 126 typedef void tdm_client_voutput;
 127
 128 typedef void (*tdm_client_voutput_commit_handler)(tdm_client_voutput *voutput,
 129                                                                                                   tbm_surface_h buffer,
 130                                                                                                   void *user_data);
 131 /* End of Virtual Output */
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135
 136 #endif /* _TDM_CLIENT_TYPES_H_ */