-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
- * A backend module @b SHOULD call a user vblank handler 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
- * A backend module @b SHOULD call a user commit handler after all change of
- * a 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
- * @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);
-
- void (*reserved1)(void);
- void (*reserved2)(void);
- void (*reserved3)(void);
- void (*reserved4)(void);
- void (*reserved5)(void);
- void (*reserved6)(void);
- void (*reserved7)(void);
- void (*reserved8)(void);
+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 Creates a new window on the given display.
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A created window object
+ * @since 2.0.0
+ */
+ tdm_hwc_window *(*output_hwc_create_window)(tdm_output *output, tdm_error *error);
+
+ /**
+ * @brief Destroys the given window.
+ * @param[in] output A output object
+ * @param[in] window the pointer of the window to destroy
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*output_hwc_destroy_window)(tdm_output *output, tdm_hwc_window *hwc_window);
+
+ /**
+ * @brief Set the client(relative to the TDM) target buffer
+ * @details Sets the buffer which will receive the output of client composition.
+ * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
+ * will be composited into this buffer prior to the call to output_commit(),
+ * and windows not marked as TDM_COMPOSITION_CLIENT and
+ * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
+ * device.
+ *
+ * The buffer handle provided may be null if no windows are being composited by
+ * the client. This must not result in an error (unless an invalid display
+ * handle is also provided).
+ *
+ * The damage parameter describes a buffer damage region as defined in the
+ * description of hwc_window_set_buffer_damage().
+ *
+ * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer)
+ * will be passed along with #target_buffer to allow tdm to make the smooth transition
+ * from a DEVICE type to a CLIENT type.
+ *
+ * Will be called before output_commit() if any of the layers are marked as
+ * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
+ * so marked, then it is not necessary to call this function. It is not necessary
+ * to call output_hwc_validate() after changing the target through this function.
+ * @param[in] output A output object
+ * @param[in] target The new target buffer
+ * @param[in] damage The buffer damage region
+ * @param[in] composited_wnds The array of composited hwc_wnds
+ * @param[in] num_wnds The size of #composited_wnds array
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*output_hwc_set_client_target_buffer)(tdm_output *output, tbm_surface_h target_buffer, tdm_hwc_region damage);
+
+ /**
+ * @brief Unset the client(relative to the TDM) target buffer
+ * @details TODO
+ * @param[in] output A output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*output_hwc_unset_client_target_buffer)(tdm_output *output);
+
+ /**
+ * @brief Get the layer associated with the client target buffer
+ * @details TODO:
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A layer object.
+ * @since 2.0.0
+ */
+ tdm_layer *(*output_hwc_get_client_target_buffer_layer)(tdm_output *output, tdm_error *error);
+
+ /**
+ * @brief Get the buffer which is set to the client target buffer
+ * @details TODO:
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A layer object.
+ * @since 2.0.0
+ */
+ tbm_surface_h (*output_hwc_get_client_target_buffer)(tdm_output *output, tdm_error *error);
+
+ /**
+ * @brief Validate the output
+ * @details Instructs the device to inspect all of the layer state and
+ * determine if there are any composition type changes necessary before
+ * presenting the output. Permitted changes are described in the definition
+ * of tdm_composition_t above.
+ * @param[in] output A output object
+ * @param[out] num_types The number of composition type changes required by
+ * the device; if greater than 0, the client must either set and validate new
+ * types, or call output_hwc_accept_changes() to accept the changes returned by
+ * output_hwc_get_changed_composition_types(); must be the same as the number of
+ * changes returned by output_hwc_get_changed_composition_types (see the
+ * declaration of that function for more information); pointer will be non-NULL
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*output_hwc_validate)(tdm_output *output, tdm_hwc_window **composited_wnds, uint32_t num_wnds,
+ uint32_t *num_types);
+
+ /**
+ * @brief Get changed composition types
+ * @details Retrieves the windows for which the device requires a different
+ * composition type than had been set prior to the last call to output_hwc_validate().
+ * The client will either update its state with these types and call
+ * output_hwc_accept_changes, or will set new types and attempt to validate the
+ * display again.
+ * layers and types may be NULL to retrieve the number of elements which
+ * will be returned. The number of elements returned must be the same as the
+ * value returned in num_types from the last call to output_hwc_validate().
+ * @param[in] output A output object
+ * @param[out] num_elements If windows or types were NULL, the number of layers
+ * and types which would have been returned; if both were non-NULL, the
+ * number of elements returned in layers and types, which must not exceed
+ * the value stored in num_elements prior to the call; pointer will be
+ * non-NULL
+ * @param[out] windows An array of windows
+ * @param[out] composition_types An array of composition types, each
+ * corresponding to an element of windows
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*output_hwc_get_changed_composition_types)(tdm_output *output,
+ uint32_t *num_elements,
+ tdm_hwc_window **hwc_window,
+ tdm_hwc_window_composition *composition_types);
+ /**
+ * @brief Accepts the changes required by the device
+ * @details Accepts the changes required by the device from the previous
+ * output_hwc_validate() call (which may be queried using
+ * output_get_chaged_composition_types()) and revalidates the display. This
+ * function is equivalent to requesting the changed types from
+ * output_get_chaged_composition_types(), setting those types on the
+ * corresponding windows, and then calling output_hwc_validate again.
+ * After this call it must be valid to present this display. Calling this after
+ * output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
+ * should have no other effect.
+ * @param[in] output A output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*output_hwc_accept_changes)(tdm_output *output);
+
+ /**
+ * @brief Get a target buffer queue
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A buffer queue
+ * @since 2.0.0
+ */
+ tbm_surface_queue_h (*output_hwc_get_target_buffer_queue)(tdm_output *output,
+ tdm_error *error);
+
+ /**
+ * @brief Get the supported format array for video hwc windows of a output object.
+ * @param[in] output A output object
+ * @param[out] formats The available format array
+ * @param[out] count The count of formats
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*output_hwc_get_video_supported_formats)(tdm_layer *layer,
+ const tbm_format **formats, int *count);
+
+ /**
+ * @brief Creates a new video window on the given output.
+ * @param[in] output A output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A created window object. If the video abilities isn't accessed return NULL
+ * @since 2.0.0
+ */
+ tdm_hwc_window *(*output_hwc_create_video_window)(tdm_output *output, tdm_error *error);
+
+ void (*reserved5)(void);
+ void (*reserved6)(void);
+ void (*reserved7)(void);
+ void (*reserved8)(void);