* Taeheon Kim <th908.kim@samsung.com>,
* YoungJun Cho <yj44.cho@samsung.com>,
* SooChan Lim <sc1.lim@samsung.com>,
- * Boram Park <sc1.lim@samsung.com>
+ * Boram Park <boram1288.park@samsung.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
#define _TDM_BACKEND_H_
#include <tbm_surface.h>
+#include <tbm_surface_queue.h>
#include "tdm_types.h"
* @see The display_get_capability() function of #tdm_func_display
*/
typedef struct _tdm_caps_display {
- int max_layer_count; /**< The maximum layer count. -1 means "not defined" */
+ int max_layer_count; /**< The maximum layer count */
} tdm_caps_display;
/**
unsigned int type_id; /**< The connection type id */
unsigned int mode_count; /**< The count of available modes */
- tdm_output_mode
- *modes; /**< The @b newly-allocated array of modes. will be freed in frontend. */
+ tdm_output_mode *modes; /**< The @b newly-allocated array of modes. will be freed in frontend. */
unsigned int prop_count; /**< The count of available properties */
tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
unsigned int mmHeight; /**< The physical height (milimeter) */
unsigned int subpixel; /**< The subpixel */
- int min_w; /**< The minimun width. -1 means "not defined" */
- int min_h; /**< The minimun height. -1 means "not defined" */
- int max_w; /**< The maximum width. -1 means "not defined" */
- int max_h; /**< The maximum height. -1 means "not defined" */
- int preferred_align; /**< The prefered align. -1 means "not defined" */
+ int min_w; /**< The minimun width */
+ int min_h; /**< The minimun height */
+ int max_w; /**< The maximum width */
+ int max_h; /**< The maximum height */
+ int preferred_align; /**< The prefered align */
tdm_output_capability capabilities; /**< The capabilities of output. @since 1.4.1 */
- int cursor_min_w; /**< The minimun width. -1 means "not defined" @since 1.5.0 */
- int cursor_min_h; /**< The minimun height. -1 means "not defined" @since 1.5.0 */
- int cursor_max_w; /**< The maximum width. -1 means "not defined" @since 1.5.0 */
- int cursor_max_h; /**< The maximum height. -1 means "not defined" @since 1.5.0 */
- int cursor_preferred_align; /**< The prefered align. -1 means "not defined" @since 1.5.0 */
+ int cursor_min_w; /**< The minimun width. @since 1.5.0 */
+ int cursor_min_h; /**< The minimun height. @since 1.5.0 */
+ int cursor_max_w; /**< The maximum width. @since 1.5.0 */
+ int cursor_max_h; /**< The maximum height. @since 1.5.0 */
+ int cursor_preferred_align; /**< The prefered align. @since 1.5.0 */
} tdm_caps_output;
/**
tbm_format
*formats; /**< The @b newly-allocated array. will be freed in frontend. */
- int min_w; /**< The minimun width. -1 means "not defined" */
- int min_h; /**< The minimun height. -1 means "not defined" */
- int max_w; /**< The maximum width. -1 means "not defined" */
- int max_h; /**< The maximum height. -1 means "not defined" */
- int preferred_align; /**< The prefered align. -1 means "not defined" */
+ int min_w; /**< The minimun width */
+ int min_h; /**< The minimun height */
+ int max_w; /**< The maximum width */
+ int max_h; /**< The maximum height */
+ int preferred_align; /**< The prefered align */
- /**< The attach count which a PP object can handle.
- * -1 means "not defined".
- * @since 1.2.0
- */
+ /**< The attach count which a PP object can handle. @since 1.2.0 */
int max_attach_count;
} tdm_caps_pp;
tbm_format
*formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
- int min_w; /**< The minimun width. -1 means "not defined" */
- int min_h; /**< The minimun height. -1 means "not defined" */
- int max_w; /**< The maximum width. -1 means "not defined" */
- int max_h; /**< The maximum height. -1 means "not defined" */
- int preferred_align; /**< The prefered align. -1 means "not defined" */
+ int min_w; /**< The minimun width */
+ int min_h; /**< The minimun height */
+ int max_w; /**< The maximum width */
+ int max_h; /**< The maximum height */
+ int preferred_align; /**< The prefered align */
- /**< The attach count which a capture object can handle.
- * -1 means "not defined".
- * @since 1.2.0
- */
+ /**< The attach count which a capture object can handle. @since 1.2.0 */
int max_attach_count;
} tdm_caps_capture;
* is connected.\n
* If a hardware has the restriction of the number of max usable layer count,
* a backend module can set the max count to max_layer_count of #tdm_caps_display
- * structure. Otherwise, set -1.
+ * structure.
*/
tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
tdm_output_commit_handler func);
/**
- * @brief Set DPMS of a output object
+ * @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.
/**
* @brief Get the mode of a output object
- * @deprecated
* @param[in] output A output object
* @param[out] mode A output mode
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
/**
* @brief Set a output dpms handler
- * @details A backend module needs to call the output dpms handler when the
- * output DPMS has been changed to let the TDM frontend know the change.
+ * @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);
- void (*reserved2)(void);
- void (*reserved3)(void);
- void (*reserved4)(void);
+
+ /**
+ * @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);
+
void (*reserved5)(void);
void (*reserved6)(void);
void (*reserved7)(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);
+
+ /**
+ * @brief Get the supported format array for the hwc windows of a hwc object.
+ * @param[in] hwc A hwc 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 (*hwc_get_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
+ int *count);
+
+
+ /**
+ * @brief Get the available property array of a hwc object.
+ * @param[in] hwc A hwc object
+ * @param[out] props The available property array
+ * @param[out] count The count of properties
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
+ int *count);
+
+ /**
+ * @brief Get a target buffer queue
+ * @param[in] hwc A hwc object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A buffer queue
+ * @since 2.0.0
+ */
+ tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
+ tdm_error *error);
+
+ /**
+ * @brief Set the client(relative to the TDM) target buffer
+ * @details Sets the buffer which will receive the hwc 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 hwc_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().
+ *
+ * Will be called before hwc_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 hwc_validate() after changing the target through this function.
+ * @param[in] hwc A hwc 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 (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
+ tbm_surface_h target_buffer,
+ tdm_region damage);
+
+ /**
+ * @brief Validate the hwc
+ * @details Instructs the device to inspect all of the layer state and
+ * determine if there are any composition type changes necessary before
+ * presenting the hwc. Permitted changes are described in the definition
+ * of tdm_composition_t above.
+ * @param[in] hwc A hwc 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 hwc_accept_changes() to accept the changes returned by
+ * hwc_get_changed_composition_types(); must be the same as the number of
+ * changes returned by 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 (*hwc_validate)(tdm_hwc *hwc, 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 hwc_validate().
+ * The client will either update its state with these types and call
+ * 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 hwc_validate().
+ * @param[in] hwc A hwc 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 (*hwc_get_changed_composition_types)(tdm_hwc *hwc, 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
+ * hwc_validate() call (which may be queried using
+ * hwc_get_chaged_composition_types()) and revalidates the display. This
+ * function is equivalent to requesting the changed types from
+ * hwc_get_chaged_composition_types(), setting those types on the
+ * corresponding windows, and then calling hwc_validate again.
+ * After this call it must be valid to present this display. Calling this after
+ * hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
+ * should have no other effect.
+ * @param[in] hwc A hwc object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+ tdm_error (*hwc_accept_changes)(tdm_hwc *hwc);
+
+ /**
+ * @brief Commit changes for a output object
+ * @param[in] hwc A hwc 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 hwc_set_commit_handler, tdm_hwc_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 (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
+
+ /**
+ * @brief Set a user commit handler
+ * @param[in] hwc A hwc object
+ * @param[in] func A user commit handler
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_set_commit_handler)(tdm_output *hwc, tdm_hwc_commit_handler func);
+} tdm_func_hwc;
+
+/**
+ * @brief The window functions for a backend module.
+ * @since 2.0.0
+ */
+typedef struct _tdm_func_hwc_window {
+ /**
+ * @brief Destroys the given window.
+ * @param[in] window the pointer of the window to destroy
+ * @since 2.0.0
+ */
+ void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
+
+ /**
+ * @brief Get a buffer queue for the window object
+ * @param[in] hwc_window A window object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A buffer queue
+ */
+ tbm_surface_queue_h (*hwc_window_get_buffer_queue)(tdm_hwc_window *hwc_window,
+ tdm_error *error);
+
+ /**
+ * @brief Sets the desired composition type of the given window.
+ * @details During hwc_validate(), the device may request changes to
+ * the composition types of any of the layers as described in the definition
+ * of tdm_hwc_window_composition_t above.
+ * @param[in] hwc_window A window object
+ * @param[in] composition_type The new composition type
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
+ tdm_hwc_window_composition composition_type);
+
+ /**
+ * @brief Set the buffer damage
+ * @details Provides the region of the source buffer which has been modified
+ * since the last frame. This region does not need to be validated before
+ * calling hwc_commit().
+ * Once set through this function, the damage region remains the same until a
+ * subsequent call to this function.
+ * If damage.num_rects > 0, then it may be assumed that any portion of the source
+ * buffer not covered by one of the rects has not been modified this frame. If
+ * damage.num_rects == 0, then the whole source buffer must be treated as if it
+ * has been modified.
+ * If the layer's contents are not modified relative to the prior frame, damage
+ * will contain exactly one empty rect([0, 0, 0, 0]).
+ * The damage rects are relative to the pre-transformed buffer, and their origin
+ * is the top-left corner. They will not exceed the dimensions of the latched
+ * buffer.
+ * @param[in] hwc_window A window object
+ * @param[in] damage The new buffer damage region
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
+ tdm_region damage);
+
+ /**
+ * @brief Set the information to a window object
+ * @details The information will be applied when the hwc object
+ * of a layer object is committed.
+ * @param[in] hwc_window A window object
+ * @param[in] info The geometry information
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
+ tdm_hwc_window_info *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 (*hwc_window_get_info)(tdm_hwc_window *hwc_window,
+ tdm_hwc_window_info *info);
+
+ /**
+ * @brief Set a TDM buffer to a window object
+ * @details A TDM buffer will be applied when the hwc object
+ * of a layer object is committed.
+ * @param[in] hwc_window A window object
+ * @param[in] buffer A TDM buffer
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ *
+ * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
+ * be updated right now, this won't be interpreted like some critical
+ * error.
+ */
+ tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
+ tbm_surface_h buffer);
+
+ /**
+ * @brief Set the property which has a given id.
+ * @param[in] hwc window A hwc window object
+ * @param[in] id The property id
+ * @param[in] value The value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
+ uint32_t id, tdm_value value);
+
+ /**
+ * @brief Get the property which has a given id.
+ * @param[in] hwc window A hwc window object
+ * @param[in] id The property id
+ * @param[out] value The value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
+ uint32_t id, tdm_value *value);
+} tdm_func_hwc_window;
+
/**
* @brief The pp functions for a backend module.
*/
tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
/**
+ * @brief Register the backend hwc functions to a display
+ * @param[in] dpy A display object
+ * @param[in] func_hwc hwc functions
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_register_func_display, tdm_backend_register_func_output
+ * @remarks
+ * A backend module @b SHOULD set the backend hwc functions at least.
+ * @since 2.0.0
+ */
+tdm_error
+tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
+
+/**
+ * @brief Register the backend hwc_window functions to a display
+ * @param[in] dpy A display object
+ * @param[in] func_hwc_window hwc_window functions
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_register_func_display, tdm_backend_register_func_output
+ * @remarks
+ * A backend module @b SHOULD set the backend hwc_window functions at least.
+ * @since 2.0.0
+ */
+tdm_error
+tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
+
+/**
* @brief Register the backend pp functions to a display
* @param[in] dpy A display object
* @param[in] func_pp pp functions
void
tdm_event_loop_source_remove(tdm_event_loop_source *source);
+/**
+ * @brief Get the ini value with given key
+ * @details
+ * @param[in] key The given key
+ * @param[in] default_value The default value
+ * @return the value of given key if success. Otherwise, default_value.
+ * @see #tdm_config_get_string
+ */
+int
+tdm_config_get_int(const char *key, int default_value);
+
+/**
+ * @brief Get the ini value with given key
+ * @details
+ * @param[in] key The given key
+ * @param[in] default_value The default value
+ * @return the value of given key if success. Otherwise, default_value.
+ * @see #tdm_config_get_int
+ */
+const char *
+tdm_config_get_string(const char *key, const char *default_value);
+
#ifdef __cplusplus
}
#endif
projects / platform / core / uifw / libtdm.git / blobdiff