X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm_backend.h;h=9a30004e774eb7d4f71fa6e489063b034380e6ca;hb=7e1f4f71006d85a16303b0b70e5b9d0e45b7e9ec;hp=a3bd3b36c1da8a1e2a76397076f1d49d80a7cd9c;hpb=5b11cd1859acaf702bff92e255beab372b7421ee;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm_backend.h b/include/tdm_backend.h index a3bd3b3..9a30004 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 @@ -103,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. */ @@ -336,8 +335,10 @@ typedef struct _tdm_func_display { */ tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error); - void (*reserved1)(void); - void (*reserved2)(void); + /* virtual */ + tdm_output *(*display_output_create)(tdm_backend_data *bdata, const char *name, tdm_error *error); + tdm_error (*display_output_destroy)(tdm_backend_data *bdata, tdm_output *output); + void (*reserved3)(void); void (*reserved4)(void); void (*reserved5)(void); @@ -477,7 +478,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. @@ -543,147 +543,12 @@ typedef struct _tdm_func_output { tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value); /** - * @brief Creates a new window on the given display. + * @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 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 + * @return A hwc object */ - 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 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); + tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error); void (*reserved5)(void); void (*reserved6)(void); @@ -820,23 +685,190 @@ 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 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_window { +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_tbm_buffer_queue)(tdm_hwc_window *hwc_window, - tdm_error *error); + 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 output_hwc_validate(), the device may request changes to + * @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 @@ -850,7 +882,7 @@ typedef struct _tdm_func_window { * @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 output_commit(). + * 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 @@ -867,11 +899,11 @@ typedef struct _tdm_func_window { * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window, - tdm_hwc_region damage); + tdm_region damage); /** * @brief Set the information to a window object - * @details The information will be applied when the output 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 @@ -881,91 +913,48 @@ typedef struct _tdm_func_window { tdm_hwc_window_info *info); /** - * @brief Set a TDM buffer to a window object - * @details A TDM buffer will be applied when the output object - * of a layer object is committed. - * @param[in] hwc_window A window object - * @param[in] buffer A TDM buffer + * @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. - * - * 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); + tdm_error (*hwc_window_get_info)(tdm_hwc_window *hwc_window, + tdm_hwc_window_info *info); /** - * @brief Unset a TDM buffer to a window object - * @details A TDM buffer will be applied when the output object + * @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_unset_buffer)(tdm_hwc_window *hwc_window); - - /** - * @brief Set a flags to a window object - * @param[in] hwc_window A window object - * @param[in] flags A hwc_window flags - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ - tdm_error (*hwc_window_set_flags)(tdm_hwc_window *hwc_window, - tdm_hwc_window_flag flags); - - /** - * @brief Unset a flags from a window object - * @param[in] hwc_window A window object - * @param[in] flags A hwc_window flags - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ - tdm_error (*hwc_window_unset_flags)(tdm_hwc_window *hwc_window, - tdm_hwc_window_flag flags); - - /** - * @brief Get the window video capability - * @param[in] hwc_window A window object - * @param[out] video_capability A hwc window video capability - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ - tdm_error (*hwc_window_video_get_capability)(tdm_hwc_window *hwc_window, - tdm_hwc_window_video_capability *video_capability); + tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window, + tbm_surface_h buffer); /** - * @brief Get the available property array of a video hwc window object. - * @param[in] hwc window A video hwc window object - * @param[out] props The available property array - * @param[out] count The count of properties + * @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_video_get_available_properties)( - tdm_hwc_window *hwc_window, - const tdm_prop **props, int *count); + 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 video hwc window object + * @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_video_get_property)(tdm_hwc_window *hwc_window, - uint32_t id, tdm_value *value); - - /** - * @brief Set the property which has a given id. - * @param[in] hwc window A video 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_video_set_property)(tdm_hwc_window *hwc_window, - uint32_t id, tdm_value value); - + tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window, + uint32_t id, tdm_value *value); } tdm_func_hwc_window; /** @@ -1147,6 +1136,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. @@ -1223,6 +1217,19 @@ 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 @@ -1380,14 +1387,26 @@ void tdm_event_loop_source_remove(tdm_event_loop_source *source); /** - * @brief Trigger a 'need to validate' event. - * @param[in] output The output the event should be triggered for. - * @note The global display lock has to be locked before the call to this function. - * @see #tdm_output_hwc_set_need_validate_handler - * @since 2.0.0 + * @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 */ -tdm_error -tdm_backend_trigger_need_validate_event(tdm_output *output); +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 }