include/tdm.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_H_
  37 #define _TDM_H_
  38
  39 #include <stdint.h>
  40 #include <tbm_surface.h>
  41 #include <tbm_surface_queue.h>
  42 #include <tbm_surface_internal.h>
  43
  44 #include "tdm_types.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /**
  51  * @file tdm.h
  52  * @brief The header file for a frontend user.
  53  * @par Example
  54  * @code
  55  * #include <tdm.h>    //for a frontend user
  56  * @endcode
  57  */
  58
  59 /**
  60  * @brief The display capability enumeration
  61  */
  62 typedef enum {
  63         TDM_DISPLAY_CAPABILITY_PP       = (1 << 0), /**< if hardware supports pp operation */
  64         TDM_DISPLAY_CAPABILITY_CAPTURE  = (1 << 1), /**< if hardware supports capture operation */
  65         TDM_DISPLAY_CAPABILITY_HWC              = (1 << 2), /**< if hardware supports hwc operation */
  66 } tdm_display_capability;
  67
  68 /**
  69  * @brief The output change handler
  70  * @details This handler will be called when the status of a output object is
  71  * changed in runtime.
  72  */
  73 typedef void (*tdm_output_change_handler)(tdm_output *output,
  74                                                                                   tdm_output_change_type type,
  75                                                                                   tdm_value value,
  76                                                                                   void *user_data);
  77
  78 /**
  79  * @brief Initialize a display object
  80  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
  81  * @return A display object
  82  * @see tdm_display_deinit
  83  */
  84 tdm_display *
  85 tdm_display_init(tdm_error *error);
  86
  87 /**
  88  * @brief Deinitialize a display object
  89  * @param[in] dpy A display object
  90  * @see tdm_display_init
  91  */
  92 void
  93 tdm_display_deinit(tdm_display *dpy);
  94
  95 /**
  96  * @brief Update a display object
  97  * @details
  98  * When new output is connected, a frontend user need to call this function.
  99  * And a frontend user can the new output information with tdm_output_get_xxx functions.
 100  * @param[in] dpy A display object
 101  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 102  */
 103 tdm_error
 104 tdm_display_update(tdm_display *dpy);
 105
 106 /**
 107  * @brief Get the file descriptor
 108  * @details TDM handles the events of fd with #tdm_display_handle_events.
 109  * @param[in] dpy A display object
 110  * @param[out] fd The file descriptor
 111  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 112  * @see tdm_display_handle_events
 113  */
 114 tdm_error
 115 tdm_display_get_fd(tdm_display *dpy, int *fd);
 116
 117 /**
 118  * @brief Handle the events
 119  * @param[in] dpy A display object
 120  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 121  * @see tdm_display_get_fd
 122  */
 123 tdm_error
 124 tdm_display_handle_events(tdm_display *dpy);
 125
 126 /**
 127  * @brief Get the information of the TDM backend module.
 128  * @param[in] dpy A display object
 129  * @param[out] name The name of the TDM backend module
 130  * @param[out] vendor The vendor of the TDM backend module
 131  * @param[out] version The version of the TDM backend module
 132  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 133  */
 134 tdm_error
 135 tdm_display_get_backend_info(tdm_display *dpy, const char **name,
 136                                                          const char **vendor, int *major, int *minor);
 137
 138 /**
 139  * @brief Get the capabilities of a display object.
 140  * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
 141  * @param[in] dpy A display object
 142  * @param[out] capabilities The capabilities of a display object
 143  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 144  */
 145 tdm_error
 146 tdm_display_get_capabilities(tdm_display *dpy,
 147                                                          tdm_display_capability *capabilities);
 148
 149 /**
 150  * @brief Get the pp capabilities of a display object.
 151  * @param[in] dpy A display object
 152  * @param[out] capabilities The pp capabilities
 153  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 154  */
 155 tdm_error
 156 tdm_display_get_pp_capabilities(tdm_display *dpy,
 157                                                                 tdm_pp_capability *capabilities);
 158
 159 /**
 160  * @brief Get the pp available format array of a display object.
 161  * @param[in] dpy A display object
 162  * @param[out] formats The pp available format array
 163  * @param[out] count The count of formats
 164  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 165  */
 166 tdm_error
 167 tdm_display_get_pp_available_formats(tdm_display *dpy,
 168                                                                          const tbm_format **formats, int *count);
 169
 170 /**
 171  * @brief Get the pp available size of a display object.
 172  * @details -1 means that a TDM backend module doesn't define the value.
 173  * @param[in] dpy A display object
 174  * @param[out] min_w The minimum width which TDM can handle
 175  * @param[out] min_h The minimum height which TDM can handle
 176  * @param[out] max_w The maximum width which TDM can handle
 177  * @param[out] max_h The maximum height which TDM can handle
 178  * @param[out] preferred_align The preferred align width which TDM can handle
 179  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 180  */
 181 tdm_error
 182 tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
 183                                                                   int *max_w, int *max_h, int *preferred_align);
 184
 185 /**
 186  * @brief Get the capture capabilities of a display object.
 187  * @param[in] dpy A display object
 188  * @param[out] capabilities The capture capabilities
 189  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 190  */
 191 tdm_error
 192 tdm_display_get_capture_capabilities(tdm_display *dpy,
 193                                                                          tdm_capture_capability *capabilities);
 194
 195 /**
 196  * @brief Get the capture available format array of a display object.
 197  * @param[in] dpy A display object
 198  * @param[out] formats The capture available format array
 199  * @param[out] count The count of formats
 200  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 201  */
 202 tdm_error
 203 tdm_display_get_catpure_available_formats(tdm_display *dpy,
 204                                                                                   const tbm_format **formats, int *count);
 205
 206 /**
 207  * @brief Get the capture available size of a display object.
 208  * @details -1 means that a TDM backend module doesn't define the value.
 209  * @param[in] dpy A display object
 210  * @param[out] min_w The minimum width which TDM can handle
 211  * @param[out] min_h The minimum height which TDM can handle
 212  * @param[out] max_w The maximum width which TDM can handle
 213  * @param[out] max_h The maximum height which TDM can handle
 214  * @param[out] preferred_align The preferred align width which TDM can handle
 215  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 216  */
 217 tdm_error
 218 tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
 219                                                                            int *max_w, int *max_h, int *preferred_align);
 220
 221 /**
 222  * @brief Get the max layer counts which a display object can show on screen.
 223  * @details -1 means that a TDM backend module doesn't define the value.
 224  * @param[in] dpy A display object
 225  * @param[out] count The max count of layers
 226  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 227  */
 228 tdm_error
 229 tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count);
 230
 231 /**
 232  * @brief Get the output counts which a display object has.
 233  * @param[in] dpy A display object
 234  * @param[out] count The count of outputs
 235  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 236  * @see tdm_display_get_output
 237  */
 238 tdm_error
 239 tdm_display_get_output_count(tdm_display *dpy, int *count);
 240
 241 /**
 242  * @brief Get a output object which has the given index.
 243  * @param[in] dpy A display object
 244  * @param[in] index The index of a output object
 245  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 246  * @return A output object if success. Otherwise, NULL.
 247  * @see tdm_display_get_output_count
 248  */
 249 tdm_output *
 250 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
 251
 252 /**
 253  * @brief Create a pp object.
 254  * @param[in] dpy A display object
 255  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 256  * @return A pp object if success. Otherwise, NULL.
 257  * @see tdm_pp_destroy
 258  */
 259 tdm_pp *
 260 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
 261
 262 /**
 263  * @brief Get the capabilities of a output object.
 264  * @param[in] output A output object
 265  * @param[out] capabilities The capabilities of a output object
 266  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 267  */
 268 tdm_error
 269 tdm_output_get_capabilities(tdm_output *output,
 270                                                         tdm_output_capability *capabilities);
 271
 272 /**
 273  * @brief Get the model information of a output object.
 274  * @param[in] output A output object
 275  * @param[out] maker The output maker.
 276  * @param[out] model The output model.
 277  * @param[out] name The output name.
 278  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 279  */
 280 tdm_error
 281 tdm_output_get_model_info(tdm_output *output, const char **maker,
 282                                                   const char **model, const char **name);
 283
 284 /**
 285  * @brief Get the connection status of a output object.
 286  * @param[in] output A output object
 287  * @param[out] status The connection status.
 288  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 289  */
 290 tdm_error
 291 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
 292
 293 /**
 294  * @brief Add a output change handler
 295  * @details The handler will be called when the status of a
 296  * output object is changed. connection, DPMS, etc.
 297  * @param[in] output A output object
 298  * @param[in] func A output change handler
 299  * @param[in] user_data The user data
 300  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 301  */
 302 tdm_error
 303 tdm_output_add_change_handler(tdm_output *output,
 304                                                           tdm_output_change_handler func,
 305                                                           void *user_data);
 306
 307 /**
 308  * @brief Remove a output change handler
 309  * @param[in] output A output object
 310  * @param[in] func A output change handler
 311  * @param[in] user_data The user data
 312  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 313  */
 314 void
 315 tdm_output_remove_change_handler(tdm_output *output,
 316                                                                  tdm_output_change_handler func,
 317                                                                  void *user_data);
 318
 319 /**
 320  * @brief Get the connection type of a output object.
 321  * @param[in] output A output object
 322  * @param[out] type The connection type.
 323  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 324  */
 325 tdm_error
 326 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
 327
 328 /**
 329  * @brief Get the layer counts which a output object has.
 330  * @param[in] output A output object
 331  * @param[out] count The count of layers
 332  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 333  * @see tdm_output_get_layer
 334  */
 335 tdm_error
 336 tdm_output_get_layer_count(tdm_output *output, int *count);
 337
 338 /**
 339  * @brief Get a layer object which has the given index.
 340  * @param[in] output A output object
 341  * @param[in] index The index of a layer object
 342  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 343  * @return A layer object if success. Otherwise, NULL.
 344  * @see tdm_output_get_layer_count
 345  */
 346 tdm_layer *
 347 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
 348
 349 /**
 350  * @brief Get the available property array of a output object.
 351  * @param[in] output A output object
 352  * @param[out] props The available property array
 353  * @param[out] count The count of properties
 354  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 355  */
 356 tdm_error
 357 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
 358                                                                         int *count);
 359
 360 /**
 361  * @brief Get the available mode array of a output object.
 362  * @param[in] output A output object
 363  * @param[out] modes The available mode array
 364  * @param[out] count The count of modes
 365  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 366  */
 367 tdm_error
 368 tdm_output_get_available_modes(tdm_output *output,
 369                                                            const tdm_output_mode **modes, int *count);
 370
 371 /**
 372  * @brief Get the available size of a output object.
 373  * @details -1 means that a TDM backend module doesn't define the value.
 374  * @param[in] output A output object
 375  * @param[out] min_w The minimum width which TDM can handle
 376  * @param[out] min_h The minimum height which TDM can handle
 377  * @param[out] max_w The maximum width which TDM can handle
 378  * @param[out] max_h The maximum height which TDM can handle
 379  * @param[out] preferred_align The preferred align width which TDM can handle
 380  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 381  */
 382 tdm_error
 383 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
 384                                                           int *max_w, int *max_h, int *preferred_align);
 385
 386 /**
 387  * @brief Get the available cursor size of a output object.
 388  * @details -1 means that a TDM backend module doesn't define the value.
 389  * @param[in] output A output object
 390  * @param[out] min_w The minimum width which TDM can handle
 391  * @param[out] min_h The minimum height which TDM can handle
 392  * @param[out] max_w The maximum width which TDM can handle
 393  * @param[out] max_h The maximum height which TDM can handle
 394  * @param[out] preferred_align The preferred align width which TDM can handle
 395  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 396  */
 397 tdm_error
 398 tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
 399                                                                          int *max_w, int *max_h, int *preferred_align);
 400
 401 /**
 402  * @brief Get the physical size of a output object.
 403  * @param[in] output A output object
 404  * @param[out] mmWidth The milimeter width
 405  * @param[out] mmHeight The milimeter height
 406  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 407  */
 408 tdm_error
 409 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
 410                                                          unsigned int *mmHeight);
 411
 412 /**
 413  * @brief Get the subpixel of a output object.
 414  * @param[in] output A output object
 415  * @param[out] subpixel The subpixel
 416  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 417  */
 418 tdm_error
 419 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
 420
 421 /**
 422  * @brief Get the pipe of a output object.
 423  * @param[in] output A output object
 424  * @param[out] pipe The pipe
 425  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 426  */
 427 tdm_error
 428 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
 429
 430 /**
 431  * @brief Get the index of a primary layer.
 432  * @param[in] output A output object
 433  * @param[out] index The primary layer index
 434  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 435  */
 436 tdm_error
 437 tdm_output_get_primary_index(tdm_output *output, int *index);
 438
 439 /**
 440  * @brief Set the property which has a given id.
 441  * @param[in] output A output object
 442  * @param[in] id The property id
 443  * @param[in] value The value
 444  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 445  */
 446 tdm_error
 447 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
 448
 449 /**
 450  * @brief Get the property which has a given id
 451  * @param[in] output A output object
 452  * @param[in] id The property id
 453  * @param[out] value The value
 454  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 455  */
 456 tdm_error
 457 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
 458
 459 /**
 460  * @brief Wait for VBLANK
 461  * @details After interval vblanks, a user vblank handler will be called.
 462  * @param[in] output A output object
 463  * @param[in] interval vblank interval
 464  * @param[in] sync 0: asynchronous, 1:synchronous
 465  * @param[in] func A user vblank handler
 466  * @param[in] user_data The user data
 467  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 468  * @see #tdm_output_vblank_handler
 469  */
 470 tdm_error
 471 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
 472                                            tdm_output_vblank_handler func, void *user_data);
 473
 474 /**
 475  * @brief Commit changes for a output object
 476  * @details After all change of a output object are applied, a user commit handler
 477  * will be called.
 478  * @param[in] output A output object
 479  * @param[in] sync 0: asynchronous, 1:synchronous
 480  * @param[in] func A user commit handler
 481  * @param[in] user_data The user data
 482  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 483  * @see #tdm_layer_commit
 484  */
 485 tdm_error
 486 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
 487                                   void *user_data);
 488
 489 /**
 490  * @brief Remove the user vblank handler
 491  * @param[in] output A output object
 492  * @param[in] func A user vblank handler
 493  * @param[in] user_data The user data
 494  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 495  */
 496 tdm_error
 497 tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
 498
 499 /**
 500  * @brief Remove the user commit handler
 501  * @param[in] output A output object
 502  * @param[in] func A user commit handler
 503  * @param[in] user_data The user data
 504  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 505  */
 506 tdm_error
 507 tdm_output_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data);
 508
 509 /**
 510  * @brief Set one of available modes of a output object
 511  * @param[in] output A output object
 512  * @param[in] mode A output mode
 513  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 514  */
 515 tdm_error
 516 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
 517
 518 /**
 519  * @brief Get the mode of a output object
 520  * @param[in] output A output object
 521  * @param[out] mode A output mode
 522  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 523  */
 524 tdm_error
 525 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
 526
 527 /**
 528  * @brief Set DPMS of a output object synchronously
 529  * @param[in] output A output object
 530  * @param[in] dpms_value DPMS value
 531  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 532  * @see tdm_output_set_dpms_async
 533  */
 534 tdm_error
 535 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
 536
 537 /**
 538  * @brief Set DPMS of a output object asynchronously
 539  * @details This function can be used when a output supports the asynchronous DPMS
 540  * control. The output has #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS flags which
 541  * #tdm_output_get_capabilities returns. If an output change handler is added with
 542  * #tdm_output_add_change_handler, the output change handler will be called when
 543  * the DPMS status is changed indeed.
 544  * @param[in] output A output object
 545  * @param[in] dpms_value DPMS value
 546  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 547  * @see tdm_output_add_change_handler, tdm_output_set_dpms,
 548  *      tdm_output_get_capabilities, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS.
 549  */
 550 tdm_error
 551 tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value);
 552
 553 /**
 554  * @brief Get DPMS of a output object
 555  * @param[in] output A output object
 556  * @param[out] dpms_value DPMS value
 557  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 558  */
 559 tdm_error
 560 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
 561
 562 /**
 563  * @brief Create a capture object of a output object
 564  * @param[in] output A output object
 565  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 566  * @return A capture object
 567  * @see tdm_capture_destroy
 568  */
 569 tdm_capture *
 570 tdm_output_create_capture(tdm_output *output, tdm_error *error);
 571
 572 /**
 573  * @brief Creates a new window on the given display.
 574  * @param[in] output A output object
 575  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 576  * @return A created window object
 577  */
 578 tdm_hwc_window *
 579 tdm_output_create_hwc_window(tdm_output *output, tdm_error *error);
 580
 581 /**
 582  * @brief Destroys the given window.
 583  * @param[in] output A output object
 584  * @param[in] window the pointer of the window to destroy
 585  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 586  */
 587 tdm_error
 588 tdm_output_destroy_hwc_window(tdm_output *output, tdm_hwc_window *hwc_window);
 589
 590 /**
 591  * @brief Set the client(relative to the TDM) target buffer
 592  * @details Sets the buffer which will receive the output of client composition.
 593  * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
 594  * will be composited into this buffer prior to the call to tdm_output_commit(),
 595  * and windows not marked as TDM_COMPOSITION_CLIENT and
 596  * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
 597  * device.
 598  *
 599  * The buffer handle provided may be null if no windows are being composited by
 600  * the client. This must not result in an error (unless an invalid display
 601  * handle is also provided).
 602  *
 603  * The damage parameter describes a surface damage region as defined in the
 604  * description of tdm_hwc_window_set_surface_damage().
 605  *
 606  * Will be called before tdm_output_commit() if any of the layers are marked as
 607  * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
 608  * so marked, then it is not necessary to call this function. It is not necessary
 609  * to call tdm_output_validate() after changing the target through this function.
 610  * @param[in] output A output object
 611  * @param[in] target The new target buffer
 612  * @param[in] damage The surface damage region
 613  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 614  */
 615 tdm_error
 616 tdm_output_set_client_target_buffer(tdm_output *output, tbm_surface_h target,
 617                                                                         tdm_hwc_region damage);
 618
 619 /**
 620  * @brief Validate the output
 621  * @details Instructs the device to inspect all of the layer state and
 622  * determine if there are any composition type changes necessary before
 623  * presenting the output. Permitted changes are described in the definition
 624  * of tdm_hwc_window_composition_t above.
 625  * @param[in] output A output object
 626  * @param[out] num_types The number of composition type changes required by
 627  * the device; if greater than 0, the client must either set and validate new
 628  * types, or call tdm_output_accept_changes() to accept the changes returned by
 629  * tdm_output_get_changed_composition_types(); must be the same as the number of
 630  * changes returned by tdm_output_get_changed_composition_types (see the
 631  * declaration of that function for more information); pointer will be non-NULL
 632  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 633  */
 634 tdm_error
 635 tdm_output_validate(tdm_output *output, uint32_t *num_types);
 636
 637 /**
 638  * @brief Set the 'need to validate' handler for the 'output'
 639  *
 640  * @details During backend's work it may need to ask for the revalidation
 641  * (make client (E20) do tdm_output_validate() again), so a 'hndl' will
 642  * be called as such need happen. Only one handler per output is supported.
 643  *
 644  * @param[in] output The output object a hndl is going to be registered for.
 645  * @param[in] hndl The handler which will be called on the 'need to validate' event.
 646  *
 647  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 648  */
 649 tdm_error
 650 tdm_output_set_need_validate_handler(tdm_output *output,
 651                 tdm_output_need_validate_handler hndl);
 652
 653 /**
 654  * @brief Get changed composition types
 655  * @details Retrieves the windows for which the device requires a different
 656  * composition type than had been set prior to the last call to tdm_output_validate().
 657  * The client will either update its state with these types and call
 658  * tdm_output_accept_changes, or will set new types and attempt to validate the
 659  * display again.
 660  * windows and types may be NULL to retrieve the number of elements which
 661  * will be returned. The number of elements returned must be the same as the
 662  * value returned in num_types from the last call to tdm_output_validate().
 663  * @param[in] output A output object
 664  * @param[out] num_elements If windows or types were NULL, the number of layers
 665  * and types which would have been returned; if both were non-NULL, the
 666  * number of elements returned in layers and types, which must not exceed
 667  * the value stored in num_elements prior to the call; pointer will be
 668  * non-NULL
 669  * @param[in] output A output object
 670  * @param[out] windows An array of windows
 671  * @param[out] composition_types An array of composition types, each corresponding
 672  * to an element of windows
 673  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 674  */
 675 tdm_error
 676 tdm_output_get_changed_composition_types(tdm_output *output,uint32_t *num_elements,
 677                                                                                  tdm_hwc_window **hwc_window,
 678                                                                                  tdm_hwc_window_composition_t *composition_types);
 679
 680 /**
 681  * @brief Accepts the changes required by the device
 682  * @details Accepts the changes required by the device from the previous
 683  * tdm_output_validate() call (which may be queried using
 684  * tdm_output_get_chaged_composition_types()) and revalidates the display. This
 685  * function is equivalent to requesting the changed types from
 686  * tdm_output_get_chaged_composition_types(), setting those types on the
 687  * corresponding windows, and then calling tdm_output_validate again.
 688  * After this call it must be valid to present this display. Calling this after
 689  * tdm_output_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
 690  * should have no other effect.
 691  * @param[in] output A output object
 692  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 693  */
 694 tdm_error
 695 tdm_output_accept_changes(tdm_output *output);
 696
 697 /**
 698  * @brief Get a target surface queue
 699  * @details Surfaces from target surface queue will receive the output of
 700  * client composition. Window marked as TDM_COMPOSITION_CLIENT or
 701  * TDM_COMPOSITION_DEVICE_CANDIDATE will be composited into this surfaces
 702  * prior to the call to tdm_output_commit().
 703  * @param[in] output A output object
 704  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 705  * @return A surface queue
 706  */
 707 tbm_surface_queue_h
 708 tdm_output_get_target_surface_queue(tdm_output *output, tdm_error *error);
 709
 710 /**
 711  * @brief Get the capabilities of a layer object.
 712  * @param[in] layer A layer object
 713  * @param[out] capabilities The capabilities of a layer object
 714  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 715  */
 716 tdm_error
 717 tdm_layer_get_capabilities(tdm_layer *layer,
 718                                                    tdm_layer_capability *capabilities);
 719
 720 /**
 721  * @brief Get the available format array of a layer object.
 722  * @param[in] layer A layer object
 723  * @param[out] formats The available format array
 724  * @param[out] count The count of formats
 725  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 726  */
 727 tdm_error
 728 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
 729                                                                 int *count);
 730
 731 /**
 732  * @brief Get the available property array of a layer object.
 733  * @param[in] layer A layer object
 734  * @param[out] props The available property array
 735  * @param[out] count The count of properties
 736  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 737  */
 738 tdm_error
 739 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
 740                                                                    int *count);
 741
 742 /**
 743  * @brief Get the zpos of a layer object.
 744  * @details
 745  * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
 746  * - But the zpos of VIDEO layers will be decided by a backend module side.
 747  * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
 748  * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
 749  * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 750  *   -------------------------------- graphic layer  3 <-- top most layer
 751  *   -------------------------------- graphic layer  2
 752  *   -------------------------------- graphic layer  1
 753  *   -------------------------------- graphic layer  0
 754  *   -------------------------------- video   layer -1
 755  *   -------------------------------- video   layer -2 <-- lowest layer
 756  * @param[in] layer A layer object
 757  * @param[out] zpos The zpos
 758  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 759  * @see tdm_layer_set_video_pos, tdm_layer_capability
 760  */
 761 tdm_error
 762 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
 763
 764 /**
 765  * @brief Set the property which has a given id.
 766  * @param[in] layer A layer object
 767  * @param[in] id The property id
 768  * @param[in] value The value
 769  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 770  */
 771 tdm_error
 772 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
 773
 774 /**
 775  * @brief Get the property which has a given id.
 776  * @param[in] layer A layer object
 777  * @param[in] id The property id
 778  * @param[out] value The value
 779  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 780  */
 781 tdm_error
 782 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
 783
 784 /**
 785  * @brief Set the geometry information to a layer object
 786  * @details The geometry information will be applied when the output object
 787  * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
 788  * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
 789  * src_config.
 790  * @param[in] layer A layer object
 791  * @param[in] info The geometry information
 792  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 793  * @see tdm_layer_commit
 794  */
 795 tdm_error
 796 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
 797
 798 /**
 799  * @brief Get the geometry information to a layer object
 800  * @param[in] layer A layer object
 801  * @param[out] info The geometry information
 802  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 803  */
 804 tdm_error
 805 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
 806
 807 /**
 808  * @brief Set a TDM buffer to a layer object
 809  * @details A TDM buffer will be applied when the output object
 810  * of a layer object is committed.
 811  * @param[in] layer A layer object
 812  * @param[in] buffer A TDM buffer
 813  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 814  * @see tdm_layer_commit
 815  */
 816 tdm_error
 817 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
 818
 819 /**
 820  * @brief Unset a TDM buffer from a layer object
 821  * @details When this function is called, a current showing buffer will be
 822  * disappeared from screen. Then nothing is showing on a layer object.
 823  * @param[in] layer A layer object
 824  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 825  */
 826 tdm_error
 827 tdm_layer_unset_buffer(tdm_layer *layer);
 828
 829 /**
 830  * @brief Commit changes for a layer object
 831  * @details After all change of a layer object are applied, a user commit handler
 832  * will be called.
 833  * @param[in] layer A layer object
 834  * @param[in] func A user commit handler
 835  * @param[in] user_data The user data
 836  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 837  */
 838 tdm_error
 839 tdm_layer_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
 840
 841 tdm_error
 842 tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing);
 843
 844 /**
 845  * @brief Remove the user commit handler
 846  * @param[in] layer A layer object
 847  * @param[in] func A user commit handler
 848  * @param[in] user_data The user data
 849  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 850  */
 851 tdm_error
 852 tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
 853
 854 /**
 855  * @brief Get a displaying TDM buffer from a layer object
 856  * @details A displaying TDM buffer is a current showing buffer on screen
 857  * that is set to layer object and applied output object of a layer object.
 858  * @param[in] layer A layer object
 859  * @return A TDM buffer if success. Otherwise, NULL.
 860  */
 861 tbm_surface_h
 862 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
 863
 864 /**
 865  * @brief Set a TBM surface_queue to a layer object
 866  * @details A TBM surface_queue will be applied when the output object
 867  * of a layer object is committed. and TDM layer will be automatically updated
 868  * @param[in] layer A layer object
 869  * @param[in] buffer_queue A TBM surface_queue
 870  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 871  * @see tdm_layer_commit
 872  */
 873 tdm_error
 874 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
 875
 876 /**
 877  * @brief Unset a TBM surface_queue from a layer object
 878  * @details When this function is called, a current surface_queue will be
 879  * disappeared from screen. Then nothing is showing on a layer object.
 880  * @param[in] layer A layer object
 881  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 882  */
 883 tdm_error
 884 tdm_layer_unset_buffer_queue(tdm_layer *layer);
 885
 886 /**
 887  * @brief Check wheter a layer object is available for a frontend user to use.
 888  * @details A layer object is not usable if a TDM buffer is showing on screen
 889  * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
 890  * will become usable.
 891  * @param[in] layer A layer object
 892  * @param[out] usable 1 if usable, 0 if not usable
 893  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 894  */
 895 tdm_error
 896 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
 897
 898 /**
 899  * @brief Set the relative zpos to a VIDEO layer object
 900  * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
 901  * it is more than the maximum zpos of GRAPHIC layers.
 902  * @param[in] layer A VIDEO layer object
 903  * @param[in] zpos The zpos
 904  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 905  * @see tdm_layer_get_zpos, tdm_layer_capability
 906  */
 907 tdm_error
 908 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
 909
 910 /**
 911  * @brief Create a capture object of a layer object
 912  * @param[in] layer A layer object
 913  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 914  * @return A capture object
 915  * @see tdm_capture_destroy
 916  */
 917 tdm_capture *
 918 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
 919
 920 /**
 921  * @brief Get buffer flags from a layer object
 922  * @param[in] layer A layer object
 923  * @param[out] flags a buffer flags value
 924  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 925  */
 926 tdm_error
 927 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
 928
 929 /**
 930  * @brief Get a tbm surface queue for the window object
 931  * @details These surfaces are used to composite by hardware a client content in
 932  * the nocomp mode.
 933  * @param[in] hwc_window A window object
 934  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 935  * @return A tbm surface queue
 936  */
 937 tbm_surface_queue_h
 938 tdm_hwc_window_get_tbm_surface_queue(tdm_hwc_window *hwc_window, tdm_error *error);
 939
 940 /**
 941  * @brief Sets the desired Z order of the given window. A window with
 942  * a greater Z value occludes a window with a lesser Z value.
 943  * @param[in] hwc_window A window object
 944  * @param[in] z the new Z order
 945  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 946  */
 947 tdm_error
 948 tdm_hwc_window_set_zpos(tdm_hwc_window *hwc_window, uint32_t zpos);
 949
 950 /**
 951  * @brief Sets the desired composition type of the given window.
 952  * @details During tdm_output_validate(), the device may request changes to
 953  * the composition types of any of the layers as described in the definition
 954  * of tdm_hwc_window_composition_t above.
 955  * @param[in] hwc_window A window object
 956  * @param[in] composition_type The new composition type
 957  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 958  */
 959 tdm_error
 960 tdm_hwc_window_set_composition_type(tdm_hwc_window *hwc_window,
 961                                                                         tdm_hwc_window_composition_t composition_type);
 962
 963 /**
 964  * @brief Set the surface damage
 965  * @details Provides the region of the source buffer which has been modified
 966  * since the last frame. This region does not need to be validated before
 967  * calling tdm_output_commit().
 968  * Once set through this function, the damage region remains the same until a
 969  * subsequent call to this function.
 970  * If damage.num_rects > 0, then it may be assumed that any portion of the source
 971  * buffer not covered by one of the rects has not been modified this frame. If
 972  * damage.num_rects == 0, then the whole source buffer must be treated as if it
 973  * has been modified.
 974  * If the layer's contents are not modified relative to the prior frame, damage
 975  * will contain exactly one empty rect([0, 0, 0, 0]).
 976  * The damage rects are relative to the pre-transformed buffer, and their origin
 977  * is the top-left corner. They will not exceed the dimensions of the latched
 978  * buffer.
 979  * @param[in] hwc_window A window object
 980  * @param[in] damage The new surface damage region
 981  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 982  */
 983 tdm_error
 984 tdm_hwc_window_set_surface_damage(tdm_hwc_window *hwc_window, tdm_hwc_region damage);
 985
 986 /**
 987  * @brief Set the information to a window object
 988  * @details The information will be applied when the output object of a window
 989  * object is committed.
 990  * @param[in] hwc_window A window object
 991  * @param[in] info The information
 992  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 993  */
 994 tdm_error
 995 tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info);
 996
 997 /**
 998  * @brief Set a TBM buffer to a window object
 999  * @details A TBM buffer will be applied when the output object of a layer
1000  * object is committed.
1001  * @param[in] hwc_window A window object
1002  * @param[in] buffer A TDM buffer
1003  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1004  */
1005 tdm_error
1006 tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer);
1007
1008 /**
1009  * @brief Set a flags to a window object
1010  * @param[in] hwc_window A window object
1011  * @param[in] flags A hwc_window flags
1012  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1013  */
1014 tdm_error
1015 tdm_hwc_window_set_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
1016
1017 /**
1018  * @brief Unset a flags from a window object
1019  * @param[in] hwc_window A window object
1020  * @param[in] flags A hwc_window flags
1021  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1022  */
1023 tdm_error
1024 tdm_hwc_window_unset_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
1025
1026 /**
1027  * @brief Get the window video capability
1028  * @param[in] hwc_window A window object
1029  * @param[out] video_capability A hwc window video capability
1030  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1031  */
1032 tdm_error
1033 tdm_hwc_window_video_get_capability(tdm_hwc_window *hwc_window,
1034                                                                         tdm_hwc_window_video_capability *video_capability);
1035
1036 /**
1037  * @brief Get the window video supported format
1038  * @param[in] hwc_window A window object
1039  * @param[out] formats A hwc window supported formats
1040  * @param[out] count A number of the hwc window supported formats
1041  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1042  */
1043 tdm_error
1044 tdm_hwc_window_video_get_supported_format(tdm_hwc_window *hwc_window,
1045                                                                                   const tbm_format **formats,
1046                                                                                   int *count);
1047
1048 /**
1049  * @brief Destroy a pp object
1050  * @param[in] pp A pp object
1051  * @see tdm_display_create_pp
1052  */
1053 void
1054 tdm_pp_destroy(tdm_pp *pp);
1055
1056 /**
1057  * @brief Set the geometry information to a pp object
1058  * @param[in] pp A pp object
1059  * @param[in] info The geometry information
1060  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1061  * @see tdm_pp_commit
1062  */
1063 tdm_error
1064 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
1065
1066 /**
1067  * @brief Set the PP done handler to a pp object
1068  * @details
1069  * The user PP done handler will be called after converting a source buffer's image
1070  * to a destination buffer.
1071  * @param[in] pp A pp object
1072  * @param[in] func A user PP done handler
1073  * @param[in] user_data The user data
1074  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1075  */
1076 tdm_error
1077 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
1078
1079 /**
1080  * @brief Attach a source buffer and a destination buffer to a pp object
1081  * @param[in] pp A pp object
1082  * @param[in] src A source buffer
1083  * @param[in] dst A destination buffer
1084  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1085  * @see tdm_pp_commit, tdm_pp_set_done_handler
1086  */
1087 tdm_error
1088 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1089
1090 /**
1091  * @brief Commit changes for a pp object
1092  * @param[in] pp A pp object
1093  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1094  */
1095 tdm_error
1096 tdm_pp_commit(tdm_pp *pp);
1097
1098 /**
1099  * @brief Destroy a capture object
1100  * @param[in] capture A capture object
1101  * @see tdm_output_create_capture, tdm_layer_create_capture
1102  */
1103 void
1104 tdm_capture_destroy(tdm_capture *capture);
1105
1106 /**
1107  * @brief Set the geometry information to a capture object
1108  * @param[in] capture A capture object
1109  * @param[in] info The geometry information
1110  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1111  * @see tdm_capture_commit
1112  */
1113 tdm_error
1114 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
1115
1116 /**
1117  * @brief Set the capture done handler to a capture object
1118  * @details
1119  * The user capture done handler will be called after capturing a screen into a
1120  * buffer.
1121  * @param[in] capture A capture object
1122  * @param[in] func A user capture done handler
1123  * @param[in] user_data The user data
1124  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1125  */
1126 tdm_error
1127 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
1128
1129 /**
1130  * @brief Attach a TDM buffer to a capture object
1131  * @param[in] capture A capture object
1132  * @param[in] buffer A TDM buffer
1133  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1134  * @see tdm_capture_commit, tdm_capture_set_done_handler
1135  */
1136 tdm_error
1137 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
1138
1139 /**
1140  * @brief Commit changes for a capture object
1141  * @param[in] capture A capture object
1142  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1143  */
1144 tdm_error
1145 tdm_capture_commit(tdm_capture *capture);
1146
1147 /**
1148  * @brief The release handler of a TDM buffer
1149  * @param[in] buffer A TDM buffer
1150  * @param[in] user_data user data
1151  * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
1152  */
1153 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
1154                                                                                    void *user_data);
1155
1156 /**
1157  * @brief Add a release handler to a TDM buffer
1158  * @details
1159  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1160  * becomes available for a next job. A TDM buffer can be used for TDM to show
1161  * it on screen or to capture an output and a layer. After all operations,
1162  * TDM will release it immediately when TDM doesn't need it any more.
1163  * @param[in] buffer A TDM buffer
1164  * @param[in] func A release handler
1165  * @param[in] user_data user data
1166  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1167  * @see tdm_buffer_remove_release_handler
1168  */
1169 tdm_error
1170 tdm_buffer_add_release_handler(tbm_surface_h buffer,
1171                                                            tdm_buffer_release_handler func, void *user_data);
1172
1173 /**
1174  * @brief Remove a release handler from a TDM buffer
1175  * @param[in] buffer A TDM buffer
1176  * @param[in] func A release handler
1177  * @param[in] user_data user data
1178  * @see tdm_buffer_add_release_handler
1179  */
1180 void
1181 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
1182                                                                   tdm_buffer_release_handler func, void *user_data);
1183
1184 /**
1185  * @brief The handler of a vblank object
1186  * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
1187  */
1188 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
1189                                                                    unsigned int tv_sec, unsigned int tv_usec, void *user_data);
1190
1191 /**
1192  * @brief Set the vblank fps for the given PID and name.
1193  * @param[in] pid The process ID
1194  * @param[in] name The client vblank name
1195  * @param[in] fps The client vblank fps
1196  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1197  */
1198 tdm_error
1199 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
1200
1201 /**
1202  * @brief Set the vblank global fps for the entire system.
1203  * @param[in] enable 1:enable, 0:disable
1204  * @param[in] fps The vblank global fps
1205  * @details
1206  * This global fps will be applied to all client's vblanks for all outputs.
1207  * If the client's vblank fps is less than this, the global fps will be ignored
1208  * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1209  * the global fps, it will be ignored also.
1210  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1211  */
1212 tdm_error
1213 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps);
1214
1215 /**
1216  * @brief Create a vblank object
1217  * @param[in] dpy A display object
1218  * @param[in] output A output object
1219  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1220  * @return A vblank object
1221  * @see #tdm_vblank_destroy
1222  */
1223 tdm_vblank*
1224 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
1225
1226 /**
1227  * @brief Destroy a vblank object
1228  * @param[in] vblank A vblank object
1229  * @see #tdm_vblank_create
1230  */
1231 void
1232 tdm_vblank_destroy(tdm_vblank *vblank);
1233
1234 /**
1235  * @brief Set the name to a vblank object
1236  * @details The default name is "unknown"
1237  * @param[in] vblank A vblank object
1238  * @param[in] name vblank name
1239  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1240  */
1241 tdm_error
1242 tdm_vblank_set_name(tdm_vblank *vblank, const char *name);
1243
1244 /**
1245  * @brief Get the name for a vblank object
1246  * @details The default name is "unknown"
1247  * @param[in] vblank A vblank object
1248  * @param[out] name vblank name
1249  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1250  */
1251 tdm_error
1252 tdm_vblank_get_name(tdm_vblank *vblank, const char **name);
1253
1254 /**
1255  * @brief Set the fps to a vblank object
1256  * @details Default is the @b vertical @b refresh @b rate of the given output.
1257  * @param[in] vblank A vblank object
1258  * @param[in] fps over 0
1259  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1260  */
1261 tdm_error
1262 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
1263
1264 /**
1265  * @brief Get the fps for a vblank object
1266  * @param[in] vblank A vblank object
1267  * @param[out] fps over 0
1268  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1269  */
1270 tdm_error
1271 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps);
1272
1273 /**
1274  * @brief Ignore the vblank global fps
1275  * @details
1276  * The global fps will be applied to all client's vblanks for all outputs.
1277  * If the client's vblank fps is less than this, the global fps will be ignored
1278  * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1279  * the global fps, it will be ignored also.
1280  * @param[in] vblank A vblank object
1281  * @param[in] ignore 1: ignore 0:not ignore(default)
1282  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1283  */
1284 tdm_error
1285 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore);
1286
1287 /**
1288  * @brief Set the offset(milli-second) to a vblank object
1289  * @details Default is @b 0.
1290  * @param[in] vblank A vblank object
1291  * @param[in] offset the offset(milli-second)
1292  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1293  */
1294 tdm_error
1295 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
1296
1297 /**
1298  * @brief Get the offset(milli-second) for a vblank object
1299  * @param[in] vblank A vblank object
1300  * @param[out] offset the offset(milli-second)
1301  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1302  */
1303 tdm_error
1304 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset);
1305
1306 /**
1307  * @brief Enable/Disable the fake vblank to a vblank object
1308  * @details
1309  * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
1310  * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
1311  * as success.
1312  * @param[in] vblank A vblank object
1313  * @param[in] enable_fake 1:enable, 0:disable
1314  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1315  */
1316 tdm_error
1317 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
1318
1319 /**
1320  * @brief Get the fake vblank
1321  * @param[in] vblank A vblank object
1322  * @param[out] enable_fake 1:enable, 0:disable
1323  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1324  */
1325 tdm_error
1326 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
1327
1328 /**
1329  * @brief Wait for a vblank
1330  * @details
1331  * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
1332  * SHOULD be called after the given interval. \n
1333  * The sequence value of tdm_vblank_handler is the relative value of fps.
1334  * If fps = 10, this sequence value should be increased by 10 during 1 second.
1335  * @param[in] vblank A vblank object
1336  * @param[in] req_sec The vblank request time(second)
1337  * @param[in] req_usec The vblank request time(micro-second)
1338  * @param[in] interval The vblank interval
1339  * @param[in] func The user vblank handler
1340  * @param[in] user_data The user data
1341  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1342  */
1343 tdm_error
1344 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1345                                 unsigned int interval, tdm_vblank_handler func, void *user_data);
1346
1347 /**
1348  * @brief Wait for a vblank with the target sequence number
1349  * @param[in] vblank A vblank object
1350  * @param[in] req_sec The vblank request time(second)
1351  * @param[in] req_usec The vblank request time(micro-second)
1352  * @param[in] sequence The target sequence number
1353  * @param[in] func The user client vblank handler
1354  * @param[in] user_data The user data
1355  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1356  */
1357 tdm_error
1358 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1359                                         unsigned int sequence, tdm_vblank_handler func, void *user_data);
1360
1361 #ifdef __cplusplus
1362 }
1363 #endif
1364
1365 #endif /* _TDM_H_ */