include/tdm_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 <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_TYPES_H_
  37 #define _TDM_TYPES_H_
  38
  39 #include <tbm_surface.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * @file tdm_types.h
  47  * @brief The header file which defines Enumerations and Structures for frontend and backend.
  48  * @details
  49  * Both frontend(@ref tdm.h) and backend(@ref tdm_backend.h) header files
  50  * include @ref tdm_types.h
  51  * @par Example
  52  * @code
  53  * #include <tdm.h>    //for a frontend user
  54  * @endcode
  55  * @code
  56  * #include <tdm_backend.h>  //for a vendor to implement a backend module
  57  * @endcode
  58  */
  59
  60 #include <tdm_common.h>
  61
  62 typedef enum {
  63         TDM_EVENT_LOOP_READABLE = (1 << 0),
  64         TDM_EVENT_LOOP_WRITABLE = (1 << 1),
  65         TDM_EVENT_LOOP_HANGUP   = (1 << 2),
  66         TDM_EVENT_LOOP_ERROR    = (1 << 3),
  67 } tdm_event_loop_mask;
  68
  69 /**
  70  * @brief The output mode structure
  71  */
  72 typedef struct _tdm_output_mode {
  73         unsigned int clock;
  74         unsigned int hdisplay, hsync_start, hsync_end, htotal, hskew;
  75         unsigned int vdisplay, vsync_start, vsync_end, vtotal, vscan;
  76         unsigned int vrefresh;
  77         unsigned int flags;
  78         unsigned int type;
  79         char name[TDM_NAME_LEN];
  80 } tdm_output_mode;
  81
  82 /**
  83  * @brief The property structure
  84  */
  85 typedef struct _tdm_prop {
  86         unsigned int id;
  87         char name[TDM_NAME_LEN];
  88         tdm_value_type type;
  89 } tdm_prop;
  90
  91 /**
  92  * @brief The info config structure
  93  */
  94 typedef struct _tdm_info_config {
  95         tdm_size size;
  96         tdm_pos pos;
  97         tbm_format format;
  98 } tdm_info_config;
  99
 100 /**
 101  * @brief The layer info structre
 102  */
 103 typedef struct _tdm_info_layer {
 104         tdm_info_config src_config;
 105         tdm_pos dst_pos;
 106         tdm_transform transform;
 107 } tdm_info_layer;
 108
 109 /**
 110  * @brief The hwc window info structure
 111  * @since 2.0.0
 112  */
 113 typedef struct _tdm_hwc_window_info {
 114         tdm_info_config src_config;
 115         tdm_pos dst_pos;
 116         tdm_transform transform;
 117 } tdm_hwc_window_info;
 118
 119 /**
 120  * @brief The pp info structre
 121  */
 122 typedef struct _tdm_info_pp {
 123         tdm_info_config src_config;
 124         tdm_info_config dst_config;
 125         tdm_transform transform;
 126         int sync;
 127         int flags;
 128 } tdm_info_pp;
 129
 130 /**
 131  * @brief The capture info structre
 132  */
 133 typedef struct _tdm_info_capture {
 134         tdm_info_config dst_config;
 135         tdm_transform transform;
 136         tdm_capture_type type;
 137         int frequency;
 138         int flags;
 139 } tdm_info_capture;
 140
 141 /**
 142  * @brief Possible composition types for a given window
 143  * @since 2.0.0
 144  */
 145 typedef enum {
 146         /** The client will composite this window into the client target window
 147          *
 148          * User can choose this type for window to avoid a hardware composition for
 149          * this window.
 150          *
 151          * User has to set this type for the window which has the TDM_COMPOSITION_CLIENT_CANDIDATE
 152          * type. (see the TDM_COMPOSITION_CLIENT_CANDIDATE type)
 153          *
 154          * The device must not request any composition type changes for windows of
 155          * this type.
 156          */
 157         TDM_COMPOSITION_CLIENT = 0,
 158
 159         /* Set by the HWC after tdm_output_hwc_validate().
 160          *
 161          * If the HWC decided that it doesn't want/can't to continue the composition for
 162          * the window through a hardware overlay or other similar way it'll change
 163          * a type to the TDM_COMPOSITION_CLIENT_CANDIDATE type.
 164          *
 165          * This transition can happen only if the window has the TDM_COMPOSITION_DEVICE
 166          * or the TDM_COMPOSITION_VIDEO type already.
 167          *
 168          * If an user changed type of a window from the TDM_COMPOSITION_DEVICE or the
 169          * TDM_COMPOSITION_VIDEO type to the the TDM_COMPOSITION_CLIENT type, the type
 170          * will be rejected to the TDM_COMPOSITION_CLIENT_CANDIDATE type.
 171          *
 172          * The user has to composite this window itself.
 173          *
 174          * The underlying hardware overlay is owned by this window till a type being
 175          * changed to the TDM_COMPOSITION_CLIENT type, but it's not possible to set a
 176          * buffer for this window after a type's been changed to the
 177          * TDM_COMPOSITION_CLIENT_CANDIDATE type.
 178          *
 179          * This transitional state is used to get rid of blinking at a transition from
 180          * the TDM_COMPOSITION_DEVICE/TDM_COMPOSITION_VIDEO type to the
 181          * TDM_COMPOSITION_CLIENT type where the hw     has to wait till a buffer, which was
 182          * on a hw overlay, get composited to the fb_target and only after this happens
 183          * unset(or set another window on) this hw overlay.
 184          *
 185          * User has to inform the HWC (the HWC got no way to know when it happens) after a buffer,
 186          * which was on a hw overlay, get composited to the fb_target by setting a type of this
 187          * window to the TDM_COMPOSITION_CLIENT type, it causes a type of this window being changed
 188          * to TDM_COMPOSITION_CLIENT.
 189          */
 190         TDM_COMPOSITION_CLIENT_CANDIDATE = 5,
 191
 192         /** Set by the client before tdm_output_hwc_validate().
 193          *
 194          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 195          * TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT. */
 196         TDM_COMPOSITION_DEVICE_CANDIDATE = 2,
 197
 198         /** Set by the HWC after tdm_output_hwc_validate().
 199          *
 200          * The device will handle the composition of this window through a hardware
 201          * overlay or other similar means.
 202          *
 203          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 204          * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. */
 205         TDM_COMPOSITION_DEVICE = 1,
 206
 207         /** Similar to DEVICE, but the position of this layer may also be set
 208          * asynchronously through layer_set_cursor_position. If this functionality is not
 209          * supported on a layer that the client sets to TDM_COMPOSITION_CURSOR, the
 210          * device must request that the composition type of that layer is changed to
 211          * TDM_COMPOSITION_CLIENT upon the next call to tdm_output_hwc_validate().
 212          *
 213          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 214          * either TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT. Changing to
 215          * TDM_COMPOSITION_DEVICE will prevent the use of layer_set_cursor_position but
 216          * still permit the device to composite the layer. */
 217         TDM_COMPOSITION_CURSOR = 3,
 218
 219         /** The device will handle the composition of this layer through a hardware
 220          * overlay or other similar means.
 221          *
 222          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 223          * either TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT, but it is
 224          * unlikely that content will display correctly in these cases. */
 225         TDM_COMPOSITION_VIDEO = 4,
 226 } tdm_hwc_window_composition;
 227
 228 /**
 229  * @brief The tdm display object
 230  */
 231 typedef void tdm_display;
 232
 233 /**
 234  * @brief The tdm output object
 235  */
 236 typedef void tdm_output;
 237
 238 /**
 239  * @brief The tdm layer object
 240  */
 241 typedef void tdm_layer;
 242
 243 /**
 244  * @brief The tdm window object
 245  * @since 2.0.0
 246  */
 247 typedef void tdm_hwc_window;
 248
 249 /**
 250  * @brief The tdm capture object
 251  */
 252 typedef void tdm_capture;
 253
 254 /**
 255  * @brief The tdm pp object
 256  */
 257 typedef void tdm_pp;
 258
 259 /**
 260  * @brief The tdm vblank object
 261  */
 262 typedef void tdm_vblank;
 263
 264 /**
 265  * @brief The vblank handler
 266  * @see output_set_vblank_handler() function of #tdm_func_display
 267  */
 268 typedef void (*tdm_output_vblank_handler)(tdm_output *output, unsigned int sequence,
 269                                                                                   unsigned int tv_sec, unsigned int tv_usec,
 270                                                                                   void *user_data);
 271
 272 /**
 273  * @brief The output commit handler
 274  * @see output_set_commit_handler() function of #tdm_func_display
 275  */
 276 typedef void (*tdm_output_commit_handler)(tdm_output *output, unsigned int sequence,
 277                                                                                   unsigned int tv_sec, unsigned int tv_usec,
 278                                                                                   void *user_data);
 279
 280 /**
 281  * @brief The layer commit handler
 282  */
 283 typedef void (*tdm_layer_commit_handler)(tdm_layer *layer, unsigned int sequence,
 284                                                                                  unsigned int tv_sec, unsigned int tv_usec,
 285                                                                                  void *user_data);
 286
 287 /**
 288  * @brief The done handler of a pp object
 289  */
 290 typedef void (*tdm_pp_done_handler)(tdm_pp *pp, tbm_surface_h src,
 291                                                                         tbm_surface_h dst, void *user_data);
 292
 293 /**
 294  * @brief The done handler of a capture object
 295  */
 296 typedef void (*tdm_capture_done_handler)(tdm_capture *capture,
 297                                                                                  tbm_surface_h buffer, void *user_data);
 298
 299 /**
 300  * @brief The 'need to validate' handler of an output object
 301  * @since 2.0.0
 302  */
 303 typedef void (*tdm_output_need_validate_handler)(tdm_output *output);
 304
 305 #ifdef __cplusplus
 306 }
 307 #endif
 308
 309 #endif /* _TDM_TYPES_H_ */