1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
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>
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:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
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.
34 **************************************************************************/
40 #include <tbm_surface.h>
41 #include <tbm_surface_queue.h>
42 #include <tbm_surface_internal.h>
44 #include "tdm_types.h"
52 * @brief The header file for a frontend user.
55 * #include <tdm.h> //for a frontend user
60 * @brief The display capability enumeration
63 TDM_DISPLAY_CAPABILITY_PP = (1 << 0), /**< if hardware supports pp operation */
64 TDM_DISPLAY_CAPABILITY_CAPTURE = (1 << 1), /**< if hardware supports capture operation */
65 } tdm_display_capability;
68 * @brief The output change handler
69 * @details This handler will be called when the status of a output object is
72 typedef void (*tdm_output_change_handler)(tdm_output *output,
73 tdm_output_change_type type,
78 * @brief Initialize a display object
79 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
80 * @return A display object
81 * @see tdm_display_deinit
84 tdm_display_init(tdm_error *error);
87 * @brief Deinitialize a display object
88 * @param[in] dpy A display object
89 * @see tdm_display_init
92 tdm_display_deinit(tdm_display *dpy);
95 * @brief Update a display object
97 * When new output is connected, a frontend user need to call this function.
98 * And a frontend user can the new output information with tdm_output_get_xxx functions.
99 * @param[in] dpy A display object
100 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
103 tdm_display_update(tdm_display *dpy);
106 * @brief Get the file descriptor
107 * @details TDM handles the events of fd with #tdm_display_handle_events.
108 * @param[in] dpy A display object
109 * @param[out] fd The file descriptor
110 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
111 * @see tdm_display_handle_events
114 tdm_display_get_fd(tdm_display *dpy, int *fd);
117 * @brief Handle the events
118 * @param[in] dpy A display object
119 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
120 * @see tdm_display_get_fd
123 tdm_display_handle_events(tdm_display *dpy);
126 * @brief Get the information of the TDM backend module.
127 * @param[in] dpy A display object
128 * @param[out] name The name of the TDM backend module
129 * @param[out] vendor The vendor of the TDM backend module
130 * @param[out] version The version of the TDM backend module
131 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
134 tdm_display_get_backend_info(tdm_display *dpy, const char **name,
135 const char **vendor, int *major, int *minor);
138 * @brief Get the capabilities of a display object.
139 * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
140 * @param[in] dpy A display object
141 * @param[out] capabilities The capabilities of a display object
142 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
145 tdm_display_get_capabilities(tdm_display *dpy,
146 tdm_display_capability *capabilities);
149 * @brief Get the pp capabilities of a display object.
150 * @param[in] dpy A display object
151 * @param[out] capabilities The pp capabilities
152 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
155 tdm_display_get_pp_capabilities(tdm_display *dpy,
156 tdm_pp_capability *capabilities);
159 * @brief Get the pp available format array of a display object.
160 * @param[in] dpy A display object
161 * @param[out] formats The pp available format array
162 * @param[out] count The count of formats
163 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
166 tdm_display_get_pp_available_formats(tdm_display *dpy,
167 const tbm_format **formats, int *count);
170 * @brief Get the pp available size of a display object.
171 * @details -1 means that a TDM backend module doesn't define the value.
172 * @param[in] dpy A display object
173 * @param[out] min_w The minimum width which TDM can handle
174 * @param[out] min_h The minimum height which TDM can handle
175 * @param[out] max_w The maximum width which TDM can handle
176 * @param[out] max_h The maximum height which TDM can handle
177 * @param[out] preferred_align The preferred align width which TDM can handle
178 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
181 tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
182 int *max_w, int *max_h, int *preferred_align);
185 * @brief Get the capture capabilities of a display object.
186 * @param[in] dpy A display object
187 * @param[out] capabilities The capture capabilities
188 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
191 tdm_display_get_capture_capabilities(tdm_display *dpy,
192 tdm_capture_capability *capabilities);
195 * @brief Get the capture available format array of a display object.
196 * @param[in] dpy A display object
197 * @param[out] formats The capture available format array
198 * @param[out] count The count of formats
199 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
202 tdm_display_get_catpure_available_formats(tdm_display *dpy,
203 const tbm_format **formats, int *count);
206 * @brief Get the capture available size of a display object.
207 * @details -1 means that a TDM backend module doesn't define the value.
208 * @param[in] dpy A display object
209 * @param[out] min_w The minimum width which TDM can handle
210 * @param[out] min_h The minimum height which TDM can handle
211 * @param[out] max_w The maximum width which TDM can handle
212 * @param[out] max_h The maximum height which TDM can handle
213 * @param[out] preferred_align The preferred align width which TDM can handle
214 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
217 tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
218 int *max_w, int *max_h, int *preferred_align);
221 * @brief Get the max layer counts which a display object can show on screen.
222 * @details -1 means that a TDM backend module doesn't define the value.
223 * @param[in] dpy A display object
224 * @param[out] count The max count of layers
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
228 tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count);
231 * @brief Get the output counts which a display object has.
232 * @param[in] dpy A display object
233 * @param[out] count The count of outputs
234 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
235 * @see tdm_display_get_output
238 tdm_display_get_output_count(tdm_display *dpy, int *count);
241 * @brief Get a output object which has the given index.
242 * @param[in] dpy A display object
243 * @param[in] index The index of a output object
244 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
245 * @return A output object if success. Otherwise, NULL.
246 * @see tdm_display_get_output_count
249 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
252 * @brief Create a pp object.
253 * @param[in] dpy A display object
254 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
255 * @return A pp object if success. Otherwise, NULL.
256 * @see tdm_pp_destroy
259 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
262 * @brief Get the capabilities of a output object.
263 * @param[in] output A output object
264 * @param[out] capabilities The capabilities of a output object
265 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
268 tdm_output_get_capabilities(tdm_output *output,
269 tdm_output_capability *capabilities);
272 * @brief Get the model information of a output object.
273 * @param[in] output A output object
274 * @param[out] maker The output maker.
275 * @param[out] model The output model.
276 * @param[out] name The output name.
277 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
280 tdm_output_get_model_info(tdm_output *output, const char **maker,
281 const char **model, const char **name);
284 * @brief Get the connection status of a output object.
285 * @param[in] output A output object
286 * @param[out] status The connection status.
287 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
290 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
293 * @brief Add a output change handler
294 * @details The handler will be called when the status of a
295 * output object is changed. connection, DPMS, etc.
296 * @param[in] output A output object
297 * @param[in] func A output change handler
298 * @param[in] user_data The user data
299 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
302 tdm_output_add_change_handler(tdm_output *output,
303 tdm_output_change_handler func,
307 * @brief Remove a output change handler
308 * @param[in] output A output object
309 * @param[in] func A output change handler
310 * @param[in] user_data The user data
311 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314 tdm_output_remove_change_handler(tdm_output *output,
315 tdm_output_change_handler func,
319 * @brief Get the connection type of a output object.
320 * @param[in] output A output object
321 * @param[out] type The connection type.
322 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
325 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
328 * @brief Get the layer counts which a output object has.
329 * @param[in] output A output object
330 * @param[out] count The count of layers
331 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
332 * @see tdm_output_get_layer
335 tdm_output_get_layer_count(tdm_output *output, int *count);
338 * @brief Get a layer object which has the given index.
339 * @param[in] output A output object
340 * @param[in] index The index of a layer object
341 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
342 * @return A layer object if success. Otherwise, NULL.
343 * @see tdm_output_get_layer_count
346 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
349 * @brief Get the available property array of a output object.
350 * @param[in] output A output object
351 * @param[out] props The available property array
352 * @param[out] count The count of properties
353 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
356 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
360 * @brief Get the available mode array of a output object.
361 * @param[in] output A output object
362 * @param[out] modes The available mode array
363 * @param[out] count The count of modes
364 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
367 tdm_output_get_available_modes(tdm_output *output,
368 const tdm_output_mode **modes, int *count);
371 * @brief Get the available size of a output object.
372 * @details -1 means that a TDM backend module doesn't define the value.
373 * @param[in] output A output object
374 * @param[out] min_w The minimum width which TDM can handle
375 * @param[out] min_h The minimum height which TDM can handle
376 * @param[out] max_w The maximum width which TDM can handle
377 * @param[out] max_h The maximum height which TDM can handle
378 * @param[out] preferred_align The preferred align width which TDM can handle
379 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
382 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
383 int *max_w, int *max_h, int *preferred_align);
386 * @brief Get the available cursor size of a output object.
387 * @details -1 means that a TDM backend module doesn't define the value.
388 * @param[in] output A output object
389 * @param[out] min_w The minimum width which TDM can handle
390 * @param[out] min_h The minimum height which TDM can handle
391 * @param[out] max_w The maximum width which TDM can handle
392 * @param[out] max_h The maximum height which TDM can handle
393 * @param[out] preferred_align The preferred align width which TDM can handle
394 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
397 tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
398 int *max_w, int *max_h, int *preferred_align);
401 * @brief Get the physical size of a output object.
402 * @param[in] output A output object
403 * @param[out] mmWidth The milimeter width
404 * @param[out] mmHeight The milimeter height
405 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
408 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
409 unsigned int *mmHeight);
412 * @brief Get the subpixel of a output object.
413 * @param[in] output A output object
414 * @param[out] subpixel The subpixel
415 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
418 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
421 * @brief Get the pipe of a output object.
422 * @param[in] output A output object
423 * @param[out] pipe The pipe
424 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
427 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
430 * @brief Get the index of a primary layer.
431 * @param[in] output A output object
432 * @param[out] index The primary layer index
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
436 tdm_output_get_primary_index(tdm_output *output, int *index);
439 * @brief Set the property which has a given id.
440 * @param[in] output A output object
441 * @param[in] id The property id
442 * @param[in] value The value
443 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
446 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
449 * @brief Get the property which has a given id
450 * @param[in] output A output object
451 * @param[in] id The property id
452 * @param[out] value The value
453 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
456 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
459 * @brief Wait for VBLANK
460 * @details After interval vblanks, a user vblank handler will be called.
461 * @param[in] output A output object
462 * @param[in] interval vblank interval
463 * @param[in] sync 0: asynchronous, 1:synchronous
464 * @param[in] func A user vblank handler
465 * @param[in] user_data The user data
466 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
467 * @see #tdm_output_vblank_handler
470 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
471 tdm_output_vblank_handler func, void *user_data);
474 * @brief Commit changes for a output object
475 * @details After all change of a output object are applied, a user commit handler
477 * @param[in] output A output object
478 * @param[in] sync 0: asynchronous, 1:synchronous
479 * @param[in] func A user commit handler
480 * @param[in] user_data The user data
481 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
484 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
488 * @brief Set one of available modes of a output object
489 * @param[in] output A output object
490 * @param[in] mode A output mode
491 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
494 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
497 * @brief Get the mode of a output object
498 * @param[in] output A output object
499 * @param[out] mode A output mode
500 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
503 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
506 * @brief Set DPMS of a output object
507 * @param[in] output A output object
508 * @param[in] dpms_value DPMS value
509 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
512 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
515 * @brief Get DPMS of a output object
516 * @param[in] output A output object
517 * @param[out] dpms_value DPMS value
518 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
521 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
524 * @brief Create a capture object of a output object
525 * @param[in] output A output object
526 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
527 * @return A capture object
528 * @see tdm_capture_destroy
531 tdm_output_create_capture(tdm_output *output, tdm_error *error);
534 * @brief Get the capabilities of a layer object.
535 * @param[in] layer A layer object
536 * @param[out] capabilities The capabilities of a layer object
537 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
540 tdm_layer_get_capabilities(tdm_layer *layer,
541 tdm_layer_capability *capabilities);
544 * @brief Get the available format array of a layer object.
545 * @param[in] layer A layer object
546 * @param[out] formats The available format array
547 * @param[out] count The count of formats
548 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
551 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
555 * @brief Get the available property array of a layer object.
556 * @param[in] layer A layer object
557 * @param[out] props The available property array
558 * @param[out] count The count of properties
559 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
562 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
566 * @brief Get the zpos of a layer object.
568 * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
569 * - But the zpos of VIDEO layers will be decided by a backend module side.
570 * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
571 * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
572 * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
573 * -------------------------------- graphic layer 3 <-- top most layer
574 * -------------------------------- graphic layer 2
575 * -------------------------------- graphic layer 1
576 * -------------------------------- graphic layer 0
577 * -------------------------------- video layer -1
578 * -------------------------------- video layer -2 <-- lowest layer
579 * @param[in] layer A layer object
580 * @param[out] zpos The zpos
581 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
582 * @see tdm_layer_set_video_pos, tdm_layer_capability
585 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
588 * @brief Set the property which has a given id.
589 * @param[in] layer A layer object
590 * @param[in] id The property id
591 * @param[in] value The value
592 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
595 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
598 * @brief Get the property which has a given id.
599 * @param[in] layer A layer object
600 * @param[in] id The property id
601 * @param[out] value The value
602 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
605 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
608 * @brief Set the geometry information to a layer object
609 * @details The geometry information will be applied when the output object
610 * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
611 * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
613 * @param[in] layer A layer object
614 * @param[in] info The geometry information
615 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
616 * @see tdm_output_commit
619 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
622 * @brief Get the geometry information to a layer object
623 * @param[in] layer A layer object
624 * @param[out] info The geometry information
625 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
628 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
631 * @brief Set a TDM buffer to a layer object
632 * @details A TDM buffer will be applied when the output object
633 * of a layer object is committed.
634 * @param[in] layer A layer object
635 * @param[in] buffer A TDM buffer
636 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
637 * @see tdm_output_commit
640 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
643 * @brief Unset a TDM buffer from a layer object
644 * @details When this function is called, a current showing buffer will be
645 * disappeared from screen. Then nothing is showing on a layer object.
646 * @param[in] layer A layer object
647 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
650 tdm_layer_unset_buffer(tdm_layer *layer);
653 * @brief Get a displaying TDM buffer from a layer object
654 * @details A displaying TDM buffer is a current showing buffer on screen
655 * that is set to layer object and applied output object of a layer object.
656 * @param[in] layer A layer object
657 * @return A TDM buffer if success. Otherwise, NULL.
660 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
663 * @brief Set a TBM surface_queue to a layer object
664 * @details A TBM surface_queue will be applied when the output object
665 * of a layer object is committed. and TDM layer will be automatically updated
666 * @param[in] layer A layer object
667 * @param[in] buffer_queue A TBM surface_queue
668 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
669 * @see tdm_output_commit
672 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
675 * @brief Unset a TBM surface_queue from a layer object
676 * @details When this function is called, a current surface_queue will be
677 * disappeared from screen. Then nothing is showing on a layer object.
678 * @param[in] layer A layer object
679 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
682 tdm_layer_unset_buffer_queue(tdm_layer *layer);
685 * @brief Check wheter a layer object is available for a frontend user to use.
686 * @details A layer object is not usable if a TDM buffer is showing on screen
687 * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
688 * will become usable.
689 * @param[in] layer A layer object
690 * @param[out] usable 1 if usable, 0 if not usable
691 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
694 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
697 * @brief Set the relative zpos to a VIDEO layer object
698 * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
699 * it is more than the maximum zpos of GRAPHIC layers.
700 * @param[in] layer A VIDEO layer object
701 * @param[in] zpos The zpos
702 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
703 * @see tdm_layer_get_zpos, tdm_layer_capability
706 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
709 * @brief Create a capture object of a layer object
710 * @param[in] layer A layer object
711 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
712 * @return A capture object
713 * @see tdm_capture_destroy
716 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
719 * @brief Get buffer flags from a layer object
720 * @param[in] layer A layer object
721 * @param[out] flags a buffer flags value
722 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
725 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
728 * @brief Destroy a pp object
729 * @param[in] pp A pp object
730 * @see tdm_display_create_pp
733 tdm_pp_destroy(tdm_pp *pp);
736 * @brief Set the geometry information to a pp object
737 * @param[in] pp A pp object
738 * @param[in] info The geometry information
739 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
743 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
746 * @brief Set the PP done handler to a pp object
748 * The user PP done handler will be called after converting a source buffer's image
749 * to a destination buffer.
750 * @param[in] pp A pp object
751 * @param[in] func A user PP done handler
752 * @param[in] user_data The user data
753 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
756 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
759 * @brief Attach a source buffer and a destination buffer to a pp object
760 * @param[in] pp A pp object
761 * @param[in] src A source buffer
762 * @param[in] dst A destination buffer
763 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
764 * @see tdm_pp_commit, tdm_pp_set_done_handler
767 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
770 * @brief Commit changes for a pp object
771 * @param[in] pp A pp object
772 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
775 tdm_pp_commit(tdm_pp *pp);
778 * @brief Destroy a capture object
779 * @param[in] capture A capture object
780 * @see tdm_output_create_capture, tdm_layer_create_capture
783 tdm_capture_destroy(tdm_capture *capture);
786 * @brief Set the geometry information to a capture object
787 * @param[in] capture A capture object
788 * @param[in] info The geometry information
789 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
790 * @see tdm_capture_commit
793 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
796 * @brief Set the capture done handler to a capture object
798 * The user capture done handler will be called after capturing a screen into a
800 * @param[in] capture A capture object
801 * @param[in] func A user capture done handler
802 * @param[in] user_data The user data
803 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
806 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
809 * @brief Attach a TDM buffer to a capture object
810 * @param[in] capture A capture object
811 * @param[in] buffer A TDM buffer
812 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
813 * @see tdm_capture_commit, tdm_capture_set_done_handler
816 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
819 * @brief Commit changes for a capture object
820 * @param[in] capture A capture object
821 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
824 tdm_capture_commit(tdm_capture *capture);
827 * @brief The release handler of a TDM buffer
828 * @param[in] buffer A TDM buffer
829 * @param[in] user_data user data
830 * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
832 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
836 * @brief Add a release handler to a TDM buffer
838 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
839 * becomes available for a next job. A TDM buffer can be used for TDM to show
840 * it on screen or to capture an output and a layer. After all operations,
841 * TDM will release it immediately when TDM doesn't need it any more.
842 * @param[in] buffer A TDM buffer
843 * @param[in] func A release handler
844 * @param[in] user_data user data
845 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
846 * @see tdm_buffer_remove_release_handler
849 tdm_buffer_add_release_handler(tbm_surface_h buffer,
850 tdm_buffer_release_handler func, void *user_data);
853 * @brief Remove a release handler from a TDM buffer
854 * @param[in] buffer A TDM buffer
855 * @param[in] func A release handler
856 * @param[in] user_data user data
857 * @see tdm_buffer_add_release_handler
860 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
861 tdm_buffer_release_handler func, void *user_data);
864 * @brief The handler of a vblank object
865 * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
867 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
868 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
871 * @brief Create a vblank object
872 * @param[in] dpy A display object
873 * @param[in] output A output object
874 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
875 * @return A vblank object
876 * @see #tdm_vblank_destroy
879 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
882 * @brief Destroy a vblank object
883 * @param[in] vblank A vblank object
884 * @see #tdm_vblank_create
887 tdm_vblank_destroy(tdm_vblank *vblank);
890 * @brief Set the fps to a vblank object
891 * @details Default is the @b vertical @b refresh @b rate of the given output.
892 * @param[in] vblank A vblank object
893 * @param[in] fps over 0
894 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
897 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
900 * @brief Set the offset(milli-second) to a vblank object
901 * @details Default is @b 0.
902 * @param[in] vblank A vblank object
903 * @param[in] offset the offset(milli-second)
904 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
907 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
910 * @brief Enable/Disable the fake vblank to a vblank object
912 * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
913 * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
915 * @param[in] vblank A vblank object
916 * @param[in] enable_fake 1:enable, 0:disable
917 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
920 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
923 * @brief Get the fake vblank
924 * @param[in] vblank A vblank object
925 * @return 1 if enable. Otherwise, 0.
928 tdm_vblank_get_enable_fake(tdm_vblank *vblank);
931 * @brief Wait for a vblank
933 * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
934 * SHOULD be called after the given interval. \n
935 * The sequence value of tdm_vblank_handler is the relative value of fps.
936 * If fps = 10, this sequence value should be increased by 10 during 1 second.
937 * @param[in] vblank A vblank object
938 * @param[in] req_sec The vblank request time(second)
939 * @param[in] req_usec The vblank request time(micro-second)
940 * @param[in] interval The vblank interval
941 * @param[in] func The user vblank handler
942 * @param[in] user_data The user data
943 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
946 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
947 unsigned int interval, tdm_vblank_handler func, void *user_data);
950 * @brief Wait for a vblank with the target sequence number
951 * @param[in] vblank A vblank object
952 * @param[in] req_sec The vblank request time(second)
953 * @param[in] req_usec The vblank request time(micro-second)
954 * @param[in] sequence The target sequence number
955 * @param[in] func The user client vblank handler
956 * @param[in] user_data The user data
957 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
960 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
961 unsigned int sequence, tdm_vblank_handler func, void *user_data);