X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm.h;h=c334b20093ef850b06a8c220db8b6e0d7574dfe3;hb=398989bae0addb8c17264d1bee02509fafcd101d;hp=7beccd0160677cf678fedd6512e0dad125347b51;hpb=08707fc90dc3c6adccea7a958ed6a58604990aee;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm.h b/include/tdm.h index 7beccd0..c334b20 100644 --- a/include/tdm.h +++ b/include/tdm.h @@ -207,6 +207,30 @@ 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 @@ -239,6 +263,30 @@ 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. @@ -305,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. @@ -577,6 +649,24 @@ tdm_hwc * tdm_output_get_hwc(tdm_output *output, tdm_error *error); /** + * @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. + */ +tdm_error +tdm_output_set_mirror(tdm_output *output, tdm_output *src_output, tdm_transform transform); + +/** + * @brief Unset the mirror + * @param[in] output A output object + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_unset_mirror(tdm_output *output); + +/** * @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. @@ -825,14 +915,33 @@ tdm_hwc_window * tdm_hwc_create_window(tdm_hwc *hwc, tdm_error *error); /** - * @brief Get the supported format array for hwc windows of a hwc object. - * @param[in] hwc A output hwc + * @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_supported_formats(tdm_hwc *hwc, const tbm_format **formats, int *count); +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. @@ -846,10 +955,9 @@ tdm_hwc_get_available_properties(tdm_hwc *hwc, const tdm_prop **props, int *coun /** * @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(). + * @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 @@ -860,33 +968,12 @@ tdm_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 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_hwc_validate() after changing the target through this function. + * @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 - * @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 */ @@ -895,18 +982,19 @@ tdm_hwc_set_client_target_buffer(tdm_hwc *hwc, tbm_surface_h target_buffer, tdm_ /** * @brief Validate the output - * @details Instructs the device to inspect all of the layer state and + * @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 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_hwc_accept_changes() to accept the changes returned by - * tdm_hwc_get_changed_composition_types(); must be the same as the number of - * changes returned by tdm_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. + * 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 @@ -915,25 +1003,19 @@ tdm_hwc_validate(tdm_hwc *hwc, tdm_hwc_window **composited_wnds, uint32_t num_wn /** * @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_hwc_validate(). + * @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_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 + * 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] 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[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 @@ -942,22 +1024,15 @@ tdm_hwc_get_changed_composition_types(tdm_hwc *hwc, uint32_t *num_elements, 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 - * tdm_hwc_validate() call (which may be queried using - * tdm_hwc_get_chaged_composition_types()) and revalidates the display. This - * function is equivalent to requesting the changed types from - * tdm_hwc_get_chaged_composition_types(), setting those types on the - * corresponding windows, and then calling tdm_hwc_validate again. - * After this call it must be valid to present this display. Calling this after - * tdm_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but - * should have no other effect. - * @param[in] output A output object + * @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_changes(tdm_hwc *hwc); +tdm_hwc_accept_validation(tdm_hwc *hwc); /** * @brief Commit changes for a hwc @@ -973,8 +1048,27 @@ 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] output A output object * @param[in] window the pointer of the window to destroy * @since 2.0.0 */ @@ -982,7 +1076,7 @@ void tdm_hwc_window_destroy(tdm_hwc_window *hwc_window); /** - * @brief Get a buffer queue for the window object + * @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 @@ -991,11 +1085,21 @@ tdm_hwc_window_destroy(tdm_hwc_window *hwc_window); * @since 2.0.0 */ tbm_surface_queue_h -tdm_hwc_window_get_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_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 @@ -1033,8 +1137,7 @@ 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. @@ -1048,35 +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 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_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] hwc_window A hwc window object * @param[in] id The property id - * @param[out] value The value + * @param[out] value The value of the propery id * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ tdm_error tdm_hwc_window_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 hwc window object - * @param[in] id The property id - * @param[in] 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_set_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 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_set_name(tdm_hwc_window *hwc_window, const char *name); + +/** + * @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. + */ +tdm_error +tdm_hwc_window_set_cursor_image(tdm_hwc_window *hwc_window, int width, int height, int stride, void *ptr); /** * @brief Destroy a pp object