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;
  66
  67 /**
  68  * @brief The output change handler
  69  * @details This handler will be called when the status of a output object is
  70  * changed in runtime.
  71  */
  72 typedef void (*tdm_output_change_handler)(tdm_output *output,
  73                                                                                   tdm_output_change_type type,
  74                                                                                   tdm_value value,
  75                                                                                   void *user_data);
  76
  77 /**
  78  * @brief Initialize a display object
  79  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
  80  * @return A display object
  81  * @see tdm_display_deinit
  82  */
  83 tdm_display *
  84 tdm_display_init(tdm_error *error);
  85
  86 /**
  87  * @brief Deinitialize a display object
  88  * @param[in] dpy A display object
  89  * @see tdm_display_init
  90  */
  91 void
  92 tdm_display_deinit(tdm_display *dpy);
  93
  94 /**
  95  * @brief Update a display object
  96  * @details
  97  * When new output is connected, a frontend user need to call this function.
  98  * And a frontend user can the new output information with tdm_output_get_xxx functions.
  99  * @param[in] dpy A display object
 100  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 101  */
 102 tdm_error
 103 tdm_display_update(tdm_display *dpy);
 104
 105 /**
 106  * @brief Get the file descriptor
 107  * @details TDM handles the events of fd with #tdm_display_handle_events.
 108  * @param[in] dpy A display object
 109  * @param[out] fd The file descriptor
 110  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 111  * @see tdm_display_handle_events
 112  */
 113 tdm_error
 114 tdm_display_get_fd(tdm_display *dpy, int *fd);
 115
 116 /**
 117  * @brief Handle the events
 118  * @param[in] dpy A display object
 119  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 120  * @see tdm_display_get_fd
 121  */
 122 tdm_error
 123 tdm_display_handle_events(tdm_display *dpy);
 124
 125 /**
 126  * @brief Get the information of the TDM backend module.
 127  * @param[in] dpy A display object
 128  * @param[out] name The name of the TDM backend module
 129  * @param[out] vendor The vendor of the TDM backend module
 130  * @param[out] version The version of the TDM backend module
 131  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 132  */
 133 tdm_error
 134 tdm_display_get_backend_info(tdm_display *dpy, const char **name,
 135                                                          const char **vendor, int *major, int *minor);
 136
 137 /**
 138  * @brief Get the capabilities of a display object.
 139  * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
 140  * @param[in] dpy A display object
 141  * @param[out] capabilities The capabilities of a display object
 142  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 143  */
 144 tdm_error
 145 tdm_display_get_capabilities(tdm_display *dpy,
 146                                                          tdm_display_capability *capabilities);
 147
 148 /**
 149  * @brief Get the pp capabilities of a display object.
 150  * @param[in] dpy A display object
 151  * @param[out] capabilities The pp capabilities
 152  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 153  */
 154 tdm_error
 155 tdm_display_get_pp_capabilities(tdm_display *dpy,
 156                                                                 tdm_pp_capability *capabilities);
 157
 158 /**
 159  * @brief Get the pp available format array of a display object.
 160  * @param[in] dpy A display object
 161  * @param[out] formats The pp available format array
 162  * @param[out] count The count of formats
 163  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 164  */
 165 tdm_error
 166 tdm_display_get_pp_available_formats(tdm_display *dpy,
 167                                                                          const tbm_format **formats, int *count);
 168
 169 /**
 170  * @brief Get the pp available size of a display object.
 171  * @details -1 means that a TDM backend module doesn't define the value.
 172  * @param[in] dpy A display object
 173  * @param[out] min_w The minimum width which TDM can handle
 174  * @param[out] min_h The minimum height which TDM can handle
 175  * @param[out] max_w The maximum width which TDM can handle
 176  * @param[out] max_h The maximum height which TDM can handle
 177  * @param[out] preferred_align The preferred align width which TDM can handle
 178  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 179  */
 180 tdm_error
 181 tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
 182                                                                   int *max_w, int *max_h, int *preferred_align);
 183
 184 /**
 185  * @brief Get the capture capabilities of a display object.
 186  * @param[in] dpy A display object
 187  * @param[out] capabilities The capture capabilities
 188  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 189  */
 190 tdm_error
 191 tdm_display_get_capture_capabilities(tdm_display *dpy,
 192                                                                          tdm_capture_capability *capabilities);
 193
 194 /**
 195  * @brief Get the capture available format array of a display object.
 196  * @param[in] dpy A display object
 197  * @param[out] formats The capture available format array
 198  * @param[out] count The count of formats
 199  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 200  */
 201 tdm_error
 202 tdm_display_get_catpure_available_formats(tdm_display *dpy,
 203                                                                                   const tbm_format **formats, int *count);
 204
 205 /**
 206  * @brief Get the capture available size of a display object.
 207  * @details -1 means that a TDM backend module doesn't define the value.
 208  * @param[in] dpy A display object
 209  * @param[out] min_w The minimum width which TDM can handle
 210  * @param[out] min_h The minimum height which TDM can handle
 211  * @param[out] max_w The maximum width which TDM can handle
 212  * @param[out] max_h The maximum height which TDM can handle
 213  * @param[out] preferred_align The preferred align width which TDM can handle
 214  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 215  */
 216 tdm_error
 217 tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
 218                                                                            int *max_w, int *max_h, int *preferred_align);
 219
 220 /**
 221  * @brief Get the max layer counts which a display object can show on screen.
 222  * @details -1 means that a TDM backend module doesn't define the value.
 223  * @param[in] dpy A display object
 224  * @param[out] count The max count of layers
 225  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 226  */
 227 tdm_error
 228 tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count);
 229
 230 /**
 231  * @brief Get the output counts which a display object has.
 232  * @param[in] dpy A display object
 233  * @param[out] count The count of outputs
 234  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 235  * @see tdm_display_get_output
 236  */
 237 tdm_error
 238 tdm_display_get_output_count(tdm_display *dpy, int *count);
 239
 240 /**
 241  * @brief Get a output object which has the given index.
 242  * @param[in] dpy A display object
 243  * @param[in] index The index of a output object
 244  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 245  * @return A output object if success. Otherwise, NULL.
 246  * @see tdm_display_get_output_count
 247  */
 248 tdm_output *
 249 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
 250
 251 /**
 252  * @brief Create a pp object.
 253  * @param[in] dpy A display object
 254  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 255  * @return A pp object if success. Otherwise, NULL.
 256  * @see tdm_pp_destroy
 257  */
 258 tdm_pp *
 259 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
 260
 261 /**
 262  * @brief Get the capabilities of a output object.
 263  * @param[in] output A output object
 264  * @param[out] capabilities The capabilities of a output object
 265  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 266  */
 267 tdm_error
 268 tdm_output_get_capabilities(tdm_output *output,
 269                                                         tdm_output_capability *capabilities);
 270
 271 /**
 272  * @brief Get the model information of a output object.
 273  * @param[in] output A output object
 274  * @param[out] maker The output maker.
 275  * @param[out] model The output model.
 276  * @param[out] name The output name.
 277  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 278  */
 279 tdm_error
 280 tdm_output_get_model_info(tdm_output *output, const char **maker,
 281                                                   const char **model, const char **name);
 282
 283 /**
 284  * @brief Get the connection status of a output object.
 285  * @param[in] output A output object
 286  * @param[out] status The connection status.
 287  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 288  */
 289 tdm_error
 290 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
 291
 292 /**
 293  * @brief Add a output change handler
 294  * @details The handler will be called when the status of a
 295  * output object is changed. connection, DPMS, etc.
 296  * @param[in] output A output object
 297  * @param[in] func A output change handler
 298  * @param[in] user_data The user data
 299  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 300  */
 301 tdm_error
 302 tdm_output_add_change_handler(tdm_output *output,
 303                                                           tdm_output_change_handler func,
 304                                                           void *user_data);
 305
 306 /**
 307  * @brief Remove a output change handler
 308  * @param[in] output A output object
 309  * @param[in] func A output change handler
 310  * @param[in] user_data The user data
 311  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 312  */
 313 void
 314 tdm_output_remove_change_handler(tdm_output *output,
 315                                                                  tdm_output_change_handler func,
 316                                                                  void *user_data);
 317
 318 /**
 319  * @brief Get the connection type of a output object.
 320  * @param[in] output A output object
 321  * @param[out] type The connection type.
 322  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 323  */
 324 tdm_error
 325 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
 326
 327 /**
 328  * @brief Get the layer counts which a output object has.
 329  * @param[in] output A output object
 330  * @param[out] count The count of layers
 331  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 332  * @see tdm_output_get_layer
 333  */
 334 tdm_error
 335 tdm_output_get_layer_count(tdm_output *output, int *count);
 336
 337 /**
 338  * @brief Get a layer object which has the given index.
 339  * @param[in] output A output object
 340  * @param[in] index The index of a layer object
 341  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 342  * @return A layer object if success. Otherwise, NULL.
 343  * @see tdm_output_get_layer_count
 344  */
 345 tdm_layer *
 346 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
 347
 348 /**
 349  * @brief Get the available property array of a output object.
 350  * @param[in] output A output object
 351  * @param[out] props The available property array
 352  * @param[out] count The count of properties
 353  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 354  */
 355 tdm_error
 356 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
 357                                                                         int *count);
 358
 359 /**
 360  * @brief Get the available mode array of a output object.
 361  * @param[in] output A output object
 362  * @param[out] modes The available mode array
 363  * @param[out] count The count of modes
 364  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 365  */
 366 tdm_error
 367 tdm_output_get_available_modes(tdm_output *output,
 368                                                            const tdm_output_mode **modes, int *count);
 369
 370 /**
 371  * @brief Get the available size of a output object.
 372  * @details -1 means that a TDM backend module doesn't define the value.
 373  * @param[in] output A output object
 374  * @param[out] min_w The minimum width which TDM can handle
 375  * @param[out] min_h The minimum height which TDM can handle
 376  * @param[out] max_w The maximum width which TDM can handle
 377  * @param[out] max_h The maximum height which TDM can handle
 378  * @param[out] preferred_align The preferred align width which TDM can handle
 379  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 380  */
 381 tdm_error
 382 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
 383                                                           int *max_w, int *max_h, int *preferred_align);
 384
 385 /**
 386  * @brief Get the available cursor size of a output object.
 387  * @details -1 means that a TDM backend module doesn't define the value.
 388  * @param[in] output A output object
 389  * @param[out] min_w The minimum width which TDM can handle
 390  * @param[out] min_h The minimum height which TDM can handle
 391  * @param[out] max_w The maximum width which TDM can handle
 392  * @param[out] max_h The maximum height which TDM can handle
 393  * @param[out] preferred_align The preferred align width which TDM can handle
 394  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 395  */
 396 tdm_error
 397 tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
 398                                                                          int *max_w, int *max_h, int *preferred_align);
 399
 400 /**
 401  * @brief Get the physical size of a output object.
 402  * @param[in] output A output object
 403  * @param[out] mmWidth The milimeter width
 404  * @param[out] mmHeight The milimeter height
 405  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 406  */
 407 tdm_error
 408 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
 409                                                          unsigned int *mmHeight);
 410
 411 /**
 412  * @brief Get the subpixel of a output object.
 413  * @param[in] output A output object
 414  * @param[out] subpixel The subpixel
 415  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 416  */
 417 tdm_error
 418 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
 419
 420 /**
 421  * @brief Get the pipe of a output object.
 422  * @param[in] output A output object
 423  * @param[out] pipe The pipe
 424  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 425  */
 426 tdm_error
 427 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
 428
 429 /**
 430  * @brief Get the index of a primary layer.
 431  * @param[in] output A output object
 432  * @param[out] index The primary layer index
 433  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 434  */
 435 tdm_error
 436 tdm_output_get_primary_index(tdm_output *output, int *index);
 437
 438 /**
 439  * @brief Set the property which has a given id.
 440  * @param[in] output A output object
 441  * @param[in] id The property id
 442  * @param[in] value The value
 443  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 444  */
 445 tdm_error
 446 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
 447
 448 /**
 449  * @brief Get the property which has a given id
 450  * @param[in] output A output object
 451  * @param[in] id The property id
 452  * @param[out] value The value
 453  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 454  */
 455 tdm_error
 456 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
 457
 458 /**
 459  * @brief Wait for VBLANK
 460  * @details After interval vblanks, a user vblank handler will be called.
 461  * @param[in] output A output object
 462  * @param[in] interval vblank interval
 463  * @param[in] sync 0: asynchronous, 1:synchronous
 464  * @param[in] func A user vblank handler
 465  * @param[in] user_data The user data
 466  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 467  * @see #tdm_output_vblank_handler
 468  */
 469 tdm_error
 470 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
 471                                            tdm_output_vblank_handler func, void *user_data);
 472
 473 /**
 474  * @brief Commit changes for a output object
 475  * @details After all change of a output object are applied, a user commit handler
 476  * will be called.
 477  * @param[in] output A output object
 478  * @param[in] sync 0: asynchronous, 1:synchronous
 479  * @param[in] func A user commit handler
 480  * @param[in] user_data The user data
 481  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 482  * @see #tdm_layer_commit
 483  */
 484 tdm_error
 485 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
 486                                   void *user_data);
 487
 488 /**
 489  * @brief Remove the user vblank handler
 490  * @param[in] output A output object
 491  * @param[in] func A user vblank handler
 492  * @param[in] user_data The user data
 493  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 494  */
 495 tdm_error
 496 tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
 497
 498 /**
 499  * @brief Remove the user commit handler
 500  * @param[in] output A output object
 501  * @param[in] func A user commit handler
 502  * @param[in] user_data The user data
 503  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 504  */
 505 tdm_error
 506 tdm_output_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data);
 507
 508 /**
 509  * @brief Set one of available modes of a output object
 510  * @param[in] output A output object
 511  * @param[in] mode A output mode
 512  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 513  */
 514 tdm_error
 515 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
 516
 517 /**
 518  * @brief Get the mode of a output object
 519  * @param[in] output A output object
 520  * @param[out] mode A output mode
 521  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 522  */
 523 tdm_error
 524 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
 525
 526 /**
 527  * @brief Set DPMS of a output object synchronously
 528  * @param[in] output A output object
 529  * @param[in] dpms_value DPMS value
 530  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 531  * @see tdm_output_set_dpms_async
 532  */
 533 tdm_error
 534 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
 535
 536 /**
 537  * @brief Set DPMS of a output object asynchronously
 538  * @details This function can be used when a output supports the asynchronous DPMS
 539  * control. The output has #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS flags which
 540  * #tdm_output_get_capabilities returns. If an output change handler is added with
 541  * #tdm_output_add_change_handler, the output change handler will be called when
 542  * the DPMS status is changed indeed.
 543  * @param[in] output A output object
 544  * @param[in] dpms_value DPMS value
 545  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 546  * @see tdm_output_add_change_handler, tdm_output_set_dpms,
 547  *      tdm_output_get_capabilities, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS.
 548  */
 549 tdm_error
 550 tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value);
 551
 552 /**
 553  * @brief Get DPMS of a output object
 554  * @param[in] output A output object
 555  * @param[out] dpms_value DPMS value
 556  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 557  */
 558 tdm_error
 559 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
 560
 561 /**
 562  * @brief Create a capture object of a output object
 563  * @param[in] output A output object
 564  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 565  * @return A capture object
 566  * @see tdm_capture_destroy
 567  */
 568 tdm_capture *
 569 tdm_output_create_capture(tdm_output *output, tdm_error *error);
 570
 571 /**
 572  * @brief Get the capabilities of a layer object.
 573  * @param[in] layer A layer object
 574  * @param[out] capabilities The capabilities of a layer object
 575  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 576  */
 577 tdm_error
 578 tdm_layer_get_capabilities(tdm_layer *layer,
 579                                                    tdm_layer_capability *capabilities);
 580
 581 /**
 582  * @brief Get the available format array of a layer object.
 583  * @param[in] layer A layer object
 584  * @param[out] formats The available format array
 585  * @param[out] count The count of formats
 586  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 587  */
 588 tdm_error
 589 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
 590                                                                 int *count);
 591
 592 /**
 593  * @brief Get the available property array of a layer object.
 594  * @param[in] layer A layer object
 595  * @param[out] props The available property array
 596  * @param[out] count The count of properties
 597  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 598  */
 599 tdm_error
 600 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
 601                                                                    int *count);
 602
 603 /**
 604  * @brief Get the zpos of a layer object.
 605  * @details
 606  * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
 607  * - But the zpos of VIDEO layers will be decided by a backend module side.
 608  * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
 609  * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
 610  * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 611  *   -------------------------------- graphic layer  3 <-- top most layer
 612  *   -------------------------------- graphic layer  2
 613  *   -------------------------------- graphic layer  1
 614  *   -------------------------------- graphic layer  0
 615  *   -------------------------------- video   layer -1
 616  *   -------------------------------- video   layer -2 <-- lowest layer
 617  * @param[in] layer A layer object
 618  * @param[out] zpos The zpos
 619  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 620  * @see tdm_layer_set_video_pos, tdm_layer_capability
 621  */
 622 tdm_error
 623 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
 624
 625 /**
 626  * @brief Set the property which has a given id.
 627  * @param[in] layer A layer object
 628  * @param[in] id The property id
 629  * @param[in] value The value
 630  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 631  */
 632 tdm_error
 633 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
 634
 635 /**
 636  * @brief Get the property which has a given id.
 637  * @param[in] layer A layer object
 638  * @param[in] id The property id
 639  * @param[out] value The value
 640  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 641  */
 642 tdm_error
 643 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
 644
 645 /**
 646  * @brief Set the geometry information to a layer object
 647  * @details The geometry information will be applied when the output object
 648  * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
 649  * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
 650  * src_config.
 651  * @param[in] layer A layer object
 652  * @param[in] info The geometry information
 653  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 654  * @see tdm_layer_commit
 655  */
 656 tdm_error
 657 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
 658
 659 /**
 660  * @brief Get the geometry information to a layer object
 661  * @param[in] layer A layer object
 662  * @param[out] info The geometry information
 663  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 664  */
 665 tdm_error
 666 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
 667
 668 /**
 669  * @brief Set a TDM buffer to a layer object
 670  * @details A TDM buffer will be applied when the output object
 671  * of a layer object is committed.
 672  * @param[in] layer A layer object
 673  * @param[in] buffer A TDM buffer
 674  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 675  * @see tdm_layer_commit
 676  */
 677 tdm_error
 678 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
 679
 680 /**
 681  * @brief Unset a TDM buffer from a layer object
 682  * @details When this function is called, a current showing buffer will be
 683  * disappeared from screen. Then nothing is showing on a layer object.
 684  * @param[in] layer A layer object
 685  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 686  */
 687 tdm_error
 688 tdm_layer_unset_buffer(tdm_layer *layer);
 689
 690 /**
 691  * @brief Commit changes for a layer object
 692  * @details After all change of a layer object are applied, a user commit handler
 693  * will be called.
 694  * @param[in] layer A layer object
 695  * @param[in] func A user commit handler
 696  * @param[in] user_data The user data
 697  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 698  */
 699 tdm_error
 700 tdm_layer_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
 701
 702 tdm_error
 703 tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing);
 704
 705 /**
 706  * @brief Remove the user commit handler
 707  * @param[in] layer A layer object
 708  * @param[in] func A user commit handler
 709  * @param[in] user_data The user data
 710  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 711  */
 712 tdm_error
 713 tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
 714
 715 /**
 716  * @brief Get a displaying TDM buffer from a layer object
 717  * @details A displaying TDM buffer is a current showing buffer on screen
 718  * that is set to layer object and applied output object of a layer object.
 719  * @param[in] layer A layer object
 720  * @return A TDM buffer if success. Otherwise, NULL.
 721  */
 722 tbm_surface_h
 723 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
 724
 725 /**
 726  * @brief Set a TBM surface_queue to a layer object
 727  * @details A TBM surface_queue will be applied when the output object
 728  * of a layer object is committed. and TDM layer will be automatically updated
 729  * @param[in] layer A layer object
 730  * @param[in] buffer_queue A TBM surface_queue
 731  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 732  * @see tdm_layer_commit
 733  */
 734 tdm_error
 735 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
 736
 737 /**
 738  * @brief Unset a TBM surface_queue from a layer object
 739  * @details When this function is called, a current surface_queue will be
 740  * disappeared from screen. Then nothing is showing on a layer object.
 741  * @param[in] layer A layer object
 742  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 743  */
 744 tdm_error
 745 tdm_layer_unset_buffer_queue(tdm_layer *layer);
 746
 747 /**
 748  * @brief Check wheter a layer object is available for a frontend user to use.
 749  * @details A layer object is not usable if a TDM buffer is showing on screen
 750  * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
 751  * will become usable.
 752  * @param[in] layer A layer object
 753  * @param[out] usable 1 if usable, 0 if not usable
 754  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 755  */
 756 tdm_error
 757 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
 758
 759 /**
 760  * @brief Set the relative zpos to a VIDEO layer object
 761  * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
 762  * it is more than the maximum zpos of GRAPHIC layers.
 763  * @param[in] layer A VIDEO layer object
 764  * @param[in] zpos The zpos
 765  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 766  * @see tdm_layer_get_zpos, tdm_layer_capability
 767  */
 768 tdm_error
 769 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
 770
 771 /**
 772  * @brief Create a capture object of a layer object
 773  * @param[in] layer A layer object
 774  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 775  * @return A capture object
 776  * @see tdm_capture_destroy
 777  */
 778 tdm_capture *
 779 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
 780
 781 /**
 782  * @brief Get buffer flags from a layer object
 783  * @param[in] layer A layer object
 784  * @param[out] flags a buffer flags value
 785  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 786  */
 787 tdm_error
 788 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
 789
 790 /**
 791  * @brief Destroy a pp object
 792  * @param[in] pp A pp object
 793  * @see tdm_display_create_pp
 794  */
 795 void
 796 tdm_pp_destroy(tdm_pp *pp);
 797
 798 /**
 799  * @brief Set the geometry information to a pp object
 800  * @param[in] pp A pp object
 801  * @param[in] info The geometry information
 802  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 803  * @see tdm_pp_commit
 804  */
 805 tdm_error
 806 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
 807
 808 /**
 809  * @brief Set the PP done handler to a pp object
 810  * @details
 811  * The user PP done handler will be called after converting a source buffer's image
 812  * to a destination buffer.
 813  * @param[in] pp A pp object
 814  * @param[in] func A user PP done handler
 815  * @param[in] user_data The user data
 816  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 817  */
 818 tdm_error
 819 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
 820
 821 /**
 822  * @brief Attach a source buffer and a destination buffer to a pp object
 823  * @param[in] pp A pp object
 824  * @param[in] src A source buffer
 825  * @param[in] dst A destination buffer
 826  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 827  * @see tdm_pp_commit, tdm_pp_set_done_handler
 828  */
 829 tdm_error
 830 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
 831
 832 /**
 833  * @brief Commit changes for a pp object
 834  * @param[in] pp A pp object
 835  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 836  */
 837 tdm_error
 838 tdm_pp_commit(tdm_pp *pp);
 839
 840 /**
 841  * @brief Destroy a capture object
 842  * @param[in] capture A capture object
 843  * @see tdm_output_create_capture, tdm_layer_create_capture
 844  */
 845 void
 846 tdm_capture_destroy(tdm_capture *capture);
 847
 848 /**
 849  * @brief Set the geometry information to a capture object
 850  * @param[in] capture A capture object
 851  * @param[in] info The geometry information
 852  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 853  * @see tdm_capture_commit
 854  */
 855 tdm_error
 856 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
 857
 858 /**
 859  * @brief Set the capture done handler to a capture object
 860  * @details
 861  * The user capture done handler will be called after capturing a screen into a
 862  * buffer.
 863  * @param[in] capture A capture object
 864  * @param[in] func A user capture done handler
 865  * @param[in] user_data The user data
 866  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 867  */
 868 tdm_error
 869 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
 870
 871 /**
 872  * @brief Attach a TDM buffer to a capture object
 873  * @param[in] capture A capture object
 874  * @param[in] buffer A TDM buffer
 875  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 876  * @see tdm_capture_commit, tdm_capture_set_done_handler
 877  */
 878 tdm_error
 879 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
 880
 881 /**
 882  * @brief Commit changes for a capture object
 883  * @param[in] capture A capture object
 884  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 885  */
 886 tdm_error
 887 tdm_capture_commit(tdm_capture *capture);
 888
 889 /**
 890  * @brief The release handler of a TDM buffer
 891  * @param[in] buffer A TDM buffer
 892  * @param[in] user_data user data
 893  * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
 894  */
 895 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
 896                                                                                    void *user_data);
 897
 898 /**
 899  * @brief Add a release handler to a TDM buffer
 900  * @details
 901  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
 902  * becomes available for a next job. A TDM buffer can be used for TDM to show
 903  * it on screen or to capture an output and a layer. After all operations,
 904  * TDM will release it immediately when TDM doesn't need it any more.
 905  * @param[in] buffer A TDM buffer
 906  * @param[in] func A release handler
 907  * @param[in] user_data user data
 908  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 909  * @see tdm_buffer_remove_release_handler
 910  */
 911 tdm_error
 912 tdm_buffer_add_release_handler(tbm_surface_h buffer,
 913                                                            tdm_buffer_release_handler func, void *user_data);
 914
 915 /**
 916  * @brief Remove a release handler from a TDM buffer
 917  * @param[in] buffer A TDM buffer
 918  * @param[in] func A release handler
 919  * @param[in] user_data user data
 920  * @see tdm_buffer_add_release_handler
 921  */
 922 void
 923 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
 924                                                                   tdm_buffer_release_handler func, void *user_data);
 925
 926 /**
 927  * @brief The handler of a vblank object
 928  * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
 929  */
 930 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
 931                                                                    unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 932
 933 /**
 934  * @brief Set the vblank fps for the given PID and name.
 935  * @param[in] pid The process ID
 936  * @param[in] name The client vblank name
 937  * @param[in] fps The client vblank fps
 938  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 939  */
 940 tdm_error
 941 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
 942
 943 /**
 944  * @brief Set the vblank global fps for the entire system.
 945  * @param[in] enable 1:enable, 0:disable
 946  * @param[in] fps The vblank global fps
 947  * @details
 948  * This global fps will be applied to all client's vblanks for all outputs.
 949  * If the client's vblank fps is less than this, the global fps will be ignored
 950  * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
 951  * the global fps, it will be ignored also.
 952  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 953  */
 954 tdm_error
 955 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps);
 956
 957 /**
 958  * @brief Create a vblank object
 959  * @param[in] dpy A display object
 960  * @param[in] output A output object
 961  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 962  * @return A vblank object
 963  * @see #tdm_vblank_destroy
 964  */
 965 tdm_vblank*
 966 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
 967
 968 /**
 969  * @brief Destroy a vblank object
 970  * @param[in] vblank A vblank object
 971  * @see #tdm_vblank_create
 972  */
 973 void
 974 tdm_vblank_destroy(tdm_vblank *vblank);
 975
 976 /**
 977  * @brief Set the name to a vblank object
 978  * @details The default name is "unknown"
 979  * @param[in] vblank A vblank object
 980  * @param[in] name vblank name
 981  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 982  */
 983 tdm_error
 984 tdm_vblank_set_name(tdm_vblank *vblank, const char *name);
 985
 986 /**
 987  * @brief Get the name for a vblank object
 988  * @details The default name is "unknown"
 989  * @param[in] vblank A vblank object
 990  * @param[out] name vblank name
 991  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 992  */
 993 tdm_error
 994 tdm_vblank_get_name(tdm_vblank *vblank, const char **name);
 995
 996 /**
 997  * @brief Set the fps to a vblank object
 998  * @details Default is the @b vertical @b refresh @b rate of the given output.
 999  * @param[in] vblank A vblank object
1000  * @param[in] fps over 0
1001  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1002  */
1003 tdm_error
1004 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
1005
1006 /**
1007  * @brief Get the fps for a vblank object
1008  * @param[in] vblank A vblank object
1009  * @param[out] fps over 0
1010  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1011  */
1012 tdm_error
1013 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps);
1014
1015 /**
1016  * @brief Ignore the vblank global fps
1017  * @details
1018  * The global fps will be applied to all client's vblanks for all outputs.
1019  * If the client's vblank fps is less than this, the global fps will be ignored
1020  * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1021  * the global fps, it will be ignored also.
1022  * @param[in] vblank A vblank object
1023  * @param[in] ignore 1: ignore 0:not ignore(default)
1024  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1025  */
1026 tdm_error
1027 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore);
1028
1029 /**
1030  * @brief Set the offset(milli-second) to a vblank object
1031  * @details Default is @b 0.
1032  * @param[in] vblank A vblank object
1033  * @param[in] offset the offset(milli-second)
1034  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1035  */
1036 tdm_error
1037 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
1038
1039 /**
1040  * @brief Get the offset(milli-second) for a vblank object
1041  * @param[in] vblank A vblank object
1042  * @param[out] offset the offset(milli-second)
1043  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1044  */
1045 tdm_error
1046 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset);
1047
1048 /**
1049  * @brief Enable/Disable the fake vblank to a vblank object
1050  * @details
1051  * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
1052  * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
1053  * as success.
1054  * @param[in] vblank A vblank object
1055  * @param[in] enable_fake 1:enable, 0:disable
1056  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1057  */
1058 tdm_error
1059 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
1060
1061 /**
1062  * @brief Get the fake vblank
1063  * @param[in] vblank A vblank object
1064  * @param[out] enable_fake 1:enable, 0:disable
1065  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1066  */
1067 tdm_error
1068 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
1069
1070 /**
1071  * @brief Wait for a vblank
1072  * @details
1073  * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
1074  * SHOULD be called after the given interval. \n
1075  * The sequence value of tdm_vblank_handler is the relative value of fps.
1076  * If fps = 10, this sequence value should be increased by 10 during 1 second.
1077  * @param[in] vblank A vblank object
1078  * @param[in] req_sec The vblank request time(second)
1079  * @param[in] req_usec The vblank request time(micro-second)
1080  * @param[in] interval The vblank interval
1081  * @param[in] func The user vblank handler
1082  * @param[in] user_data The user data
1083  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1084  */
1085 tdm_error
1086 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1087                                 unsigned int interval, tdm_vblank_handler func, void *user_data);
1088
1089 /**
1090  * @brief Wait for a vblank with the target sequence number
1091  * @param[in] vblank A vblank object
1092  * @param[in] req_sec The vblank request time(second)
1093  * @param[in] req_usec The vblank request time(micro-second)
1094  * @param[in] sequence The target sequence number
1095  * @param[in] func The user client vblank handler
1096  * @param[in] user_data The user data
1097  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1098  */
1099 tdm_error
1100 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1101                                         unsigned int sequence, tdm_vblank_handler func, void *user_data);
1102
1103 #ifdef __cplusplus
1104 }
1105 #endif
1106
1107 #endif /* _TDM_H_ */