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 * @brief Create a virtual output object of a backend module
340 * @param[in] bdata The backend module data
341 * @param[in] name The output name
342 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
343 * @return A tdm_voutput object
344 * @see voutput_destroy() function
346 * A backend module doesn't need to implement this function if doesn't support virtual output.
348 tdm_voutput *(*voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
350 void (*reserved2)(void);
351 void (*reserved3)(void);
352 void (*reserved4)(void);
353 void (*reserved5)(void);
354 void (*reserved6)(void);
355 void (*reserved7)(void);
356 void (*reserved8)(void);
360 * @brief The output functions for a backend module.
362 typedef struct _tdm_func_output {
364 * @brief Get the capabilities of a output object
365 * @param[in] output A output object
366 * @param[out] caps The capabilities of a output object
367 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
369 * A backend module @b SHOULD implement this function. TDM calls this function
370 * not only at the initial time, but also at the update time when new output
372 * #tdm_caps_output contains connection status, modes, avaiable properties,
373 * size restriction information, etc.
375 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
378 * @brief Get a layer array of a output object
379 * @param[in] output A output object
380 * @param[out] count The count of layers
381 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
382 * @return A layer array which is @b newly-allocated
384 * A backend module @b SHOULD implement this function. TDM calls this function
385 * not only at the initial time, but also at the update time when new output
387 * A backend module @b SHOULD return the @b newly-allocated array which contains
388 * "tdm_layer*" data. It will be freed in frontend.
390 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
394 * @brief Set the property which has a given id
395 * @param[in] output A output object
396 * @param[in] id The property id
397 * @param[in] value The value
398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
400 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
404 * @brief Get the property which has a given id
405 * @param[in] output A output object
406 * @param[in] id The property id
407 * @param[out] value The value
408 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
410 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
414 * @brief Wait for VBLANK
415 * @param[in] output A output object
416 * @param[in] interval vblank interval
417 * @param[in] sync 0: asynchronous, 1:synchronous
418 * @param[in] user_data The user data
419 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
420 * @see output_set_vblank_handler, tdm_output_vblank_handler
422 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
423 * a user vblank handler with the user data of this function after interval
426 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
430 * @brief Set a user vblank handler
431 * @param[in] output A output object
432 * @param[in] func A user vblank handler
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
435 tdm_error (*output_set_vblank_handler)(tdm_output *output,
436 tdm_output_vblank_handler func);
439 * @brief Commit changes for a output object
440 * @param[in] output A output object
441 * @param[in] sync 0: asynchronous, 1:synchronous
442 * @param[in] user_data The user data
443 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
444 * @see output_set_commit_handler, tdm_output_commit_handler
446 * When this function is called, a backend module @b SHOULD apply the all
447 * changes of the given output object to screen as well as the layer changes
449 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
450 * a user commit handler with the user data of this function after all
451 * changes of the given output object are applied.
453 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
456 * @brief Set a user commit handler
457 * @param[in] output A output object
458 * @param[in] func A user commit handler
459 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
461 tdm_error (*output_set_commit_handler)(tdm_output *output,
462 tdm_output_commit_handler func);
465 * @brief Set DPMS of a output object synchronously
466 * @param[in] output A output object
467 * @param[in] dpms_value DPMS value
468 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
470 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
473 * @brief Get DPMS of a output object
474 * @param[in] output A output object
475 * @param[out] dpms_value DPMS value
476 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
478 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
481 * @brief Set one of available modes of a output object
482 * @param[in] output A output object
483 * @param[in] mode A output mode
484 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
486 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
489 * @brief Get the mode of a output object
490 * @param[in] output A output object
491 * @param[out] mode A output mode
492 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
494 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
497 * @brief Create a capture object of a output object
498 * @param[in] output A output object
499 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
500 * @return A capture object
501 * @see capture_destroy() function of #tdm_func_capture
503 * A backend module doesn't need to implement this function if a hardware
504 * doesn't have the capture device.
506 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
509 * @brief Set a output connection status handler
510 * @details A backend module need to call the output status handler when the
511 * output connection status has been changed to let the TDM frontend know
513 * @param[in] output A output object
514 * @param[in] func A output status handler
515 * @param[in] user_data The user data
516 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
519 tdm_error (*output_set_status_handler)(tdm_output *output,
520 tdm_output_status_handler func,
524 * @brief Set a output dpms handler
525 * @details This function can be NULL if an output doesn't support asynchronous
526 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
527 * to let the TDM frontend know the output DPMS change indeed.
528 * @param[in] output A output object
529 * @param[in] func A output dpms handler
530 * @param[in] user_data The user data
531 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
532 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
535 tdm_error (*output_set_dpms_handler)(tdm_output *output,
536 tdm_output_dpms_handler func,
540 * @brief Set DPMS of a output object asynchronously
541 * @param[in] output A output object
542 * @details This function can be NULL if an output doesn't support asynchronous
543 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
544 * flags which #output_get_capability returns. And if a output dpms handler is added with
545 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
546 * to let the TDM frontend know the output DPMS change indeed.
547 * @param[in] dpms_value DPMS value
548 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
549 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
552 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
555 * @brief Get a hwc object of a output object
556 * @param[in] output A output object
557 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
558 * @return A hwc object
560 tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
562 void (*reserved3)(void);
563 void (*reserved4)(void);
564 void (*reserved5)(void);
565 void (*reserved6)(void);
566 void (*reserved7)(void);
567 void (*reserved8)(void);
570 typedef struct _tdm_func_voutput {
572 * @brief Destroy a virtual output object of a backend module
573 * @param[in] voutput The voutput object
574 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
575 * @see voutput_create() function
577 * A backend module doesn't need to implement this function if doesn't support virtual output.
579 tdm_error (*voutput_destroy)(tdm_voutput *voutput);
582 * @brief Set available modes of a virtual output object
583 * @param[in] voutput A voutput object
584 * @param[in] modes Modes of voutput
585 * @param[in] count A count of modes
586 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
588 * A backend module doesn't need to implement this function if doesn't support virtual output.
590 tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
593 * @brief Set physical size(mm) of a virtual output object
594 * @param[in] voutput A voutput object
595 * @param[in] mmwidth Width of voutput
596 * @param[in] mmheight Height of voutput
597 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
599 * A backend module doesn't need to implement this function if doesn't support virtual output.
601 tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
604 * @brief Set connect status of a virtual output object
605 * @param[in] voutput A voutput object
606 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
608 * A backend module doesn't need to implement this function if doesn't support virtual output.
610 tdm_error (*voutput_connect)(tdm_voutput *voutput);
613 * @brief Set disconnect status of a virtual output object
614 * @param[in] voutput A voutput object
615 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
617 * A backend module doesn't need to implement this function if doesn't support virtual output.
619 tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
622 * @brief Get output object from virtual output object
623 * @param[in] voutput A voutput object
624 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
625 * @return A tdm_output object
627 * A backend module doesn't need to implement this function if doesn't support virtual output.
629 tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
632 * @brief Set a user commit function
633 * @param[in] voutput A voutput object
634 * @param[in] func A user voutput commit function
635 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
637 * A backend module doesn't need to implement this function if doesn't support virtual output.
638 * If virtual output's output_commit is executed, call this voutput commit func.
640 tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
643 * @brief Notify commit done to backend
644 * @param[in] voutput A voutput object
645 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
647 * A backend module doesn't need to implement this function if doesn't support virtual output.
649 tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
651 void (*reserved1)(void);
652 void (*reserved2)(void);
653 void (*reserved3)(void);
654 void (*reserved4)(void);
655 void (*reserved5)(void);
656 void (*reserved6)(void);
659 * @brief The layer functions for a backend module.
661 typedef struct _tdm_func_layer {
663 * @brief Get the capabilities of a layer object
664 * @param[in] layer A layer object
665 * @param[out] caps The capabilities of a layer object
666 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
668 * A backend module @b SHOULD implement this function. TDM calls this function
669 * not only at the initial time, but also at the update time when new output
671 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
673 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
676 * @brief Set the property which has a given id.
677 * @param[in] layer A layer object
678 * @param[in] id The property id
679 * @param[in] value The value
680 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
682 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
686 * @brief Get the property which has a given id.
687 * @param[in] layer A layer object
688 * @param[in] id The property id
689 * @param[out] value The value
690 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
692 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
696 * @brief Set the geometry information to a layer object
697 * @param[in] layer A layer object
698 * @param[in] info The geometry information
699 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
700 * @see output_commit() function of #tdm_func_output
702 * A backend module would apply the geometry information when the output object
703 * of a layer object is committed.
705 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
708 * @brief Get the geometry information to a layer object
709 * @param[in] layer A layer object
710 * @param[out] info The geometry information
711 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
713 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
716 * @brief Set a TDM buffer to a layer object
717 * @param[in] layer A layer object
718 * @param[in] buffer A TDM buffer
719 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
720 * @see output_commit() function of #tdm_func_output
722 * A backend module would show a TDM buffer on screen when the output object
723 * of a layer object is committed.
725 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
728 * @brief Unset a TDM buffer from a layer object
729 * @param[in] layer A layer object
730 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
732 * A backend module @b SHOULD remove the current showing buffer from screen.
734 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
737 * @brief Set the zpos for a VIDEO layer object
738 * @param[in] layer A layer object
739 * @param[in] zpos z-order
740 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
741 * @see tdm_caps_layer, tdm_layer_capability
743 * A backend module doesn't need to implement this function if a backend
744 * module doesn't have VIDEO layers.\n
745 * This function is for VIDEO layers.
746 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
747 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
748 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
749 * is less than GRAPHIC layers or more than GRAPHIC layers.
750 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
751 * The zpos of VIDEO layers is @b relative. It doesn't need to start
752 * from -1 or 4. Let's suppose that there are two VIDEO layers.
753 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
754 * than -4 VIDEO layer.
756 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
759 * @brief Create a capture object of a layer object
760 * @param[in] output A output object
761 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
762 * @return A capture object
763 * @see capture_destroy() function of #tdm_func_capture
765 * A backend module doesn't need to implement this function if a hardware
766 * doesn't have the capture device.
768 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
771 * @brief Get buffer flags which the layer can support.
772 * @param[in] layer A layer object
773 * @param[out] flags The buffer flags which should be the tbm_bo flags
774 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
776 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
778 void (*reserved1)(void);
779 void (*reserved2)(void);
780 void (*reserved3)(void);
781 void (*reserved4)(void);
782 void (*reserved5)(void);
783 void (*reserved6)(void);
784 void (*reserved7)(void);
787 typedef struct _tdm_func_hwc {
789 * @brief Create a new window on the given hwc.
790 * @param[in] hwc A hwc object
791 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
792 * @return A created window object
795 tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
798 * @brief Get video the supported format array for the hwc windows of a hwc object.
799 * @param[in] hwc A hwc object
800 * @param[out] formats The available format array
801 * @param[out] count The count of formats
802 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
804 tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
807 * @brief Get the hwc video capability
808 * @param[in] hwc A hwc object
809 * @param[out] video_capability A hwc hwc video capability
810 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
812 tdm_error (*hwc_get_video_capability)(tdm_hwc *hwc,
813 tdm_hwc_video_capability *video_capability);
816 * @brief Get the available property array of a hwc object.
817 * @param[in] hwc A hwc object
818 * @param[out] props The available property array
819 * @param[out] count The count of properties
820 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
822 tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
826 * @brief Get a target buffer queue
827 * @param[in] hwc A hwc object
828 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
829 * @return A buffer queue
832 tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
836 * @brief Set the client(relative to the TDM) target buffer
837 * @details This function lets the backend know the target buffer.
838 * The target buffer contains the result of the gl composition with the
839 * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
840 * @param[in] hwc A hwc object
841 * @param[in] target_buffer The new target buffer
842 * @param[in] damage The buffer damage region
843 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
846 tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
847 tbm_surface_h target_buffer,
851 * @brief Validate the hwc
852 * @details Instructs the backend to inspect all of the hw layer state and
853 * determine if there are any composition type changes necessary before
854 * presenting the hwc.
855 * @param[in] hwc A hwc object
856 * @param[in] composited_wnds the hwc window list which is visible.
857 * @param[in] num_wnds the number of the visible windows in the composited_wnds
858 * @param[out] num_types The number of composition type changes
859 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
861 * The backend has to return the num_types when the assgined comopsite types of
862 * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
863 * 0, the cleint must get the changed composite types of the tdm_hwc_windows
864 * and change the comopsite types
867 tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
868 uint32_t num_wnds, uint32_t *num_types);
871 * @brief Get changed composition types
872 * @details Retrieves the windows for which the backend requires a different
873 * composition types that had been set prior to the last call to tdm_hwc_validate().
874 * The client will either update its state with these types and call
875 * tdm_hwc_accept_validation, or will set new types and attempt to validate the
876 * display again. The number of elements returned must be the same as the
877 * value returned in num_types from the last call to tdm_hwc_validate().
878 * @param[in] hwc A hwc object
879 * @param[out] num_elements the number of hwc_windows
880 * @param[out] windows An array of windows
881 * @param[out] composition_types An array of composition types, each corresponding
882 * to an element of windows
883 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
886 tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
887 tdm_hwc_window **hwc_window,
888 tdm_hwc_window_composition *composition_types);
890 * @brief Accepts the validation required by the backend
891 * @details Accepts the validation required by the backend from the previous
892 * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
893 * @param[in] hwc A hwc object
894 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
897 tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
900 * @brief Commit changes for a hwc object
901 * @param[in] hwc A hwc object
902 * @param[in] sync 0: asynchronous, 1:synchronous
903 * @param[in] user_data The user data
904 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
905 * @see hwc_set_commit_handler, tdm_hwc_commit_handler
907 * When this function is called, a backend module @b SHOULD apply the all
908 * changes of the given hwc object to screen as well as the layer changes
910 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
911 * a user commit handler with the user data of this function after all
912 * changes of the given hwc object are applied.
914 tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
917 * @brief Set a user commit handler
918 * @param[in] hwc A hwc object
919 * @param[in] func A user commit handler
920 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
922 tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
926 * @brief The window functions for a backend module.
929 typedef struct _tdm_func_hwc_window {
931 * @brief Destroys the given window.
932 * @param[in] window the pointer of the window to destroy
935 void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
938 * @brief Acquire a buffer queue for the window object
939 * @details These buffers are used to composite by hardware a client content in
941 * @param[in] hwc_window A window object
942 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
943 * @return A buffer queue
945 tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
949 * @brief Release a buffer queue for the window object
950 * @details Release buffer queue when the client no longer uses buferrs of queue.
951 * @param[in] hwc_window A window object
952 * @param[in] A tbm buffer queue
954 void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
955 tbm_surface_queue_h queue);
958 * @brief Sets the desired composition type of the given window.
959 * @details During hwc_validate(), the backend may request changes to
960 * the composition types of any of the layers as described in the definition
961 * of tdm_hwc_window_composition_t above.
962 * @param[in] hwc_window A window object
963 * @param[in] composition_type The new composition type
964 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
966 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
967 tdm_hwc_window_composition composition_type);
970 * @brief Set the buffer damage
971 * @details Provides the region of the source buffer which has been modified
972 * since the last frame. This region does not need to be validated before
973 * calling hwc_commit().
974 * Once set through this function, the damage region remains the same until a
975 * subsequent call to this function.
976 * If damage.num_rects > 0, then it may be assumed that any portion of the source
977 * buffer not covered by one of the rects has not been modified this frame. If
978 * damage.num_rects == 0, then the whole source buffer must be treated as if it
980 * If the layer's contents are not modified relative to the prior frame, damage
981 * will contain exactly one empty rect([0, 0, 0, 0]).
982 * The damage rects are relative to the pre-transformed buffer, and their origin
983 * is the top-left corner. They will not exceed the dimensions of the latched
985 * @param[in] hwc_window A window object
986 * @param[in] damage The new buffer damage region
987 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
989 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
993 * @brief Set the information to a window object
994 * @details The information will be applied when the hwc object is committed.
995 * @param[in] hwc_window A window object
996 * @param[in] info The geometry information
997 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
999 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
1000 tdm_hwc_window_info *info);
1003 * @brief Set a TDM buffer to a window object
1004 * @details A TDM buffer will be applied when the hwc object
1005 * of a layer object is committed.
1006 * @param[in] hwc_window A window object
1007 * @param[in] buffer A TBM buffer
1008 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1010 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
1011 tbm_surface_h buffer);
1014 * @brief Set the property which has a given id.
1015 * @param[in] hwc_window A hwc window object
1016 * @param[in] id The property id
1017 * @param[in] value The value of the propery id
1018 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1020 tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
1021 uint32_t id, tdm_value value);
1024 * @brief Get the property which has a given id.
1025 * @param[in] hwc_window A hwc window object
1026 * @param[in] id The property id
1027 * @param[out] value The value of the propery id
1028 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1030 tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
1031 uint32_t id, tdm_value *value);
1034 * @brief Get the constraints of hwc_window
1035 * @param[in] hwc_window A hwc window object
1036 * @param[out] constraints The tdm_hwc_window_constraint types
1037 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1039 tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
1041 } tdm_func_hwc_window;
1044 * @brief The pp functions for a backend module.
1046 typedef struct _tdm_func_pp {
1048 * @brief Destroy a pp object
1049 * @param[in] pp A pp object
1050 * @see display_create_pp() function of #tdm_func_display
1052 void (*pp_destroy)(tdm_pp *pp);
1055 * @brief Set the geometry information to a pp object
1056 * @param[in] pp A pp object
1057 * @param[in] info The geometry information
1058 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1059 * @see pp_commit() function of #tdm_func_pp
1061 * A backend module would apply the geometry information when committed.
1063 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1066 * @brief Attach a source buffer and a destination buffer to a pp object
1067 * @param[in] pp A pp object
1068 * @param[in] src A source buffer
1069 * @param[in] dst A destination buffer
1070 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1071 * @see pp_set_info() function of #tdm_func_pp
1072 * @see pp_commit() function of #tdm_func_pp
1073 * @see pp_set_done_handler, tdm_pp_done_handler
1075 * A backend module converts the image of a source buffer to a destination
1076 * buffer when committed. The size/crop/transform information is set via
1077 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1078 * return the source/destination buffer via tdm_pp_done_handler.
1080 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1083 * @brief Commit changes for a pp object
1084 * @param[in] pp A pp object
1085 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1087 tdm_error (*pp_commit)(tdm_pp *pp);
1090 * @brief Set a user done handler to a pp object
1091 * @param[in] pp A pp object
1092 * @param[in] func A user done handler
1093 * @param[in] user_data user data
1094 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1096 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1098 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1101 void (*reserved1)(void);
1102 void (*reserved2)(void);
1103 void (*reserved3)(void);
1104 void (*reserved4)(void);
1105 void (*reserved5)(void);
1106 void (*reserved6)(void);
1107 void (*reserved7)(void);
1108 void (*reserved8)(void);
1112 * @brief The capture functions for a backend module.
1114 typedef struct _tdm_func_capture {
1116 * @brief Destroy a capture object
1117 * @param[in] capture A capture object
1118 * @see output_create_capture() function of #tdm_func_output
1119 * @see layer_create_capture() function of #tdm_func_layer
1121 void (*capture_destroy)(tdm_capture *capture);
1124 * @brief Set the geometry information to a capture object
1125 * @param[in] capture A capture object
1126 * @param[in] info The geometry information
1127 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1128 * @see capture_commit() function of #tdm_func_capture
1130 * A backend module would apply the geometry information when committed.
1132 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1135 * @brief Attach a TDM buffer to a capture object
1136 * @details When capture_commit() function is called, a backend module starts
1137 * to dump a output or a layer to a TDM buffer.
1138 * @param[in] capture A capture object
1139 * @param[in] buffer A TDM buffer
1140 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1141 * @see capture_set_info() function of #tdm_func_capture
1142 * @see capture_commit() function of #tdm_func_capture
1143 * @see capture_set_done_handler, tdm_capture_done_handler
1145 * A backend module starts to dump a output or a layer to to a TDM buffer when
1146 * committed. The size/crop/transform information is set via #capture_set_info()
1147 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1148 * buffer via tdm_capture_done_handler.
1150 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1153 * @brief Commit changes for a capture object
1154 * @param[in] capture A capture object
1155 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1157 tdm_error (*capture_commit)(tdm_capture *capture);
1160 * @brief Set a user done handler to a capture object
1161 * @param[in] capture A capture object
1162 * @param[in] func A user done handler
1163 * @param[in] user_data user data
1164 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1166 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1168 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1169 tdm_capture_done_handler func, void *user_data);
1171 void (*reserved1)(void);
1172 void (*reserved2)(void);
1173 void (*reserved3)(void);
1174 void (*reserved4)(void);
1175 void (*reserved5)(void);
1176 void (*reserved6)(void);
1177 void (*reserved7)(void);
1178 void (*reserved8)(void);
1182 * @brief The tdm event source
1184 typedef void tdm_event_loop_source;
1187 * @brief The fd source handler
1189 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1192 * @brief The timer source handler
1194 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1196 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1197 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1198 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1199 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1203 * The ABI version of TDM backend module. It has a major and minor revision.
1204 * Modules using lower minor revisions will work with TDM frontend of a higher
1205 * minor revision. There is no compatibility between different major revisions.
1206 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1209 * tdm_backend_module tdm_backend_module_data = {
1212 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1218 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1219 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1220 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1223 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1224 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1225 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */
1229 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1231 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1233 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1236 * @brief The backend module information of the entry point to initialize a TDM
1239 * A backend module @b SHOULD define the global data symbol of which name is
1240 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1241 * at the initial time and call init() function of #tdm_backend_module.
1243 typedef struct _tdm_backend_module {
1244 const char *name; /**< The module name of a backend module */
1245 const char *vendor; /**< The vendor name of a backend module */
1246 unsigned long abi_version; /**< The ABI version of a backend module */
1249 * @brief The init function of a backend module
1250 * @param[in] dpy A display object
1251 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1252 * @return The backend module data
1253 * @see tdm_backend_data
1255 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1258 * @brief The deinit function of a backend module
1259 * @param[in] bdata The backend module data
1261 void (*deinit)(tdm_backend_data *bdata);
1262 } tdm_backend_module;
1265 * @brief Register the backend display functions to a display
1266 * @param[in] dpy A display object
1267 * @param[in] func_display display functions
1268 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1269 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1271 * A backend module @b SHOULD set the backend display functions at least.
1274 tdm_backend_register_func_display(tdm_display *dpy,
1275 tdm_func_display *func_display);
1278 * @brief Register the backend output functions to a display
1279 * @param[in] dpy A display object
1280 * @param[in] func_output output functions
1281 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1282 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1284 * A backend module @b SHOULD set the backend output functions at least.
1287 tdm_backend_register_func_output(tdm_display *dpy,
1288 tdm_func_output *func_output);
1291 * @brief Register the backend voutput functions to a display
1292 * @param[in] dpy A display object
1293 * @param[in] func_voutput voutput functions
1294 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1295 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1297 * A backend module doesn't need to implement this function if doesn't support virtual output.
1300 tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
1303 * @brief Register the backend layer functions to a display
1304 * @param[in] dpy A display object
1305 * @param[in] func_layer layer functions
1306 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1307 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1309 * A backend module @b SHOULD set the backend layer functions at least.
1312 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1315 * @brief Register the backend hwc functions to a display
1316 * @param[in] dpy A display object
1317 * @param[in] func_hwc hwc functions
1318 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1319 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1321 * A backend module @b SHOULD set the backend hwc functions at least.
1325 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1328 * @brief Register the backend hwc_window functions to a display
1329 * @param[in] dpy A display object
1330 * @param[in] func_hwc_window hwc_window functions
1331 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1332 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1334 * A backend module @b SHOULD set the backend hwc_window functions at least.
1338 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1341 * @brief Register the backend pp functions to a display
1342 * @param[in] dpy A display object
1343 * @param[in] func_pp pp functions
1344 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1345 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1347 * A backend module doesn'tcan skip to register the backend pp functions
1348 * if a hardware doesn't have the memory-to-memory converting device.
1351 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1354 * @brief Register the backend capture functions to a display
1355 * @param[in] dpy A display object
1356 * @param[in] func_capture capture functions
1357 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1358 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1360 * A backend module can skip to register the backend capture functions
1361 * if a hardware doesn't have the capture device.
1364 tdm_backend_register_func_capture(tdm_display *dpy,
1365 tdm_func_capture *func_capture);
1368 * @brief Register the backend output to a display
1369 * @param[in] dpy A display object
1370 * @param[in] output A backend output object
1371 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1372 * @see tdm_backend_unregister_output
1375 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1378 * @brief Unregister the backend output to a display
1379 * @param[in] dpy A display object
1380 * @param[in] output A backend output object
1381 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1382 * @see tdm_backend_register_output
1385 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1388 * @brief Increase the ref_count of a TDM buffer
1390 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1391 * becomes available for a next job. A TDM buffer can be used for TDM to show
1392 * it on screen or to capture an output and a layer. After all operations,
1393 * TDM will release it immediately when TDM doesn't need it any more.
1394 * @param[in] buffer A TDM buffer
1395 * @return A buffer itself. Otherwise, NULL.
1396 * @see tdm_buffer_unref_backend
1398 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1399 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1400 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1403 tdm_buffer_ref_backend(tbm_surface_h buffer);
1406 * @brief Decrease the ref_count of a TDM buffer
1407 * @param[in] buffer A TDM buffer
1408 * @see tdm_buffer_ref_backend
1411 tdm_buffer_unref_backend(tbm_surface_h buffer);
1414 * @brief The destroy handler of a TDM buffer
1415 * @param[in] buffer A TDM buffer
1416 * @param[in] user_data user data
1417 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1419 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1423 * @brief Add a destroy handler to a TDM buffer
1424 * @param[in] buffer A TDM buffer
1425 * @param[in] func A destroy handler
1426 * @param[in] user_data user data
1427 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1428 * @see tdm_buffer_remove_destroy_handler
1430 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1431 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1435 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1436 tdm_buffer_destroy_handler func, void *user_data);
1439 * @brief Remove a destroy handler from a TDM buffer
1440 * @param[in] buffer A TDM buffer
1441 * @param[in] func A destroy handler
1442 * @param[in] user_data user data
1443 * @see tdm_buffer_add_destroy_handler
1446 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1447 tdm_buffer_destroy_handler func, void *user_data);
1450 * @brief Add a FD handler for activity on the given file descriptor
1451 * @param[in] dpy A display object
1452 * @param[in] fd A file descriptor
1453 * @param[in] mask to monitor FD
1454 * @param[in] func A FD handler function
1455 * @param[in] user_data user data
1456 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1457 * @return A FD event source
1458 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1460 tdm_event_loop_source*
1461 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1462 tdm_event_loop_fd_handler func, void *user_data,
1466 * @brief Update the mask of the given FD event source
1467 * @param[in] source The given FD event source
1468 * @param[in] mask to monitor FD
1469 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1472 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1475 * @brief Add a timer handler
1476 * @param[in] dpy A display object
1477 * @param[in] func A timer handler function
1478 * @param[in] user_data user data
1479 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1480 * @return A timer event source
1481 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1483 tdm_event_loop_source*
1484 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1485 void *user_data, tdm_error *error);
1488 * @brief Update the millisecond delay time of the given timer event source.
1489 * @param[in] source The given timer event source
1490 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1491 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1494 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1497 * @brief Remove the given event source
1498 * @param[in] source The given event source
1499 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1502 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1505 * @brief Get the ini value with given key
1507 * @param[in] key The given key
1508 * @param[in] default_value The default value
1509 * @return the value of given key if success. Otherwise, default_value.
1510 * @see #tdm_config_get_string
1513 tdm_config_get_int(const char *key, int default_value);
1516 * @brief Get the ini value with given key
1518 * @param[in] key The given key
1519 * @param[in] default_value The default value
1520 * @return the value of given key if success. Otherwise, default_value.
1521 * @see #tdm_config_get_int
1524 tdm_config_get_string(const char *key, const char *default_value);
1530 #endif /* _TDM_BACKEND_H_ */