X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm.h;h=7aee6b8959991c0323ac6f39c6a635baf8197e1d;hb=4f27d4f31e3281c07f131d9a089ab5a7d6c01a97;hp=3a066c183b8a50c18440b84e29640f9b1cadaa4f;hpb=323fcbba2cb5dc0ccdad67008c768b240809df19;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm.h b/include/tdm.h index 3a066c1..7aee6b8 100644 --- a/include/tdm.h +++ b/include/tdm.h @@ -37,6 +37,7 @@ #define _TDM_H_ #include +#include #include #include #include @@ -486,6 +487,26 @@ tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data); /** + * @brief Remove the user vblank handler + * @param[in] output A output object + * @param[in] func A user vblank handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data); + +/** + * @brief Remove the user commit handler + * @param[in] output A output 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_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data); + +/** * @brief Set one of available modes of a output object * @param[in] output A output object * @param[in] mode A output mode @@ -504,15 +525,32 @@ tdm_error tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode); /** - * @brief Set DPMS of a output object + * @brief Set DPMS of a output object synchronously * @param[in] output A output object * @param[in] dpms_value DPMS value * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @see tdm_output_set_dpms_async */ tdm_error tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value); /** + * @brief Set DPMS of a output object asynchronously + * @details This function can be used when a output supports the asynchronous DPMS + * control. The output has #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS flags which + * #tdm_output_get_capabilities returns. If an output change handler is added with + * #tdm_output_add_change_handler, the output change handler will be called when + * the DPMS status is changed indeed. + * @param[in] output A output object + * @param[in] dpms_value DPMS value + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @see tdm_output_add_change_handler, tdm_output_set_dpms, + * tdm_output_get_capabilities, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS. + */ +tdm_error +tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value); + +/** * @brief Get DPMS of a output object * @param[in] output A output object * @param[out] dpms_value DPMS value @@ -532,6 +570,179 @@ 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. + * @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 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 + * @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); + +/** + * @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. + * @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); + +/** + * @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 + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A buffer queue + * @since 2.0.0 + */ +tbm_surface_queue_h +tdm_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 +tdm_output_hwc_get_video_supported_formats(tdm_layer *layer, const tbm_format **formats, + int *count); + +/** * @brief Get the capabilities of a layer object. * @param[in] layer A layer object * @param[out] capabilities The capabilities of a layer object @@ -666,6 +877,16 @@ tdm_error tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing); /** + * @brief Remove the user commit handler + * @param[in] layer A layer 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_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data); + +/** * @brief Get a displaying TDM buffer from a layer object * @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. @@ -741,6 +962,158 @@ tdm_error tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags); /** + * @brief Get 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 tbm buffer queue + * @since 2.0.0 + */ +tbm_surface_queue_h +tdm_hwc_window_get_tbm_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error); + +/** + * @brief Sets the desired Z order of the given window. A window with + * a greater Z value occludes a window with a lesser Z value. + * @param[in] hwc_window A window object + * @param[in] z the new Z order + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_zpos(tdm_hwc_window *hwc_window, int32_t zpos); + +/** + * @brief Sets the desired composition type of the given window. + * @details During tdm_output_hwc_validate(), the device may request changes to + * the composition types of any of the layers as described in the definition + * of tdm_hwc_window_composition_t above. + * @param[in] hwc_window A window object + * @param[in] composition_type The new composition type + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_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 tdm_output_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. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_buffer_damage(tdm_hwc_window *hwc_window, tdm_hwc_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. + * @param[in] hwc_window A window object + * @param[in] info The information + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info); + +/** + * @brief Set 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 + * @param[in] buffer A TDM 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 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 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 + * @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); + +/** + * @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 + * @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); + +/** + * @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 +tdm_hwc_window_video_set_property(tdm_hwc_window *hwc_window, uint32_t id, + tdm_value value); + +/** + * @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. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_video_get_capability(tdm_hwc_window *hwc_window, + tdm_hwc_window_video_capability *video_capability); + +/** * @brief Destroy a pp object * @param[in] pp A pp object * @see tdm_display_create_pp @@ -884,6 +1257,62 @@ typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned unsigned int tv_sec, unsigned int tv_usec, void *user_data); /** + * @brief Set the vblank fps for the given PID and name. + * @param[in] pid The process ID + * @param[in] name The client vblank name + * @param[in] fps The client vblank fps + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps); + +/** + * @brief Set the ignore global fps for the given PID and name. + * @param[in] pid The process ID + * @param[in] name The client vblank name + * @param[in] ignore 1: ignore 0:not ignore(default) + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_set_client_ignore_global_fps(unsigned int pid, const char *name, unsigned int ignore); + +/** + * @brief Set the vblank global fps for the entire system. + * @param[in] enable 1:enable, 0:disable + * @param[in] fps The vblank global fps + * @details + * This global fps will be applied to all client's vblanks for all outputs. + * If the client's vblank fps is less than this, the global fps will be ignored + * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore + * the global fps, it will be ignored also. + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps); + +/** + * @brief Add the vblank create handler. + * @param[in] dpy A display object + * @param[in] func The user vblank create handler + * @param[in] user_data The user data + * @details + * The user vblank create handler will be called when new vblank object created. + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data); + +/** + * @brief Remove the vblank create handler. + * @param[in] dpy A display object + * @param[in] func The user vblank create handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +void +tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data); + +/** * @brief Create a vblank object * @param[in] dpy A display object * @param[in] output A output object @@ -903,8 +1332,38 @@ void tdm_vblank_destroy(tdm_vblank *vblank); /** + * @brief Get the client PID for a vblank object + * @param[in] vblank A vblank object + * @param[out] pid PID of vblank's client + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid); + +/** + * @brief Set the name to a vblank object + * @details The default name is "unknown" + * @param[in] vblank A vblank object + * @param[in] name vblank name + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_set_name(tdm_vblank *vblank, const char *name); + +/** + * @brief Get the name for a vblank object + * @details The default name is "unknown" + * @param[in] vblank A vblank object + * @param[out] name vblank name + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_get_name(tdm_vblank *vblank, const char **name); + +/** * @brief Set the fps to a vblank object * @details Default is the @b vertical @b refresh @b rate of the given output. + * It could be ignored when the fixed fps is set by #tdm_vblank_set_fixed_fps * @param[in] vblank A vblank object * @param[in] fps over 0 * @return #TDM_ERROR_NONE if success. Otherwise, error value. @@ -913,6 +1372,40 @@ tdm_error tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps); /** + * @brief Get the fps for a vblank object + * @param[in] vblank A vblank object + * @param[out] fps over 0 + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps); + +/** + * @brief Set the fixed fps to a vblank object + * @details + * It could be ignored when the global fps is set by #tdm_vblank_enable_global_fps + * @param[in] vblank A vblank object + * @param[in] fps over 0 + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps); + +/** + * @brief Ignore the vblank global fps + * @details + * The global fps will be applied to all client's vblanks for all outputs. + * If the client's vblank fps is less than this, the global fps will be ignored + * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore + * the global fps, it will be ignored also. + * @param[in] vblank A vblank object + * @param[in] ignore 1: ignore 0:not ignore(default) + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore); + +/** * @brief Set the offset(milli-second) to a vblank object * @details Default is @b 0. * @param[in] vblank A vblank object @@ -923,6 +1416,15 @@ tdm_error tdm_vblank_set_offset(tdm_vblank *vblank, int offset); /** + * @brief Get the offset(milli-second) for a vblank object + * @param[in] vblank A vblank object + * @param[out] offset the offset(milli-second) + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_get_offset(tdm_vblank *vblank, int *offset); + +/** * @brief Enable/Disable the fake vblank to a vblank object * @details * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF @@ -938,10 +1440,11 @@ tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake); /** * @brief Get the fake vblank * @param[in] vblank A vblank object - * @return 1 if enable. Otherwise, 0. + * @param[out] enable_fake 1:enable, 0:disable + * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ -unsigned int -tdm_vblank_get_enable_fake(tdm_vblank *vblank); +tdm_error +tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake); /** * @brief Wait for a vblank