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