/**************************************************************************
-
-libtdm
-
-Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
-
-Contact: Eunchul Kim <chulspro.kim@samsung.com>,
- JinYoung Jeon <jy0.jeon@samsung.com>,
- Taeheon Kim <th908.kim@samsung.com>,
- YoungJun Cho <yj44.cho@samsung.com>,
- SooChan Lim <sc1.lim@samsung.com>,
- Boram Park <sc1.lim@samsung.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sub license, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice (including the
-next paragraph) shall be included in all copies or substantial portions
-of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
-IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
-ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
+ *
+ * libtdm
+ *
+ * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
+ *
+ * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
+ * JinYoung Jeon <jy0.jeon@samsung.com>,
+ * Taeheon Kim <th908.kim@samsung.com>,
+ * YoungJun Cho <yj44.cho@samsung.com>,
+ * SooChan Lim <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
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
+ * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
+ * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
**************************************************************************/
#ifndef _TDM_H_
#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 header file for a frontend user.
* @par Example
* @code
- #include <tdm.h> //for a frontend user
+ * #include <tdm.h> //for a frontend user
* @endcode
*/
/**
- * @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;
-
-/**
* @brief Initialize a display object
* @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
* @return A display object
* @see tdm_display_deinit
*/
-tdm_display* tdm_display_init(tdm_error *error);
+tdm_display *
+tdm_display_init(tdm_error *error);
/**
* @brief Deinitialize a display object
* @param[in] dpy A display object
* @see tdm_display_init
*/
-void 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);
+void
+tdm_display_deinit(tdm_display *dpy);
/**
* @brief Get the file descriptor
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_display_handle_events
*/
-tdm_error tdm_display_get_fd(tdm_display *dpy, int *fd);
+tdm_error
+tdm_display_get_fd(tdm_display *dpy, int *fd);
/**
* @brief Handle the events
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_display_get_fd
*/
-tdm_error tdm_display_handle_events(tdm_display *dpy);
+tdm_error
+tdm_display_handle_events(tdm_display *dpy);
+
+/**
+ * @brief Flush the all events to clients
+ * @param[in] dpy A display object
+ */
+void
+tdm_display_flush(tdm_display *dpy);
/**
* @brief Get the capabilities of a display object.
* @param[out] capabilities The capabilities of a display object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_display_get_capabilities(tdm_display *dpy, tdm_display_capability *capabilities);
+tdm_error
+tdm_display_get_capabilities(tdm_display *dpy,
+ tdm_display_capability *capabilities);
/**
* @brief Get the pp capabilities of a display object.
* @param[out] capabilities The pp capabilities
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_display_get_pp_capabilities(tdm_display *dpy, tdm_pp_capability *capabilities);
+tdm_error
+tdm_display_get_pp_capabilities(tdm_display *dpy,
+ tdm_pp_capability *capabilities);
/**
* @brief Get the pp available format array of a display object.
* @param[out] count The count of formats
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_display_get_pp_available_formats(tdm_display *dpy, const tbm_format **formats, int *count);
+tdm_error
+tdm_display_get_pp_available_formats(tdm_display *dpy,
+ const tbm_format **formats, int *count);
/**
* @brief Get the pp available size of a display object.
* @param[out] preferred_align The preferred align width which TDM can handle
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h, int *max_w, int *max_h, int *preferred_align);
+tdm_error
+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 capture capabilities of a display object.
* @param[out] capabilities The capture capabilities
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_display_get_capture_capabilities(tdm_display *dpy, tdm_capture_capability *capabilities);
+tdm_error
+tdm_display_get_capture_capabilities(tdm_display *dpy,
+ tdm_capture_capability *capabilities);
/**
* @brief Get the capture available format array of a display object.
* @param[out] count The count of formats
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_display_get_catpure_available_formats(tdm_display *dpy, const tbm_format **formats, int *count);
+tdm_error
+tdm_display_get_capture_available_formats(tdm_display *dpy,
+ const tbm_format **formats, int *count);
+
+/**
+ * @brief Get the capture available size 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] min_w The minimum width which TDM can handle
+ * @param[out] min_h The minimum height which TDM can handle
+ * @param[out] max_w The maximum width which TDM can handle
+ * @param[out] max_h The maximum height which TDM can handle
+ * @param[out] preferred_align The preferred align width which TDM can handle
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
+ int *max_w, int *max_h, int *preferred_align);
/**
* @brief Get the output counts which a display object has.
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_display_get_output
*/
-tdm_error tdm_display_get_output_count(tdm_display *dpy, int *count);
+tdm_error
+tdm_display_get_output_count(tdm_display *dpy, int *count);
/**
* @brief Get a output object which has the given index.
* @return A output object if success. Otherwise, NULL.
* @see tdm_display_get_output_count
*/
-tdm_output* tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
+tdm_output *
+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.
* @return A pp object if success. Otherwise, NULL.
* @see tdm_pp_destroy
*/
-tdm_pp* tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
+tdm_pp *
+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
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_output_get_capabilities(tdm_output *output,
+ tdm_output_capability *capabilities);
+
+/**
+ * @brief Get the model information of a output object.
+ * @param[in] output A output object
+ * @param[out] maker The output maker.
+ * @param[out] model The output model.
+ * @param[out] name The output name.
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_output_get_model_info(tdm_output *output, const char **maker,
+ const char **model, const char **name);
/**
* @brief Get the connection status of a output object.
* @param[out] status The connection status.
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
+tdm_error
+tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
+
+/**
+ * @brief Add a output change handler
+ * @details The handler will be called when the status of a
+ * output object is changed. connection, DPMS, etc.
+ * @param[in] output A output object
+ * @param[in] func A output change handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_output_add_change_handler(tdm_output *output,
+ tdm_output_change_handler func,
+ void *user_data);
+
+/**
+ * @brief Remove a output change handler
+ * @param[in] output A output object
+ * @param[in] func A output change handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+void
+tdm_output_remove_change_handler(tdm_output *output,
+ tdm_output_change_handler func,
+ void *user_data);
/**
* @brief Get the connection type of a output object.
* @param[out] type The connection type.
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
+tdm_error
+tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
/**
* @brief Get the layer counts which a output object has.
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_output_get_layer
*/
-tdm_error tdm_output_get_layer_count(tdm_output *output, int *count);
+tdm_error
+tdm_output_get_layer_count(tdm_output *output, int *count);
/**
* @brief Get a layer object which has the given index.
* @return A layer object if success. Otherwise, NULL.
* @see tdm_output_get_layer_count
*/
-tdm_layer* tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
+tdm_layer *
+tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
/**
* @brief Get the available property array of a output object.
* @param[out] count The count of properties
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props, int *count);
+tdm_error
+tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
+ int *count);
/**
* @brief Get the available mode array of a output object.
* @param[out] count The count of modes
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_available_modes(tdm_output *output, const tdm_output_mode **modes, int *count);
+tdm_error
+tdm_output_get_available_modes(tdm_output *output,
+ const tdm_output_mode **modes, int *count);
/**
* @brief Get the available size of a output object.
* @param[out] preferred_align The preferred align width which TDM can handle
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h, int *max_w, int *max_h, int *preferred_align);
+tdm_error
+tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
+ int *max_w, int *max_h, int *preferred_align);
+
+/**
+ * @brief Get the available cursor size of a output object.
+ * @details -1 means that a TDM backend module doesn't define the value.
+ * @param[in] output A output object
+ * @param[out] min_w The minimum width which TDM can handle
+ * @param[out] min_h The minimum height which TDM can handle
+ * @param[out] max_w The maximum width which TDM can handle
+ * @param[out] max_h The maximum height which TDM can handle
+ * @param[out] preferred_align The preferred align width which TDM can handle
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
+ int *max_w, int *max_h, int *preferred_align);
/**
* @brief Get the physical size of a output object.
* @param[out] mmHeight The milimeter height
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth, unsigned int *mmHeight);
+tdm_error
+tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
+ unsigned int *mmHeight);
/**
* @brief Get the subpixel of a output object.
* @param[out] subpixel The subpixel
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
+tdm_error
+tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
/**
* @brief Get the pipe of a output object.
* @param[out] pipe The pipe
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
+tdm_error
+tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
+
+/**
+ * @brief Get the index of a primary layer.
+ * @param[in] output A output object
+ * @param[out] index The primary layer index
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_output_get_primary_index(tdm_output *output, int *index);
/**
* @brief Set the property which has a given id.
* @param[in] value The value
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
+tdm_error
+tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
/**
* @brief Get the property which has a given id
* @param[out] value The value
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
+tdm_error
+tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
/**
* @brief Wait for VBLANK
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see #tdm_output_vblank_handler
*/
-tdm_error tdm_output_wait_vblank(tdm_output *output, int interval, int sync, tdm_output_vblank_handler func, void *user_data);
+tdm_error
+tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
+ tdm_output_vblank_handler func, void *user_data);
/**
* @brief Commit changes for 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.
+ * @see #tdm_layer_commit
+ */
+tdm_error
+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_commit(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
+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] mode A output mode
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
+tdm_error
+tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
/**
* @brief Get the mode of a output object
* @param[out] mode A output mode
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
+tdm_error
+tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
+
+/**
+ * @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
+ * @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(tdm_output *output, tdm_output_dpms dpms_value);
+tdm_error
+tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value);
/**
* @brief Get DPMS of a output object
* @param[out] dpms_value DPMS value
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
+tdm_error
+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
* @return A capture object
* @see tdm_capture_destroy
*/
-tdm_capture *tdm_output_create_capture(tdm_output *output, tdm_error *error);
+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 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
+ * @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 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[out] capabilities The capabilities of a layer object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_get_capabilities(tdm_layer *layer, tdm_layer_capability *capabilities);
+tdm_error
+tdm_layer_get_capabilities(tdm_layer *layer,
+ tdm_layer_capability *capabilities);
/**
* @brief Get the available format array of a layer object.
* @param[out] count The count of formats
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats, int *count);
+tdm_error
+tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
+ int *count);
/**
* @brief Get the available property array of a layer object.
* @param[out] count The count of properties
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props, int *count);
+tdm_error
+tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
+ int *count);
/**
* @brief Get the zpos of a layer object.
* - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
* - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
* layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
+ * -------------------------------- graphic layer 3 <-- top most layer
+ * -------------------------------- graphic layer 2
+ * -------------------------------- graphic layer 1
+ * -------------------------------- graphic layer 0
+ * -------------------------------- video layer -1
+ * -------------------------------- video layer -2 <-- lowest layer
* @param[in] layer A layer object
* @param[out] zpos The zpos
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_layer_set_video_pos, tdm_layer_capability
*/
-tdm_error tdm_layer_get_zpos(tdm_layer *layer, unsigned int *zpos);
+tdm_error
+tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
/**
* @brief Set the property which has a given id.
* @param[in] value The value
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
+tdm_error
+tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
/**
* @brief Get the property which has a given id.
* @param[out] value The value
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
+tdm_error
+tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
/**
* @brief Set the geometry information to a layer object
* @details The geometry information will be applied when the output object
- * of a layer object is committed.
+ * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
+ * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
+ * src_config.
* @param[in] layer A layer object
* @param[in] info The geometry information
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
- * @see tdm_output_commit
+ * @see tdm_layer_commit
*/
-tdm_error tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
+tdm_error
+tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
/**
* @brief Get the geometry information to a layer object
* @param[out] info The geometry information
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
+tdm_error
+tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
/**
* @brief Set a TDM buffer to a layer object
* @param[in] layer A layer object
* @param[in] buffer A TDM buffer
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
- * @see tdm_output_commit
+ * @see tdm_layer_commit
*/
-tdm_error tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
+tdm_error
+tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
/**
* @brief Unset a TDM buffer from a layer object
* @param[in] layer A layer object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_unset_buffer(tdm_layer *layer);
+tdm_error
+tdm_layer_unset_buffer(tdm_layer *layer);
+
+/**
+ * @brief Commit changes for a layer object
+ * @details After all change of a layer object are applied, a user commit handler
+ * will be called.
+ * @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_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
+
+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.
+ * @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_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
/**
* @brief Set a TBM surface_queue to a layer object
* @param[in] layer A layer object
* @param[in] buffer_queue A TBM surface_queue
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
- * @see tdm_output_commit
+ * @see tdm_layer_commit
*/
-tdm_error tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
+tdm_error
+tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
/**
* @brief Unset a TBM surface_queue from a layer object
* @param[in] layer A layer object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_unset_buffer_queue(tdm_layer *layer);
+tdm_error
+tdm_layer_unset_buffer_queue(tdm_layer *layer);
/**
* @brief Check wheter a layer object is available for a frontend user to use.
* @param[out] usable 1 if usable, 0 if not usable
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
+tdm_error
+tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
/**
* @brief Set the relative zpos to a VIDEO layer object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_layer_get_zpos, tdm_layer_capability
*/
-tdm_error tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
+tdm_error
+tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
/**
* @brief Create a capture object of a layer object
* @return A capture object
* @see tdm_capture_destroy
*/
-tdm_capture *tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
+tdm_capture *
+tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
+
+/**
+ * @brief Get buffer flags from a layer object
+ * @param[in] layer A layer object
+ * @param[out] flags a buffer flags value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+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 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 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
+ * @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 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
+ * @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
*/
-void tdm_pp_destroy(tdm_pp *pp);
+void
+tdm_pp_destroy(tdm_pp *pp);
/**
* @brief Set the geometry information to a pp object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_pp_commit
*/
-tdm_error tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
+tdm_error
+tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
+
+/**
+ * @brief Set the PP done handler to a pp object
+ * @details
+ * The user PP done handler will be called after converting a source buffer's image
+ * to a destination buffer.
+ * @param[in] pp A pp object
+ * @param[in] func A user PP done handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
/**
* @brief Attach a source buffer and a destination buffer to a pp object
* @param[in] src A source buffer
* @param[in] dst A destination buffer
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
- * @see tdm_pp_commit, tdm_buffer_add_release_handler, tdm_buffer_release_handler
+ * @see tdm_pp_commit, tdm_pp_set_done_handler
*/
-tdm_error tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
+tdm_error
+tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
/**
* @brief Commit changes for a pp object
* @param[in] pp A pp object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_pp_commit(tdm_pp *pp);
+tdm_error
+tdm_pp_commit(tdm_pp *pp);
/**
* @brief Destroy a capture object
* @param[in] capture A capture object
* @see tdm_output_create_capture, tdm_layer_create_capture
*/
-void tdm_capture_destroy(tdm_capture *capture);
+void
+tdm_capture_destroy(tdm_capture *capture);
/**
* @brief Set the geometry information to a capture object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_capture_commit
*/
-tdm_error tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
+tdm_error
+tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
+
+/**
+ * @brief Set the capture done handler to a capture object
+ * @details
+ * The user capture done handler will be called after capturing a screen into a
+ * buffer.
+ * @param[in] capture A capture object
+ * @param[in] func A user capture done handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
/**
* @brief Attach a TDM buffer to a capture object
* @param[in] capture A capture object
* @param[in] buffer A TDM buffer
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
- * @see tdm_capture_commit, tdm_buffer_add_release_handler, tdm_buffer_release_handler
+ * @see tdm_capture_commit, tdm_capture_set_done_handler
*/
-tdm_error tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
+tdm_error
+tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
/**
* @brief Commit changes for a capture object
* @param[in] capture A capture object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
-tdm_error tdm_capture_commit(tdm_capture *capture);
+tdm_error
+tdm_capture_commit(tdm_capture *capture);
/**
* @brief The release handler of a TDM buffer
* @param[in] user_data user data
* @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
*/
-typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer, void *user_data);
+typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
+ void *user_data);
/**
* @brief Add a release handler to a TDM buffer
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see tdm_buffer_remove_release_handler
*/
-tdm_error tdm_buffer_add_release_handler(tbm_surface_h buffer, tdm_buffer_release_handler func, void *user_data);
+tdm_error
+tdm_buffer_add_release_handler(tbm_surface_h buffer,
+ tdm_buffer_release_handler func, void *user_data);
/**
* @brief Remove a release handler from a TDM buffer
* @param[in] user_data user data
* @see tdm_buffer_add_release_handler
*/
-void tdm_buffer_remove_release_handler(tbm_surface_h buffer, tdm_buffer_release_handler func, void *user_data);
+void
+tdm_buffer_remove_release_handler(tbm_surface_h buffer,
+ tdm_buffer_release_handler func, void *user_data);
+
+/**
+ * @brief The handler of a vblank object
+ * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
+ */
+typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
+ 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
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A vblank object
+ * @see #tdm_vblank_destroy
+ */
+tdm_vblank*
+tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
+
+/**
+ * @brief Destroy a vblank object
+ * @param[in] vblank A vblank object
+ * @see #tdm_vblank_create
+ */
+void
+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
+ * @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.
+ */
+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
+ * @param[in] offset the offset(milli-second)
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+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
+ * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
+ * as success.
+ * @param[in] vblank A vblank object
+ * @param[in] enable_fake 1:enable, 0:disable
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
+
+/**
+ * @brief Get the fake vblank
+ * @param[in] vblank A vblank object
+ * @param[out] enable_fake 1:enable, 0:disable
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
+
+/**
+ * @brief Wait for a vblank
+ * @details
+ * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
+ * SHOULD be called after the given interval. \n
+ * The sequence value of tdm_vblank_handler is the relative value of fps.
+ * If fps = 10, this sequence value should be increased by 10 during 1 second.
+ * @param[in] vblank A vblank object
+ * @param[in] req_sec The vblank request time(second)
+ * @param[in] req_usec The vblank request time(micro-second)
+ * @param[in] interval The vblank interval
+ * @param[in] func The user vblank handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
+ unsigned int interval, tdm_vblank_handler func, void *user_data);
+
+/**
+ * @brief Wait for a vblank with the target sequence number
+ * @param[in] vblank A vblank object
+ * @param[in] req_sec The vblank request time(second)
+ * @param[in] req_usec The vblank request time(micro-second)
+ * @param[in] sequence The target sequence number
+ * @param[in] func The user client vblank handler
+ * @param[in] user_data The user data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
+ unsigned int sequence, tdm_vblank_handler func, void *user_data);
#ifdef __cplusplus
}
projects / platform / core / uifw / libtdm.git / blobdiff