include/tdm_backend.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_BACKEND_H_
  37 #define _TDM_BACKEND_H_
  38
  39 #include <tbm_surface.h>
  40
  41 #include "tdm_types.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * @file tdm_backend.h
  49  * @brief The backend header file of TDM to implement a TDM backend module.
  50  * @par Example
  51  * @code
  52  * #include <tdm_backend.h>
  53  * @endcode
  54  */
  55
  56 /**
  57  * @brief The backend module data
  58  * @details
  59  * The init() function of #tdm_backend_module returns the backend module data.
  60  * And it will be passed to display functions of #tdm_func_display.
  61  * @see tdm_backend_module, tdm_backend_module
  62  */
  63 typedef void tdm_backend_data;
  64
  65 /**
  66  * @brief The output status handler
  67  * @details This handler will be called when the status of a output object is
  68  * changed in runtime.
  69  */
  70 typedef void (*tdm_output_status_handler)(tdm_output *output,
  71                                                                                   tdm_output_conn_status status,
  72                                                                                   void *user_data);
  73
  74 /**
  75  * @brief The output dpms handler
  76  * @details This handler will be called when the dpms of a output object is
  77  * changed in runtime.
  78  */
  79 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
  80                                                                                 tdm_output_dpms dpms,
  81                                                                                 void *user_data);
  82
  83 /**
  84  * @brief The display capabilities structure of a backend module
  85  * @see The display_get_capability() function of #tdm_func_display
  86  */
  87 typedef struct _tdm_caps_display {
  88         int max_layer_count;    /**< The maximum layer count */
  89 } tdm_caps_display;
  90
  91 /**
  92  * @brief The capabilities structure of a output object
  93  * @see The output_get_capability() function of #tdm_func_output
  94  */
  95 typedef struct _tdm_caps_output {
  96         char maker[TDM_NAME_LEN];       /**< The output maker */
  97         char model[TDM_NAME_LEN];       /**< The output model */
  98         char name[TDM_NAME_LEN];        /**< The output name */
  99
 100         tdm_output_conn_status status;  /**< The connection status */
 101         tdm_output_type type;           /**< The connection type */
 102         unsigned int type_id;           /**< The connection type id */
 103
 104         unsigned int mode_count;        /**< The count of available modes */
 105         tdm_output_mode
 106         *modes;         /**< The @b newly-allocated array of modes. will be freed in frontend. */
 107
 108         unsigned int prop_count;        /**< The count of available properties */
 109         tdm_prop *props;                /**< The @b newly-allocated array of properties. will be freed in frontend. */
 110
 111         unsigned int mmWidth;           /**< The physical width (milimeter) */
 112         unsigned int mmHeight;          /**< The physical height (milimeter) */
 113         unsigned int subpixel;          /**< The subpixel */
 114
 115         int min_w;              /**< The minimun width */
 116         int min_h;              /**< The minimun height */
 117         int max_w;              /**< The maximum width */
 118         int max_h;              /**< The maximum height */
 119         int preferred_align;    /**< The prefered align */
 120
 121         tdm_output_capability capabilities;  /**< The capabilities of output. @since 1.4.1 */
 122
 123         int cursor_min_w;              /**< The minimun width.  @since 1.5.0 */
 124         int cursor_min_h;              /**< The minimun height. @since 1.5.0 */
 125         int cursor_max_w;              /**< The maximum width. @since 1.5.0 */
 126         int cursor_max_h;              /**< The maximum height. @since 1.5.0 */
 127         int cursor_preferred_align;    /**< The prefered align. @since 1.5.0 */
 128 } tdm_caps_output;
 129
 130 /**
 131  * @brief The capabilities structure of a layer object
 132  * @see The layer_get_capability() function of #tdm_func_layer
 133  */
 134 typedef struct _tdm_caps_layer {
 135         tdm_layer_capability capabilities;  /**< The capabilities of layer */
 136
 137         /**
 138          * The z-order
 139          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
 140          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
 141          * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
 142          * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
 143          * layers or more than GRAPHIC layers.
 144          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 145          * The zpos of VIDEO layers is @b relative. It doesn't need to start
 146          * from -1 or 4. Let's suppose that there are two VIDEO layers.
 147          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
 148          * than -4 VIDEO layer.
 149         */
 150         int zpos;
 151
 152         unsigned int format_count;      /**< The count of available formats */
 153         tbm_format
 154         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
 155
 156         unsigned int prop_count;        /**< The count of available properties */
 157         tdm_prop *props;                /**< The @b newly-allocated array of properties. will be freed in frontend. */
 158 } tdm_caps_layer;
 159
 160 /**
 161  * @brief The capabilities structure of a pp object
 162  * @see The display_get_pp_capability() function of #tdm_func_display
 163  */
 164 typedef struct _tdm_caps_pp {
 165         tdm_pp_capability capabilities; /**< The capabilities of pp */
 166
 167         unsigned int format_count;      /**< The count of available formats */
 168         tbm_format
 169         *formats;            /**< The @b newly-allocated array. will be freed in frontend. */
 170
 171         int min_w;              /**< The minimun width */
 172         int min_h;              /**< The minimun height */
 173         int max_w;              /**< The maximum width */
 174         int max_h;              /**< The maximum height */
 175         int preferred_align;    /**< The prefered align */
 176
 177         /**< The attach count which a PP object can handle. @since 1.2.0 */
 178         int max_attach_count;
 179 } tdm_caps_pp;
 180
 181 /**
 182  * @brief The capabilities structure of a capture object
 183  * @see The display_get_capture_capability() function of #tdm_func_display
 184  */
 185 typedef struct _tdm_caps_capture {
 186         tdm_capture_capability capabilities;    /**< The capabilities of capture */
 187
 188         unsigned int format_count;      /**< The count of available formats */
 189         tbm_format
 190         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
 191
 192         int min_w;              /**< The minimun width */
 193         int min_h;              /**< The minimun height */
 194         int max_w;              /**< The maximum width */
 195         int max_h;              /**< The maximum height */
 196         int preferred_align;    /**< The prefered align */
 197
 198         /**< The attach count which a capture object can handle. @since 1.2.0 */
 199         int max_attach_count;
 200 } tdm_caps_capture;
 201
 202 /**
 203  * @brief The display functions for a backend module.
 204  */
 205 typedef struct _tdm_func_display {
 206         /**
 207          * @brief Get the display capabilities of a backend module
 208          * @param[in] bdata The backend module data
 209          * @param[out] caps The display capabilities of a backend module
 210          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 211          * @remark
 212          * A backend module @b SHOULD implement this function. TDM calls this function
 213          * not only at the initial time, but also at the update time when new output
 214          * is connected.\n
 215          * If a hardware has the restriction of the number of max usable layer count,
 216          * a backend module can set the max count to max_layer_count of #tdm_caps_display
 217          * structure.
 218          */
 219         tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
 220
 221         /**
 222          * @brief Get the pp capabilities of a backend module
 223          * @param[in] bdata The backend module data
 224          * @param[out] caps The pp capabilities of a backend module
 225          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 226          * @see tdm_backend_register_func_pp
 227          * @remark
 228          * TDM calls this function not only at the initial time, but also at the update
 229          * time when new output is connected.\n
 230          * A backend module doesn't need to implement this function if a hardware
 231          * doesn't have the memory-to-memory converting device. Otherwise, a backend module
 232          * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
 233          * restriction information which a converting device can handle. ie, format, size, etc.
 234          */
 235         tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
 236
 237         /**
 238          * @brief Get the capture capabilities of a backend module
 239          * @param[in] bdata The backend module data
 240          * @param[out] caps The capture capabilities of a backend module
 241          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 242          * @see tdm_backend_register_func_capture
 243          * @remark
 244          * TDM calls this function not only at the initial time, but also at the update
 245          * time when new output is connected.\n
 246          * A backend module doesn't need to implement this function if a hardware
 247          * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
 248          * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
 249          * information which a capture device can handle. ie, format, size, etc.
 250          */
 251         tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
 252
 253         /**
 254          * @brief Get a output array of a backend module
 255          * @param[in] bdata The backend module data
 256          * @param[out] count The count of outputs
 257          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 258          * @return A output array which is @b newly-allocated
 259          * @see tdm_backend_register_func_capture
 260          * @remark
 261          * A backend module @b SHOULD implement this function. TDM calls this function
 262          * not only at the initial time, but also at the update time when new output
 263          * is connected.\n
 264          * A backend module @b SHOULD return the @b newly-allocated array which contains
 265          * "tdm_output*" data. It will be freed in frontend.
 266          * @par Example
 267          * @code
 268          *  tdm_output**
 269          *  drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
 270          *  {
 271          *      tdm_drm_data *drm_data = bdata;
 272          *      tdm_drm_output_data *output_data = NULL;
 273          *      tdm_output **outputs;
 274          *      int i;
 275          *
 276          *      (*count) = 0;
 277          *      LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
 278          *          (*count)++;
 279          *
 280          *      if ((*count) == 0)
 281          *      {
 282          *          if (error) *error = TDM_ERROR_NONE;
 283          *          return NULL;
 284          *      }
 285          *
 286          *      // will be freed in frontend
 287          *      outputs = calloc(*count, sizeof(tdm_drm_output_data*));
 288          *      if (!outputs)
 289          *      {
 290          *          (*count) = 0;
 291          *          if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
 292          *          return NULL;
 293          *      }
 294          *
 295          *      i = 0;
 296          *      LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
 297          *          outputs[i++] = output_data;
 298          *
 299          *      if (error) *error = TDM_ERROR_NONE;
 300          *
 301          *      return outputs;
 302          *  }
 303          * @endcode
 304          */
 305         tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
 306                                                                                 tdm_error *error);
 307
 308         /**
 309          * @brief Get the file descriptor of a backend module
 310          * @param[in] bdata The backend module data
 311          * @param[out] fd The fd of a backend module
 312          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 313          * @see display_handle_events() function of #tdm_func_display
 314          * @remark
 315          * A backend module can return epoll's fd which is watching the backend device one more fds.
 316          */
 317         tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
 318
 319         /**
 320          * @brief Handle the events which happens on the fd of a backend module
 321          * @param[in] bdata The backend module data
 322          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 323          */
 324         tdm_error (*display_handle_events)(tdm_backend_data *bdata);
 325
 326         /**
 327          * @brief Create a pp object of a backend module
 328          * @param[in] bdata The backend module data
 329          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 330          * @return A pp object
 331          * @see pp_destroy() function of #tdm_func_pp
 332          * @remark
 333          * A backend module doesn't need to implement this function if a hardware
 334          * doesn't have the memory-to-memory converting device.
 335          */
 336         tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
 337
 338         void (*reserved1)(void);
 339         void (*reserved2)(void);
 340         void (*reserved3)(void);
 341         void (*reserved4)(void);
 342         void (*reserved5)(void);
 343         void (*reserved6)(void);
 344         void (*reserved7)(void);
 345         void (*reserved8)(void);
 346 } tdm_func_display;
 347
 348 /**
 349  * @brief The output functions for a backend module.
 350  */
 351 typedef struct _tdm_func_output {
 352         /**
 353          * @brief Get the capabilities of a output object
 354          * @param[in] output A output object
 355          * @param[out] caps The capabilities of a output object
 356          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 357          * @remark
 358          * A backend module @b SHOULD implement this function. TDM calls this function
 359          * not only at the initial time, but also at the update time when new output
 360          * is connected.\n
 361          * #tdm_caps_output contains connection status, modes, avaiable properties,
 362          * size restriction information, etc.
 363          */
 364         tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
 365
 366         /**
 367          * @brief Get a layer array of a output object
 368          * @param[in] output A output object
 369          * @param[out] count The count of layers
 370          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 371          * @return A layer array which is @b newly-allocated
 372          * @remark
 373          * A backend module @b SHOULD implement this function. TDM calls this function
 374          * not only at the initial time, but also at the update time when new output
 375          * is connected.\n
 376          * A backend module @b SHOULD return the @b newly-allocated array which contains
 377          * "tdm_layer*" data. It will be freed in frontend.
 378          */
 379         tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
 380                                                                          tdm_error *error);
 381
 382         /**
 383          * @brief Set the property which has a given id
 384          * @param[in] output A output object
 385          * @param[in] id The property id
 386          * @param[in] value The value
 387          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 388          */
 389         tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
 390                                                                          tdm_value value);
 391
 392         /**
 393          * @brief Get the property which has a given id
 394          * @param[in] output A output object
 395          * @param[in] id The property id
 396          * @param[out] value The value
 397          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 398          */
 399         tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
 400                                                                          tdm_value *value);
 401
 402         /**
 403          * @brief Wait for VBLANK
 404          * @param[in] output A output object
 405          * @param[in] interval vblank interval
 406          * @param[in] sync 0: asynchronous, 1:synchronous
 407          * @param[in] user_data The user data
 408          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 409          * @see output_set_vblank_handler, tdm_output_vblank_handler
 410          * @remark
 411          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 412          * a user vblank handler with the user data of this function after interval
 413          * vblanks.
 414          */
 415         tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
 416                                                                         void *user_data);
 417
 418         /**
 419          * @brief Set a user vblank handler
 420          * @param[in] output A output object
 421          * @param[in] func A user vblank handler
 422          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 423          */
 424         tdm_error (*output_set_vblank_handler)(tdm_output *output,
 425                                                                                    tdm_output_vblank_handler func);
 426
 427         /**
 428          * @brief Commit changes for a output object
 429          * @param[in] output A output object
 430          * @param[in] sync 0: asynchronous, 1:synchronous
 431          * @param[in] user_data The user data
 432          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 433          * @see output_set_commit_handler, tdm_output_commit_handler
 434          * @remark
 435          * When this function is called, a backend module @b SHOULD apply the all
 436          * changes of the given output object to screen as well as the layer changes
 437          * of this output.
 438          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 439          * a user commit handler with the user data of this function after all
 440          * changes of the given output object are applied.
 441          */
 442         tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
 443
 444         /**
 445          * @brief Set a user commit handler
 446          * @param[in] output A output object
 447          * @param[in] func A user commit handler
 448          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 449          */
 450         tdm_error (*output_set_commit_handler)(tdm_output *output,
 451                                                                                    tdm_output_commit_handler func);
 452
 453         /**
 454          * @brief Set DPMS of a output object
 455          * @param[in] output A output object
 456          * @param[in] dpms_value DPMS value
 457          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 458          */
 459         tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
 460
 461         /**
 462          * @brief Get DPMS of a output object
 463          * @param[in] output A output object
 464          * @param[out] dpms_value DPMS value
 465          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 466          */
 467         tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
 468
 469         /**
 470          * @brief Set one of available modes of a output object
 471          * @param[in] output A output object
 472          * @param[in] mode A output mode
 473          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 474          */
 475         tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
 476
 477         /**
 478          * @brief Get the mode of a output object
 479          * @deprecated
 480          * @param[in] output A output object
 481          * @param[out] mode A output mode
 482          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 483          */
 484         tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
 485
 486         /**
 487          * @brief Create a capture object of a output object
 488          * @param[in] output A output object
 489          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 490          * @return A capture object
 491          * @see capture_destroy() function of #tdm_func_capture
 492          * @remark
 493          * A backend module doesn't need to implement this function if a hardware
 494          * doesn't have the capture device.
 495          */
 496         tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
 497
 498         /**
 499          * @brief Set a output connection status handler
 500          * @details A backend module need to call the output status handler when the
 501          * output connection status has been changed to let the TDM frontend know
 502          * the change.
 503          * @param[in] output A output object
 504          * @param[in] func A output status handler
 505          * @param[in] user_data The user data
 506          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 507          * @since 1.1.0
 508          */
 509         tdm_error (*output_set_status_handler)(tdm_output *output,
 510                                                                                    tdm_output_status_handler func,
 511                                                                                    void *user_data);
 512
 513         /**
 514          * @brief Set a output dpms handler
 515          * @details A backend module needs to call the output dpms handler when the
 516          * output DPMS has been changed to let the TDM frontend know the change.
 517          * @param[in] output A output object
 518          * @param[in] func A output dpms handler
 519          * @param[in] user_data The user data
 520          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 521          * @since 1.4.0
 522          */
 523         tdm_error (*output_set_dpms_handler)(tdm_output *output,
 524                                                                                  tdm_output_dpms_handler func,
 525                                                                                  void *user_data);
 526         /**
 527          * @brief Creates a new window on the given display.
 528          * @param[in] output A output object
 529          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 530          * @return A created window object
 531          */
 532         tdm_hwc_window *(*output_create_hwc_window)(tdm_output *output, tdm_error *error);
 533
 534         /**
 535          * @brief Destroys the given window.
 536          * @param[in] output A output object
 537          * @param[in] window the pointer of the window to destroy
 538          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 539          */
 540         tdm_error (*output_destroy_hwc_window)(tdm_output *output, tdm_hwc_window *hwc_window);
 541
 542         /**
 543          * @brief Set the client(relative to the TDM) target buffer
 544          * @details Sets the buffer which will receive the output of client composition.
 545          * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
 546          * will be composited into this buffer prior to the call to output_commit(),
 547          * and windows not marked as TDM_COMPOSITION_CLIENT and
 548          * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
 549          * device.
 550          *
 551          * The buffer handle provided may be null if no windows are being composited by
 552          * the client. This must not result in an error (unless an invalid display
 553          * handle is also provided).
 554          *
 555          * The damage parameter describes a surface damage region as defined in the
 556          * description of hwc_window_set_surface_damage().
 557          *
 558          * Will be called before output_commit() if any of the layers are marked as
 559          * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
 560          * so marked, then it is not necessary to call this function. It is not necessary
 561          * to call output_validate() after changing the target through this function.
 562          * @param[in] output A output object
 563          * @param[in] target The new target buffer
 564          * @param[in] damage The surface damage region
 565          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 566          */
 567         tdm_error (*output_set_client_target_buffer)(tdm_output *output, tbm_surface_h target,
 568                                                                                                  tdm_hwc_region damage);
 569
 570         /**
 571          * @brief Validate the output
 572          * @details Instructs the device to inspect all of the layer state and
 573          * determine if there are any composition type changes necessary before
 574          * presenting the output. Permitted changes are described in the definition
 575          * of tdm_composition_t above.
 576          * @param[in] output A output object
 577          * @param[out] num_types The number of composition type changes required by
 578          * the device; if greater than 0, the client must either set and validate new
 579          * types, or call output_accept_changes() to accept the changes returned by
 580          * output_get_changed_composition_types(); must be the same as the number of
 581          * changes returned by output_get_changed_composition_types (see the
 582          * declaration of that function for more information); pointer will be non-NULL
 583          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 584          */
 585         tdm_error (*output_validate)(tdm_output *output, uint32_t *num_types);
 586
 587         /**
 588          * @brief Get changed composition types
 589          * @details Retrieves the windows for which the device requires a different
 590          * composition type than had been set prior to the last call to output_validate().
 591          * The client will either update its state with these types and call
 592          * output_accept_changes, or will set new types and attempt to validate the
 593          * display again.
 594          * layers and types may be NULL to retrieve the number of elements which
 595          * will be returned. The number of elements returned must be the same as the
 596          * value returned in num_types from the last call to output_validate().
 597          * @param[in] output A output object
 598          * @param[out] num_elements If windows or types were NULL, the number of layers
 599          * and types which would have been returned; if both were non-NULL, the
 600          * number of elements returned in layers and types, which must not exceed
 601          * the value stored in num_elements prior to the call; pointer will be
 602          * non-NULL
 603          * @param[out] windows An array of windows
 604          * @param[out] composition_types An array of composition types, each
 605          * corresponding to an element of windows
 606          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 607          */
 608         tdm_error (*output_get_changed_composition_types)(tdm_output *output,
 609                                                                                                           uint32_t *num_elements,
 610                                                                                                           tdm_hwc_window **hwc_window,
 611                                                                                                           tdm_hwc_window_composition_t *composition_types);
 612         /**
 613          * @brief Accepts the changes required by the device
 614          * @details Accepts the changes required by the device from the previous
 615          * output_validate() call (which may be queried using
 616          * output_get_chaged_composition_types()) and revalidates the display. This
 617          * function is equivalent to requesting the changed types from
 618          * output_get_chaged_composition_types(), setting those types on the
 619          * corresponding windows, and then calling output_validate again.
 620          * After this call it must be valid to present this display. Calling this after
 621          * output_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
 622          * should have no other effect.
 623          * @param[in] output A output object
 624          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 625          */
 626         tdm_error (*output_accept_changes)(tdm_output *output);
 627
 628         /**
 629          * @brief Get a target surface queue
 630          * @param[in] output A output object
 631          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 632          * @return A surface queue
 633          */
 634         tbm_surface_queue_h (*output_get_target_surface_queue)(tdm_output *output,
 635                                                                                                                    tdm_error *error);
 636 } tdm_func_output;
 637
 638 /**
 639  * @brief The layer functions for a backend module.
 640  */
 641 typedef struct _tdm_func_layer {
 642         /**
 643          * @brief Get the capabilities of a layer object
 644          * @param[in] layer A layer object
 645          * @param[out] caps The capabilities of a layer object
 646          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 647          * @remark
 648          * A backend module @b SHOULD implement this function. TDM calls this function
 649          * not only at the initial time, but also at the update time when new output
 650          * is connected.\n
 651          * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
 652          */
 653         tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
 654
 655         /**
 656          * @brief Set the property which has a given id.
 657          * @param[in] layer A layer object
 658          * @param[in] id The property id
 659          * @param[in] value The value
 660          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 661          */
 662         tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
 663                                                                         tdm_value value);
 664
 665         /**
 666          * @brief Get the property which has a given id.
 667          * @param[in] layer A layer object
 668          * @param[in] id The property id
 669          * @param[out] value The value
 670          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 671          */
 672         tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
 673                                                                         tdm_value *value);
 674
 675         /**
 676          * @brief Set the geometry information to a layer object
 677          * @param[in] layer A layer object
 678          * @param[in] info The geometry information
 679          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 680          * @see output_commit() function of #tdm_func_output
 681          * @remark
 682          * A backend module would apply the geometry information when the output object
 683          * of a layer object is committed.
 684          */
 685         tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
 686
 687         /**
 688          * @brief Get the geometry information to a layer object
 689          * @param[in] layer A layer object
 690          * @param[out] info The geometry information
 691          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 692          */
 693         tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
 694
 695         /**
 696          * @brief Set a TDM buffer to a layer object
 697          * @param[in] layer A layer object
 698          * @param[in] buffer A TDM buffer
 699          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 700          * @see output_commit() function of #tdm_func_output
 701          * @remark
 702          * A backend module would show a TDM buffer on screen when the output object
 703          * of a layer object is committed.
 704          */
 705         tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
 706
 707         /**
 708          * @brief Unset a TDM buffer from a layer object
 709          * @param[in] layer A layer object
 710          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 711          * @remark
 712          * A backend module @b SHOULD remove the current showing buffer from screen.
 713          */
 714         tdm_error (*layer_unset_buffer)(tdm_layer *layer);
 715
 716         /**
 717          * @brief Set the zpos for a VIDEO layer object
 718          * @param[in] layer A layer object
 719          * @param[in] zpos z-order
 720          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 721          * @see tdm_caps_layer, tdm_layer_capability
 722          * @remark
 723          * A backend module doesn't need to implement this function if a backend
 724          * module doesn't have VIDEO layers.\n
 725          * This function is for VIDEO layers.
 726          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
 727          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
 728          * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
 729          * is less than GRAPHIC layers or more than GRAPHIC layers.
 730          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 731          * The zpos of VIDEO layers is @b relative. It doesn't need to start
 732          * from -1 or 4. Let's suppose that there are two VIDEO layers.
 733          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
 734          * than -4 VIDEO layer.
 735          */
 736         tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
 737
 738         /**
 739          * @brief Create a capture object of a layer object
 740          * @param[in] output A output object
 741          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 742          * @return A capture object
 743          * @see capture_destroy() function of #tdm_func_capture
 744          * @remark
 745          * A backend module doesn't need to implement this function if a hardware
 746          * doesn't have the capture device.
 747          */
 748         tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
 749
 750         /**
 751          * @brief Get buffer flags which the layer can support.
 752          * @param[in] layer A layer object
 753          * @param[out] flags The buffer flags which should be the tbm_bo flags
 754          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 755          */
 756         tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
 757
 758         void (*reserved1)(void);
 759         void (*reserved2)(void);
 760         void (*reserved3)(void);
 761         void (*reserved4)(void);
 762         void (*reserved5)(void);
 763         void (*reserved6)(void);
 764         void (*reserved7)(void);
 765 } tdm_func_layer;
 766
 767 /**
 768  * @brief The window functions for a backend module.
 769  */
 770 typedef struct _tdm_func_window {
 771         /**
 772          * @brief Get a tbm surface queue for the window object
 773          * @param[in] hwc_window A window object
 774          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 775          * @return A tbm surface queue
 776          */
 777         tbm_surface_queue_h (*hwc_window_get_tbm_surface_queue)(tdm_hwc_window *hwc_window,
 778                                                                                                                         tdm_error *error);
 779
 780         /**
 781          * @brief Sets the desired Z order (height) of the given window. A window with
 782          * a greater Z value occludes a window with a lesser Z value.
 783          * @param[in] hwc_window A window object
 784          * @param[in] z the new Z order
 785          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 786          */
 787         tdm_error (*hwc_window_set_zpos)(tdm_hwc_window *hwc_window, uint32_t zpos);
 788
 789         /**
 790          * @brief Sets the desired composition type of the given window.
 791          * @details During output_validate(), the device may request changes to
 792          * the composition types of any of the layers as described in the definition
 793          * of tdm_hwc_window_composition_t above.
 794          * @param[in] hwc_window A window object
 795          * @param[in] composition_type The new composition type
 796          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 797          */
 798         tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
 799                                                                                                  tdm_hwc_window_composition_t composition_type);
 800
 801         /**
 802          * @brief Set the surface damage
 803          * @details Provides the region of the source buffer which has been modified
 804          * since the last frame. This region does not need to be validated before
 805          * calling output_commit().
 806          * Once set through this function, the damage region remains the same until a
 807          * subsequent call to this function.
 808          * If damage.num_rects > 0, then it may be assumed that any portion of the source
 809          * buffer not covered by one of the rects has not been modified this frame. If
 810          * damage.num_rects == 0, then the whole source buffer must be treated as if it
 811          * has been modified.
 812          * If the layer's contents are not modified relative to the prior frame, damage
 813          * will contain exactly one empty rect([0, 0, 0, 0]).
 814          * The damage rects are relative to the pre-transformed buffer, and their origin
 815          * is the top-left corner. They will not exceed the dimensions of the latched
 816          * buffer.
 817          * @param[in] hwc_window A window object
 818          * @param[in] damage The new surface damage region
 819          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 820          */
 821         tdm_error (*hwc_window_set_surface_damage)(tdm_hwc_window *hwc_window,
 822                                                                                            tdm_hwc_region damage);
 823
 824         /**
 825          * @brief Set the information to a window object
 826          * @details The information will be applied when the output object
 827          * of a layer object is committed.
 828          * @param[in] hwc_window A window object
 829          * @param[in] info The geometry information
 830          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 831          */
 832         tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
 833                                                                          tdm_hwc_window_info *info);
 834
 835         /**
 836          * @brief Set a TDM buffer to a window object
 837          * @details A TDM buffer will be applied when the output object
 838          * of a layer object is committed.
 839          * @param[in] hwc_window A layer object
 840          * @param[in] buffer A TDM buffer
 841          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 842          */
 843         tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
 844                                                                            tbm_surface_h buffer);
 845 } tdm_func_hwc_window;
 846
 847 /**
 848  * @brief The pp functions for a backend module.
 849  */
 850 typedef struct _tdm_func_pp {
 851         /**
 852          * @brief Destroy a pp object
 853          * @param[in] pp A pp object
 854          * @see display_create_pp() function of #tdm_func_display
 855          */
 856         void (*pp_destroy)(tdm_pp *pp);
 857
 858         /**
 859          * @brief Set the geometry information to a pp object
 860          * @param[in] pp A pp object
 861          * @param[in] info The geometry information
 862          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 863          * @see pp_commit() function of #tdm_func_pp
 864          * @remark
 865          * A backend module would apply the geometry information when committed.
 866          */
 867         tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
 868
 869         /**
 870          * @brief Attach a source buffer and a destination buffer to a pp object
 871          * @param[in] pp A pp object
 872          * @param[in] src A source buffer
 873          * @param[in] dst A destination buffer
 874          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 875          * @see pp_set_info() function of #tdm_func_pp
 876          * @see pp_commit() function of #tdm_func_pp
 877          * @see pp_set_done_handler, tdm_pp_done_handler
 878          * @remark
 879          * A backend module converts the image of a source buffer to a destination
 880          * buffer when committed. The size/crop/transform information is set via
 881          * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
 882          * return the source/destination buffer via tdm_pp_done_handler.
 883          */
 884         tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
 885
 886         /**
 887          * @brief Commit changes for a pp object
 888          * @param[in] pp A pp object
 889          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 890          */
 891         tdm_error (*pp_commit)(tdm_pp *pp);
 892
 893         /**
 894          * @brief Set a user done handler to a pp object
 895          * @param[in] pp A pp object
 896          * @param[in] func A user done handler
 897          * @param[in] user_data user data
 898          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 899          * @remark
 900          * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
 901          */
 902         tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
 903                                                                          void *user_data);
 904
 905         void (*reserved1)(void);
 906         void (*reserved2)(void);
 907         void (*reserved3)(void);
 908         void (*reserved4)(void);
 909         void (*reserved5)(void);
 910         void (*reserved6)(void);
 911         void (*reserved7)(void);
 912         void (*reserved8)(void);
 913 } tdm_func_pp;
 914
 915 /**
 916  * @brief The capture functions for a backend module.
 917  */
 918 typedef struct _tdm_func_capture {
 919         /**
 920          * @brief Destroy a capture object
 921          * @param[in] capture A capture object
 922          * @see output_create_capture() function of #tdm_func_output
 923          * @see layer_create_capture() function of #tdm_func_layer
 924          */
 925         void (*capture_destroy)(tdm_capture *capture);
 926
 927         /**
 928          * @brief Set the geometry information to a capture object
 929          * @param[in] capture A capture object
 930          * @param[in] info The geometry information
 931          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 932          * @see capture_commit() function of #tdm_func_capture
 933          * @remark
 934          * A backend module would apply the geometry information when committed.
 935          */
 936         tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
 937
 938         /**
 939          * @brief Attach a TDM buffer to a capture object
 940          * @details When capture_commit() function is called, a backend module starts
 941          * to dump a output or a layer to a TDM buffer.
 942          * @param[in] capture A capture object
 943          * @param[in] buffer A TDM buffer
 944          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 945          * @see capture_set_info() function of #tdm_func_capture
 946          * @see capture_commit() function of #tdm_func_capture
 947          * @see capture_set_done_handler, tdm_capture_done_handler
 948          * @remark
 949          * A backend module starts to dump a output or a layer to to a TDM buffer when
 950          * committed. The size/crop/transform information is set via #capture_set_info()
 951          * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
 952          * buffer via tdm_capture_done_handler.
 953          */
 954         tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
 955
 956         /**
 957          * @brief Commit changes for a capture object
 958          * @param[in] capture A capture object
 959          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 960          */
 961         tdm_error (*capture_commit)(tdm_capture *capture);
 962
 963         /**
 964          * @brief Set a user done handler to a capture object
 965          * @param[in] capture A capture object
 966          * @param[in] func A user done handler
 967          * @param[in] user_data user data
 968          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 969          * @remark
 970          * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
 971          */
 972         tdm_error (*capture_set_done_handler)(tdm_capture *capture,
 973                                                                                   tdm_capture_done_handler func, void *user_data);
 974
 975         void (*reserved1)(void);
 976         void (*reserved2)(void);
 977         void (*reserved3)(void);
 978         void (*reserved4)(void);
 979         void (*reserved5)(void);
 980         void (*reserved6)(void);
 981         void (*reserved7)(void);
 982         void (*reserved8)(void);
 983 } tdm_func_capture;
 984
 985 /**
 986  * @brief The tdm event source
 987  */
 988 typedef void tdm_event_loop_source;
 989
 990 /**
 991  * @brief The fd source handler
 992  */
 993 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
 994
 995 /**
 996  * @brief The timer source handler
 997  */
 998 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
 999
1000 #define TDM_BACKEND_MINOR_VERSION_MASK  0x0000FFFF
1001 #define TDM_BACKEND_MAJOR_VERSION_MASK  0xFFFF0000
1002 #define TDM_BACKEND_GET_ABI_MINOR(v)    ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1003 #define TDM_BACKEND_GET_ABI_MAJOR(v)    (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1004
1005 /**
1006  * @brief
1007  * The ABI version of TDM backend module. It has a major and minor revision.
1008  * Modules using lower minor revisions will work with TDM frontend of a higher
1009  * minor revision. There is no compatibility between different major revisions.
1010  * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1011  * @par Example
1012  * @code
1013  *  tdm_backend_module tdm_backend_module_data = {
1014  *      "drm",
1015  *      "Samsung",
1016  *      TDM_BACKEND_SET_ABI_VERSION(1,1),
1017  *      tdm_drm_init,
1018  *      tdm_drm_deinit
1019  *  };
1020  * @endcode
1021  */
1022 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1023         (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1024         ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1025
1026 /**
1027  * @brief
1028  * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1029  * @deprecated
1030  * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1031  */
1032 #define TDM_BACKEND_ABI_VERSION     TDM_BACKEND_SET_ABI_VERSION(1, 1)
1033
1034 /**
1035  * @brief The backend module information of the entry point to initialize a TDM
1036  * backend module.
1037  * @remark
1038  * A backend module @b SHOULD define the global data symbol of which name is
1039  * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1040  * at the initial time and call init() function of #tdm_backend_module.
1041  */
1042 typedef struct _tdm_backend_module {
1043         const char *name;           /**< The module name of a backend module */
1044         const char *vendor;         /**< The vendor name of a backend module */
1045         unsigned long abi_version;  /**< The ABI version of a backend module */
1046
1047         /**
1048          * @brief The init function of a backend module
1049          * @param[in] dpy A display object
1050          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1051          * @return The backend module data
1052          * @see tdm_backend_data
1053          */
1054         tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1055
1056         /**
1057          * @brief The deinit function of a backend module
1058          * @param[in] bdata The backend module data
1059          */
1060         void (*deinit)(tdm_backend_data *bdata);
1061 } tdm_backend_module;
1062
1063 /**
1064  * @brief Register the backend display functions to a display
1065  * @param[in] dpy A display object
1066  * @param[in] func_display display functions
1067  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1068  * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1069  * @remarks
1070  * A backend module @b SHOULD set the backend display functions at least.
1071  */
1072 tdm_error
1073 tdm_backend_register_func_display(tdm_display *dpy,
1074                                                                   tdm_func_display *func_display);
1075
1076 /**
1077  * @brief Register the backend output functions to a display
1078  * @param[in] dpy A display object
1079  * @param[in] func_output output functions
1080  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1081  * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1082  * @remarks
1083  * A backend module @b SHOULD set the backend output functions at least.
1084  */
1085 tdm_error
1086 tdm_backend_register_func_output(tdm_display *dpy,
1087                                                                  tdm_func_output *func_output);
1088
1089 /**
1090  * @brief Register the backend layer functions to a display
1091  * @param[in] dpy A display object
1092  * @param[in] func_layer layer functions
1093  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1094  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1095  * @remarks
1096  * A backend module @b SHOULD set the backend layer functions at least.
1097  */
1098 tdm_error
1099 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1100
1101 /**
1102  * @brief Register the backend hwc_window functions to a display
1103  * @param[in] dpy A display object
1104  * @param[in] func_hwc_window hwc_window functions
1105  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1106  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1107  * @remarks
1108  * A backend module @b SHOULD set the backend hwc_window functions at least.
1109  */
1110 tdm_error
1111 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1112
1113 /**
1114  * @brief Register the backend pp functions to a display
1115  * @param[in] dpy A display object
1116  * @param[in] func_pp pp functions
1117  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1118  * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1119  * @remark
1120  * A backend module doesn'tcan skip to register the backend pp functions
1121  * if a hardware doesn't have the memory-to-memory converting device.
1122  */
1123 tdm_error
1124 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1125
1126 /**
1127  * @brief Register the backend capture functions to a display
1128  * @param[in] dpy A display object
1129  * @param[in] func_capture capture functions
1130  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1131  * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1132  * @remark
1133  * A backend module can skip to register the backend capture functions
1134  * if a hardware doesn't have the capture device.
1135  */
1136 tdm_error
1137 tdm_backend_register_func_capture(tdm_display *dpy,
1138                                                                   tdm_func_capture *func_capture);
1139
1140 /**
1141  * @brief Increase the ref_count of a TDM buffer
1142  * @details
1143  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1144  * becomes available for a next job. A TDM buffer can be used for TDM to show
1145  * it on screen or to capture an output and a layer. After all operations,
1146  * TDM will release it immediately when TDM doesn't need it any more.
1147  * @param[in] buffer A TDM buffer
1148  * @return A buffer itself. Otherwise, NULL.
1149  * @see tdm_buffer_unref_backend
1150  * @remark
1151  * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1152  * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1153  * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1154  */
1155 tbm_surface_h
1156 tdm_buffer_ref_backend(tbm_surface_h buffer);
1157
1158 /**
1159  * @brief Decrease the ref_count of a TDM buffer
1160  * @param[in] buffer A TDM buffer
1161  * @see tdm_buffer_ref_backend
1162  */
1163 void
1164 tdm_buffer_unref_backend(tbm_surface_h buffer);
1165
1166 /**
1167  * @brief The destroy handler of a TDM buffer
1168  * @param[in] buffer A TDM buffer
1169  * @param[in] user_data user data
1170  * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1171  */
1172 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1173                                                                                    void *user_data);
1174
1175 /**
1176  * @brief Add a destroy handler to a TDM buffer
1177  * @param[in] buffer A TDM buffer
1178  * @param[in] func A destroy handler
1179  * @param[in] user_data user data
1180  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1181  * @see tdm_buffer_remove_destroy_handler
1182  * @remark
1183  * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1184  * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1185  * be called.
1186  */
1187 tdm_error
1188 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1189                                                            tdm_buffer_destroy_handler func, void *user_data);
1190
1191 /**
1192  * @brief Remove a destroy handler from a TDM buffer
1193  * @param[in] buffer A TDM buffer
1194  * @param[in] func A destroy handler
1195  * @param[in] user_data user data
1196  * @see tdm_buffer_add_destroy_handler
1197  */
1198 void
1199 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1200                                                                   tdm_buffer_destroy_handler func, void *user_data);
1201
1202 /**
1203  * @brief Add a FD handler for activity on the given file descriptor
1204  * @param[in] dpy A display object
1205  * @param[in] fd A file descriptor
1206  * @param[in] mask to monitor FD
1207  * @param[in] func A FD handler function
1208  * @param[in] user_data user data
1209  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1210  * @return A FD event source
1211  * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1212  */
1213 tdm_event_loop_source*
1214 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1215                                                           tdm_event_loop_fd_handler func, void *user_data,
1216                                                           tdm_error *error);
1217
1218 /**
1219  * @brief Update the mask of the given FD event source
1220  * @param[in] source The given FD event source
1221  * @param[in] mask to monitor FD
1222  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1223  */
1224 tdm_error
1225 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1226
1227 /**
1228  * @brief Add a timer handler
1229  * @param[in] dpy A display object
1230  * @param[in] func A timer handler function
1231  * @param[in] user_data user data
1232  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1233  * @return A timer event source
1234  * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1235  */
1236 tdm_event_loop_source*
1237 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1238                                                                  void *user_data, tdm_error *error);
1239
1240 /**
1241  * @brief Update the millisecond delay time of the given timer event source.
1242  * @param[in] source The given timer event source
1243  * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1244  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1245  */
1246 tdm_error
1247 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1248
1249 /**
1250  * @brief Remove the given event source
1251  * @param[in] source The given event source
1252  * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1253  */
1254 void
1255 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1256
1257 #ifdef __cplusplus
1258 }
1259 #endif
1260
1261 #endif /* _TDM_BACKEND_H_ */