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