* Taeheon Kim <th908.kim@samsung.com>,
* YoungJun Cho <yj44.cho@samsung.com>,
* SooChan Lim <sc1.lim@samsung.com>,
- * Boram Park <sc1.lim@samsung.com>
+ * Boram Park <boram1288.park@samsung.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
#define _TDM_H_
#include <stdint.h>
+#include <sys/types.h>
#include <tbm_surface.h>
#include <tbm_surface_queue.h>
#include <tbm_surface_internal.h>
#include "tdm_types.h"
+#include "tdm_deprecated.h"
#ifdef __cplusplus
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_HWC = (1 << 2), /**< if hardware supports hwc operation @since 2.0.0*/
-} 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
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
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.
* @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);
/**
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
tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
/**
+ * @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.
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 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
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.
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
* The damage parameter describes a buffer damage region as defined in the
* description of tdm_hwc_window_set_buffer_damage().
*
- * Will be called before tdm_output_commit() if any of the layers are marked as
+ * 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 The new target buffer
+ * @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.
* @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);
+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);
/**
* @brief Validate the output
* @since 2.0.0
*/
tdm_error
-tdm_output_hwc_validate(tdm_output *output, uint32_t *num_types);
+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'
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 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 TDM output object if success. Otherwise, NULL.
+ */
+tdm_output*
+tdm_layer_get_output(tdm_layer *layer, tdm_error *error);
+
+/**
+ * @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_layer_get_index(tdm_layer *layer, int *index);
+
+/**
* @brief Get the capabilities of a layer object.
* @param[in] layer A layer object
* @param[out] capabilities The capabilities of 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.
* @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
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, uint32_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
* @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 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
tdm_hwc_window_unset_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
/**
- * @brief Get the window video capability
+ * @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[out] video_capability A hwc window video capability
+ * @param[in] func A user commit handler
+ * @param[in] user_data The user data
* @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_commit(tdm_hwc_window *hwc_window, tdm_hwc_window_commit_handler func, void *user_data);
+
+/**
+ * @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 supported format
+ * @brief Get the window video capability
* @param[in] hwc_window A window object
- * @param[out] formats A hwc window supported formats
- * @param[out] count A number of the hwc window supported formats
+ * @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_supported_format(tdm_hwc_window *hwc_window,
- const tbm_format **formats,
- int *count);
+tdm_hwc_window_video_get_capability(tdm_hwc_window *hwc_window,
+ tdm_hwc_window_video_capability *video_capability);
/**
* @brief Destroy a pp object
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
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
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
+ * @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
/**
* @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.
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.
projects / platform / core / uifw / libtdm.git / blobdiff