X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm_backend.h;h=1b73ba9e9e70376a61ac8114b83a8cd39be47964;hb=d18570c1256f15468761ccf7eece3f329c1d3c5b;hp=2de8c7b35879f97a4950289c03277e5a15d1b93f;hpb=7f8c3b416f50b7a13d22f79cfc813d5ef8c34d79;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm_backend.h b/include/tdm_backend.h index 2de8c7b..1b73ba9 100644 --- a/include/tdm_backend.h +++ b/include/tdm_backend.h @@ -9,7 +9,7 @@ * Taeheon Kim , * YoungJun Cho , * SooChan Lim , - * Boram Park + * Boram Park * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the @@ -37,6 +37,7 @@ #define _TDM_BACKEND_H_ #include +#include #include "tdm_types.h" @@ -102,8 +103,7 @@ typedef struct _tdm_caps_output { 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. */ @@ -150,8 +150,7 @@ typedef struct _tdm_caps_layer { int zpos; unsigned int format_count; /**< The count of available formats */ - tbm_format - *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */ + tbm_format *formats; /**< The @b newly-allocated array of formats. 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. */ @@ -335,7 +334,18 @@ typedef struct _tdm_func_display { */ tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error); - void (*reserved1)(void); + /** + * @brief Create a virtual output object of a backend module + * @param[in] bdata The backend module data + * @param[in] name The output name + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A tdm_voutput object + * @see voutput_destroy() function + * @remark + * A backend module doesn't need to implement this function if doesn't support virtual output. + */ + tdm_voutput *(*voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error); + void (*reserved2)(void); void (*reserved3)(void); void (*reserved4)(void); @@ -476,7 +486,6 @@ typedef struct _tdm_func_output { /** * @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. @@ -541,6 +550,14 @@ typedef struct _tdm_func_output { */ 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 (*reserved3)(void); void (*reserved4)(void); void (*reserved5)(void); @@ -549,6 +566,94 @@ typedef struct _tdm_func_output { 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. */ @@ -678,6 +783,281 @@ typedef struct _tdm_func_layer { 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 video 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_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats, + int *count); + /** + * @brief Get the available video property array of a hwc object. + * @param[in] hwc A hwc object + * @param[out] props The available video property array + * @param[out] count The count of video properties + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ + tdm_error (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props, + int *count); + + /** + * @brief Get the hwc video capability + * @param[in] hwc A hwc object + * @param[out] video_capability A hwc hwc video capability + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ + tdm_error (*hwc_get_video_capability)(tdm_hwc *hwc, + tdm_hwc_video_capability *video_capability); + + /** + * @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 This function lets the backend know the target buffer. + * The target buffer contains the result of the gl composition with the + * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT. + * @param[in] hwc A hwc object + * @param[in] target_buffer The new target buffer + * @param[in] damage The buffer damage region + * @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 backend to inspect all of the hw layer state and + * determine if there are any composition type changes necessary before + * presenting the hwc. + * @param[in] hwc A hwc object + * @param[in] composited_wnds the hwc window list which is visible. + * @param[in] num_wnds the number of the visible windows in the composited_wnds + * @param[out] num_types The number of composition type changes + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @remark + * The backend has to return the num_types when the assgined comopsite types of + * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than + * 0, the cleint must get the changed composite types of the tdm_hwc_windows + * and change the comopsite types + * @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 backend requires a different + * composition types that had been set prior to the last call to tdm_hwc_validate(). + * The client will either update its state with these types and call + * tdm_hwc_accept_validation, or will set new types and attempt to validate the + * display again. The number of elements returned must be the same as the + * value returned in num_types from the last call to tdm_hwc_validate(). + * @param[in] hwc A hwc object + * @param[out] num_elements the number of hwc_windows + * @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 validation required by the backend + * @details Accepts the validation required by the backend from the previous + * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types(). + * @param[in] hwc A hwc object + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ + tdm_error (*hwc_accept_validation)(tdm_hwc *hwc); + + /** + * @brief Commit changes for a hwc 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 hwc object to screen as well as the layer changes + * of this hwc. + * 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 hwc 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_hwc *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 Acquire a buffer queue for the window object + * @details These buffers are used to composite by hardware a client content in + * the nocomp mode. + * @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_acquire_buffer_queue)(tdm_hwc_window *hwc_window, + tdm_error *error); + + /** + * @brief Release a buffer queue for the window object + * @details Release buffer queue when the client no longer uses buferrs of queue. + * @param[in] hwc_window A window object + * @param[in] A tbm buffer queue + */ + void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window, + tbm_surface_queue_h queue); + + /** + * @brief Sets the desired composition type of the given window. + * @details During hwc_validate(), the backend 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 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 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 TBM buffer + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ + 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 of the propery id + * @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 of the propery id + * @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); + + /** + * @brief Get the constraints of hwc_window + * @param[in] hwc_window A hwc window object + * @param[out] constraints The tdm_hwc_window_constraint types + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ + tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window, + int *constraints); + + /** + * @brief Set the name of hwc_window + * @param[in] hwc_window A hwc window object + * @param[in] name of the hwc_window + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ + tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window, + const char *name); +} tdm_func_hwc_window; + /** * @brief The pp functions for a backend module. */ @@ -857,6 +1237,11 @@ typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data); (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \ ((minor) & TDM_BACKEND_MINOR_VERSION_MASK) + +#define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0) +#define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0) +#define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */ + /** * @brief * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this. @@ -921,6 +1306,18 @@ tdm_backend_register_func_output(tdm_display *dpy, tdm_func_output *func_output); /** + * @brief Register the backend voutput functions to a display + * @param[in] dpy A display object + * @param[in] func_voutput voutput 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 doesn't need to implement this function if doesn't support virtual output. + */ +tdm_error +tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput); + +/** * @brief Register the backend layer functions to a display * @param[in] dpy A display object * @param[in] func_layer layer functions @@ -933,6 +1330,32 @@ tdm_error 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 @@ -960,6 +1383,26 @@ tdm_backend_register_func_capture(tdm_display *dpy, tdm_func_capture *func_capture); /** + * @brief Register the backend output to a display + * @param[in] dpy A display object + * @param[in] output A backend output object + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @see tdm_backend_unregister_output + */ +tdm_error +tdm_backend_register_output(tdm_display *dpy, tdm_output *output); + +/** + * @brief Unregister the backend output to a display + * @param[in] dpy A display object + * @param[in] output A backend output object + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @see tdm_backend_register_output + */ +void +tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output); + +/** * @brief Increase the ref_count of a TDM buffer * @details * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer @@ -1076,6 +1519,28 @@ tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int m 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