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 output counts which a display object has.
207 * @param[in] dpy A display object
208 * @param[out] count The count of outputs
209 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
210 * @see tdm_display_get_output
213 tdm_display_get_output_count(tdm_display *dpy, int *count);
216 * @brief Get a output object which has the given index.
217 * @param[in] dpy A display object
218 * @param[in] index The index of a output object
219 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
220 * @return A output object if success. Otherwise, NULL.
221 * @see tdm_display_get_output_count
224 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
227 * @brief Create a pp object.
228 * @param[in] dpy A display object
229 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
230 * @return A pp object if success. Otherwise, NULL.
231 * @see tdm_pp_destroy
234 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
237 * @brief Get the model information of a output object.
238 * @param[in] output A output object
239 * @param[out] maker The output maker.
240 * @param[out] model The output model.
241 * @param[out] name The output name.
242 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
245 tdm_output_get_model_info(tdm_output *output, const char **maker,
246 const char **model, const char **name);
249 * @brief Get the connection status of a output object.
250 * @param[in] output A output object
251 * @param[out] status The connection status.
252 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
255 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
258 * @brief Add a output change handler
259 * @details The handler will be called when the status of a
260 * output object is changed. connection, DPMS, etc.
261 * @param[in] output A output object
262 * @param[in] func A output change handler
263 * @param[in] user_data The user data
264 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
267 tdm_output_add_change_handler(tdm_output *output,
268 tdm_output_change_handler func,
272 * @brief Remove a output change handler
273 * @param[in] output A output object
274 * @param[in] func A output change handler
275 * @param[in] user_data The user data
276 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
279 tdm_output_remove_change_handler(tdm_output *output,
280 tdm_output_change_handler func,
284 * @brief Get the connection type of a output object.
285 * @param[in] output A output object
286 * @param[out] type The connection type.
287 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
290 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
293 * @brief Get the layer counts which a output object has.
294 * @param[in] output A output object
295 * @param[out] count The count of layers
296 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
297 * @see tdm_output_get_layer
300 tdm_output_get_layer_count(tdm_output *output, int *count);
303 * @brief Get a layer object which has the given index.
304 * @param[in] output A output object
305 * @param[in] index The index of a layer object
306 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
307 * @return A layer object if success. Otherwise, NULL.
308 * @see tdm_output_get_layer_count
311 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
314 * @brief Get the available property array of a output object.
315 * @param[in] output A output object
316 * @param[out] props The available property array
317 * @param[out] count The count of properties
318 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
321 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
325 * @brief Get the available mode array of a output object.
326 * @param[in] output A output object
327 * @param[out] modes The available mode array
328 * @param[out] count The count of modes
329 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
332 tdm_output_get_available_modes(tdm_output *output,
333 const tdm_output_mode **modes, int *count);
336 * @brief Get the available size of a output object.
337 * @details -1 means that a TDM backend module doesn't define the value.
338 * @param[in] output A output object
339 * @param[out] min_w The minimum width which TDM can handle
340 * @param[out] min_h The minimum height which TDM can handle
341 * @param[out] max_w The maximum width which TDM can handle
342 * @param[out] max_h The maximum height which TDM can handle
343 * @param[out] preferred_align The preferred align width which TDM can handle
344 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
347 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
348 int *max_w, int *max_h, int *preferred_align);
351 * @brief Get the physical size of a output object.
352 * @param[in] output A output object
353 * @param[out] mmWidth The milimeter width
354 * @param[out] mmHeight The milimeter height
355 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
358 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
359 unsigned int *mmHeight);
362 * @brief Get the subpixel of a output object.
363 * @param[in] output A output object
364 * @param[out] subpixel The subpixel
365 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
368 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
371 * @brief Get the pipe of a output object.
372 * @param[in] output A output object
373 * @param[out] pipe The pipe
374 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
377 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
380 * @brief Get the index of a primary layer.
381 * @param[in] output A output object
382 * @param[out] index The primary layer index
383 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
386 tdm_output_get_primary_index(tdm_output *output, int *index);
389 * @brief Set the property which has a given id.
390 * @param[in] output A output object
391 * @param[in] id The property id
392 * @param[in] value The value
393 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
396 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
399 * @brief Get the property which has a given id
400 * @param[in] output A output object
401 * @param[in] id The property id
402 * @param[out] value The value
403 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
406 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
409 * @brief Wait for VBLANK
410 * @details After interval vblanks, a user vblank handler will be called.
411 * @param[in] output A output object
412 * @param[in] interval vblank interval
413 * @param[in] sync 0: asynchronous, 1:synchronous
414 * @param[in] func A user vblank handler
415 * @param[in] user_data The user data
416 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
417 * @see #tdm_output_vblank_handler
420 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
421 tdm_output_vblank_handler func, void *user_data);
424 * @brief Commit changes for a output object
425 * @details After all change of a output object are applied, a user commit handler
427 * @param[in] output A output object
428 * @param[in] sync 0: asynchronous, 1:synchronous
429 * @param[in] func A user commit handler
430 * @param[in] user_data The user data
431 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
434 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
438 * @brief Set one of available modes of a output object
439 * @param[in] output A output object
440 * @param[in] mode A output mode
441 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
444 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
447 * @brief Get the mode of a output object
448 * @param[in] output A output object
449 * @param[out] mode A output mode
450 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
453 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
456 * @brief Set DPMS of a output object
457 * @param[in] output A output object
458 * @param[in] dpms_value DPMS value
459 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
462 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
465 * @brief Get DPMS of a output object
466 * @param[in] output A output object
467 * @param[out] dpms_value DPMS value
468 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
471 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
474 * @brief Create a capture object of a output object
475 * @param[in] output A output object
476 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
477 * @return A capture object
478 * @see tdm_capture_destroy
481 tdm_output_create_capture(tdm_output *output, tdm_error *error);
484 * @brief Get the capabilities of a layer object.
485 * @param[in] layer A layer object
486 * @param[out] capabilities The capabilities of a layer object
487 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
490 tdm_layer_get_capabilities(tdm_layer *layer,
491 tdm_layer_capability *capabilities);
494 * @brief Get the available format array of a layer object.
495 * @param[in] layer A layer object
496 * @param[out] formats The available format array
497 * @param[out] count The count of formats
498 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
501 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
505 * @brief Get the available property array of a layer object.
506 * @param[in] layer A layer object
507 * @param[out] props The available property array
508 * @param[out] count The count of properties
509 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
512 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
516 * @brief Get the zpos of a layer object.
518 * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
519 * - But the zpos of VIDEO layers will be decided by a backend module side.
520 * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
521 * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
522 * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
523 * -------------------------------- graphic layer 3 <-- top most layer
524 * -------------------------------- graphic layer 2
525 * -------------------------------- graphic layer 1
526 * -------------------------------- graphic layer 0
527 * -------------------------------- video layer -1
528 * -------------------------------- video layer -2 <-- lowest layer
529 * @param[in] layer A layer object
530 * @param[out] zpos The zpos
531 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
532 * @see tdm_layer_set_video_pos, tdm_layer_capability
535 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
538 * @brief Set the property which has a given id.
539 * @param[in] layer A layer object
540 * @param[in] id The property id
541 * @param[in] value The value
542 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
545 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
548 * @brief Get the property which has a given id.
549 * @param[in] layer A layer object
550 * @param[in] id The property id
551 * @param[out] value The value
552 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
555 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
558 * @brief Set the geometry information to a layer object
559 * @details The geometry information will be applied when the output object
560 * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
561 * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
563 * @param[in] layer A layer object
564 * @param[in] info The geometry information
565 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
566 * @see tdm_output_commit
569 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
572 * @brief Get the geometry information to a layer object
573 * @param[in] layer A layer object
574 * @param[out] info The geometry information
575 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
578 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
581 * @brief Set a TDM buffer to a layer object
582 * @details A TDM buffer will be applied when the output object
583 * of a layer object is committed.
584 * @param[in] layer A layer object
585 * @param[in] buffer A TDM buffer
586 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
587 * @see tdm_output_commit
590 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
593 * @brief Unset a TDM buffer from a layer object
594 * @details When this function is called, a current showing buffer will be
595 * disappeared from screen. Then nothing is showing on a layer object.
596 * @param[in] layer A layer object
597 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
600 tdm_layer_unset_buffer(tdm_layer *layer);
603 * @brief Get a displaying TDM buffer from a layer object
604 * @details A displaying TDM buffer is a current showing buffer on screen
605 * that is set to layer object and applied output object of a layer object.
606 * @param[in] layer A layer object
607 * @return A TDM buffer if success. Otherwise, NULL.
610 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
613 * @brief Set a TBM surface_queue to a layer object
614 * @details A TBM surface_queue will be applied when the output object
615 * of a layer object is committed. and TDM layer will be automatically updated
616 * @param[in] layer A layer object
617 * @param[in] buffer_queue A TBM surface_queue
618 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
619 * @see tdm_output_commit
622 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
625 * @brief Unset a TBM surface_queue from a layer object
626 * @details When this function is called, a current surface_queue will be
627 * disappeared from screen. Then nothing is showing on a layer object.
628 * @param[in] layer A layer object
629 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
632 tdm_layer_unset_buffer_queue(tdm_layer *layer);
635 * @brief Check wheter a layer object is available for a frontend user to use.
636 * @details A layer object is not usable if a TDM buffer is showing on screen
637 * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
638 * will become usable.
639 * @param[in] layer A layer object
640 * @param[out] usable 1 if usable, 0 if not usable
641 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
644 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
647 * @brief Set the relative zpos to a VIDEO layer object
648 * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
649 * it is more than the maximum zpos of GRAPHIC layers.
650 * @param[in] layer A VIDEO layer object
651 * @param[in] zpos The zpos
652 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
653 * @see tdm_layer_get_zpos, tdm_layer_capability
656 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
659 * @brief Create a capture object of a layer object
660 * @param[in] layer A layer object
661 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
662 * @return A capture object
663 * @see tdm_capture_destroy
666 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
669 * @brief Get buffer flags from a layer object
670 * @param[in] layer A layer object
671 * @param[out] flags a buffer flags value
672 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
675 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
678 * @brief Destroy a pp object
679 * @param[in] pp A pp object
680 * @see tdm_display_create_pp
683 tdm_pp_destroy(tdm_pp *pp);
686 * @brief Set the geometry information to a pp object
687 * @param[in] pp A pp object
688 * @param[in] info The geometry information
689 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
693 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
696 * @brief Attach a source buffer and a destination buffer to a pp object
697 * @param[in] pp A pp object
698 * @param[in] src A source buffer
699 * @param[in] dst A destination buffer
700 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
701 * @see tdm_pp_commit, tdm_buffer_add_release_handler, tdm_buffer_release_handler
704 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
707 * @brief Commit changes for a pp object
708 * @param[in] pp A pp object
709 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
712 tdm_pp_commit(tdm_pp *pp);
715 * @brief Destroy a capture object
716 * @param[in] capture A capture object
717 * @see tdm_output_create_capture, tdm_layer_create_capture
720 tdm_capture_destroy(tdm_capture *capture);
723 * @brief Set the geometry information to a capture object
724 * @param[in] capture A capture object
725 * @param[in] info The geometry information
726 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
727 * @see tdm_capture_commit
730 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
733 * @brief Attach a TDM buffer to a capture object
734 * @param[in] capture A capture object
735 * @param[in] buffer A TDM buffer
736 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
737 * @see tdm_capture_commit, tdm_buffer_add_release_handler, tdm_buffer_release_handler
740 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
743 * @brief Commit changes for a capture object
744 * @param[in] capture A capture object
745 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
748 tdm_capture_commit(tdm_capture *capture);
751 * @brief The release handler of a TDM buffer
752 * @param[in] buffer A TDM buffer
753 * @param[in] user_data user data
754 * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
756 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
760 * @brief Add a release handler to a TDM buffer
762 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
763 * becomes available for a next job. A TDM buffer can be used for TDM to show
764 * it on screen or to capture an output and a layer. After all operations,
765 * TDM will release it immediately when TDM doesn't need it any more.
766 * @param[in] buffer A TDM buffer
767 * @param[in] func A release handler
768 * @param[in] user_data user data
769 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
770 * @see tdm_buffer_remove_release_handler
773 tdm_buffer_add_release_handler(tbm_surface_h buffer,
774 tdm_buffer_release_handler func, void *user_data);
777 * @brief Remove a release handler from a TDM buffer
778 * @param[in] buffer A TDM buffer
779 * @param[in] func A release handler
780 * @param[in] user_data user data
781 * @see tdm_buffer_add_release_handler
784 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
785 tdm_buffer_release_handler func, void *user_data);