X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm.h;h=c334b20093ef850b06a8c220db8b6e0d7574dfe3;hb=859f51f8606bff3235d75130635ade4e8a8ce338;hp=f90fbe8ad7f5ab4ff886c185eec81d1983a01ea7;hpb=1eeff4b0b05d15287ed013a3529a3abe18563b8d;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm.h b/include/tdm.h index f90fbe8..c334b20 100644 --- a/include/tdm.h +++ b/include/tdm.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 @@ -43,6 +43,7 @@ #include #include "tdm_types.h" +#include "tdm_deprecated.h" #ifdef __cplusplus extern "C" { @@ -58,24 +59,6 @@ extern "C" { */ /** - * @brief The display capability enumeration - */ -typedef enum { - TDM_DISPLAY_CAPABILITY_PP = (1 << 0), /**< if hardware supports pp operation */ - TDM_DISPLAY_CAPABILITY_CAPTURE = (1 << 1), /**< if hardware supports capture operation */ -} tdm_display_capability; - -/** - * @brief The output change handler - * @details This handler will be called when the status of a output object is - * changed in runtime. - */ -typedef void (*tdm_output_change_handler)(tdm_output *output, - tdm_output_change_type type, - tdm_value value, - void *user_data); - -/** * @brief Initialize a display object * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. * @return A display object @@ -93,17 +76,6 @@ void tdm_display_deinit(tdm_display *dpy); /** - * @brief Update a display object - * @details - * When new output is connected, a frontend user need to call this function. - * And a frontend user can the new output information with tdm_output_get_xxx functions. - * @param[in] dpy A display object - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ -tdm_error -tdm_display_update(tdm_display *dpy); - -/** * @brief Get the file descriptor * @details TDM handles the events of fd with #tdm_display_handle_events. * @param[in] dpy A display object @@ -124,16 +96,11 @@ tdm_error tdm_display_handle_events(tdm_display *dpy); /** - * @brief Get the information of the TDM backend module. + * @brief Flush the all events to clients * @param[in] dpy A display object - * @param[out] name The name of the TDM backend module - * @param[out] vendor The vendor of the TDM backend module - * @param[out] version The version of the TDM backend module - * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ -tdm_error -tdm_display_get_backend_info(tdm_display *dpy, const char **name, - const char **vendor, int *major, int *minor); +void +tdm_display_flush(tdm_display *dpy); /** * @brief Get the capabilities of a display object. @@ -200,7 +167,7 @@ tdm_display_get_capture_capabilities(tdm_display *dpy, * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ tdm_error -tdm_display_get_catpure_available_formats(tdm_display *dpy, +tdm_display_get_capture_available_formats(tdm_display *dpy, const tbm_format **formats, int *count); /** @@ -219,16 +186,6 @@ tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h, int *max_w, int *max_h, int *preferred_align); /** - * @brief Get the max layer counts which a display object can show on screen. - * @details -1 means that a TDM backend module doesn't define the value. - * @param[in] dpy A display object - * @param[out] count The max count of layers - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ -tdm_error -tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count); - -/** * @brief Get the output counts which a display object has. * @param[in] dpy A display object * @param[out] count The count of outputs @@ -250,6 +207,40 @@ tdm_output * tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error); /** + * @brief Add a output create handler + * @param[in] output A output object + * @param[in] func A output create handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_display_add_output_create_handler(tdm_display *dpy, + tdm_output_create_handler func, + void *user_data); + +/** + * @brief Remove a output create handler + * @param[in] output A output object + * @param[in] func A output create handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +void +tdm_display_remove_output_create_handler(tdm_display *dpy, + tdm_output_create_handler func, + void *user_data); + +/** + * @brief Find a output object which has the given name. + * @param[in] dpy A display object + * @param[in] name The name of a output object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A output object if success. Otherwise, NULL. + */ +tdm_output * +tdm_display_find_output(tdm_display *dpy, const char *name, tdm_error *error); + +/** * @brief Create a pp object. * @param[in] dpy A display object * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. @@ -260,6 +251,51 @@ tdm_pp * tdm_display_create_pp(tdm_display *dpy, tdm_error *error); /** + * @brief Get the information of the TDM backend module. + * @param[in] module A backend module object + * @param[out] name The name of the TDM backend module + * @param[out] vendor The vendor of the TDM backend module + * @param[out] version The version of the TDM backend module + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_module_get_info(tdm_module *module, const char **name, + const char **vendor, int *major, int *minor); + +/** + * @brief Add a output destroy handler + * @param[in] output A output object + * @param[in] func A output destroy handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_add_destroy_handler(tdm_output *output, + tdm_output_destroy_handler func, + void *user_data); + +/** + * @brief Remove a output destroy handler + * @param[in] output A output object + * @param[in] func A output destroy handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +void +tdm_output_remove_destroy_handler(tdm_output *output, + tdm_output_destroy_handler func, + void *user_data); + +/** + * @brief Get a backend module object of the given output. + * @param[in] output A output object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A backend object if success. Otherwise, NULL. + */ +tdm_module * +tdm_output_get_backend_module(tdm_output *output, tdm_error *error); + +/** * @brief Get the capabilities of a output object. * @param[in] output A output object * @param[out] capabilities The capabilities of a output object @@ -317,6 +353,30 @@ tdm_output_remove_change_handler(tdm_output *output, void *user_data); /** + * @brief Add a output mode change handler + * @param[in] output A output object + * @param[in] func A output mode change handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_add_mode_change_request_handler(tdm_output *output, + tdm_output_mode_change_request_handler func, + void *user_data); + +/** + * @brief Remove a output mode change handler + * @param[in] output A output object + * @param[in] func A output mode change handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_remove_mode_change_request_handler(tdm_output *output, + tdm_output_mode_change_request_handler func, + void *user_data); + +/** * @brief Get the connection type of a output object. * @param[in] output A output object * @param[out] type The connection type. @@ -560,6 +620,15 @@ tdm_error tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value); /** + * @brief Check if a output object has the capture capability + * @param[in] output A output object + * @param[out] has_capability 1: has the capability, 0: not has the capability + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_has_capture_capability(tdm_output *output, unsigned int *has_capability); + +/** * @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. @@ -570,199 +639,50 @@ tdm_capture * tdm_output_create_capture(tdm_output *output, tdm_error *error); /** - * @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 * -tdm_output_hwc_create_window(tdm_output *output, tdm_error *error); - -/** - * @brief Creates a new video window on the given output. + * @brief Get a hwc associated with 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 * -tdm_output_hwc_create_video_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 -tdm_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 tdm_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 tdm_hwc_window_set_buffer_damage(). - * - * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer) - * should be passed along with #target_buffer to allow tdm to make the smooth transition - * from a DEVICE type to a CLIENT type. - * - * Should be called before tdm_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 tdm_output_hwc_validate() after changing the target through this function. - * @param[in] output A output object - * @param[in] target_buffer 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 -tdm_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. + * @return A hwc object * @since 2.0.0 */ -tdm_error -tdm_output_hwc_unset_client_target_buffer(tdm_output *output); - -/** - * @brief Commit changes for a target_window - * @details After all change of a window object are applied, a user commit handler - * will be called. - * @param[in] hwc_window A window object - * @param[in] func A user commit handler - * @param[in] user_data The user data - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ -tdm_error -tdm_output_hwc_commit_client_target_buffer(tdm_output *output, tdm_output_hwc_target_buffer_commit_handler func, void *user_data); +tdm_hwc * +tdm_output_get_hwc(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_hwc_window_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 tdm_output_hwc_accept_changes() to accept the changes returned by - * tdm_output_hwc_get_changed_composition_types(); must be the same as the number of - * changes returned by tdm_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 -tdm_output_hwc_validate(tdm_output *output, tdm_hwc_window **composited_wnds, uint32_t num_wnds, - uint32_t *num_types); - -/** - * @brief Set the 'need to validate' handler for the 'output' - * - * @details During backend's work it may need to ask for the revalidation - * (make client (E20) do tdm_output_hwc_validate() again), so a 'hndl' will - * be called as such need happen. Only one handler per output is supported. - * - * @param[in] output The output object a hndl is going to be registered for. - * @param[in] hndl The handler which will be called on the 'need to validate' event. - * - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - * @since 2.0.0 - */ -tdm_error -tdm_output_hwc_set_need_validate_handler(tdm_output *output, - tdm_output_need_validate_handler hndl); - -/** - * @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 tdm_output_hwc_validate(). - * The client will either update its state with these types and call - * tdm_output_hwc_accept_changes, or will set new types and attempt to validate the - * display again. - * windows 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 tdm_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[in] output A output object - * @param[out] windows An array of windows - * @param[out] composition_types An array of composition types, each corresponding - * to an element of windows + * @brief Set the mirror image of the src_output to the output + * @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. - * @since 2.0.0 */ tdm_error -tdm_output_hwc_get_changed_composition_types(tdm_output *output,uint32_t *num_elements, - tdm_hwc_window **hwc_window, - tdm_hwc_window_composition *composition_types); +tdm_output_set_mirror(tdm_output *output, tdm_output *src_output, tdm_transform transform); /** - * @brief Accepts the changes required by the device - * @details Accepts the changes required by the device from the previous - * tdm_output_hwc_validate() call (which may be queried using - * tdm_output_get_chaged_composition_types()) and revalidates the display. This - * function is equivalent to requesting the changed types from - * tdm_output_get_chaged_composition_types(), setting those types on the - * corresponding windows, and then calling tdm_output_hwc_validate again. - * After this call it must be valid to present this display. Calling this after - * tdm_output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but - * should have no other effect. + * @brief Unset the mirror * @param[in] output A output object * @return #TDM_ERROR_NONE if success. Otherwise, error value. - * @since 2.0.0 */ tdm_error -tdm_output_hwc_accept_changes(tdm_output *output); +tdm_output_unset_mirror(tdm_output *output); /** - * @brief Get a target buffer queue - * @details Buffers from target buffer queue will receive the output of - * client composition. Window marked as TDM_COMPOSITION_CLIENT or - * TDM_COMPOSITION_DEVICE_CANDIDATE will be composited into this buffers - * prior to the call to tdm_output_commit(). - * @param[in] output A output object + * @brief Get a output object of a layer object + * @param[in] layer A layer object * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. - * @return A buffer queue - * @since 2.0.0 + * @return A TDM output object if success. Otherwise, NULL. */ -tbm_surface_queue_h -tdm_output_hwc_get_target_buffer_queue(tdm_output *output, tdm_error *error); +tdm_output* +tdm_layer_get_output(tdm_layer *layer, 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 + * @brief Get the index of a layer object. + * @param[in] layer A layer object + * @param[out] index The index of a layer object * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ tdm_error -tdm_output_hwc_get_video_supported_formats(tdm_layer *layer, const tbm_format **formats, - int *count); +tdm_layer_get_index(tdm_layer *layer, int *index); /** * @brief Get the capabilities of a layer object. @@ -913,6 +833,7 @@ tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, * @details A displaying TDM buffer is a current showing buffer on screen * that is set to layer object and applied output object of a layer object. * @param[in] layer A layer object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. * @return A TDM buffer if success. Otherwise, NULL. */ tbm_surface_h @@ -984,7 +905,178 @@ tdm_error tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags); /** - * @brief Get a buffer queue for the window object + * @brief Creates 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 * +tdm_hwc_create_window(tdm_hwc *hwc, tdm_error *error); + +/** + * @brief Get the video supported format array for hwc windows of a output 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 +tdm_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 + * @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 +tdm_hwc_get_video_available_properties(tdm_hwc *hwc, const tdm_prop **props, int *count); + +/** + * @brief Get the hwc capabilites + * @param[in] hwc A hwc object + * @param[out] capabilities A hwc capability + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_get_capabilities(tdm_hwc *hwc, tdm_hwc_capability *capabilities); + +/** + * @brief Get the available property array of a hwc object. + * @param[in] hwc A hwc + * @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 +tdm_hwc_get_available_properties(tdm_hwc *hwc, const tdm_prop **props, int *count); + +/** + * @brief Get a target buffer queue + * @details The client composites the tdm_hwd_windows which have + * TDM_COMPOSITE_CLIENT types on the buffer from this target buffer queue. + * Then, the client set the buffer by calling tdm_hwc_set_client_target_buffer. + * @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 +tdm_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 output hwc + * @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 +tdm_hwc_set_client_target_buffer(tdm_hwc *hwc, tbm_surface_h target_buffer, tdm_region damage); + +/** + * @brief Validate the output + * @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 +tdm_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. + * @remark + * @since 2.0.0 + */ +tdm_error +tdm_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 +tdm_hwc_accept_validation(tdm_hwc *hwc); + +/** + * @brief Commit changes for a hwc + * @details After all change of a window object are applied, a user commit handler + * will be called. + * @param[in] hwc A hwc object + * @param[in] sync 0: asynchronous, 1:synchronous + * @param[in] func A user commit handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_commit(tdm_hwc *hwc, int sync, tdm_hwc_commit_handler func, void *user_data); + +/** + * @brief Set the property which has a given id on the hwc object. + * @param[in] hwc A hwc 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 +tdm_hwc_set_property(tdm_hwc *hwc, uint32_t id, tdm_value value); + +/** + * @brief Get the property which has a given id on the hwc object. + * @param[in] hwc A hwc 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 +tdm_hwc_get_property(tdm_hwc *hwc, uint32_t id, tdm_value *value); + +/** + * @brief Destroys the given window. + * @param[in] window the pointer of the window to destroy + * @since 2.0.0 + */ +void +tdm_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 @@ -993,11 +1085,21 @@ tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags); * @since 2.0.0 */ tbm_surface_queue_h -tdm_hwc_window_get_tbm_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error); +tdm_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 buffers of queue. + * @param[in] hwc_window A window object + * @param[in] A tbm buffer queue + * @since 2.0.0 + */ +void +tdm_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 tdm_output_hwc_validate(), the device may request changes to + * @details During tdm_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 @@ -1031,12 +1133,11 @@ tdm_hwc_window_set_composition_type(tdm_hwc_window *hwc_window, * @since 2.0.0 */ tdm_error -tdm_hwc_window_set_buffer_damage(tdm_hwc_window *hwc_window, tdm_hwc_region damage); +tdm_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 output object of a window - * object is committed. + * @details The information will be applied when the hwc object is committed. * @param[in] hwc_window A window object * @param[in] info The information * @return #TDM_ERROR_NONE if success. Otherwise, error value. @@ -1050,105 +1151,62 @@ tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info); * @details A TBM 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 + * @param[in] buffer A TBM buffer * @return #TDM_ERROR_NONE if success. Otherwise, error value. - * @return #TDM_ERROR_BUSY if #hwc_window can't be updated right now, this - * can happen if #hwc_window is involved in the smooth transition from - * DEVICE to CLIENT, this shouldn't be interpreted like some critical error. * @since 2.0.0 */ tdm_error tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer); /** - * @brief Unset a TBM buffer to a window object - * @details A TBM buffer will be applied when the output object of a layer - * object is committed. - * @param[in] hwc_window A window object - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - * @return #TDM_ERROR_BUSY if #hwc_window can't be updated right now, this - * can happen if #hwc_window is involved in the smooth transition from - * DEVICE to CLIENT, this shouldn't be interpreted like some critical error. - * @since 2.0.0 - */ -tdm_error -tdm_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. - * @since 2.0.0 - */ -tdm_error -tdm_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. - * @since 2.0.0 - */ -tdm_error -tdm_hwc_window_unset_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags); - -/** - * @brief Commit changes for a window object - * @details After all change of a window object are applied, a user commit handler - * will be called. - * @param[in] hwc_window A window object - * @param[in] func A user commit handler - * @param[in] user_data The user data + * @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 -tdm_hwc_window_commit(tdm_hwc_window *hwc_window, tdm_hwc_window_commit_handler func, void *user_data); +tdm_hwc_window_set_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value value); /** - * @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 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 -tdm_hwc_window_video_get_available_properties(tdm_hwc_window *hwc_window, - const tdm_prop **props, int *count); +tdm_hwc_window_get_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] id The property id - * @param[out] value The 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 -tdm_hwc_window_video_get_property(tdm_hwc_window *hwc_window, uint32_t id, - tdm_value *value); +tdm_hwc_window_get_constraints(tdm_hwc_window *hwc_window, int *constraints); /** - * @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 + * @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 -tdm_hwc_window_video_set_property(tdm_hwc_window *hwc_window, uint32_t id, - tdm_value value); +tdm_hwc_window_set_name(tdm_hwc_window *hwc_window, const char *name); /** - * @brief Get the window video capability - * @param[in] hwc_window A window object - * @param[out] video_capability A hwc window video capability + * @brief Get buffer flags of cursor hwc_window + * @param[in] hwc_window A hwc window object + * @param[in] width of the cursor image + * @param[in] height of the cursor image + * @param[in] stride of the cursor image + * @param[in] virtual address of the cursor image * @return #TDM_ERROR_NONE if success. Otherwise, error value. - * @since 2.0.0 */ tdm_error -tdm_hwc_window_video_get_capability(tdm_hwc_window *hwc_window, - tdm_hwc_window_video_capability *video_capability); +tdm_hwc_window_set_cursor_image(tdm_hwc_window *hwc_window, int width, int height, int stride, void *ptr); /** * @brief Destroy a pp object @@ -1369,6 +1427,16 @@ void tdm_vblank_destroy(tdm_vblank *vblank); /** + * @brief Get a output object of a vblank object + * @param[in] vblank A vblank object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A TDM output object if success. Otherwise, NULL. + * @see #tdm_vblank_create + */ +tdm_output * +tdm_vblank_get_output(tdm_vblank *vblank, tdm_error *error); + +/** * @brief Get the client PID for a vblank object * @param[in] vblank A vblank object * @param[out] pid PID of vblank's client