1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
7 * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8 * JinYoung Jeon <jy0.jeon@samsung.com>,
9 * Taeheon Kim <th908.kim@samsung.com>,
10 * YoungJun Cho <yj44.cho@samsung.com>,
11 * SooChan Lim <sc1.lim@samsung.com>,
12 * Boram Park <sc1.lim@samsung.com>
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sub license, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 **************************************************************************/
36 #ifndef _TDM_BACKEND_H_
37 #define _TDM_BACKEND_H_
39 #include <tbm_surface.h>
41 #include "tdm_types.h"
49 * @brief The backend header file of TDM to implement a TDM backend module.
52 * #include <tdm_backend.h>
57 * @brief The backend module data
59 * The init() function of #tdm_backend_module returns the backend module data.
60 * And it will be passed to display functions of #tdm_func_display.
61 * @see tdm_backend_module, tdm_backend_module
63 typedef void tdm_backend_data;
66 * @brief The output status handler
67 * @details This handler will be called when the status of a output object is
70 typedef void (*tdm_output_status_handler)(tdm_output *output,
71 tdm_output_conn_status status,
75 * @brief The output dpms handler
76 * @details This handler will be called when the dpms of a output object is
79 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
84 * @brief The display capabilities structure of a backend module
85 * @see The display_get_capability() function of #tdm_func_display
87 typedef struct _tdm_caps_display {
88 int max_layer_count; /**< The maximum layer count */
92 * @brief The capabilities structure of a output object
93 * @see The output_get_capability() function of #tdm_func_output
95 typedef struct _tdm_caps_output {
96 char maker[TDM_NAME_LEN]; /**< The output maker */
97 char model[TDM_NAME_LEN]; /**< The output model */
98 char name[TDM_NAME_LEN]; /**< The output name */
100 tdm_output_conn_status status; /**< The connection status */
101 tdm_output_type type; /**< The connection type */
102 unsigned int type_id; /**< The connection type id */
104 unsigned int mode_count; /**< The count of available modes */
106 *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);
338 void (*reserved1)(void);
339 void (*reserved2)(void);
340 void (*reserved3)(void);
341 void (*reserved4)(void);
342 void (*reserved5)(void);
343 void (*reserved6)(void);
344 void (*reserved7)(void);
345 void (*reserved8)(void);
349 * @brief The output functions for a backend module.
351 typedef struct _tdm_func_output {
353 * @brief Get the capabilities of a output object
354 * @param[in] output A output object
355 * @param[out] caps The capabilities of a output object
356 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
358 * A backend module @b SHOULD implement this function. TDM calls this function
359 * not only at the initial time, but also at the update time when new output
361 * #tdm_caps_output contains connection status, modes, avaiable properties,
362 * size restriction information, etc.
364 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
367 * @brief Get a layer array of a output object
368 * @param[in] output A output object
369 * @param[out] count The count of layers
370 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
371 * @return A layer array which is @b newly-allocated
373 * A backend module @b SHOULD implement this function. TDM calls this function
374 * not only at the initial time, but also at the update time when new output
376 * A backend module @b SHOULD return the @b newly-allocated array which contains
377 * "tdm_layer*" data. It will be freed in frontend.
379 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
383 * @brief Set the property which has a given id
384 * @param[in] output A output object
385 * @param[in] id The property id
386 * @param[in] value The value
387 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
389 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
393 * @brief Get the property which has a given id
394 * @param[in] output A output object
395 * @param[in] id The property id
396 * @param[out] value The value
397 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
399 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
403 * @brief Wait for VBLANK
404 * @param[in] output A output object
405 * @param[in] interval vblank interval
406 * @param[in] sync 0: asynchronous, 1:synchronous
407 * @param[in] user_data The user data
408 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
409 * @see output_set_vblank_handler, tdm_output_vblank_handler
411 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
412 * a user vblank handler with the user data of this function after interval
415 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
419 * @brief Set a user vblank handler
420 * @param[in] output A output object
421 * @param[in] func A user vblank handler
422 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
424 tdm_error (*output_set_vblank_handler)(tdm_output *output,
425 tdm_output_vblank_handler func);
428 * @brief Commit changes for a output object
429 * @param[in] output A output object
430 * @param[in] sync 0: asynchronous, 1:synchronous
431 * @param[in] user_data The user data
432 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
433 * @see output_set_commit_handler, tdm_output_commit_handler
435 * When this function is called, a backend module @b SHOULD apply the all
436 * changes of the given output object to screen as well as the layer changes
438 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
439 * a user commit handler with the user data of this function after all
440 * changes of the given output object are applied.
442 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
445 * @brief Set a user commit handler
446 * @param[in] output A output object
447 * @param[in] func A user commit handler
448 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
450 tdm_error (*output_set_commit_handler)(tdm_output *output,
451 tdm_output_commit_handler func);
454 * @brief Set DPMS of a output object
455 * @param[in] output A output object
456 * @param[in] dpms_value DPMS value
457 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
459 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
462 * @brief Get DPMS of a output object
463 * @param[in] output A output object
464 * @param[out] dpms_value DPMS value
465 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
467 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
470 * @brief Set one of available modes of a output object
471 * @param[in] output A output object
472 * @param[in] mode A output mode
473 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
475 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
478 * @brief Get the mode of a output object
480 * @param[in] output A output object
481 * @param[out] mode A output mode
482 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
484 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
487 * @brief Create a capture object of a output object
488 * @param[in] output A output object
489 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
490 * @return A capture object
491 * @see capture_destroy() function of #tdm_func_capture
493 * A backend module doesn't need to implement this function if a hardware
494 * doesn't have the capture device.
496 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
499 * @brief Set a output connection status handler
500 * @details A backend module need to call the output status handler when the
501 * output connection status has been changed to let the TDM frontend know
503 * @param[in] output A output object
504 * @param[in] func A output status handler
505 * @param[in] user_data The user data
506 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
509 tdm_error (*output_set_status_handler)(tdm_output *output,
510 tdm_output_status_handler func,
514 * @brief Set a output dpms handler
515 * @details A backend module needs to call the output dpms handler when the
516 * output DPMS has been changed to let the TDM frontend know the change.
517 * @param[in] output A output object
518 * @param[in] func A output dpms handler
519 * @param[in] user_data The user data
520 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
523 tdm_error (*output_set_dpms_handler)(tdm_output *output,
524 tdm_output_dpms_handler func,
526 void (*reserved2)(void);
527 void (*reserved3)(void);
528 void (*reserved4)(void);
529 void (*reserved5)(void);
530 void (*reserved6)(void);
531 void (*reserved7)(void);
532 void (*reserved8)(void);
536 * @brief The layer functions for a backend module.
538 typedef struct _tdm_func_layer {
540 * @brief Get the capabilities of a layer object
541 * @param[in] layer A layer object
542 * @param[out] caps The capabilities of a layer object
543 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
545 * A backend module @b SHOULD implement this function. TDM calls this function
546 * not only at the initial time, but also at the update time when new output
548 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
550 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
553 * @brief Set the property which has a given id.
554 * @param[in] layer A layer object
555 * @param[in] id The property id
556 * @param[in] value The value
557 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
559 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
563 * @brief Get the property which has a given id.
564 * @param[in] layer A layer object
565 * @param[in] id The property id
566 * @param[out] value The value
567 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
569 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
573 * @brief Set the geometry information to a layer object
574 * @param[in] layer A layer object
575 * @param[in] info The geometry information
576 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
577 * @see output_commit() function of #tdm_func_output
579 * A backend module would apply the geometry information when the output object
580 * of a layer object is committed.
582 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
585 * @brief Get the geometry information to a layer object
586 * @param[in] layer A layer object
587 * @param[out] info The geometry information
588 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
590 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
593 * @brief Set a TDM buffer to a layer object
594 * @param[in] layer A layer object
595 * @param[in] buffer A TDM buffer
596 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
597 * @see output_commit() function of #tdm_func_output
599 * A backend module would show a TDM buffer on screen when the output object
600 * of a layer object is committed.
602 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
605 * @brief Unset a TDM buffer from a layer object
606 * @param[in] layer A layer object
607 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
609 * A backend module @b SHOULD remove the current showing buffer from screen.
611 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
614 * @brief Set the zpos for a VIDEO layer object
615 * @param[in] layer A layer object
616 * @param[in] zpos z-order
617 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
618 * @see tdm_caps_layer, tdm_layer_capability
620 * A backend module doesn't need to implement this function if a backend
621 * module doesn't have VIDEO layers.\n
622 * This function is for VIDEO layers.
623 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
624 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
625 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
626 * is less than GRAPHIC layers or more than GRAPHIC layers.
627 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
628 * The zpos of VIDEO layers is @b relative. It doesn't need to start
629 * from -1 or 4. Let's suppose that there are two VIDEO layers.
630 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
631 * than -4 VIDEO layer.
633 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
636 * @brief Create a capture object of a layer object
637 * @param[in] output A output object
638 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
639 * @return A capture object
640 * @see capture_destroy() function of #tdm_func_capture
642 * A backend module doesn't need to implement this function if a hardware
643 * doesn't have the capture device.
645 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
648 * @brief Get buffer flags which the layer can support.
649 * @param[in] layer A layer object
650 * @param[out] flags The buffer flags which should be the tbm_bo flags
651 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
653 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
655 void (*reserved1)(void);
656 void (*reserved2)(void);
657 void (*reserved3)(void);
658 void (*reserved4)(void);
659 void (*reserved5)(void);
660 void (*reserved6)(void);
661 void (*reserved7)(void);
665 * @brief The pp functions for a backend module.
667 typedef struct _tdm_func_pp {
669 * @brief Destroy a pp object
670 * @param[in] pp A pp object
671 * @see display_create_pp() function of #tdm_func_display
673 void (*pp_destroy)(tdm_pp *pp);
676 * @brief Set the geometry information to a pp object
677 * @param[in] pp A pp object
678 * @param[in] info The geometry information
679 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
680 * @see pp_commit() function of #tdm_func_pp
682 * A backend module would apply the geometry information when committed.
684 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
687 * @brief Attach a source buffer and a destination buffer to a pp object
688 * @param[in] pp A pp object
689 * @param[in] src A source buffer
690 * @param[in] dst A destination buffer
691 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
692 * @see pp_set_info() function of #tdm_func_pp
693 * @see pp_commit() function of #tdm_func_pp
694 * @see pp_set_done_handler, tdm_pp_done_handler
696 * A backend module converts the image of a source buffer to a destination
697 * buffer when committed. The size/crop/transform information is set via
698 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
699 * return the source/destination buffer via tdm_pp_done_handler.
701 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
704 * @brief Commit changes for a pp object
705 * @param[in] pp A pp object
706 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
708 tdm_error (*pp_commit)(tdm_pp *pp);
711 * @brief Set a user done handler to a pp object
712 * @param[in] pp A pp object
713 * @param[in] func A user done handler
714 * @param[in] user_data user data
715 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
717 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
719 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
722 void (*reserved1)(void);
723 void (*reserved2)(void);
724 void (*reserved3)(void);
725 void (*reserved4)(void);
726 void (*reserved5)(void);
727 void (*reserved6)(void);
728 void (*reserved7)(void);
729 void (*reserved8)(void);
733 * @brief The capture functions for a backend module.
735 typedef struct _tdm_func_capture {
737 * @brief Destroy a capture object
738 * @param[in] capture A capture object
739 * @see output_create_capture() function of #tdm_func_output
740 * @see layer_create_capture() function of #tdm_func_layer
742 void (*capture_destroy)(tdm_capture *capture);
745 * @brief Set the geometry information to a capture object
746 * @param[in] capture A capture object
747 * @param[in] info The geometry information
748 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
749 * @see capture_commit() function of #tdm_func_capture
751 * A backend module would apply the geometry information when committed.
753 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
756 * @brief Attach a TDM buffer to a capture object
757 * @details When capture_commit() function is called, a backend module starts
758 * to dump a output or a layer to a TDM buffer.
759 * @param[in] capture A capture object
760 * @param[in] buffer A TDM buffer
761 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
762 * @see capture_set_info() function of #tdm_func_capture
763 * @see capture_commit() function of #tdm_func_capture
764 * @see capture_set_done_handler, tdm_capture_done_handler
766 * A backend module starts to dump a output or a layer to to a TDM buffer when
767 * committed. The size/crop/transform information is set via #capture_set_info()
768 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
769 * buffer via tdm_capture_done_handler.
771 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
774 * @brief Commit changes for a capture object
775 * @param[in] capture A capture object
776 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
778 tdm_error (*capture_commit)(tdm_capture *capture);
781 * @brief Set a user done handler to a capture object
782 * @param[in] capture A capture object
783 * @param[in] func A user done handler
784 * @param[in] user_data user data
785 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
787 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
789 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
790 tdm_capture_done_handler func, void *user_data);
792 void (*reserved1)(void);
793 void (*reserved2)(void);
794 void (*reserved3)(void);
795 void (*reserved4)(void);
796 void (*reserved5)(void);
797 void (*reserved6)(void);
798 void (*reserved7)(void);
799 void (*reserved8)(void);
803 * @brief The tdm event source
805 typedef void tdm_event_loop_source;
808 * @brief The fd source handler
810 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
813 * @brief The timer source handler
815 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
817 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
818 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
819 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
820 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
824 * The ABI version of TDM backend module. It has a major and minor revision.
825 * Modules using lower minor revisions will work with TDM frontend of a higher
826 * minor revision. There is no compatibility between different major revisions.
827 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
830 * tdm_backend_module tdm_backend_module_data = {
833 * TDM_BACKEND_SET_ABI_VERSION(1,1),
839 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
840 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
841 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
845 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
847 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
849 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
852 * @brief The backend module information of the entry point to initialize a TDM
855 * A backend module @b SHOULD define the global data symbol of which name is
856 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
857 * at the initial time and call init() function of #tdm_backend_module.
859 typedef struct _tdm_backend_module {
860 const char *name; /**< The module name of a backend module */
861 const char *vendor; /**< The vendor name of a backend module */
862 unsigned long abi_version; /**< The ABI version of a backend module */
865 * @brief The init function of a backend module
866 * @param[in] dpy A display object
867 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
868 * @return The backend module data
869 * @see tdm_backend_data
871 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
874 * @brief The deinit function of a backend module
875 * @param[in] bdata The backend module data
877 void (*deinit)(tdm_backend_data *bdata);
878 } tdm_backend_module;
881 * @brief Register the backend display functions to a display
882 * @param[in] dpy A display object
883 * @param[in] func_display display functions
884 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
885 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
887 * A backend module @b SHOULD set the backend display functions at least.
890 tdm_backend_register_func_display(tdm_display *dpy,
891 tdm_func_display *func_display);
894 * @brief Register the backend output functions to a display
895 * @param[in] dpy A display object
896 * @param[in] func_output output functions
897 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
898 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
900 * A backend module @b SHOULD set the backend output functions at least.
903 tdm_backend_register_func_output(tdm_display *dpy,
904 tdm_func_output *func_output);
907 * @brief Register the backend layer functions to a display
908 * @param[in] dpy A display object
909 * @param[in] func_layer layer functions
910 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
911 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
913 * A backend module @b SHOULD set the backend layer functions at least.
916 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
919 * @brief Register the backend pp functions to a display
920 * @param[in] dpy A display object
921 * @param[in] func_pp pp functions
922 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
923 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
925 * A backend module doesn'tcan skip to register the backend pp functions
926 * if a hardware doesn't have the memory-to-memory converting device.
929 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
932 * @brief Register the backend capture functions to a display
933 * @param[in] dpy A display object
934 * @param[in] func_capture capture functions
935 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
936 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
938 * A backend module can skip to register the backend capture functions
939 * if a hardware doesn't have the capture device.
942 tdm_backend_register_func_capture(tdm_display *dpy,
943 tdm_func_capture *func_capture);
946 * @brief Increase the ref_count of a TDM buffer
948 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
949 * becomes available for a next job. A TDM buffer can be used for TDM to show
950 * it on screen or to capture an output and a layer. After all operations,
951 * TDM will release it immediately when TDM doesn't need it any more.
952 * @param[in] buffer A TDM buffer
953 * @return A buffer itself. Otherwise, NULL.
954 * @see tdm_buffer_unref_backend
956 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
957 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
958 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
961 tdm_buffer_ref_backend(tbm_surface_h buffer);
964 * @brief Decrease the ref_count of a TDM buffer
965 * @param[in] buffer A TDM buffer
966 * @see tdm_buffer_ref_backend
969 tdm_buffer_unref_backend(tbm_surface_h buffer);
972 * @brief The destroy handler of a TDM buffer
973 * @param[in] buffer A TDM buffer
974 * @param[in] user_data user data
975 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
977 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
981 * @brief Add a destroy handler to a TDM buffer
982 * @param[in] buffer A TDM buffer
983 * @param[in] func A destroy handler
984 * @param[in] user_data user data
985 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
986 * @see tdm_buffer_remove_destroy_handler
988 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
989 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
993 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
994 tdm_buffer_destroy_handler func, void *user_data);
997 * @brief Remove a destroy handler from a TDM buffer
998 * @param[in] buffer A TDM buffer
999 * @param[in] func A destroy handler
1000 * @param[in] user_data user data
1001 * @see tdm_buffer_add_destroy_handler
1004 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1005 tdm_buffer_destroy_handler func, void *user_data);
1008 * @brief Add a FD handler for activity on the given file descriptor
1009 * @param[in] dpy A display object
1010 * @param[in] fd A file descriptor
1011 * @param[in] mask to monitor FD
1012 * @param[in] func A FD handler function
1013 * @param[in] user_data user data
1014 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1015 * @return A FD event source
1016 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1018 tdm_event_loop_source*
1019 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1020 tdm_event_loop_fd_handler func, void *user_data,
1024 * @brief Update the mask of the given FD event source
1025 * @param[in] source The given FD event source
1026 * @param[in] mask to monitor FD
1027 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1030 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1033 * @brief Add a timer handler
1034 * @param[in] dpy A display object
1035 * @param[in] func A timer handler function
1036 * @param[in] user_data user data
1037 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1038 * @return A timer event source
1039 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1041 tdm_event_loop_source*
1042 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1043 void *user_data, tdm_error *error);
1046 * @brief Update the millisecond delay time of the given timer event source.
1047 * @param[in] source The given timer event source
1048 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1049 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1052 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1055 * @brief Remove the given event source
1056 * @param[in] source The given event source
1057 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1060 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1066 #endif /* _TDM_BACKEND_H_ */