log: check log level
[platform/core/uifw/libtdm.git] / include / tdm.h
index 2c0ba6a..70c99af 100644 (file)
@@ -37,6 +37,7 @@
 #define _TDM_H_
 
 #include <stdint.h>
+#include <sys/types.h>
 #include <tbm_surface.h>
 #include <tbm_surface_queue.h>
 #include <tbm_surface_internal.h>
@@ -199,7 +200,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);
 
 /**
@@ -631,9 +632,29 @@ tdm_output_hwc_destroy_window(tdm_output *output, tdm_hwc_window *hwc_window);
  * @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_hwc_window **composited_wnds,
-                                                                       uint32_t num_wnds);
+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_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
@@ -652,7 +673,8 @@ tdm_output_hwc_set_client_target_buffer(tdm_output *output, tbm_surface_h target
  * @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'
@@ -743,6 +765,14 @@ tdm_output_hwc_get_video_supported_formats(tdm_layer *layer, const tbm_format **
                                                                int *count);
 
 /**
+ * @brief Get a output object of a layer object
+ * @param[in] layer A layer object
+ * @return A TDM output object if success. Otherwise, NULL.
+ */
+tdm_output*
+tdm_layer_get_output(tdm_layer *layer, tdm_error *error);
+
+/**
  * @brief Get the capabilities of a layer object.
  * @param[in] layer A layer object
  * @param[out] capabilities The capabilities of a layer object
@@ -974,17 +1004,6 @@ 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, 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
@@ -1050,6 +1069,20 @@ 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
@@ -1070,6 +1103,18 @@ 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
+ * @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);
+
+/**
  * @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
@@ -1267,6 +1312,16 @@ 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
@@ -1281,6 +1336,28 @@ 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
@@ -1300,6 +1377,15 @@ 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
@@ -1322,6 +1408,7 @@ 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.
@@ -1339,6 +1426,17 @@ 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.