Merge branch 'tizen' into sandbox/cyeon/devel
[platform/core/uifw/libtdm.git] / include / tdm.h
index 3f0b89d..5dddc18 100644 (file)
@@ -150,6 +150,17 @@ tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
                                                                  int *max_w, int *max_h, int *preferred_align);
 
 /**
+ * @brief Get the pp vertical preferred align of a display object.
+ * @details -1 means that a TDM backend module doesn't define the value.
+ * @param[in] dpy A display object
+ * @param[out] preferred_align_vertical The preferred align height which TDM can handle
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_display_get_pp_preferred_align_vertical(tdm_display *dpy, int *preferred_align_vertical);
+
+
+/**
  * @brief Get the capture capabilities of a display object.
  * @param[in] dpy A display object
  * @param[out] capabilities The capture capabilities
@@ -207,6 +218,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 +274,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 +364,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 +660,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.
@@ -834,15 +935,24 @@ tdm_hwc_create_window(tdm_hwc *hwc, tdm_error *error);
 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 video capability
+ * @brief Get the hwc capabilites
  * @param[in] hwc A hwc object
- * @param[out] video_capability A hwc video capability
+ * @param[out] capabilities A hwc capability
  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
  */
 tdm_error
-tdm_hwc_get_video_capability(tdm_hwc *hwc, tdm_hwc_video_capability *video_capability);
+tdm_hwc_get_capabilities(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
 
 /**
  * @brief Get the available property array  of a hwc object.
@@ -871,7 +981,7 @@ 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_COMPOSITION_CLIENT.
+ * 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
@@ -882,6 +992,16 @@ tdm_error
 tdm_hwc_set_client_target_buffer(tdm_hwc *hwc, tbm_surface_h target_buffer, tdm_region damage);
 
 /**
+ * @brief Set the acquire fence fd of client(relative to the TDM) target
+ * @param[in] hwc A output hwc
+ * @param[in] acquire_fence  The acquire fence fd of target
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @since 2.0.0
+ */
+tdm_error
+tdm_hwc_set_client_target_acquire_fence(tdm_hwc *hwc, int acquire_fence);
+
+/**
  * @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
@@ -907,7 +1027,7 @@ tdm_hwc_validate(tdm_hwc *hwc, tdm_hwc_window **composited_wnds, uint32_t num_wn
  * @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
+ * 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
@@ -925,15 +1045,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 backend
- * @details Accepts the changes required by the backend from the previous
+ * @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
@@ -949,6 +1069,37 @@ tdm_error
 tdm_hwc_commit(tdm_hwc *hwc, int sync, tdm_hwc_commit_handler func, void *user_data);
 
 /**
+ * @brief Get commit fence
+ * @details After all change of a window object are applied about last tdm_hwc_commit,
+ * the fence is signaled.
+ * @param[in] hwc A hwc object
+ * @param[out] commit_fence the commit fence fd of tdm_hwc_commit
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_hwc_get_commit_fence(tdm_hwc *hwc, int *commit_fence);
+
+/**
+ * @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
@@ -970,7 +1121,7 @@ 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 buferrs of queue.
+ * @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
@@ -1040,24 +1191,24 @@ tdm_error
 tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer);
 
 /**
- * @brief Get the property which has a given id.
- * @param[in] hwc_window A hwc window object
+ * @brief Set 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
+ * @param[in] 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);
+tdm_hwc_window_set_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
+ * @brief Get 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
+ * @param[out] 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);
+tdm_hwc_window_get_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value *value);
 
 /**
  * @brief Get the constraints of hwc_window
@@ -1068,13 +1219,35 @@ tdm_hwc_window_set_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value v
 tdm_error
 tdm_hwc_window_get_constraints(tdm_hwc_window *hwc_window, int *constraints);
 
-// TODO : this will be removed...
-#define TDM_PREPARATION_BUFFER_QUEUE 1000
-#define TDM_PREPARATION_NONE 1001
+/**
+ * @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 Set the acquire fence of hwc_window
+ * @param[in] hwc_window A hwc window object
+ * @param[in] acquire_fence the acquire fence fd of a hwc window object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
-tdm_hwc_window_get_preparation_types(tdm_hwc_window *hwc_window, int *preparation_types);
-// TODO
+tdm_hwc_window_set_acquire_fence(tdm_hwc_window *hwc_window, int acquire_fence);
 
 /**
  * @brief Destroy a pp object