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. -1 means "not defined" */
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. -1 means "not defined" */
116 int min_h; /**< The minimun height. -1 means "not defined" */
117 int max_w; /**< The maximum width. -1 means "not defined" */
118 int max_h; /**< The maximum height. -1 means "not defined" */
119 int preferred_align; /**< The prefered align. -1 means "not defined" */
121 tdm_output_capability capabilities; /**< The capabilities of output. @since 1.4.1 */
125 * @brief The capabilities structure of a layer object
126 * @see The layer_get_capability() function of #tdm_func_layer
128 typedef struct _tdm_caps_layer {
129 tdm_layer_capability capabilities; /**< The capabilities of layer */
133 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
134 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
135 * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
136 * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
137 * layers or more than GRAPHIC layers.
138 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
139 * The zpos of VIDEO layers is @b relative. It doesn't need to start
140 * from -1 or 4. Let's suppose that there are two VIDEO layers.
141 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
142 * than -4 VIDEO layer.
146 unsigned int format_count; /**< The count of available formats */
148 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
150 unsigned int prop_count; /**< The count of available properties */
151 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
155 * @brief The capabilities structure of a pp object
156 * @see The display_get_pp_capability() function of #tdm_func_display
158 typedef struct _tdm_caps_pp {
159 tdm_pp_capability capabilities; /**< The capabilities of pp */
161 unsigned int format_count; /**< The count of available formats */
163 *formats; /**< The @b newly-allocated array. will be freed in frontend. */
165 int min_w; /**< The minimun width. -1 means "not defined" */
166 int min_h; /**< The minimun height. -1 means "not defined" */
167 int max_w; /**< The maximum width. -1 means "not defined" */
168 int max_h; /**< The maximum height. -1 means "not defined" */
169 int preferred_align; /**< The prefered align. -1 means "not defined" */
171 /**< The attach count which a PP object can handle.
172 * -1 means "not defined".
175 int max_attach_count;
179 * @brief The capabilities structure of a capture object
180 * @see The display_get_capture_capability() function of #tdm_func_display
182 typedef struct _tdm_caps_capture {
183 tdm_capture_capability capabilities; /**< The capabilities of capture */
185 unsigned int format_count; /**< The count of available formats */
187 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
189 int min_w; /**< The minimun width. -1 means "not defined" */
190 int min_h; /**< The minimun height. -1 means "not defined" */
191 int max_w; /**< The maximum width. -1 means "not defined" */
192 int max_h; /**< The maximum height. -1 means "not defined" */
193 int preferred_align; /**< The prefered align. -1 means "not defined" */
195 /**< The attach count which a capture object can handle.
196 * -1 means "not defined".
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
217 * structure. Otherwise, set -1.
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 tdm_error (*display_get_capabilitiy)(tdm_backend_data *bdata, tdm_caps_display *caps);
340 void (*reserved2)(void);
341 void (*reserved3)(void);
342 void (*reserved4)(void);
343 void (*reserved5)(void);
344 void (*reserved6)(void);
345 void (*reserved7)(void);
346 void (*reserved8)(void);
350 * @brief The output functions for a backend module.
352 typedef struct _tdm_func_output {
354 * @brief Get the capabilities of a output object
355 * @param[in] output A output object
356 * @param[out] caps The capabilities of a output object
357 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
359 * A backend module @b SHOULD implement this function. TDM calls this function
360 * not only at the initial time, but also at the update time when new output
362 * #tdm_caps_output contains connection status, modes, avaiable properties,
363 * size restriction information, etc.
365 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
368 * @brief Get a layer array of a output object
369 * @param[in] output A output object
370 * @param[out] count The count of layers
371 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
372 * @return A layer array which is @b newly-allocated
374 * A backend module @b SHOULD implement this function. TDM calls this function
375 * not only at the initial time, but also at the update time when new output
377 * A backend module @b SHOULD return the @b newly-allocated array which contains
378 * "tdm_layer*" data. It will be freed in frontend.
380 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
384 * @brief Set the property which has a given id
385 * @param[in] output A output object
386 * @param[in] id The property id
387 * @param[in] value The value
388 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
390 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
394 * @brief Get the property which has a given id
395 * @param[in] output A output object
396 * @param[in] id The property id
397 * @param[out] value The value
398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
400 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
404 * @brief Wait for VBLANK
405 * @param[in] output A output object
406 * @param[in] interval vblank interval
407 * @param[in] sync 0: asynchronous, 1:synchronous
408 * @param[in] user_data The user data
409 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
410 * @see output_set_vblank_handler, tdm_output_vblank_handler
412 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
413 * a user vblank handler with the user data of this function after interval
416 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
420 * @brief Set a user vblank handler
421 * @param[in] output A output object
422 * @param[in] func A user vblank handler
423 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
425 tdm_error (*output_set_vblank_handler)(tdm_output *output,
426 tdm_output_vblank_handler func);
429 * @brief Commit changes for a output object
430 * @param[in] output A output object
431 * @param[in] sync 0: asynchronous, 1:synchronous
432 * @param[in] user_data The user data
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
434 * @see output_set_commit_handler, tdm_output_commit_handler
436 * When this function is called, a backend module @b SHOULD apply the all
437 * changes of the given output object to screen as well as the layer changes
439 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
440 * a user commit handler with the user data of this function after all
441 * changes of the given output object are applied.
443 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
446 * @brief Set a user commit handler
447 * @param[in] output A output object
448 * @param[in] func A user commit handler
449 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
451 tdm_error (*output_set_commit_handler)(tdm_output *output,
452 tdm_output_commit_handler func);
455 * @brief Set DPMS of a output object
456 * @param[in] output A output object
457 * @param[in] dpms_value DPMS value
458 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
460 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
463 * @brief Get DPMS of a output object
464 * @param[in] output A output object
465 * @param[out] dpms_value DPMS value
466 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
468 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
471 * @brief Set one of available modes of a output object
472 * @param[in] output A output object
473 * @param[in] mode A output mode
474 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
476 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
479 * @brief Get the mode of a output object
481 * @param[in] output A output object
482 * @param[out] mode A output mode
483 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
485 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
488 * @brief Create a capture object of a output object
489 * @param[in] output A output object
490 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
491 * @return A capture object
492 * @see capture_destroy() function of #tdm_func_capture
494 * A backend module doesn't need to implement this function if a hardware
495 * doesn't have the capture device.
497 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
500 * @brief Set a output connection status handler
501 * @details A backend module need to call the output status handler when the
502 * output connection status has been changed to let the TDM frontend know
504 * @param[in] output A output object
505 * @param[in] func A output status handler
506 * @param[in] user_data The user data
507 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
510 tdm_error (*output_set_status_handler)(tdm_output *output,
511 tdm_output_status_handler func,
515 * @brief Set a output dpms handler
516 * @details A backend module needs to call the output dpms handler when the
517 * output DPMS has been changed to let the TDM frontend know the change.
518 * @param[in] output A output object
519 * @param[in] func A output dpms handler
520 * @param[in] user_data The user data
521 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
524 tdm_error (*output_set_dpms_handler)(tdm_output *output,
525 tdm_output_dpms_handler func,
527 void (*reserved2)(void);
528 void (*reserved3)(void);
529 void (*reserved4)(void);
530 void (*reserved5)(void);
531 void (*reserved6)(void);
532 void (*reserved7)(void);
533 void (*reserved8)(void);
537 * @brief The layer functions for a backend module.
539 typedef struct _tdm_func_layer {
541 * @brief Get the capabilities of a layer object
542 * @param[in] layer A layer object
543 * @param[out] caps The capabilities of a layer object
544 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
546 * A backend module @b SHOULD implement this function. TDM calls this function
547 * not only at the initial time, but also at the update time when new output
549 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
551 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
554 * @brief Set the property which has a given id.
555 * @param[in] layer A layer object
556 * @param[in] id The property id
557 * @param[in] value The value
558 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
560 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
564 * @brief Get the property which has a given id.
565 * @param[in] layer A layer object
566 * @param[in] id The property id
567 * @param[out] value The value
568 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
570 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
574 * @brief Set the geometry information to a layer object
575 * @param[in] layer A layer object
576 * @param[in] info The geometry information
577 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
578 * @see output_commit() function of #tdm_func_output
580 * A backend module would apply the geometry information when the output object
581 * of a layer object is committed.
583 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
586 * @brief Get the geometry information to a layer object
587 * @param[in] layer A layer object
588 * @param[out] info The geometry information
589 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
591 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
594 * @brief Set a TDM buffer to a layer object
595 * @param[in] layer A layer object
596 * @param[in] buffer A TDM buffer
597 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
598 * @see output_commit() function of #tdm_func_output
600 * A backend module would show a TDM buffer on screen when the output object
601 * of a layer object is committed.
603 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
606 * @brief Unset a TDM buffer from a layer object
607 * @param[in] layer A layer object
608 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
610 * A backend module @b SHOULD remove the current showing buffer from screen.
612 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
615 * @brief Set the zpos for a VIDEO layer object
616 * @param[in] layer A layer object
617 * @param[in] zpos z-order
618 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
619 * @see tdm_caps_layer, tdm_layer_capability
621 * A backend module doesn't need to implement this function if a backend
622 * module doesn't have VIDEO layers.\n
623 * This function is for VIDEO layers.
624 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
625 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
626 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
627 * is less than GRAPHIC layers or more than GRAPHIC layers.
628 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
629 * The zpos of VIDEO layers is @b relative. It doesn't need to start
630 * from -1 or 4. Let's suppose that there are two VIDEO layers.
631 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
632 * than -4 VIDEO layer.
634 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
637 * @brief Create a capture object of a layer object
638 * @param[in] output A output object
639 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
640 * @return A capture object
641 * @see capture_destroy() function of #tdm_func_capture
643 * A backend module doesn't need to implement this function if a hardware
644 * doesn't have the capture device.
646 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
649 * @brief Get buffer flags which the layer can support.
650 * @param[in] layer A layer object
651 * @param[out] flags The buffer flags which should be the tbm_bo flags
652 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
654 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
656 void (*reserved1)(void);
657 void (*reserved2)(void);
658 void (*reserved3)(void);
659 void (*reserved4)(void);
660 void (*reserved5)(void);
661 void (*reserved6)(void);
662 void (*reserved7)(void);
666 * @brief The pp functions for a backend module.
668 typedef struct _tdm_func_pp {
670 * @brief Destroy a pp object
671 * @param[in] pp A pp object
672 * @see display_create_pp() function of #tdm_func_display
674 void (*pp_destroy)(tdm_pp *pp);
677 * @brief Set the geometry information to a pp object
678 * @param[in] pp A pp object
679 * @param[in] info The geometry information
680 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
681 * @see pp_commit() function of #tdm_func_pp
683 * A backend module would apply the geometry information when committed.
685 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
688 * @brief Attach a source buffer and a destination buffer to a pp object
689 * @param[in] pp A pp object
690 * @param[in] src A source buffer
691 * @param[in] dst A destination buffer
692 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
693 * @see pp_set_info() function of #tdm_func_pp
694 * @see pp_commit() function of #tdm_func_pp
695 * @see pp_set_done_handler, tdm_pp_done_handler
697 * A backend module converts the image of a source buffer to a destination
698 * buffer when committed. The size/crop/transform information is set via
699 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
700 * return the source/destination buffer via tdm_pp_done_handler.
702 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
705 * @brief Commit changes for a pp object
706 * @param[in] pp A pp object
707 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
709 tdm_error (*pp_commit)(tdm_pp *pp);
712 * @brief Set a user done handler to a pp object
713 * @param[in] pp A pp object
714 * @param[in] func A user done handler
715 * @param[in] user_data user data
716 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
718 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
720 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
723 void (*reserved1)(void);
724 void (*reserved2)(void);
725 void (*reserved3)(void);
726 void (*reserved4)(void);
727 void (*reserved5)(void);
728 void (*reserved6)(void);
729 void (*reserved7)(void);
730 void (*reserved8)(void);
734 * @brief The capture functions for a backend module.
736 typedef struct _tdm_func_capture {
738 * @brief Destroy a capture object
739 * @param[in] capture A capture object
740 * @see output_create_capture() function of #tdm_func_output
741 * @see layer_create_capture() function of #tdm_func_layer
743 void (*capture_destroy)(tdm_capture *capture);
746 * @brief Set the geometry information to a capture object
747 * @param[in] capture A capture object
748 * @param[in] info The geometry information
749 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
750 * @see capture_commit() function of #tdm_func_capture
752 * A backend module would apply the geometry information when committed.
754 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
757 * @brief Attach a TDM buffer to a capture object
758 * @details When capture_commit() function is called, a backend module starts
759 * to dump a output or a layer to a TDM buffer.
760 * @param[in] capture A capture object
761 * @param[in] buffer A TDM buffer
762 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
763 * @see capture_set_info() function of #tdm_func_capture
764 * @see capture_commit() function of #tdm_func_capture
765 * @see capture_set_done_handler, tdm_capture_done_handler
767 * A backend module starts to dump a output or a layer to to a TDM buffer when
768 * committed. The size/crop/transform information is set via #capture_set_info()
769 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
770 * buffer via tdm_capture_done_handler.
772 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
775 * @brief Commit changes for a capture object
776 * @param[in] capture A capture object
777 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
779 tdm_error (*capture_commit)(tdm_capture *capture);
782 * @brief Set a user done handler to a capture object
783 * @param[in] capture A capture object
784 * @param[in] func A user done handler
785 * @param[in] user_data user data
786 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
788 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
790 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
791 tdm_capture_done_handler func, void *user_data);
793 void (*reserved1)(void);
794 void (*reserved2)(void);
795 void (*reserved3)(void);
796 void (*reserved4)(void);
797 void (*reserved5)(void);
798 void (*reserved6)(void);
799 void (*reserved7)(void);
800 void (*reserved8)(void);
804 * @brief The tdm event source
806 typedef void tdm_event_loop_source;
809 * @brief The fd source handler
811 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
814 * @brief The timer source handler
816 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
818 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
819 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
820 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
821 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
825 * The ABI version of TDM backend module. It has a major and minor revision.
826 * Modules using lower minor revisions will work with TDM frontend of a higher
827 * minor revision. There is no compatibility between different major revisions.
828 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
831 * tdm_backend_module tdm_backend_module_data = {
834 * TDM_BACKEND_SET_ABI_VERSION(1,1),
840 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
841 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
842 ((major) & TDM_BACKEND_MINOR_VERSION_MASK)
846 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
848 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
850 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
853 * @brief The backend module information of the entry point to initialize a TDM
856 * A backend module @b SHOULD define the global data symbol of which name is
857 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
858 * at the initial time and call init() function of #tdm_backend_module.
860 typedef struct _tdm_backend_module {
861 const char *name; /**< The module name of a backend module */
862 const char *vendor; /**< The vendor name of a backend module */
863 unsigned long abi_version; /**< The ABI version of a backend module */
866 * @brief The init function of a backend module
867 * @param[in] dpy A display object
868 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
869 * @return The backend module data
870 * @see tdm_backend_data
872 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
875 * @brief The deinit function of a backend module
876 * @param[in] bdata The backend module data
878 void (*deinit)(tdm_backend_data *bdata);
879 } tdm_backend_module;
882 * @brief Register the backend display functions to a display
883 * @param[in] dpy A display object
884 * @param[in] func_display display functions
885 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
886 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
888 * A backend module @b SHOULD set the backend display functions at least.
891 tdm_backend_register_func_display(tdm_display *dpy,
892 tdm_func_display *func_display);
895 * @brief Register the backend output functions to a display
896 * @param[in] dpy A display object
897 * @param[in] func_output output functions
898 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
899 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
901 * A backend module @b SHOULD set the backend output functions at least.
904 tdm_backend_register_func_output(tdm_display *dpy,
905 tdm_func_output *func_output);
908 * @brief Register the backend layer functions to a display
909 * @param[in] dpy A display object
910 * @param[in] func_layer layer functions
911 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
912 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
914 * A backend module @b SHOULD set the backend layer functions at least.
917 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
920 * @brief Register the backend pp functions to a display
921 * @param[in] dpy A display object
922 * @param[in] func_pp pp functions
923 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
924 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
926 * A backend module doesn'tcan skip to register the backend pp functions
927 * if a hardware doesn't have the memory-to-memory converting device.
930 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
933 * @brief Register the backend capture functions to a display
934 * @param[in] dpy A display object
935 * @param[in] func_capture capture functions
936 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
937 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
939 * A backend module can skip to register the backend capture functions
940 * if a hardware doesn't have the capture device.
943 tdm_backend_register_func_capture(tdm_display *dpy,
944 tdm_func_capture *func_capture);
947 * @brief Increase the ref_count of a TDM buffer
949 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
950 * becomes available for a next job. A TDM buffer can be used for TDM to show
951 * it on screen or to capture an output and a layer. After all operations,
952 * TDM will release it immediately when TDM doesn't need it any more.
953 * @param[in] buffer A TDM buffer
954 * @return A buffer itself. Otherwise, NULL.
955 * @see tdm_buffer_unref_backend
957 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
958 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
959 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
962 tdm_buffer_ref_backend(tbm_surface_h buffer);
965 * @brief Decrease the ref_count of a TDM buffer
966 * @param[in] buffer A TDM buffer
967 * @see tdm_buffer_ref_backend
970 tdm_buffer_unref_backend(tbm_surface_h buffer);
973 * @brief The destroy handler of a TDM buffer
974 * @param[in] buffer A TDM buffer
975 * @param[in] user_data user data
976 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
978 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
982 * @brief Add a destroy handler to a TDM buffer
983 * @param[in] buffer A TDM buffer
984 * @param[in] func A destroy handler
985 * @param[in] user_data user data
986 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
987 * @see tdm_buffer_remove_destroy_handler
989 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
990 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
994 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
995 tdm_buffer_destroy_handler func, void *user_data);
998 * @brief Remove a destroy handler from a TDM buffer
999 * @param[in] buffer A TDM buffer
1000 * @param[in] func A destroy handler
1001 * @param[in] user_data user data
1002 * @see tdm_buffer_add_destroy_handler
1005 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1006 tdm_buffer_destroy_handler func, void *user_data);
1009 * @brief Add a FD handler for activity on the given file descriptor
1010 * @param[in] dpy A display object
1011 * @param[in] fd A file descriptor
1012 * @param[in] mask to monitor FD
1013 * @param[in] func A FD handler function
1014 * @param[in] user_data user data
1015 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1016 * @return A FD event source
1017 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1019 tdm_event_loop_source*
1020 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1021 tdm_event_loop_fd_handler func, void *user_data,
1025 * @brief Update the mask of the given FD event source
1026 * @param[in] source The given FD event source
1027 * @param[in] mask to monitor FD
1028 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1031 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1034 * @brief Add a timer handler
1035 * @param[in] dpy A display object
1036 * @param[in] func A timer handler function
1037 * @param[in] user_data user data
1038 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1039 * @return A timer event source
1040 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1042 tdm_event_loop_source*
1043 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1044 void *user_data, tdm_error *error);
1047 * @brief Update the millisecond delay time of the given timer event source.
1048 * @param[in] source The given timer event source
1049 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1050 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1053 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1056 * @brief Remove the given event source
1057 * @param[in] source The given event source
1058 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1061 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1067 #endif /* _TDM_BACKEND_H_ */