+/**
+ * @brief The output functions for a backend module.
+ */
+typedef struct _tdm_func_output {
+ /**
+ * @brief Get the capabilities of a output object
+ * @param[in] output A output object
+ * @param[out] caps The capabilities of a output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module @b SHOULD implement this function. TDM calls this function
+ * not only at the initial time, but also at the update time when new output
+ * is connected.\n
+ * #tdm_caps_output contains connection status, modes, avaiable properties,
+ * size restriction information, etc.
+ */
+ tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
+
+ /**
+ * @brief Get a layer array of a output object
+ * @param[in] output A output object
+ * @param[out] count The count of layers
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A layer array which is @b newly-allocated
+ * @remark
+ * A backend module @b SHOULD implement this function. TDM calls this function
+ * not only at the initial time, but also at the update time when new output
+ * is connected.\n
+ * A backend module @b SHOULD return the @b newly-allocated array which contains
+ * "tdm_layer*" data. It will be freed in frontend.
+ */
+ tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
+ tdm_error *error);
+
+ /**
+ * @brief Set the property which has a given id
+ * @param[in] output A output object
+ * @param[in] id The property id
+ * @param[in] value The value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
+ tdm_value value);
+
+ /**
+ * @brief Get the property which has a given id
+ * @param[in] output A output object
+ * @param[in] id The property id
+ * @param[out] value The value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
+ tdm_value *value);
+
+ /**
+ * @brief Wait for VBLANK
+ * @param[in] output A output object
+ * @param[in] interval vblank interval
+ * @param[in] sync 0: asynchronous, 1:synchronous
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see output_set_vblank_handler, tdm_output_vblank_handler
+ * @remark
+ * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
+ * a user vblank handler with the user data of this function after interval
+ * vblanks.
+ */
+ tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
+ void *user_data);
+
+ /**
+ * @brief Set a user vblank handler
+ * @param[in] output A output object
+ * @param[in] func A user vblank handler
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_set_vblank_handler)(tdm_output *output,
+ tdm_output_vblank_handler func);
+
+ /**
+ * @brief Commit changes for a output object
+ * @param[in] output A output object
+ * @param[in] sync 0: asynchronous, 1:synchronous
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see output_set_commit_handler, tdm_output_commit_handler
+ * @remark
+ * When this function is called, a backend module @b SHOULD apply the all
+ * changes of the given output object to screen as well as the layer changes
+ * of this output.
+ * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
+ * a user commit handler with the user data of this function after all
+ * changes of the given output object are applied.
+ */
+ tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
+
+ /**
+ * @brief Set a user commit handler
+ * @param[in] output A output object
+ * @param[in] func A user commit handler
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_set_commit_handler)(tdm_output *output,
+ tdm_output_commit_handler func);
+
+ /**
+ * @brief Set DPMS of a output object synchronously
+ * @param[in] output A output object
+ * @param[in] dpms_value DPMS value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
+
+ /**
+ * @brief Get DPMS of a output object
+ * @param[in] output A output object
+ * @param[out] dpms_value DPMS value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
+
+ /**
+ * @brief Set one of available modes of a output object
+ * @param[in] output A output object
+ * @param[in] mode A output mode
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
+
+ /**
+ * @brief Get the mode of a output object
+ * @param[in] output A output object
+ * @param[out] mode A output mode
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
+
+ /**
+ * @brief Create a capture object of a output object
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A capture object
+ * @see capture_destroy() function of #tdm_func_capture
+ * @remark
+ * A backend module doesn't need to implement this function if a hardware
+ * doesn't have the capture device.
+ */
+ tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
+
+ /**
+ * @brief Set a output connection status handler
+ * @details A backend module need to call the output status handler when the
+ * output connection status has been changed to let the TDM frontend know
+ * the change.
+ * @param[in] output A output object
+ * @param[in] func A output status handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 1.1.0
+ */
+ tdm_error (*output_set_status_handler)(tdm_output *output,
+ tdm_output_status_handler func,
+ void *user_data);
+
+ /**
+ * @brief Set a output dpms handler
+ * @details This function can be NULL if an output doesn't support asynchronous
+ * DPMS control. Otherwise, a backend module needs to call the output dpms handler
+ * to let the TDM frontend know the output DPMS change indeed.
+ * @param[in] output A output object
+ * @param[in] func A output dpms handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
+ * @since 1.4.0
+ */
+ tdm_error (*output_set_dpms_handler)(tdm_output *output,
+ tdm_output_dpms_handler func,
+ void *user_data);
+
+ /**
+ * @brief Set DPMS of a output object asynchronously
+ * @param[in] output A output object
+ * @details This function can be NULL if an output doesn't support asynchronous
+ * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
+ * flags which #output_get_capability returns. And if a output dpms handler is added with
+ * #output_set_dpms_handler, a backend module needs to call the output dpms handler
+ * to let the TDM frontend know the output DPMS change indeed.
+ * @param[in] dpms_value DPMS value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
+ * @since 1.7.0
+ */
+ tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
+
+ /**
+ * @brief Get a hwc object of a output object
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A hwc object
+ */
+ tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
+
+ /**
+ * @brief Set the mirror image of the src_output to the output
+ * @details This function set the mirro image of the src_output to the output.
+ * If there is the hardware or the implementation to display the mirror image
+ * of the src_output to the output, the backend does it in this function.
+ * If the backend output gets the ability of the mirror displaying, it has to
+ * set the TDM_OUTPUT_CAPABILITY_MIRROR on the output capability.
+ * @param[in] output A output object to display the src_output image
+ * @param[in] src_output A src output object of which image is displayed on the output
+ * @param[in] transform A transform value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
+ */
+ tdm_error (*output_set_mirror)(tdm_output *output,
+ tdm_output *src_output,
+ tdm_transform transform);
+ /**
+ * @brief Unset the mirror image
+ * @details This function unset the mirro image of the output.
+ * @param[in] output A output object to display the src_output image
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
+ */
+ tdm_error (*output_unset_mirror)(tdm_output *output);
+
+ void (*reserved4)(void);
+ void (*reserved5)(void);
+ void (*reserved6)(void);
+ void (*reserved7)(void);
+ void (*reserved8)(void);
+} tdm_func_output;
+
+typedef struct _tdm_func_voutput {
+ /**
+ * @brief Destroy a virtual output object of a backend module
+ * @param[in] voutput The voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see voutput_create() function
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_destroy)(tdm_voutput *voutput);
+
+ /**
+ * @brief Set available modes of a virtual output object
+ * @param[in] voutput A voutput object
+ * @param[in] modes Modes of voutput
+ * @param[in] count A count of modes
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
+
+ /**
+ * @brief Set physical size(mm) of a virtual output object
+ * @param[in] voutput A voutput object
+ * @param[in] mmwidth Width of voutput
+ * @param[in] mmheight Height of voutput
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
+
+ /**
+ * @brief Set connect status of a virtual output object
+ * @param[in] voutput A voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_connect)(tdm_voutput *voutput);
+
+ /**
+ * @brief Set disconnect status of a virtual output object
+ * @param[in] voutput A voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
+
+ /**
+ * @brief Get output object from virtual output object
+ * @param[in] voutput A voutput object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A tdm_output object
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
+
+ /**
+ * @brief Set a user commit function
+ * @param[in] voutput A voutput object
+ * @param[in] func A user voutput commit function
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ * If virtual output's output_commit is executed, call this voutput commit func.
+ */
+ tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
+
+ /**
+ * @brief Notify commit done to backend
+ * @param[in] voutput A voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
+
+ void (*reserved1)(void);
+ void (*reserved2)(void);
+ void (*reserved3)(void);
+ void (*reserved4)(void);
+ void (*reserved5)(void);
+ void (*reserved6)(void);
+} tdm_func_voutput;
+/**
+ * @brief The layer functions for a backend module.
+ */
+typedef struct _tdm_func_layer {
+ /**
+ * @brief Get the capabilities of a layer object
+ * @param[in] layer A layer object
+ * @param[out] caps The capabilities of a layer object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module @b SHOULD implement this function. TDM calls this function
+ * not only at the initial time, but also at the update time when new output
+ * is connected.\n
+ * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
+ */
+ tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
+
+ /**
+ * @brief Set the property which has a given id.
+ * @param[in] layer A layer object
+ * @param[in] id The property id
+ * @param[in] value The value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
+ tdm_value value);
+
+ /**
+ * @brief Get the property which has a given id.
+ * @param[in] layer A layer object
+ * @param[in] id The property id
+ * @param[out] value The value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
+ tdm_value *value);
+
+ /**
+ * @brief Set the geometry information to a layer object
+ * @param[in] layer A layer object
+ * @param[in] info The geometry information
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see output_commit() function of #tdm_func_output
+ * @remark
+ * A backend module would apply the geometry information when the output object
+ * of a layer object is committed.
+ */
+ tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
+
+ /**
+ * @brief Get the geometry information to a layer object
+ * @param[in] layer A layer object
+ * @param[out] info The geometry information
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
+
+ /**
+ * @brief Set a TDM buffer to a layer object
+ * @param[in] layer A layer object
+ * @param[in] buffer A TDM buffer
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see output_commit() function of #tdm_func_output
+ * @remark
+ * A backend module would show a TDM buffer on screen when the output object
+ * of a layer object is committed.
+ */
+ tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
+
+ /**
+ * @brief Unset a TDM buffer from a layer object
+ * @param[in] layer A layer object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module @b SHOULD remove the current showing buffer from screen.
+ */
+ tdm_error (*layer_unset_buffer)(tdm_layer *layer);
+
+ /**
+ * @brief Set the zpos for a VIDEO layer object
+ * @param[in] layer A layer object
+ * @param[in] zpos z-order
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_caps_layer, tdm_layer_capability
+ * @remark
+ * A backend module doesn't need to implement this function if a backend
+ * module doesn't have VIDEO layers.\n
+ * This function is for VIDEO layers.
+ * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
+ * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
+ * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
+ * is less than GRAPHIC layers or more than GRAPHIC layers.
+ * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
+ * The zpos of VIDEO layers is @b relative. It doesn't need to start
+ * from -1 or 4. Let's suppose that there are two VIDEO layers.
+ * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
+ * than -4 VIDEO layer.
+ */
+ tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
+
+ /**
+ * @brief Create a capture object of a layer object
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A capture object
+ * @see capture_destroy() function of #tdm_func_capture
+ * @remark
+ * A backend module doesn't need to implement this function if a hardware
+ * doesn't have the capture device.
+ */
+ tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
+
+ /**
+ * @brief Get buffer flags which the layer can support.
+ * @param[in] layer A layer object
+ * @param[out] flags The buffer flags which should be the tbm_bo flags
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
+
+ void (*reserved1)(void);
+ void (*reserved2)(void);
+ void (*reserved3)(void);
+ void (*reserved4)(void);
+ void (*reserved5)(void);
+ void (*reserved6)(void);
+ void (*reserved7)(void);
+} tdm_func_layer;
+
+typedef struct _tdm_func_hwc {
+ /**
+ * @brief Create a new window on the given hwc.
+ * @param[in] hwc A hwc object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A created window object
+ * @since 2.0.0
+ */
+ tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);