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 output counts which a display object has.
 207  * @param[in] dpy A display object
 208  * @param[out] count The count of outputs
 209  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 210  * @see tdm_display_get_output
 211  */
 212 tdm_error
 213 tdm_display_get_output_count(tdm_display *dpy, int *count);
 214
 215 /**
 216  * @brief Get a output object which has the given index.
 217  * @param[in] dpy A display object
 218  * @param[in] index The index of a output object
 219  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 220  * @return A output object if success. Otherwise, NULL.
 221  * @see tdm_display_get_output_count
 222  */
 223 tdm_output *
 224 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
 225
 226 /**
 227  * @brief Create a pp object.
 228  * @param[in] dpy A display object
 229  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 230  * @return A pp object if success. Otherwise, NULL.
 231  * @see tdm_pp_destroy
 232  */
 233 tdm_pp *
 234 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
 235
 236 /**
 237  * @brief Get the capabilities of a output object.
 238  * @param[in] output A output object
 239  * @param[out] capabilities The capabilities of a output object
 240  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 241  */
 242 tdm_error
 243 tdm_output_get_capabilities(tdm_output *output,
 244                                                         tdm_output_capability *capabilities);
 245
 246 /**
 247  * @brief Get the model information of a output object.
 248  * @param[in] output A output object
 249  * @param[out] maker The output maker.
 250  * @param[out] model The output model.
 251  * @param[out] name The output name.
 252  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 253  */
 254 tdm_error
 255 tdm_output_get_model_info(tdm_output *output, const char **maker,
 256                                                   const char **model, const char **name);
 257
 258 /**
 259  * @brief Get the connection status of a output object.
 260  * @param[in] output A output object
 261  * @param[out] status The connection status.
 262  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 263  */
 264 tdm_error
 265 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
 266
 267 /**
 268  * @brief Add a output change handler
 269  * @details The handler will be called when the status of a
 270  * output object is changed. connection, DPMS, etc.
 271  * @param[in] output A output object
 272  * @param[in] func A output change handler
 273  * @param[in] user_data The user data
 274  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 275  */
 276 tdm_error
 277 tdm_output_add_change_handler(tdm_output *output,
 278                                                           tdm_output_change_handler func,
 279                                                           void *user_data);
 280
 281 /**
 282  * @brief Remove a output change handler
 283  * @param[in] output A output object
 284  * @param[in] func A output change handler
 285  * @param[in] user_data The user data
 286  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 287  */
 288 void
 289 tdm_output_remove_change_handler(tdm_output *output,
 290                                                                  tdm_output_change_handler func,
 291                                                                  void *user_data);
 292
 293 /**
 294  * @brief Get the connection type of a output object.
 295  * @param[in] output A output object
 296  * @param[out] type The connection type.
 297  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 298  */
 299 tdm_error
 300 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
 301
 302 /**
 303  * @brief Get the layer counts which a output object has.
 304  * @param[in] output A output object
 305  * @param[out] count The count of layers
 306  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 307  * @see tdm_output_get_layer
 308  */
 309 tdm_error
 310 tdm_output_get_layer_count(tdm_output *output, int *count);
 311
 312 /**
 313  * @brief Get a layer object which has the given index.
 314  * @param[in] output A output object
 315  * @param[in] index The index of a layer object
 316  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 317  * @return A layer object if success. Otherwise, NULL.
 318  * @see tdm_output_get_layer_count
 319  */
 320 tdm_layer *
 321 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
 322
 323 /**
 324  * @brief Get the available property array of a output object.
 325  * @param[in] output A output object
 326  * @param[out] props The available property array
 327  * @param[out] count The count of properties
 328  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 329  */
 330 tdm_error
 331 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
 332                                                                         int *count);
 333
 334 /**
 335  * @brief Get the available mode array of a output object.
 336  * @param[in] output A output object
 337  * @param[out] modes The available mode array
 338  * @param[out] count The count of modes
 339  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 340  */
 341 tdm_error
 342 tdm_output_get_available_modes(tdm_output *output,
 343                                                            const tdm_output_mode **modes, int *count);
 344
 345 /**
 346  * @brief Get the available size of a output object.
 347  * @details -1 means that a TDM backend module doesn't define the value.
 348  * @param[in] output A output object
 349  * @param[out] min_w The minimum width which TDM can handle
 350  * @param[out] min_h The minimum height which TDM can handle
 351  * @param[out] max_w The maximum width which TDM can handle
 352  * @param[out] max_h The maximum height which TDM can handle
 353  * @param[out] preferred_align The preferred align width which TDM can handle
 354  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 355  */
 356 tdm_error
 357 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
 358                                                           int *max_w, int *max_h, int *preferred_align);
 359
 360 /**
 361  * @brief Get the physical size of a output object.
 362  * @param[in] output A output object
 363  * @param[out] mmWidth The milimeter width
 364  * @param[out] mmHeight The milimeter height
 365  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 366  */
 367 tdm_error
 368 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
 369                                                          unsigned int *mmHeight);
 370
 371 /**
 372  * @brief Get the subpixel of a output object.
 373  * @param[in] output A output object
 374  * @param[out] subpixel The subpixel
 375  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 376  */
 377 tdm_error
 378 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
 379
 380 /**
 381  * @brief Get the pipe of a output object.
 382  * @param[in] output A output object
 383  * @param[out] pipe The pipe
 384  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 385  */
 386 tdm_error
 387 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
 388
 389 /**
 390  * @brief Get the index of a primary layer.
 391  * @param[in] output A output object
 392  * @param[out] index The primary layer index
 393  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 394  */
 395 tdm_error
 396 tdm_output_get_primary_index(tdm_output *output, int *index);
 397
 398 /**
 399  * @brief Set the property which has a given id.
 400  * @param[in] output A output object
 401  * @param[in] id The property id
 402  * @param[in] value The value
 403  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 404  */
 405 tdm_error
 406 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
 407
 408 /**
 409  * @brief Get the property which has a given id
 410  * @param[in] output A output object
 411  * @param[in] id The property id
 412  * @param[out] value The value
 413  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 414  */
 415 tdm_error
 416 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
 417
 418 /**
 419  * @brief Wait for VBLANK
 420  * @details After interval vblanks, a user vblank handler will be called.
 421  * @param[in] output A output object
 422  * @param[in] interval vblank interval
 423  * @param[in] sync 0: asynchronous, 1:synchronous
 424  * @param[in] func A user vblank handler
 425  * @param[in] user_data The user data
 426  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 427  * @see #tdm_output_vblank_handler
 428  */
 429 tdm_error
 430 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
 431                                            tdm_output_vblank_handler func, void *user_data);
 432
 433 /**
 434  * @brief Commit changes for a output object
 435  * @details After all change of a output object are applied, a user commit handler
 436  * will be called.
 437  * @param[in] output A output object
 438  * @param[in] sync 0: asynchronous, 1:synchronous
 439  * @param[in] func A user commit handler
 440  * @param[in] user_data The user data
 441  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 442  */
 443 tdm_error
 444 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
 445                                   void *user_data);
 446
 447 /**
 448  * @brief Set one of available modes of a output object
 449  * @param[in] output A output object
 450  * @param[in] mode A output mode
 451  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 452  */
 453 tdm_error
 454 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
 455
 456 /**
 457  * @brief Get the mode of a output object
 458  * @param[in] output A output object
 459  * @param[out] mode A output mode
 460  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 461  */
 462 tdm_error
 463 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
 464
 465 /**
 466  * @brief Set DPMS of a output object
 467  * @param[in] output A output object
 468  * @param[in] dpms_value DPMS value
 469  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 470  */
 471 tdm_error
 472 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
 473
 474 /**
 475  * @brief Get DPMS of a output object
 476  * @param[in] output A output object
 477  * @param[out] dpms_value DPMS value
 478  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 479  */
 480 tdm_error
 481 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
 482
 483 /**
 484  * @brief Create a capture object of a output object
 485  * @param[in] output A output object
 486  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 487  * @return A capture object
 488  * @see tdm_capture_destroy
 489  */
 490 tdm_capture *
 491 tdm_output_create_capture(tdm_output *output, tdm_error *error);
 492
 493 /**
 494  * @brief Get the capabilities of a layer object.
 495  * @param[in] layer A layer object
 496  * @param[out] capabilities The capabilities of a layer object
 497  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 498  */
 499 tdm_error
 500 tdm_layer_get_capabilities(tdm_layer *layer,
 501                                                    tdm_layer_capability *capabilities);
 502
 503 /**
 504  * @brief Get the available format array of a layer object.
 505  * @param[in] layer A layer object
 506  * @param[out] formats The available format array
 507  * @param[out] count The count of formats
 508  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 509  */
 510 tdm_error
 511 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
 512                                                                 int *count);
 513
 514 /**
 515  * @brief Get the available property array of a layer object.
 516  * @param[in] layer A layer object
 517  * @param[out] props The available property array
 518  * @param[out] count The count of properties
 519  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 520  */
 521 tdm_error
 522 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
 523                                                                    int *count);
 524
 525 /**
 526  * @brief Get the zpos of a layer object.
 527  * @details
 528  * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
 529  * - But the zpos of VIDEO layers will be decided by a backend module side.
 530  * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
 531  * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
 532  * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 533  *   -------------------------------- graphic layer  3 <-- top most layer
 534  *   -------------------------------- graphic layer  2
 535  *   -------------------------------- graphic layer  1
 536  *   -------------------------------- graphic layer  0
 537  *   -------------------------------- video   layer -1
 538  *   -------------------------------- video   layer -2 <-- lowest layer
 539  * @param[in] layer A layer object
 540  * @param[out] zpos The zpos
 541  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 542  * @see tdm_layer_set_video_pos, tdm_layer_capability
 543  */
 544 tdm_error
 545 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
 546
 547 /**
 548  * @brief Set the property which has a given id.
 549  * @param[in] layer A layer object
 550  * @param[in] id The property id
 551  * @param[in] value The value
 552  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 553  */
 554 tdm_error
 555 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
 556
 557 /**
 558  * @brief Get the property which has a given id.
 559  * @param[in] layer A layer object
 560  * @param[in] id The property id
 561  * @param[out] value The value
 562  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 563  */
 564 tdm_error
 565 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
 566
 567 /**
 568  * @brief Set the geometry information to a layer object
 569  * @details The geometry information will be applied when the output object
 570  * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
 571  * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
 572  * src_config.
 573  * @param[in] layer A layer object
 574  * @param[in] info The geometry information
 575  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 576  * @see tdm_output_commit
 577  */
 578 tdm_error
 579 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
 580
 581 /**
 582  * @brief Get the geometry information to a layer object
 583  * @param[in] layer A layer object
 584  * @param[out] info The geometry information
 585  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 586  */
 587 tdm_error
 588 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
 589
 590 /**
 591  * @brief Set a TDM buffer to a layer object
 592  * @details A TDM buffer will be applied when the output object
 593  * of a layer object is committed.
 594  * @param[in] layer A layer object
 595  * @param[in] buffer A TDM buffer
 596  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 597  * @see tdm_output_commit
 598  */
 599 tdm_error
 600 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
 601
 602 /**
 603  * @brief Unset a TDM buffer from a layer object
 604  * @details When this function is called, a current showing buffer will be
 605  * disappeared from screen. Then nothing is showing on a layer object.
 606  * @param[in] layer A layer object
 607  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 608  */
 609 tdm_error
 610 tdm_layer_unset_buffer(tdm_layer *layer);
 611
 612 /**
 613  * @brief Get a displaying TDM buffer from a layer object
 614  * @details A displaying TDM buffer is a current showing buffer on screen
 615  * that is set to layer object and applied output object of a layer object.
 616  * @param[in] layer A layer object
 617  * @return A TDM buffer if success. Otherwise, NULL.
 618  */
 619 tbm_surface_h
 620 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
 621
 622 /**
 623  * @brief Set a TBM surface_queue to a layer object
 624  * @details A TBM surface_queue will be applied when the output object
 625  * of a layer object is committed. and TDM layer will be automatically updated
 626  * @param[in] layer A layer object
 627  * @param[in] buffer_queue A TBM surface_queue
 628  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 629  * @see tdm_output_commit
 630  */
 631 tdm_error
 632 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
 633
 634 /**
 635  * @brief Unset a TBM surface_queue from a layer object
 636  * @details When this function is called, a current surface_queue will be
 637  * disappeared from screen. Then nothing is showing on a layer object.
 638  * @param[in] layer A layer object
 639  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 640  */
 641 tdm_error
 642 tdm_layer_unset_buffer_queue(tdm_layer *layer);
 643
 644 /**
 645  * @brief Check wheter a layer object is available for a frontend user to use.
 646  * @details A layer object is not usable if a TDM buffer is showing on screen
 647  * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
 648  * will become usable.
 649  * @param[in] layer A layer object
 650  * @param[out] usable 1 if usable, 0 if not usable
 651  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 652  */
 653 tdm_error
 654 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
 655
 656 /**
 657  * @brief Set the relative zpos to a VIDEO layer object
 658  * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
 659  * it is more than the maximum zpos of GRAPHIC layers.
 660  * @param[in] layer A VIDEO layer object
 661  * @param[in] zpos The zpos
 662  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 663  * @see tdm_layer_get_zpos, tdm_layer_capability
 664  */
 665 tdm_error
 666 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
 667
 668 /**
 669  * @brief Create a capture object of a layer object
 670  * @param[in] layer A layer object
 671  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 672  * @return A capture object
 673  * @see tdm_capture_destroy
 674  */
 675 tdm_capture *
 676 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
 677
 678 /**
 679  * @brief Get buffer flags from a layer object
 680  * @param[in] layer A layer object
 681  * @param[out] flags a buffer flags value
 682  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 683  */
 684 tdm_error
 685 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
 686
 687 /**
 688  * @brief Destroy a pp object
 689  * @param[in] pp A pp object
 690  * @see tdm_display_create_pp
 691  */
 692 void
 693 tdm_pp_destroy(tdm_pp *pp);
 694
 695 /**
 696  * @brief Set the geometry information to a pp object
 697  * @param[in] pp A pp object
 698  * @param[in] info The geometry information
 699  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 700  * @see tdm_pp_commit
 701  */
 702 tdm_error
 703 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
 704
 705 /**
 706  * @brief Set the PP done handler to a pp object
 707  * @details
 708  * The user PP done handler will be called after converting a source buffer's image
 709  * to a destination buffer.
 710  * @param[in] pp A pp object
 711  * @param[in] func A user PP done handler
 712  * @param[in] user_data The user data
 713  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 714  */
 715 tdm_error
 716 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
 717
 718 /**
 719  * @brief Attach a source buffer and a destination buffer to a pp object
 720  * @param[in] pp A pp object
 721  * @param[in] src A source buffer
 722  * @param[in] dst A destination buffer
 723  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 724  * @see tdm_pp_commit, tdm_pp_set_done_handler
 725  */
 726 tdm_error
 727 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
 728
 729 /**
 730  * @brief Commit changes for a pp object
 731  * @param[in] pp A pp object
 732  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 733  */
 734 tdm_error
 735 tdm_pp_commit(tdm_pp *pp);
 736
 737 /**
 738  * @brief Destroy a capture object
 739  * @param[in] capture A capture object
 740  * @see tdm_output_create_capture, tdm_layer_create_capture
 741  */
 742 void
 743 tdm_capture_destroy(tdm_capture *capture);
 744
 745 /**
 746  * @brief Set the geometry information to a capture object
 747  * @param[in] capture A capture object
 748  * @param[in] info The geometry information
 749  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 750  * @see tdm_capture_commit
 751  */
 752 tdm_error
 753 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
 754
 755 /**
 756  * @brief Set the capture done handler to a capture object
 757  * @details
 758  * The user capture done handler will be called after capturing a screen into a
 759  * buffer.
 760  * @param[in] capture A capture object
 761  * @param[in] func A user capture done handler
 762  * @param[in] user_data The user data
 763  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 764  */
 765 tdm_error
 766 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
 767
 768 /**
 769  * @brief Attach a TDM buffer to a capture object
 770  * @param[in] capture A capture object
 771  * @param[in] buffer A TDM buffer
 772  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 773  * @see tdm_capture_commit, tdm_capture_set_done_handler
 774  */
 775 tdm_error
 776 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
 777
 778 /**
 779  * @brief Commit changes for a capture object
 780  * @param[in] capture A capture object
 781  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 782  */
 783 tdm_error
 784 tdm_capture_commit(tdm_capture *capture);
 785
 786 /**
 787  * @brief The release handler of a TDM buffer
 788  * @param[in] buffer A TDM buffer
 789  * @param[in] user_data user data
 790  * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
 791  */
 792 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
 793                                                                                    void *user_data);
 794
 795 /**
 796  * @brief Add a release handler to a TDM buffer
 797  * @details
 798  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
 799  * becomes available for a next job. A TDM buffer can be used for TDM to show
 800  * it on screen or to capture an output and a layer. After all operations,
 801  * TDM will release it immediately when TDM doesn't need it any more.
 802  * @param[in] buffer A TDM buffer
 803  * @param[in] func A release handler
 804  * @param[in] user_data user data
 805  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 806  * @see tdm_buffer_remove_release_handler
 807  */
 808 tdm_error
 809 tdm_buffer_add_release_handler(tbm_surface_h buffer,
 810                                                            tdm_buffer_release_handler func, void *user_data);
 811
 812 /**
 813  * @brief Remove a release handler from a TDM buffer
 814  * @param[in] buffer A TDM buffer
 815  * @param[in] func A release handler
 816  * @param[in] user_data user data
 817  * @see tdm_buffer_add_release_handler
 818  */
 819 void
 820 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
 821                                                                   tdm_buffer_release_handler func, void *user_data);
 822
 823 /**
 824  * @brief The handler of a vblank object
 825  * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
 826  */
 827 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
 828                                                                    unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 829
 830 /**
 831  * @brief Create a vblank object
 832  * @param[in] dpy A display object
 833  * @param[in] output A output object
 834  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 835  * @return A vblank object
 836  * @see #tdm_vblank_destroy
 837  */
 838 tdm_vblank*
 839 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
 840
 841 /**
 842  * @brief Destroy a vblank object
 843  * @param[in] vblank A vblank object
 844  * @see #tdm_vblank_create
 845  */
 846 void
 847 tdm_vblank_destroy(tdm_vblank *vblank);
 848
 849 /**
 850  * @brief Set the fps to a vblank object
 851  * @details Default is the @b vertical @b refresh @b rate of the given output.
 852  * @param[in] vblank A vblank object
 853  * @param[in] fps over 0
 854  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 855  */
 856 tdm_error
 857 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
 858
 859 /**
 860  * @brief Set the offset(milli-second) to a vblank object
 861  * @details Default is @b 0.
 862  * @param[in] vblank A vblank object
 863  * @param[in] offset the offset(milli-second)
 864  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 865  */
 866 tdm_error
 867 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
 868
 869 /**
 870  * @brief Enable/Disable the fake vblank to a vblank object
 871  * @details
 872  * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
 873  * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
 874  * as success.
 875  * @param[in] vblank A vblank object
 876  * @param[in] enable_fake 1:enable, 0:disable
 877  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 878  */
 879 tdm_error
 880 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
 881
 882 /**
 883  * @brief Get the fake vblank
 884  * @param[in] vblank A vblank object
 885  * @return 1 if enable. Otherwise, 0.
 886  */
 887 unsigned int
 888 tdm_vblank_get_enable_fake(tdm_vblank *vblank);
 889
 890 /**
 891  * @brief Wait for a vblank
 892  * @details
 893  * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
 894  * SHOULD be called after the given interval. \n
 895  * The sequence value of tdm_vblank_handler is the relative value of fps.
 896  * If fps = 10, this sequence value should be increased by 10 during 1 second.
 897  * @param[in] vblank A vblank object
 898  * @param[in] req_sec The vblank request time(second)
 899  * @param[in] req_usec The vblank request time(micro-second)
 900  * @param[in] interval The vblank interval
 901  * @param[in] func The user vblank handler
 902  * @param[in] user_data The user data
 903  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 904  */
 905 tdm_error
 906 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
 907                                 unsigned int interval, tdm_vblank_handler func, void *user_data);
 908
 909 /**
 910  * @brief Wait for a vblank with the target sequence number
 911  * @param[in] vblank A vblank object
 912  * @param[in] req_sec The vblank request time(second)
 913  * @param[in] req_usec The vblank request time(micro-second)
 914  * @param[in] sequence The target sequence number
 915  * @param[in] func The user client vblank handler
 916  * @param[in] user_data The user data
 917  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 918  */
 919 tdm_error
 920 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
 921                                         unsigned int sequence, tdm_vblank_handler func, void *user_data);
 922
 923 #ifdef __cplusplus
 924 }
 925 #endif
 926
 927 #endif /* _TDM_H_ */