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