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 <boram1288.park@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 **************************************************************************/
36 #ifndef _TDM_BACKEND_H_
37 #define _TDM_BACKEND_H_
39 #include <tbm_surface.h>
40 #include <tbm_surface_queue.h>
42 #include "tdm_types.h"
50 * @brief The backend header file of TDM to implement a TDM backend module.
53 * #include <tdm_backend.h>
58 * @brief The backend module data
60 * The init() function of #tdm_backend_module returns the backend module data.
61 * And it will be passed to display functions of #tdm_func_display.
62 * @see tdm_backend_module, tdm_backend_module
64 typedef void tdm_backend_data;
67 * @brief The output status handler
68 * @details This handler will be called when the status of a output object is
71 typedef void (*tdm_output_status_handler)(tdm_output *output,
72 tdm_output_conn_status status,
76 * @brief The output dpms handler
77 * @details This handler will be called when the dpms of a output object is
80 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
85 * @brief The display capabilities structure of a backend module
86 * @see The display_get_capability() function of #tdm_func_display
88 typedef struct _tdm_caps_display {
89 int max_layer_count; /**< The maximum layer count */
93 * @brief The capabilities structure of a output object
94 * @see The output_get_capability() function of #tdm_func_output
96 typedef struct _tdm_caps_output {
97 char maker[TDM_NAME_LEN]; /**< The output maker */
98 char model[TDM_NAME_LEN]; /**< The output model */
99 char name[TDM_NAME_LEN]; /**< The output name */
101 tdm_output_conn_status status; /**< The connection status */
102 tdm_output_type type; /**< The connection type */
103 unsigned int type_id; /**< The connection type id */
105 unsigned int mode_count; /**< The count of available modes */
106 tdm_output_mode *modes; /**< The @b newly-allocated array of modes. will be freed in frontend. */
108 unsigned int prop_count; /**< The count of available properties */
109 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
111 unsigned int mmWidth; /**< The physical width (milimeter) */
112 unsigned int mmHeight; /**< The physical height (milimeter) */
113 unsigned int subpixel; /**< The subpixel */
115 int min_w; /**< The minimun width */
116 int min_h; /**< The minimun height */
117 int max_w; /**< The maximum width */
118 int max_h; /**< The maximum height */
119 int preferred_align; /**< The prefered align */
121 tdm_output_capability capabilities; /**< The capabilities of output. @since 1.4.1 */
123 int cursor_min_w; /**< The minimun width. @since 1.5.0 */
124 int cursor_min_h; /**< The minimun height. @since 1.5.0 */
125 int cursor_max_w; /**< The maximum width. @since 1.5.0 */
126 int cursor_max_h; /**< The maximum height. @since 1.5.0 */
127 int cursor_preferred_align; /**< The prefered align. @since 1.5.0 */
131 * @brief The capabilities structure of a layer object
132 * @see The layer_get_capability() function of #tdm_func_layer
134 typedef struct _tdm_caps_layer {
135 tdm_layer_capability capabilities; /**< The capabilities of layer */
139 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
140 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
141 * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
142 * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
143 * layers or more than GRAPHIC layers.
144 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
145 * The zpos of VIDEO layers is @b relative. It doesn't need to start
146 * from -1 or 4. Let's suppose that there are two VIDEO layers.
147 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
148 * than -4 VIDEO layer.
152 unsigned int format_count; /**< The count of available formats */
154 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
156 unsigned int prop_count; /**< The count of available properties */
157 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
161 * @brief The capabilities structure of a pp object
162 * @see The display_get_pp_capability() function of #tdm_func_display
164 typedef struct _tdm_caps_pp {
165 tdm_pp_capability capabilities; /**< The capabilities of pp */
167 unsigned int format_count; /**< The count of available formats */
169 *formats; /**< The @b newly-allocated array. will be freed in frontend. */
171 int min_w; /**< The minimun width */
172 int min_h; /**< The minimun height */
173 int max_w; /**< The maximum width */
174 int max_h; /**< The maximum height */
175 int preferred_align; /**< The prefered align */
177 /**< The attach count which a PP object can handle. @since 1.2.0 */
178 int max_attach_count;
182 * @brief The capabilities structure of a capture object
183 * @see The display_get_capture_capability() function of #tdm_func_display
185 typedef struct _tdm_caps_capture {
186 tdm_capture_capability capabilities; /**< The capabilities of capture */
188 unsigned int format_count; /**< The count of available formats */
190 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
192 int min_w; /**< The minimun width */
193 int min_h; /**< The minimun height */
194 int max_w; /**< The maximum width */
195 int max_h; /**< The maximum height */
196 int preferred_align; /**< The prefered align */
198 /**< The attach count which a capture object can handle. @since 1.2.0 */
199 int max_attach_count;
203 * @brief The display functions for a backend module.
205 typedef struct _tdm_func_display {
207 * @brief Get the display capabilities of a backend module
208 * @param[in] bdata The backend module data
209 * @param[out] caps The display capabilities of a backend module
210 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
212 * A backend module @b SHOULD implement this function. TDM calls this function
213 * not only at the initial time, but also at the update time when new output
215 * If a hardware has the restriction of the number of max usable layer count,
216 * a backend module can set the max count to max_layer_count of #tdm_caps_display
219 tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
222 * @brief Get the pp capabilities of a backend module
223 * @param[in] bdata The backend module data
224 * @param[out] caps The pp capabilities of a backend module
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
226 * @see tdm_backend_register_func_pp
228 * TDM calls this function not only at the initial time, but also at the update
229 * time when new output is connected.\n
230 * A backend module doesn't need to implement this function if a hardware
231 * doesn't have the memory-to-memory converting device. Otherwise, a backend module
232 * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
233 * restriction information which a converting device can handle. ie, format, size, etc.
235 tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
238 * @brief Get the capture capabilities of a backend module
239 * @param[in] bdata The backend module data
240 * @param[out] caps The capture capabilities of a backend module
241 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
242 * @see tdm_backend_register_func_capture
244 * TDM calls this function not only at the initial time, but also at the update
245 * time when new output is connected.\n
246 * A backend module doesn't need to implement this function if a hardware
247 * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
248 * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
249 * information which a capture device can handle. ie, format, size, etc.
251 tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
254 * @brief Get a output array of a backend module
255 * @param[in] bdata The backend module data
256 * @param[out] count The count of outputs
257 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
258 * @return A output array which is @b newly-allocated
259 * @see tdm_backend_register_func_capture
261 * A backend module @b SHOULD implement this function. TDM calls this function
262 * not only at the initial time, but also at the update time when new output
264 * A backend module @b SHOULD return the @b newly-allocated array which contains
265 * "tdm_output*" data. It will be freed in frontend.
269 * drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
271 * tdm_drm_data *drm_data = bdata;
272 * tdm_drm_output_data *output_data = NULL;
273 * tdm_output **outputs;
277 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
282 * if (error) *error = TDM_ERROR_NONE;
286 * // will be freed in frontend
287 * outputs = calloc(*count, sizeof(tdm_drm_output_data*));
291 * if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
296 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
297 * outputs[i++] = output_data;
299 * if (error) *error = TDM_ERROR_NONE;
305 tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
309 * @brief Get the file descriptor of a backend module
310 * @param[in] bdata The backend module data
311 * @param[out] fd The fd of a backend module
312 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
313 * @see display_handle_events() function of #tdm_func_display
315 * A backend module can return epoll's fd which is watching the backend device one more fds.
317 tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
320 * @brief Handle the events which happens on the fd of a backend module
321 * @param[in] bdata The backend module data
322 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
324 tdm_error (*display_handle_events)(tdm_backend_data *bdata);
327 * @brief Create a pp object of a backend module
328 * @param[in] bdata The backend module data
329 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
330 * @return A pp object
331 * @see pp_destroy() function of #tdm_func_pp
333 * A backend module doesn't need to implement this function if a hardware
334 * doesn't have the memory-to-memory converting device.
336 tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
339 tdm_output *(*display_output_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
340 tdm_error (*display_output_destroy)(tdm_backend_data *bdata, tdm_output *output);
342 void (*reserved3)(void);
343 void (*reserved4)(void);
344 void (*reserved5)(void);
345 void (*reserved6)(void);
346 void (*reserved7)(void);
347 void (*reserved8)(void);
351 * @brief The output functions for a backend module.
353 typedef struct _tdm_func_output {
355 * @brief Get the capabilities of a output object
356 * @param[in] output A output object
357 * @param[out] caps The capabilities of a output object
358 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
360 * A backend module @b SHOULD implement this function. TDM calls this function
361 * not only at the initial time, but also at the update time when new output
363 * #tdm_caps_output contains connection status, modes, avaiable properties,
364 * size restriction information, etc.
366 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
369 * @brief Get a layer array of a output object
370 * @param[in] output A output object
371 * @param[out] count The count of layers
372 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
373 * @return A layer array which is @b newly-allocated
375 * A backend module @b SHOULD implement this function. TDM calls this function
376 * not only at the initial time, but also at the update time when new output
378 * A backend module @b SHOULD return the @b newly-allocated array which contains
379 * "tdm_layer*" data. It will be freed in frontend.
381 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
385 * @brief Set the property which has a given id
386 * @param[in] output A output object
387 * @param[in] id The property id
388 * @param[in] value The value
389 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
391 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
395 * @brief Get the property which has a given id
396 * @param[in] output A output object
397 * @param[in] id The property id
398 * @param[out] value The value
399 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
401 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
405 * @brief Wait for VBLANK
406 * @param[in] output A output object
407 * @param[in] interval vblank interval
408 * @param[in] sync 0: asynchronous, 1:synchronous
409 * @param[in] user_data The user data
410 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
411 * @see output_set_vblank_handler, tdm_output_vblank_handler
413 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
414 * a user vblank handler with the user data of this function after interval
417 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
421 * @brief Set a user vblank handler
422 * @param[in] output A output object
423 * @param[in] func A user vblank handler
424 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
426 tdm_error (*output_set_vblank_handler)(tdm_output *output,
427 tdm_output_vblank_handler func);
430 * @brief Commit changes for a output object
431 * @param[in] output A output object
432 * @param[in] sync 0: asynchronous, 1:synchronous
433 * @param[in] user_data The user data
434 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
435 * @see output_set_commit_handler, tdm_output_commit_handler
437 * When this function is called, a backend module @b SHOULD apply the all
438 * changes of the given output object to screen as well as the layer changes
440 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
441 * a user commit handler with the user data of this function after all
442 * changes of the given output object are applied.
444 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
447 * @brief Set a user commit handler
448 * @param[in] output A output object
449 * @param[in] func A user commit handler
450 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
452 tdm_error (*output_set_commit_handler)(tdm_output *output,
453 tdm_output_commit_handler func);
456 * @brief Set DPMS of a output object synchronously
457 * @param[in] output A output object
458 * @param[in] dpms_value DPMS value
459 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
461 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
464 * @brief Get DPMS of a output object
465 * @param[in] output A output object
466 * @param[out] dpms_value DPMS value
467 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
469 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
472 * @brief Set one of available modes of a output object
473 * @param[in] output A output object
474 * @param[in] mode A output mode
475 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
477 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
480 * @brief Get the mode of a output object
481 * @param[in] output A output object
482 * @param[out] mode A output mode
483 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
485 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
488 * @brief Create a capture object of a output object
489 * @param[in] output A output object
490 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
491 * @return A capture object
492 * @see capture_destroy() function of #tdm_func_capture
494 * A backend module doesn't need to implement this function if a hardware
495 * doesn't have the capture device.
497 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
500 * @brief Set a output connection status handler
501 * @details A backend module need to call the output status handler when the
502 * output connection status has been changed to let the TDM frontend know
504 * @param[in] output A output object
505 * @param[in] func A output status handler
506 * @param[in] user_data The user data
507 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
510 tdm_error (*output_set_status_handler)(tdm_output *output,
511 tdm_output_status_handler func,
515 * @brief Set a output dpms handler
516 * @details This function can be NULL if an output doesn't support asynchronous
517 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
518 * to let the TDM frontend know the output DPMS change indeed.
519 * @param[in] output A output object
520 * @param[in] func A output dpms handler
521 * @param[in] user_data The user data
522 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
523 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
526 tdm_error (*output_set_dpms_handler)(tdm_output *output,
527 tdm_output_dpms_handler func,
531 * @brief Set DPMS of a output object asynchronously
532 * @param[in] output A output object
533 * @details This function can be NULL if an output doesn't support asynchronous
534 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
535 * flags which #output_get_capability returns. And if a output dpms handler is added with
536 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
537 * to let the TDM frontend know the output DPMS change indeed.
538 * @param[in] dpms_value DPMS value
539 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
540 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
543 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
546 * @brief Get a hwc object of a output object
547 * @param[in] output A output object
548 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
549 * @return A hwc object
551 tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
554 tdm_error (*output_set_available_mode)(tdm_output *output, const tdm_output_mode *modes, int count);
555 tdm_error (*output_set_physical_size)(tdm_output *output, unsigned int mmwidth, unsigned int mmheight);
556 tdm_error (*output_set_connect)(tdm_output *output);
557 tdm_error (*output_set_disconnect)(tdm_output *output);
559 void (*reserved5)(void);
560 void (*reserved6)(void);
561 void (*reserved7)(void);
562 void (*reserved8)(void);
566 * @brief The layer functions for a backend module.
568 typedef struct _tdm_func_layer {
570 * @brief Get the capabilities of a layer object
571 * @param[in] layer A layer object
572 * @param[out] caps The capabilities of a layer object
573 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
575 * A backend module @b SHOULD implement this function. TDM calls this function
576 * not only at the initial time, but also at the update time when new output
578 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
580 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
583 * @brief Set the property which has a given id.
584 * @param[in] layer A layer object
585 * @param[in] id The property id
586 * @param[in] value The value
587 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
589 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
593 * @brief Get the property which has a given id.
594 * @param[in] layer A layer object
595 * @param[in] id The property id
596 * @param[out] value The value
597 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
599 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
603 * @brief Set the geometry information to a layer object
604 * @param[in] layer A layer object
605 * @param[in] info The geometry information
606 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
607 * @see output_commit() function of #tdm_func_output
609 * A backend module would apply the geometry information when the output object
610 * of a layer object is committed.
612 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
615 * @brief Get the geometry information to a layer object
616 * @param[in] layer A layer object
617 * @param[out] info The geometry information
618 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
620 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
623 * @brief Set a TDM buffer to a layer object
624 * @param[in] layer A layer object
625 * @param[in] buffer A TDM buffer
626 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
627 * @see output_commit() function of #tdm_func_output
629 * A backend module would show a TDM buffer on screen when the output object
630 * of a layer object is committed.
632 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
635 * @brief Unset a TDM buffer from a layer object
636 * @param[in] layer A layer object
637 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
639 * A backend module @b SHOULD remove the current showing buffer from screen.
641 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
644 * @brief Set the zpos for a VIDEO layer object
645 * @param[in] layer A layer object
646 * @param[in] zpos z-order
647 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
648 * @see tdm_caps_layer, tdm_layer_capability
650 * A backend module doesn't need to implement this function if a backend
651 * module doesn't have VIDEO layers.\n
652 * This function is for VIDEO layers.
653 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
654 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
655 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
656 * is less than GRAPHIC layers or more than GRAPHIC layers.
657 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
658 * The zpos of VIDEO layers is @b relative. It doesn't need to start
659 * from -1 or 4. Let's suppose that there are two VIDEO layers.
660 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
661 * than -4 VIDEO layer.
663 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
666 * @brief Create a capture object of a layer object
667 * @param[in] output A output object
668 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
669 * @return A capture object
670 * @see capture_destroy() function of #tdm_func_capture
672 * A backend module doesn't need to implement this function if a hardware
673 * doesn't have the capture device.
675 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
678 * @brief Get buffer flags which the layer can support.
679 * @param[in] layer A layer object
680 * @param[out] flags The buffer flags which should be the tbm_bo flags
681 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
683 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
686 * @brief Get buffer queue which the layer offers.
687 * @param[in] layer A layer object
688 * @param[out] buffer_queue The buffer queue
689 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
692 tdm_error (*layer_get_buffer_queue)(tdm_layer *layer, tbm_surface_queue_h *buffer_queue);
694 void (*reserved1)(void);
695 void (*reserved2)(void);
696 void (*reserved3)(void);
697 void (*reserved4)(void);
698 void (*reserved5)(void);
699 void (*reserved6)(void);
700 void (*reserved7)(void);
703 typedef struct _tdm_func_hwc {
705 * @brief Create a new window on the given hwc.
706 * @param[in] hwc A hwc object
707 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
708 * @return A created window object
711 tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
714 * @brief Get the supported format array for the hwc windows of a hwc object.
715 * @param[in] hwc A hwc object
716 * @param[out] formats The available format array
717 * @param[out] count The count of formats
718 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
720 tdm_error (*hwc_get_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
725 * @brief Get the available property array of a hwc object.
726 * @param[in] hwc A hwc object
727 * @param[out] props The available property array
728 * @param[out] count The count of properties
729 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
731 tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
735 * @brief Get a target buffer queue
736 * @param[in] hwc A hwc object
737 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
738 * @return A buffer queue
741 tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
745 * @brief Set the client(relative to the TDM) target buffer
746 * @details Sets the buffer which will receive the hwc of client composition.
747 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
748 * will be composited into this buffer prior to the call to hwc_commit(),
749 * and windows not marked as TDM_COMPOSITION_CLIENT and
750 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
753 * The buffer handle provided may be null if no windows are being composited by
754 * the client. This must not result in an error (unless an invalid display
755 * handle is also provided).
757 * The damage parameter describes a buffer damage region as defined in the
758 * description of hwc_window_set_buffer_damage().
760 * Will be called before hwc_commit() if any of the layers are marked as
761 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
762 * so marked, then it is not necessary to call this function. It is not necessary
763 * to call hwc_validate() after changing the target through this function.
764 * @param[in] hwc A hwc object
765 * @param[in] target The new target buffer
766 * @param[in] damage The buffer damage region
767 * @param[in] composited_wnds The array of composited hwc_wnds
768 * @param[in] num_wnds The size of #composited_wnds array
769 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
772 tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
773 tbm_surface_h target_buffer,
777 * @brief Validate the hwc
778 * @details Instructs the device to inspect all of the layer state and
779 * determine if there are any composition type changes necessary before
780 * presenting the hwc. Permitted changes are described in the definition
781 * of tdm_composition_t above.
782 * @param[in] hwc A hwc object
783 * @param[out] num_types The number of composition type changes required by
784 * the device; if greater than 0, the client must either set and validate new
785 * types, or call hwc_accept_changes() to accept the changes returned by
786 * hwc_get_changed_composition_types(); must be the same as the number of
787 * changes returned by hwc_get_changed_composition_types (see the
788 * declaration of that function for more information); pointer will be non-NULL
789 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
792 tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
793 uint32_t num_wnds, uint32_t *num_types);
796 * @brief Get changed composition types
797 * @details Retrieves the windows for which the device requires a different
798 * composition type than had been set prior to the last call to hwc_validate().
799 * The client will either update its state with these types and call
800 * hwc_accept_changes, or will set new types and attempt to validate the
802 * layers and types may be NULL to retrieve the number of elements which
803 * will be returned. The number of elements returned must be the same as the
804 * value returned in num_types from the last call to hwc_validate().
805 * @param[in] hwc A hwc object
806 * @param[out] num_elements If windows or types were NULL, the number of layers
807 * and types which would have been returned; if both were non-NULL, the
808 * number of elements returned in layers and types, which must not exceed
809 * the value stored in num_elements prior to the call; pointer will be
811 * @param[out] windows An array of windows
812 * @param[out] composition_types An array of composition types, each
813 * corresponding to an element of windows
814 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
817 tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
818 tdm_hwc_window **hwc_window,
819 tdm_hwc_window_composition *composition_types);
821 * @brief Accepts the changes required by the device
822 * @details Accepts the changes required by the device from the previous
823 * hwc_validate() call (which may be queried using
824 * hwc_get_chaged_composition_types()) and revalidates the display. This
825 * function is equivalent to requesting the changed types from
826 * hwc_get_chaged_composition_types(), setting those types on the
827 * corresponding windows, and then calling hwc_validate again.
828 * After this call it must be valid to present this display. Calling this after
829 * hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
830 * should have no other effect.
831 * @param[in] hwc A hwc object
832 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
835 tdm_error (*hwc_accept_changes)(tdm_hwc *hwc);
838 * @brief Commit changes for a output object
839 * @param[in] hwc A hwc object
840 * @param[in] sync 0: asynchronous, 1:synchronous
841 * @param[in] user_data The user data
842 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
843 * @see hwc_set_commit_handler, tdm_hwc_commit_handler
845 * When this function is called, a backend module @b SHOULD apply the all
846 * changes of the given output object to screen as well as the layer changes
848 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
849 * a user commit handler with the user data of this function after all
850 * changes of the given output object are applied.
852 tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
855 * @brief Set a user commit handler
856 * @param[in] hwc A hwc object
857 * @param[in] func A user commit handler
858 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
860 tdm_error (*hwc_set_commit_handler)(tdm_output *hwc, tdm_hwc_commit_handler func);
864 * @brief The window functions for a backend module.
867 typedef struct _tdm_func_hwc_window {
869 * @brief Destroys the given window.
870 * @param[in] window the pointer of the window to destroy
873 void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
876 * @brief Get a buffer queue for the window object
877 * @param[in] hwc_window A window object
878 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
879 * @return A buffer queue
881 tbm_surface_queue_h (*hwc_window_get_buffer_queue)(tdm_hwc_window *hwc_window,
885 * @brief Sets the desired composition type of the given window.
886 * @details During hwc_validate(), the device may request changes to
887 * the composition types of any of the layers as described in the definition
888 * of tdm_hwc_window_composition_t above.
889 * @param[in] hwc_window A window object
890 * @param[in] composition_type The new composition type
891 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
893 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
894 tdm_hwc_window_composition composition_type);
897 * @brief Set the buffer damage
898 * @details Provides the region of the source buffer which has been modified
899 * since the last frame. This region does not need to be validated before
900 * calling hwc_commit().
901 * Once set through this function, the damage region remains the same until a
902 * subsequent call to this function.
903 * If damage.num_rects > 0, then it may be assumed that any portion of the source
904 * buffer not covered by one of the rects has not been modified this frame. If
905 * damage.num_rects == 0, then the whole source buffer must be treated as if it
907 * If the layer's contents are not modified relative to the prior frame, damage
908 * will contain exactly one empty rect([0, 0, 0, 0]).
909 * The damage rects are relative to the pre-transformed buffer, and their origin
910 * is the top-left corner. They will not exceed the dimensions of the latched
912 * @param[in] hwc_window A window object
913 * @param[in] damage The new buffer damage region
914 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
916 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
920 * @brief Set the information to a window object
921 * @details The information will be applied when the hwc object
922 * of a layer object is committed.
923 * @param[in] hwc_window A window object
924 * @param[in] info The geometry information
925 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
927 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
928 tdm_hwc_window_info *info);
931 * @brief Get the geometry information to a layer object
932 * @param[in] layer A layer object
933 * @param[out] info The geometry information
934 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
936 tdm_error (*hwc_window_get_info)(tdm_hwc_window *hwc_window,
937 tdm_hwc_window_info *info);
940 * @brief Set a TDM buffer to a window object
941 * @details A TDM buffer will be applied when the hwc object
942 * of a layer object is committed.
943 * @param[in] hwc_window A window object
944 * @param[in] buffer A TDM buffer
945 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
947 * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
948 * be updated right now, this won't be interpreted like some critical
951 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
952 tbm_surface_h buffer);
955 * @brief Set the property which has a given id.
956 * @param[in] hwc window A hwc window object
957 * @param[in] id The property id
958 * @param[in] value The value
959 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
961 tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
962 uint32_t id, tdm_value value);
965 * @brief Get the property which has a given id.
966 * @param[in] hwc window A hwc window object
967 * @param[in] id The property id
968 * @param[out] value The value
969 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
971 tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
972 uint32_t id, tdm_value *value);
973 } tdm_func_hwc_window;
976 * @brief The pp functions for a backend module.
978 typedef struct _tdm_func_pp {
980 * @brief Destroy a pp object
981 * @param[in] pp A pp object
982 * @see display_create_pp() function of #tdm_func_display
984 void (*pp_destroy)(tdm_pp *pp);
987 * @brief Set the geometry information to a pp object
988 * @param[in] pp A pp object
989 * @param[in] info The geometry information
990 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
991 * @see pp_commit() function of #tdm_func_pp
993 * A backend module would apply the geometry information when committed.
995 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
998 * @brief Attach a source buffer and a destination buffer to a pp object
999 * @param[in] pp A pp object
1000 * @param[in] src A source buffer
1001 * @param[in] dst A destination buffer
1002 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1003 * @see pp_set_info() function of #tdm_func_pp
1004 * @see pp_commit() function of #tdm_func_pp
1005 * @see pp_set_done_handler, tdm_pp_done_handler
1007 * A backend module converts the image of a source buffer to a destination
1008 * buffer when committed. The size/crop/transform information is set via
1009 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1010 * return the source/destination buffer via tdm_pp_done_handler.
1012 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1015 * @brief Commit changes for a pp object
1016 * @param[in] pp A pp object
1017 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1019 tdm_error (*pp_commit)(tdm_pp *pp);
1022 * @brief Set a user done handler to a pp object
1023 * @param[in] pp A pp object
1024 * @param[in] func A user done handler
1025 * @param[in] user_data user data
1026 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1028 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1030 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1033 void (*reserved1)(void);
1034 void (*reserved2)(void);
1035 void (*reserved3)(void);
1036 void (*reserved4)(void);
1037 void (*reserved5)(void);
1038 void (*reserved6)(void);
1039 void (*reserved7)(void);
1040 void (*reserved8)(void);
1044 * @brief The capture functions for a backend module.
1046 typedef struct _tdm_func_capture {
1048 * @brief Destroy a capture object
1049 * @param[in] capture A capture object
1050 * @see output_create_capture() function of #tdm_func_output
1051 * @see layer_create_capture() function of #tdm_func_layer
1053 void (*capture_destroy)(tdm_capture *capture);
1056 * @brief Set the geometry information to a capture object
1057 * @param[in] capture A capture object
1058 * @param[in] info The geometry information
1059 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1060 * @see capture_commit() function of #tdm_func_capture
1062 * A backend module would apply the geometry information when committed.
1064 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1067 * @brief Attach a TDM buffer to a capture object
1068 * @details When capture_commit() function is called, a backend module starts
1069 * to dump a output or a layer to a TDM buffer.
1070 * @param[in] capture A capture object
1071 * @param[in] buffer A TDM buffer
1072 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1073 * @see capture_set_info() function of #tdm_func_capture
1074 * @see capture_commit() function of #tdm_func_capture
1075 * @see capture_set_done_handler, tdm_capture_done_handler
1077 * A backend module starts to dump a output or a layer to to a TDM buffer when
1078 * committed. The size/crop/transform information is set via #capture_set_info()
1079 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1080 * buffer via tdm_capture_done_handler.
1082 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1085 * @brief Commit changes for a capture object
1086 * @param[in] capture A capture object
1087 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1089 tdm_error (*capture_commit)(tdm_capture *capture);
1092 * @brief Set a user done handler to a capture object
1093 * @param[in] capture A capture object
1094 * @param[in] func A user done handler
1095 * @param[in] user_data user data
1096 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1098 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1100 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1101 tdm_capture_done_handler func, void *user_data);
1103 void (*reserved1)(void);
1104 void (*reserved2)(void);
1105 void (*reserved3)(void);
1106 void (*reserved4)(void);
1107 void (*reserved5)(void);
1108 void (*reserved6)(void);
1109 void (*reserved7)(void);
1110 void (*reserved8)(void);
1114 * @brief The tdm event source
1116 typedef void tdm_event_loop_source;
1119 * @brief The fd source handler
1121 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1124 * @brief The timer source handler
1126 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1128 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1129 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1130 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1131 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1135 * The ABI version of TDM backend module. It has a major and minor revision.
1136 * Modules using lower minor revisions will work with TDM frontend of a higher
1137 * minor revision. There is no compatibility between different major revisions.
1138 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1141 * tdm_backend_module tdm_backend_module_data = {
1144 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1150 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1151 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1152 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1155 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1156 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1157 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */
1161 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1163 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1165 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1168 * @brief The backend module information of the entry point to initialize a TDM
1171 * A backend module @b SHOULD define the global data symbol of which name is
1172 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1173 * at the initial time and call init() function of #tdm_backend_module.
1175 typedef struct _tdm_backend_module {
1176 const char *name; /**< The module name of a backend module */
1177 const char *vendor; /**< The vendor name of a backend module */
1178 unsigned long abi_version; /**< The ABI version of a backend module */
1181 * @brief The init function of a backend module
1182 * @param[in] dpy A display object
1183 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1184 * @return The backend module data
1185 * @see tdm_backend_data
1187 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1190 * @brief The deinit function of a backend module
1191 * @param[in] bdata The backend module data
1193 void (*deinit)(tdm_backend_data *bdata);
1194 } tdm_backend_module;
1197 * @brief Register the backend display functions to a display
1198 * @param[in] dpy A display object
1199 * @param[in] func_display display functions
1200 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1201 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1203 * A backend module @b SHOULD set the backend display functions at least.
1206 tdm_backend_register_func_display(tdm_display *dpy,
1207 tdm_func_display *func_display);
1210 * @brief Register the backend output functions to a display
1211 * @param[in] dpy A display object
1212 * @param[in] func_output output functions
1213 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1214 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1216 * A backend module @b SHOULD set the backend output functions at least.
1219 tdm_backend_register_func_output(tdm_display *dpy,
1220 tdm_func_output *func_output);
1223 * @brief Register the backend layer functions to a display
1224 * @param[in] dpy A display object
1225 * @param[in] func_layer layer functions
1226 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1227 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1229 * A backend module @b SHOULD set the backend layer functions at least.
1232 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1235 * @brief Register the backend hwc functions to a display
1236 * @param[in] dpy A display object
1237 * @param[in] func_hwc hwc functions
1238 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1239 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1241 * A backend module @b SHOULD set the backend hwc functions at least.
1245 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1248 * @brief Register the backend hwc_window functions to a display
1249 * @param[in] dpy A display object
1250 * @param[in] func_hwc_window hwc_window functions
1251 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1252 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1254 * A backend module @b SHOULD set the backend hwc_window functions at least.
1258 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1261 * @brief Register the backend pp functions to a display
1262 * @param[in] dpy A display object
1263 * @param[in] func_pp pp functions
1264 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1265 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1267 * A backend module doesn'tcan skip to register the backend pp functions
1268 * if a hardware doesn't have the memory-to-memory converting device.
1271 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1274 * @brief Register the backend capture functions to a display
1275 * @param[in] dpy A display object
1276 * @param[in] func_capture capture functions
1277 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1278 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1280 * A backend module can skip to register the backend capture functions
1281 * if a hardware doesn't have the capture device.
1284 tdm_backend_register_func_capture(tdm_display *dpy,
1285 tdm_func_capture *func_capture);
1289 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1292 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1295 * @brief Increase the ref_count of a TDM buffer
1297 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1298 * becomes available for a next job. A TDM buffer can be used for TDM to show
1299 * it on screen or to capture an output and a layer. After all operations,
1300 * TDM will release it immediately when TDM doesn't need it any more.
1301 * @param[in] buffer A TDM buffer
1302 * @return A buffer itself. Otherwise, NULL.
1303 * @see tdm_buffer_unref_backend
1305 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1306 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1307 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1310 tdm_buffer_ref_backend(tbm_surface_h buffer);
1313 * @brief Decrease the ref_count of a TDM buffer
1314 * @param[in] buffer A TDM buffer
1315 * @see tdm_buffer_ref_backend
1318 tdm_buffer_unref_backend(tbm_surface_h buffer);
1321 * @brief The destroy handler of a TDM buffer
1322 * @param[in] buffer A TDM buffer
1323 * @param[in] user_data user data
1324 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1326 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1330 * @brief Add a destroy handler to a TDM buffer
1331 * @param[in] buffer A TDM buffer
1332 * @param[in] func A destroy handler
1333 * @param[in] user_data user data
1334 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1335 * @see tdm_buffer_remove_destroy_handler
1337 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1338 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1342 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1343 tdm_buffer_destroy_handler func, void *user_data);
1346 * @brief Remove a destroy handler from a TDM buffer
1347 * @param[in] buffer A TDM buffer
1348 * @param[in] func A destroy handler
1349 * @param[in] user_data user data
1350 * @see tdm_buffer_add_destroy_handler
1353 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1354 tdm_buffer_destroy_handler func, void *user_data);
1357 * @brief Add a FD handler for activity on the given file descriptor
1358 * @param[in] dpy A display object
1359 * @param[in] fd A file descriptor
1360 * @param[in] mask to monitor FD
1361 * @param[in] func A FD handler function
1362 * @param[in] user_data user data
1363 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1364 * @return A FD event source
1365 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1367 tdm_event_loop_source*
1368 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1369 tdm_event_loop_fd_handler func, void *user_data,
1373 * @brief Update the mask of the given FD event source
1374 * @param[in] source The given FD event source
1375 * @param[in] mask to monitor FD
1376 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1379 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1382 * @brief Add a timer handler
1383 * @param[in] dpy A display object
1384 * @param[in] func A timer handler function
1385 * @param[in] user_data user data
1386 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1387 * @return A timer event source
1388 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1390 tdm_event_loop_source*
1391 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1392 void *user_data, tdm_error *error);
1395 * @brief Update the millisecond delay time of the given timer event source.
1396 * @param[in] source The given timer event source
1397 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1401 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1404 * @brief Remove the given event source
1405 * @param[in] source The given event source
1406 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1409 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1412 * @brief Get the ini value with given key
1414 * @param[in] key The given key
1415 * @param[in] default_value The default value
1416 * @return the value of given key if success. Otherwise, default_value.
1417 * @see #tdm_config_get_string
1420 tdm_config_get_int(const char *key, int default_value);
1423 * @brief Get the ini value with given key
1425 * @param[in] key The given key
1426 * @param[in] default_value The default value
1427 * @return the value of given key if success. Otherwise, default_value.
1428 * @see #tdm_config_get_int
1431 tdm_config_get_string(const char *key, const char *default_value);
1437 #endif /* _TDM_BACKEND_H_ */