add tdm_vblank_set_client_ignore_global_fps
[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,
636                                                                         tdm_hwc_region damage, tdm_hwc_window **composited_wnds,
637                                                                         uint32_t num_wnds);
638
639 /**
640  * @brief Validate the output
641  * @details Instructs the device to inspect all of the layer state and
642  * determine if there are any composition type changes necessary before
643  * presenting the output. Permitted changes are described in the definition
644  * of tdm_hwc_window_composition_t above.
645  * @param[in] output A output object
646  * @param[out] num_types The number of composition type changes required by
647  * the device; if greater than 0, the client must either set and validate new
648  * types, or call tdm_output_hwc_accept_changes() to accept the changes returned by
649  * tdm_output_hwc_get_changed_composition_types(); must be the same as the number of
650  * changes returned by tdm_output_hwc_get_changed_composition_types (see the
651  * declaration of that function for more information); pointer will be non-NULL
652  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
653  * @since 2.0.0
654  */
655 tdm_error
656 tdm_output_hwc_validate(tdm_output *output, uint32_t *num_types);
657
658 /**
659  * @brief Set the 'need to validate' handler for the 'output'
660  *
661  * @details During backend's work it may need to ask for the revalidation
662  * (make client (E20) do tdm_output_hwc_validate() again), so a 'hndl' will
663  * be called as such need happen. Only one handler per output is supported.
664  *
665  * @param[in] output The output object a hndl is going to be registered for.
666  * @param[in] hndl The handler which will be called on the 'need to validate' event.
667  *
668  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
669  * @since 2.0.0
670  */
671 tdm_error
672 tdm_output_hwc_set_need_validate_handler(tdm_output *output,
673                 tdm_output_need_validate_handler hndl);
674
675 /**
676  * @brief Get changed composition types
677  * @details Retrieves the windows for which the device requires a different
678  * composition type than had been set prior to the last call to tdm_output_hwc_validate().
679  * The client will either update its state with these types and call
680  * tdm_output_hwc_accept_changes, or will set new types and attempt to validate the
681  * display again.
682  * windows and types may be NULL to retrieve the number of elements which
683  * will be returned. The number of elements returned must be the same as the
684  * value returned in num_types from the last call to tdm_output_hwc_validate().
685  * @param[in] output A output object
686  * @param[out] num_elements If windows or types were NULL, the number of layers
687  * and types which would have been returned; if both were non-NULL, the
688  * number of elements returned in layers and types, which must not exceed
689  * the value stored in num_elements prior to the call; pointer will be
690  * non-NULL
691  * @param[in] output A output object
692  * @param[out] windows An array of windows
693  * @param[out] composition_types An array of composition types, each corresponding
694  * to an element of windows
695  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
696  * @since 2.0.0
697  */
698 tdm_error
699 tdm_output_hwc_get_changed_composition_types(tdm_output *output,uint32_t *num_elements,
700                                                                                  tdm_hwc_window **hwc_window,
701                                                                                  tdm_hwc_window_composition *composition_types);
702
703 /**
704  * @brief Accepts the changes required by the device
705  * @details Accepts the changes required by the device from the previous
706  * tdm_output_hwc_validate() call (which may be queried using
707  * tdm_output_get_chaged_composition_types()) and revalidates the display. This
708  * function is equivalent to requesting the changed types from
709  * tdm_output_get_chaged_composition_types(), setting those types on the
710  * corresponding windows, and then calling tdm_output_hwc_validate again.
711  * After this call it must be valid to present this display. Calling this after
712  * tdm_output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
713  * should have no other effect.
714  * @param[in] output A output object
715  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
716  * @since 2.0.0
717  */
718 tdm_error
719 tdm_output_hwc_accept_changes(tdm_output *output);
720
721 /**
722  * @brief Get a target buffer queue
723  * @details Buffers from target buffer queue will receive the output of
724  * client composition. Window marked as TDM_COMPOSITION_CLIENT or
725  * TDM_COMPOSITION_DEVICE_CANDIDATE will be composited into this buffers
726  * prior to the call to tdm_output_commit().
727  * @param[in] output A output object
728  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
729  * @return A buffer queue
730  * @since 2.0.0
731  */
732 tbm_surface_queue_h
733 tdm_output_hwc_get_target_buffer_queue(tdm_output *output, tdm_error *error);
734
735 /**
736  * @brief Get the supported format array for video hwc windows of a output object.
737  * @param[in] output A output object
738  * @param[out] formats The available format array
739  * @param[out] count The count of formats
740  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
741  */
742 tdm_error
743 tdm_output_hwc_get_video_supported_formats(tdm_layer *layer, const tbm_format **formats,
744                                                                 int *count);
745
746 /**
747  * @brief Get the capabilities of a layer object.
748  * @param[in] layer A layer object
749  * @param[out] capabilities The capabilities of a layer object
750  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
751  */
752 tdm_error
753 tdm_layer_get_capabilities(tdm_layer *layer,
754                                                    tdm_layer_capability *capabilities);
755
756 /**
757  * @brief Get the available format array of a layer object.
758  * @param[in] layer A layer object
759  * @param[out] formats The available format array
760  * @param[out] count The count of formats
761  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
762  */
763 tdm_error
764 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
765                                                                 int *count);
766
767 /**
768  * @brief Get the available property array of a layer object.
769  * @param[in] layer A layer object
770  * @param[out] props The available property array
771  * @param[out] count The count of properties
772  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
773  */
774 tdm_error
775 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
776                                                                    int *count);
777
778 /**
779  * @brief Get the zpos of a layer object.
780  * @details
781  * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
782  * - But the zpos of VIDEO layers will be decided by a backend module side.
783  * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
784  * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
785  * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
786  *   -------------------------------- graphic layer  3 <-- top most layer
787  *   -------------------------------- graphic layer  2
788  *   -------------------------------- graphic layer  1
789  *   -------------------------------- graphic layer  0
790  *   -------------------------------- video   layer -1
791  *   -------------------------------- video   layer -2 <-- lowest layer
792  * @param[in] layer A layer object
793  * @param[out] zpos The zpos
794  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
795  * @see tdm_layer_set_video_pos, tdm_layer_capability
796  */
797 tdm_error
798 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
799
800 /**
801  * @brief Set the property which has a given id.
802  * @param[in] layer A layer object
803  * @param[in] id The property id
804  * @param[in] value The value
805  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
806  */
807 tdm_error
808 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
809
810 /**
811  * @brief Get the property which has a given id.
812  * @param[in] layer A layer object
813  * @param[in] id The property id
814  * @param[out] value The value
815  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
816  */
817 tdm_error
818 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
819
820 /**
821  * @brief Set the geometry information to a layer object
822  * @details The geometry information will be applied when the output object
823  * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
824  * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
825  * src_config.
826  * @param[in] layer A layer object
827  * @param[in] info The geometry information
828  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
829  * @see tdm_layer_commit
830  */
831 tdm_error
832 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
833
834 /**
835  * @brief Get the geometry information to a layer object
836  * @param[in] layer A layer object
837  * @param[out] info The geometry information
838  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
839  */
840 tdm_error
841 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
842
843 /**
844  * @brief Set a TDM buffer to a layer object
845  * @details A TDM buffer will be applied when the output object
846  * of a layer object is committed.
847  * @param[in] layer A layer object
848  * @param[in] buffer A TDM buffer
849  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
850  * @see tdm_layer_commit
851  */
852 tdm_error
853 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
854
855 /**
856  * @brief Unset a TDM buffer from a layer object
857  * @details When this function is called, a current showing buffer will be
858  * disappeared from screen. Then nothing is showing on a layer object.
859  * @param[in] layer A layer object
860  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
861  */
862 tdm_error
863 tdm_layer_unset_buffer(tdm_layer *layer);
864
865 /**
866  * @brief Commit changes for a layer object
867  * @details After all change of a layer object are applied, a user commit handler
868  * will be called.
869  * @param[in] layer A layer object
870  * @param[in] func A user commit handler
871  * @param[in] user_data The user data
872  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
873  */
874 tdm_error
875 tdm_layer_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
876
877 tdm_error
878 tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing);
879
880 /**
881  * @brief Remove the user commit handler
882  * @param[in] layer A layer object
883  * @param[in] func A user commit handler
884  * @param[in] user_data The user data
885  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
886  */
887 tdm_error
888 tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
889
890 /**
891  * @brief Get a displaying TDM buffer from a layer object
892  * @details A displaying TDM buffer is a current showing buffer on screen
893  * that is set to layer object and applied output object of a layer object.
894  * @param[in] layer A layer object
895  * @return A TDM buffer if success. Otherwise, NULL.
896  */
897 tbm_surface_h
898 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
899
900 /**
901  * @brief Set a TBM surface_queue to a layer object
902  * @details A TBM surface_queue will be applied when the output object
903  * of a layer object is committed. and TDM layer will be automatically updated
904  * @param[in] layer A layer object
905  * @param[in] buffer_queue A TBM surface_queue
906  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
907  * @see tdm_layer_commit
908  */
909 tdm_error
910 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
911
912 /**
913  * @brief Unset a TBM surface_queue from a layer object
914  * @details When this function is called, a current surface_queue will be
915  * disappeared from screen. Then nothing is showing on a layer object.
916  * @param[in] layer A layer object
917  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
918  */
919 tdm_error
920 tdm_layer_unset_buffer_queue(tdm_layer *layer);
921
922 /**
923  * @brief Check wheter a layer object is available for a frontend user to use.
924  * @details A layer object is not usable if a TDM buffer is showing on screen
925  * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
926  * will become usable.
927  * @param[in] layer A layer object
928  * @param[out] usable 1 if usable, 0 if not usable
929  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
930  */
931 tdm_error
932 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
933
934 /**
935  * @brief Set the relative zpos to a VIDEO layer object
936  * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
937  * it is more than the maximum zpos of GRAPHIC layers.
938  * @param[in] layer A VIDEO layer object
939  * @param[in] zpos The zpos
940  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
941  * @see tdm_layer_get_zpos, tdm_layer_capability
942  */
943 tdm_error
944 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
945
946 /**
947  * @brief Create a capture object of a layer object
948  * @param[in] layer A layer object
949  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
950  * @return A capture object
951  * @see tdm_capture_destroy
952  */
953 tdm_capture *
954 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
955
956 /**
957  * @brief Get buffer flags from a layer object
958  * @param[in] layer A layer object
959  * @param[out] flags a buffer flags value
960  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
961  */
962 tdm_error
963 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
964
965 /**
966  * @brief Get a buffer queue for the window object
967  * @details These buffers are used to composite by hardware a client content in
968  * the nocomp mode.
969  * @param[in] hwc_window A window object
970  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
971  * @return A tbm buffer queue
972  * @since 2.0.0
973  */
974 tbm_surface_queue_h
975 tdm_hwc_window_get_tbm_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error);
976
977 /**
978  * @brief Sets the desired Z order of the given window. A window with
979  * a greater Z value occludes a window with a lesser Z value.
980  * @param[in] hwc_window A window object
981  * @param[in] z the new Z order
982  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
983  * @since 2.0.0
984  */
985 tdm_error
986 tdm_hwc_window_set_zpos(tdm_hwc_window *hwc_window, int32_t zpos);
987
988 /**
989  * @brief Sets the desired composition type of the given window.
990  * @details During tdm_output_hwc_validate(), the device may request changes to
991  * the composition types of any of the layers as described in the definition
992  * of tdm_hwc_window_composition_t above.
993  * @param[in] hwc_window A window object
994  * @param[in] composition_type The new composition type
995  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
996  * @since 2.0.0
997  */
998 tdm_error
999 tdm_hwc_window_set_composition_type(tdm_hwc_window *hwc_window,
1000                                                                         tdm_hwc_window_composition composition_type);
1001
1002 /**
1003  * @brief Set the buffer damage
1004  * @details Provides the region of the source buffer which has been modified
1005  * since the last frame. This region does not need to be validated before
1006  * calling tdm_output_commit().
1007  * Once set through this function, the damage region remains the same until a
1008  * subsequent call to this function.
1009  * If damage.num_rects > 0, then it may be assumed that any portion of the source
1010  * buffer not covered by one of the rects has not been modified this frame. If
1011  * damage.num_rects == 0, then the whole source buffer must be treated as if it
1012  * has been modified.
1013  * If the layer's contents are not modified relative to the prior frame, damage
1014  * will contain exactly one empty rect([0, 0, 0, 0]).
1015  * The damage rects are relative to the pre-transformed buffer, and their origin
1016  * is the top-left corner. They will not exceed the dimensions of the latched
1017  * buffer.
1018  * @param[in] hwc_window A window object
1019  * @param[in] damage The new buffer damage region
1020  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1021  * @since 2.0.0
1022  */
1023 tdm_error
1024 tdm_hwc_window_set_buffer_damage(tdm_hwc_window *hwc_window, tdm_hwc_region damage);
1025
1026 /**
1027  * @brief Set the information to a window object
1028  * @details The information will be applied when the output object of a window
1029  * object is committed.
1030  * @param[in] hwc_window A window object
1031  * @param[in] info The information
1032  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1033  * @since 2.0.0
1034  */
1035 tdm_error
1036 tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info);
1037
1038 /**
1039  * @brief Set a TBM buffer to a window object
1040  * @details A TBM buffer will be applied when the output object of a layer
1041  * object is committed.
1042  * @param[in] hwc_window A window object
1043  * @param[in] buffer A TDM buffer
1044  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1045  * @return #TDM_ERROR_BUSY if #hwc_window can't be updated right now, this
1046  * can happen if #hwc_window is involved in the smooth transition from
1047  * DEVICE to CLIENT, this shouldn't be interpreted like some critical error.
1048  * @since 2.0.0
1049  */
1050 tdm_error
1051 tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer);
1052
1053 /**
1054  * @brief Set a flags to a window object
1055  * @param[in] hwc_window A window object
1056  * @param[in] flags A hwc_window flags
1057  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1058  * @since 2.0.0
1059  */
1060 tdm_error
1061 tdm_hwc_window_set_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
1062
1063 /**
1064  * @brief Unset a flags from a window object
1065  * @param[in] hwc_window A window object
1066  * @param[in] flags A hwc_window flags
1067  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1068  * @since 2.0.0
1069  */
1070 tdm_error
1071 tdm_hwc_window_unset_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
1072
1073 /**
1074  * @brief Get the available property array  of a video hwc window object.
1075  * @param[in] hwc window A video hwc window object
1076  * @param[out] props The available property array
1077  * @param[out] count The count of properties
1078  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1079  */
1080 tdm_error
1081 tdm_hwc_window_video_get_available_properties(tdm_hwc_window *hwc_window,
1082                                                                   const tdm_prop **props, int *count);
1083
1084 /**
1085  * @brief Get the property which has a given id.
1086  * @param[in] hwc window A video hwc window object
1087  * @param[in] id The property id
1088  * @param[out] value The value
1089  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1090  */
1091 tdm_error
1092 tdm_hwc_window_video_get_property(tdm_hwc_window *hwc_window, uint32_t id,
1093                                                                   tdm_value *value);
1094
1095 /**
1096  * @brief Set the property which has a given id.
1097  * @param[in] hwc window  A video hwc window object
1098  * @param[in] id The property id
1099  * @param[in] value The value
1100  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1101  */
1102 tdm_error
1103 tdm_hwc_window_video_set_property(tdm_hwc_window *hwc_window, uint32_t id,
1104                                                                   tdm_value value);
1105
1106 /**
1107  * @brief Get the window video capability
1108  * @param[in] hwc_window A window object
1109  * @param[out] video_capability A hwc window video capability
1110  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1111  * @since 2.0.0
1112  */
1113 tdm_error
1114 tdm_hwc_window_video_get_capability(tdm_hwc_window *hwc_window,
1115                                                                         tdm_hwc_window_video_capability *video_capability);
1116
1117 /**
1118  * @brief Destroy a pp object
1119  * @param[in] pp A pp object
1120  * @see tdm_display_create_pp
1121  */
1122 void
1123 tdm_pp_destroy(tdm_pp *pp);
1124
1125 /**
1126  * @brief Set the geometry information to a pp object
1127  * @param[in] pp A pp object
1128  * @param[in] info The geometry information
1129  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1130  * @see tdm_pp_commit
1131  */
1132 tdm_error
1133 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
1134
1135 /**
1136  * @brief Set the PP done handler to a pp object
1137  * @details
1138  * The user PP done handler will be called after converting a source buffer's image
1139  * to a destination buffer.
1140  * @param[in] pp A pp object
1141  * @param[in] func A user PP done handler
1142  * @param[in] user_data The user data
1143  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1144  */
1145 tdm_error
1146 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
1147
1148 /**
1149  * @brief Attach a source buffer and a destination buffer to a pp object
1150  * @param[in] pp A pp object
1151  * @param[in] src A source buffer
1152  * @param[in] dst A destination buffer
1153  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1154  * @see tdm_pp_commit, tdm_pp_set_done_handler
1155  */
1156 tdm_error
1157 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1158
1159 /**
1160  * @brief Commit changes for a pp object
1161  * @param[in] pp A pp object
1162  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1163  */
1164 tdm_error
1165 tdm_pp_commit(tdm_pp *pp);
1166
1167 /**
1168  * @brief Destroy a capture object
1169  * @param[in] capture A capture object
1170  * @see tdm_output_create_capture, tdm_layer_create_capture
1171  */
1172 void
1173 tdm_capture_destroy(tdm_capture *capture);
1174
1175 /**
1176  * @brief Set the geometry information to a capture object
1177  * @param[in] capture A capture object
1178  * @param[in] info The geometry information
1179  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1180  * @see tdm_capture_commit
1181  */
1182 tdm_error
1183 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
1184
1185 /**
1186  * @brief Set the capture done handler to a capture object
1187  * @details
1188  * The user capture done handler will be called after capturing a screen into a
1189  * buffer.
1190  * @param[in] capture A capture object
1191  * @param[in] func A user capture done handler
1192  * @param[in] user_data The user data
1193  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1194  */
1195 tdm_error
1196 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
1197
1198 /**
1199  * @brief Attach a TDM buffer to a capture object
1200  * @param[in] capture A capture object
1201  * @param[in] buffer A TDM buffer
1202  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1203  * @see tdm_capture_commit, tdm_capture_set_done_handler
1204  */
1205 tdm_error
1206 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
1207
1208 /**
1209  * @brief Commit changes for a capture object
1210  * @param[in] capture A capture object
1211  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1212  */
1213 tdm_error
1214 tdm_capture_commit(tdm_capture *capture);
1215
1216 /**
1217  * @brief The release handler of a TDM buffer
1218  * @param[in] buffer A TDM buffer
1219  * @param[in] user_data user data
1220  * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
1221  */
1222 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
1223                                                                                    void *user_data);
1224
1225 /**
1226  * @brief Add a release handler to a TDM buffer
1227  * @details
1228  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1229  * becomes available for a next job. A TDM buffer can be used for TDM to show
1230  * it on screen or to capture an output and a layer. After all operations,
1231  * TDM will release it immediately when TDM doesn't need it any more.
1232  * @param[in] buffer A TDM buffer
1233  * @param[in] func A release handler
1234  * @param[in] user_data user data
1235  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1236  * @see tdm_buffer_remove_release_handler
1237  */
1238 tdm_error
1239 tdm_buffer_add_release_handler(tbm_surface_h buffer,
1240                                                            tdm_buffer_release_handler func, void *user_data);
1241
1242 /**
1243  * @brief Remove a release handler from a TDM buffer
1244  * @param[in] buffer A TDM buffer
1245  * @param[in] func A release handler
1246  * @param[in] user_data user data
1247  * @see tdm_buffer_add_release_handler
1248  */
1249 void
1250 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
1251                                                                   tdm_buffer_release_handler func, void *user_data);
1252
1253 /**
1254  * @brief The handler of a vblank object
1255  * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
1256  */
1257 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
1258                                                                    unsigned int tv_sec, unsigned int tv_usec, void *user_data);
1259
1260 /**
1261  * @brief Set the vblank fps for the given PID and name.
1262  * @param[in] pid The process ID
1263  * @param[in] name The client vblank name
1264  * @param[in] fps The client vblank fps
1265  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1266  */
1267 tdm_error
1268 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
1269
1270 /**
1271  * @brief Set the ignore global fps for the given PID and name.
1272  * @param[in] pid The process ID
1273  * @param[in] name The client vblank name
1274  * @param[in] ignore 1: ignore 0:not ignore(default)
1275  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1276  */
1277 tdm_error
1278 tdm_vblank_set_client_ignore_global_fps(unsigned int pid, const char *name, unsigned int ignore);
1279
1280 /**
1281  * @brief Set the vblank global fps for the entire system.
1282  * @param[in] enable 1:enable, 0:disable
1283  * @param[in] fps The vblank global fps
1284  * @details
1285  * This global fps will be applied to all client's vblanks for all outputs.
1286  * If the client's vblank fps is less than this, the global fps will be ignored
1287  * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1288  * the global fps, it will be ignored also.
1289  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1290  */
1291 tdm_error
1292 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps);
1293
1294 /**
1295  * @brief Add 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  * @details
1300  * The user vblank create handler will be called when new vblank object created.
1301  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1302  */
1303 tdm_error
1304 tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data);
1305
1306 /**
1307  * @brief Remove the vblank create handler.
1308  * @param[in] dpy A display object
1309  * @param[in] func The user vblank create handler
1310  * @param[in] user_data The user data
1311  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1312  */
1313 void
1314 tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data);
1315
1316 /**
1317  * @brief Create a vblank object
1318  * @param[in] dpy A display object
1319  * @param[in] output A output object
1320  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1321  * @return A vblank object
1322  * @see #tdm_vblank_destroy
1323  */
1324 tdm_vblank*
1325 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
1326
1327 /**
1328  * @brief Destroy a vblank object
1329  * @param[in] vblank A vblank object
1330  * @see #tdm_vblank_create
1331  */
1332 void
1333 tdm_vblank_destroy(tdm_vblank *vblank);
1334
1335 /**
1336  * @brief Get the client PID for a vblank object
1337  * @param[in] vblank A vblank object
1338  * @param[out] pid PID of vblank's client
1339  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1340  */
1341 tdm_error
1342 tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid);
1343
1344 /**
1345  * @brief Set the name to a vblank object
1346  * @details The default name is "unknown"
1347  * @param[in] vblank A vblank object
1348  * @param[in] name vblank name
1349  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1350  */
1351 tdm_error
1352 tdm_vblank_set_name(tdm_vblank *vblank, const char *name);
1353
1354 /**
1355  * @brief Get the name for a vblank object
1356  * @details The default name is "unknown"
1357  * @param[in] vblank A vblank object
1358  * @param[out] name vblank name
1359  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1360  */
1361 tdm_error
1362 tdm_vblank_get_name(tdm_vblank *vblank, const char **name);
1363
1364 /**
1365  * @brief Set the fps to a vblank object
1366  * @details Default is the @b vertical @b refresh @b rate of the given output.
1367  * It could be ignored when the fixed fps is set by #tdm_vblank_set_fixed_fps
1368  * @param[in] vblank A vblank object
1369  * @param[in] fps over 0
1370  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1371  */
1372 tdm_error
1373 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
1374
1375 /**
1376  * @brief Get the fps for a vblank object
1377  * @param[in] vblank A vblank object
1378  * @param[out] fps over 0
1379  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1380  */
1381 tdm_error
1382 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps);
1383
1384 /**
1385  * @brief Set the fixed fps to a vblank object
1386  * @details
1387  * It could be ignored when the global fps is set by #tdm_vblank_enable_global_fps
1388  * @param[in] vblank A vblank object
1389  * @param[in] fps over 0
1390  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1391  */
1392 tdm_error
1393 tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps);
1394
1395 /**
1396  * @brief Ignore the vblank global fps
1397  * @details
1398  * The global fps will be applied to all client's vblanks for all outputs.
1399  * If the client's vblank fps is less than this, the global fps will be ignored
1400  * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1401  * the global fps, it will be ignored also.
1402  * @param[in] vblank A vblank object
1403  * @param[in] ignore 1: ignore 0:not ignore(default)
1404  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1405  */
1406 tdm_error
1407 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore);
1408
1409 /**
1410  * @brief Set the offset(milli-second) to a vblank object
1411  * @details Default is @b 0.
1412  * @param[in] vblank A vblank object
1413  * @param[in] offset the offset(milli-second)
1414  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1415  */
1416 tdm_error
1417 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
1418
1419 /**
1420  * @brief Get the offset(milli-second) for a vblank object
1421  * @param[in] vblank A vblank object
1422  * @param[out] offset the offset(milli-second)
1423  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1424  */
1425 tdm_error
1426 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset);
1427
1428 /**
1429  * @brief Enable/Disable the fake vblank to a vblank object
1430  * @details
1431  * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
1432  * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
1433  * as success.
1434  * @param[in] vblank A vblank object
1435  * @param[in] enable_fake 1:enable, 0:disable
1436  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1437  */
1438 tdm_error
1439 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
1440
1441 /**
1442  * @brief Get the fake vblank
1443  * @param[in] vblank A vblank object
1444  * @param[out] enable_fake 1:enable, 0:disable
1445  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1446  */
1447 tdm_error
1448 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
1449
1450 /**
1451  * @brief Wait for a vblank
1452  * @details
1453  * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
1454  * SHOULD be called after the given interval. \n
1455  * The sequence value of tdm_vblank_handler is the relative value of fps.
1456  * If fps = 10, this sequence value should be increased by 10 during 1 second.
1457  * @param[in] vblank A vblank object
1458  * @param[in] req_sec The vblank request time(second)
1459  * @param[in] req_usec The vblank request time(micro-second)
1460  * @param[in] interval The vblank interval
1461  * @param[in] func The user vblank handler
1462  * @param[in] user_data The user data
1463  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1464  */
1465 tdm_error
1466 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1467                                 unsigned int interval, tdm_vblank_handler func, void *user_data);
1468
1469 /**
1470  * @brief Wait for a vblank with the target sequence number
1471  * @param[in] vblank A vblank object
1472  * @param[in] req_sec The vblank request time(second)
1473  * @param[in] req_usec The vblank request time(micro-second)
1474  * @param[in] sequence The target sequence number
1475  * @param[in] func The user client vblank handler
1476  * @param[in] user_data The user data
1477  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1478  */
1479 tdm_error
1480 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1481                                         unsigned int sequence, tdm_vblank_handler func, void *user_data);
1482
1483 #ifdef __cplusplus
1484 }
1485 #endif
1486
1487 #endif /* _TDM_H_ */