Package version up to 2.7.1
[platform/core/uifw/libtdm.git] / include / tdm_types.h
index 050dad8..d9ab984 100644 (file)
@@ -9,7 +9,7 @@
  *          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
@@ -38,6 +38,8 @@
 
 #include <tbm_surface.h>
 
+#include "tdm_common.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -57,137 +59,6 @@ extern "C" {
  * @endcode
  */
 
-#include <tdm_common.h>
-
-/**
- * @brief The transform enumeration(rotate, flip)
- */
-typedef enum {
-       TDM_TRANSFORM_NORMAL            = 0, /**< no transform */
-       TDM_TRANSFORM_90                = 1, /**< rotate 90 */
-       TDM_TRANSFORM_180               = 2, /**< rotate 180 */
-       TDM_TRANSFORM_270               = 3, /**< rotate 270 */
-       TDM_TRANSFORM_FLIPPED           = 4, /**< no rotate and horizontal flip */
-       TDM_TRANSFORM_FLIPPED_90        = 5, /**< rotate 90 and horizontal flip */
-       TDM_TRANSFORM_FLIPPED_180       = 6, /**< rotate 180 and horizontal flip */
-       TDM_TRANSFORM_FLIPPED_270       = 7, /**< rotate 270 and horizontal flip */
-} tdm_transform;
-
-/**
- * @brief The output connection status enumeration
- * @details bit compatible with the libdrm definitions.
- */
-typedef enum {
-       TDM_OUTPUT_TYPE_Unknown,        /**< unknown */
-       TDM_OUTPUT_TYPE_VGA,            /**< VGA connection */
-       TDM_OUTPUT_TYPE_DVII,           /**< DVII connection */
-       TDM_OUTPUT_TYPE_DVID,           /**< DVID connection */
-       TDM_OUTPUT_TYPE_DVIA,           /**< DVIA connection */
-       TDM_OUTPUT_TYPE_Composite,      /**< Composite connection */
-       TDM_OUTPUT_TYPE_SVIDEO,         /**< SVIDEO connection */
-       TDM_OUTPUT_TYPE_LVDS,           /**< LVDS connection */
-       TDM_OUTPUT_TYPE_Component,      /**< Component connection */
-       TDM_OUTPUT_TYPE_9PinDIN,        /**< 9PinDIN connection */
-       TDM_OUTPUT_TYPE_DisplayPort,    /**< DisplayPort connection */
-       TDM_OUTPUT_TYPE_HDMIA,          /**< HDMIA connection */
-       TDM_OUTPUT_TYPE_HDMIB,          /**< HDMIB connection */
-       TDM_OUTPUT_TYPE_TV,             /**< TV connection */
-       TDM_OUTPUT_TYPE_eDP,            /**< eDP connection */
-       TDM_OUTPUT_TYPE_VIRTUAL,        /**< Virtual connection for WiFi Display */
-       TDM_OUTPUT_TYPE_DSI,            /**< DSI connection */
-} tdm_output_type;
-
-/**
- * @brief The layer capability enumeration
- * @details
- * A layer can have one of CURSOR, PRIMARY and OVERLAY capability. And a layer
- * also can have one of GRAPHIC and VIDEO capability. And a layer also can have
- * SCALE and TRANSFORM capability.\n
- * @par Example
- * @code
- *  //For example
- *  capabilities = TDM_LAYER_CAPABILITY_PRIMARY | TDM_LAYER_CAPABILITY_GRAPHIC;
- *  capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_GRAPHIC | TDM_LAYER_CAPABILITY_SCALE;
- *  capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_GRAPHIC | TDM_LAYER_CAPABILITY_SCALE | TDM_LAYER_CAPABILITY_TRANSFORM;
- *  capabilities = TDM_LAYER_CAPABILITY_CURSOR | TDM_LAYER_CAPABILITY_GRAPHIC;
- *  capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_VIDEO;
- * @endcode
- * @remark
- * - When a video plays, in most of cases, video buffers will be displayed to
- * a GRAPHIC layer after converting RGB buffers via PP. In this case, a backend
- * module doesn't need to offer VIDEO layer.
- * - But in case that s vendor wants to handle a video by their own way,
- * a backend module offer VIDEO layers. And a display server will pass a video
- * buffer to a VIDEO layer without converting.
- */
-typedef enum {
-       TDM_LAYER_CAPABILITY_CURSOR         = (1 << 0), /**< cursor */
-       TDM_LAYER_CAPABILITY_PRIMARY        = (1 << 1), /**< primary */
-       TDM_LAYER_CAPABILITY_OVERLAY        = (1 << 2), /**< overlay */
-       TDM_LAYER_CAPABILITY_GRAPHIC        = (1 << 4), /**< graphic */
-       TDM_LAYER_CAPABILITY_VIDEO          = (1 << 5), /**< video */
-       TDM_LAYER_CAPABILITY_SCALE          = (1 << 8), /**< if a layer has scale capability  */
-       TDM_LAYER_CAPABILITY_TRANSFORM      = (1 << 9), /**< if a layer has transform capability  */
-       TDM_LAYER_CAPABILITY_SCANOUT        = (1 << 10), /**< if a layer allows a scanout buffer only */
-       TDM_LAYER_CAPABILITY_RESEVED_MEMORY = (1 << 11), /**< if a layer allows a reserved buffer only */
-       TDM_LAYER_CAPABILITY_NO_CROP        = (1 << 12), /**< if a layer has no cropping capability */
-} tdm_layer_capability;
-
-/**
- * @brief The pp capability enumeration
- */
-typedef enum {
-       TDM_PP_CAPABILITY_SYNC           = (1 << 0), /**< The pp device supports synchronous operation */
-       TDM_PP_CAPABILITY_ASYNC          = (1 << 1), /**< The pp device supports asynchronous operation */
-       TDM_PP_CAPABILITY_SCALE          = (1 << 4), /**< The pp device supports scale operation */
-       TDM_PP_CAPABILITY_TRANSFORM      = (1 << 5), /**< The pp device supports transform operation */
-} tdm_pp_capability;
-
-/**
- * @brief The capture capability enumeration
- */
-typedef enum {
-       TDM_CAPTURE_CAPABILITY_OUTPUT    = (1 << 0), /**< The capture device supports to dump a output */
-       TDM_CAPTURE_CAPABILITY_LAYER     = (1 << 1), /**< The capture device supports to dump a layer */
-       TDM_CAPTURE_CAPABILITY_SCALE     = (1 << 4), /**< The capture device supports scale operation */
-       TDM_CAPTURE_CAPABILITY_TRANSFORM = (1 << 5), /**< The capture device supports transform operation */
-} tdm_capture_capability;
-
-/**
- * @brief The output mode type enumeration
- * @details bit compatible with the libdrm definitions.
- */
-typedef enum {
-       TDM_OUTPUT_MODE_TYPE_BUILTIN    = (1 << 0),
-       TDM_OUTPUT_MODE_TYPE_CLOCK_C    = ((1 << 1) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
-       TDM_OUTPUT_MODE_TYPE_CRTC_C     = ((1 << 2) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
-       TDM_OUTPUT_MODE_TYPE_PREFERRED  = (1 << 3),
-       TDM_OUTPUT_MODE_TYPE_DEFAULT    = (1 << 4),
-       TDM_OUTPUT_MODE_TYPE_USERDEF    = (1 << 5),
-       TDM_OUTPUT_MODE_TYPE_DRIVER     = (1 << 6),
-} tdm_output_mode_type;
-
-/**
- * @brief The output mode flag enumeration
- * @details bit compatible with the libdrm definitions.
- */
-typedef enum {
-       TDM_OUTPUT_MODE_FLAG_PHSYNC     = (1 << 0),
-       TDM_OUTPUT_MODE_FLAG_NHSYNC     = (1 << 1),
-       TDM_OUTPUT_MODE_FLAG_PVSYNC     = (1 << 2),
-       TDM_OUTPUT_MODE_FLAG_NVSYNC     = (1 << 3),
-       TDM_OUTPUT_MODE_FLAG_INTERLACE  = (1 << 4),
-       TDM_OUTPUT_MODE_FLAG_DBLSCAN    = (1 << 5),
-       TDM_OUTPUT_MODE_FLAG_CSYNC      = (1 << 6),
-       TDM_OUTPUT_MODE_FLAG_PCSYNC     = (1 << 7),
-       TDM_OUTPUT_MODE_FLAG_NCSYNC     = (1 << 8),
-       TDM_OUTPUT_MODE_FLAG_HSKEW      = (1 << 9), /* hskew provided */
-       TDM_OUTPUT_MODE_FLAG_BCAST      = (1 << 10),
-       TDM_OUTPUT_MODE_FLAG_PIXMUX     = (1 << 11),
-       TDM_OUTPUT_MODE_FLAG_DBLCLK     = (1 << 12),
-       TDM_OUTPUT_MODE_FLAG_CLKDIV2    = (1 << 13),
-} tdm_output_mode_flag;
-
 typedef enum {
        TDM_EVENT_LOOP_READABLE = (1 << 0),
        TDM_EVENT_LOOP_WRITABLE = (1 << 1),
@@ -196,6 +67,14 @@ typedef enum {
 } tdm_event_loop_mask;
 
 /**
+ * @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 The output mode structure
  */
 typedef struct _tdm_output_mode {
@@ -214,6 +93,7 @@ typedef struct _tdm_output_mode {
 typedef struct _tdm_prop {
        unsigned int id;
        char name[TDM_NAME_LEN];
+       tdm_value_type type;
 } tdm_prop;
 
 /**
@@ -235,6 +115,25 @@ typedef struct _tdm_info_layer {
 } tdm_info_layer;
 
 /**
+ * @brief The region structure
+ * @since 2.0.0
+ */
+typedef struct _tdm_region {
+       unsigned int num_rects;
+       tdm_pos const *rects;
+} tdm_region;
+
+/**
+ * @brief The hwc window info structure
+ * @since 2.0.0
+ */
+typedef struct _tdm_hwc_window_info {
+       tdm_info_config src_config;
+       tdm_pos dst_pos;
+       tdm_transform transform;
+} tdm_hwc_window_info;
+
+/**
  * @brief The pp info structre
  */
 typedef struct _tdm_info_pp {
@@ -251,27 +150,116 @@ typedef struct _tdm_info_pp {
 typedef struct _tdm_info_capture {
        tdm_info_config dst_config;
        tdm_transform transform;
-       int oneshot;
+       tdm_capture_type type;
        int frequency;
        int flags;
 } tdm_info_capture;
 
 /**
+ * @brief Possible composition types for a given window
+ * @since 2.0.0
+ */
+typedef enum {
+
+       /** The composition type for an invisible window. The value by default.
+        *
+        * The backend ignores windows of this type.
+        */
+       TDM_HWC_WIN_COMPOSITION_NONE = 0,
+
+       /** The compostion type for an window to be compsoited by the client.
+        *
+        * When the client sets this composition type,
+        * the backend MUST NOT modify this composition type into other types.
+        *
+        * When the backend changes TDM_HWC_WIN_COMPOSITION_DEVICE or TDM_HWC_WIN_COMPOSITION_CURSOR
+        * to this composition type at the time of tdm_hwc_validate and
+        * tdm_hwc_get_changed_composition_types,
+        * the client has to composite this window with gl or other drawing operations.
+        */
+       TDM_HWC_WIN_COMPOSITION_CLIENT = 1,
+
+       /** The compostion type for an window to be set to the hw overlay.
+        *
+        * The client sets this composition type to the visible windows before requesting
+        * the tdm_hwc_validate.
+        * Nomally, the backend leave it if the backend sets the window to the hw overlay.
+        * If the backend does not set the window to the hw overlay at the time of
+        * tdm_hwc_validate, the backend changes the composition type of the window into
+        * TDM_HWC_WIN_COMPOSITION_CLIENT.
+        */
+       TDM_HWC_WIN_COMPOSITION_DEVICE = 3,
+
+       /** The compostion type for an window to be set to the cursor hw overlay.
+        *
+        * The client sets this composition type to the cursor window before requesting
+        * the tdm_hwc_validate.
+        * If the backend does not support the cursor hw overlay, the backend can change
+        * the comopsition type into the TDM_HWC_WIN_COMPOSITION_CLIENT.
+        */
+       TDM_HWC_WIN_COMPOSITION_CURSOR = 4,
+
+       /** The compostion type for an window to be set to the video hw overlay.
+        *
+        * The client sets this composition type to the video window before requesting
+        * the tdm_hwc_validate.
+        * If the backend does not support the video hw overlay, the backend can change
+        * the comopsition type into the TDM_HWC_WIN_COMPOSITION_CLIENT.
+        * Normally, this VIDEO window displays under the primary hw overlayer of the output.
+        */
+       TDM_HWC_WIN_COMPOSITION_VIDEO = 5,
+} tdm_hwc_window_composition;
+
+typedef enum {
+       TDM_HWC_WIN_CONSTRAINT_NONE = 0,
+       /** If the client needs to render to a specific buffer for compositing
+        *  with TDM_HWC_WIN_COMPOSITION_DEVICE, the backend needs to set
+        *  TDM_HWC_WIN_CONSTRAINT_BUFFER_QUEUE to hwc_window until the hwc_window is not
+        *  TDM_HWC_WIN_COMPOSITION_DEVICE. The client gets the tbm_surface_queue_h through
+        *  the tdm_hwc_window_aquire_buffer_queue. It will render the frames on
+        *  the buffers which gets from the tbm_surface_queue_h.
+        */
+       TDM_HWC_WIN_CONSTRAINT_BUFFER_QUEUE = (1 << 0),
+} tdm_hwc_window_constraint;
+
+/**
  * @brief The tdm display object
  */
 typedef void tdm_display;
 
 /**
+ * @brief The tdm backend object
+ */
+typedef void tdm_module;
+
+/**
  * @brief The tdm output object
  */
 typedef void tdm_output;
 
 /**
+ * @brief The tdm voutput object
+ */
+typedef void tdm_voutput;
+
+/**
  * @brief The tdm layer object
  */
 typedef void tdm_layer;
 
 /**
+ * @brief The tdm hwc object
+ * @since 2.0.0
+ */
+typedef void tdm_hwc;
+
+/**
+ * @brief The tdm hwc window object
+ * @since 2.0.0
+ */
+typedef void tdm_hwc_window;
+
+/**
  * @brief The tdm capture object
  */
 typedef void tdm_capture;
@@ -282,6 +270,35 @@ typedef void tdm_capture;
 typedef void tdm_pp;
 
 /**
+ * @brief The tdm vblank object
+ */
+typedef void tdm_vblank;
+
+/**
+ * @brief The output create handler
+ * @details This handler will be called when the output object is
+ * createed in runtime.
+ */
+typedef void (*tdm_output_create_handler)(tdm_display *dpy, tdm_output *output, void *user_data);
+
+/**
+ * @brief The output destroy handler
+ * @details This handler will be called when the output object is
+ * destroied in runtime.
+ */
+typedef void (*tdm_output_destroy_handler)(tdm_output *output, void *user_data);
+
+/**
+ * @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 The vblank handler
  * @see output_set_vblank_handler() function of #tdm_func_display
  */
@@ -290,13 +307,56 @@ typedef void (*tdm_output_vblank_handler)(tdm_output *output, unsigned int seque
                                                                                  void *user_data);
 
 /**
- * @brief The commit handler
+ * @brief The output commit handler
  * @see output_set_commit_handler() function of #tdm_func_display
  */
 typedef void (*tdm_output_commit_handler)(tdm_output *output, unsigned int sequence,
                                                                                  unsigned int tv_sec, unsigned int tv_usec,
                                                                                  void *user_data);
 
+/**
+ * @brief The output mode change request handler
+ */
+typedef void (*tdm_output_mode_change_request_handler)(tdm_output *output,
+                                                                                                          unsigned int index, void *user_data);
+
+/**
+ * @brief The layer commit handler
+ */
+typedef void (*tdm_layer_commit_handler)(tdm_layer *layer, unsigned int sequence,
+                                                                                unsigned int tv_sec, unsigned int tv_usec,
+                                                                                void *user_data);
+
+/**
+ * @brief The done handler of a pp object
+ */
+typedef void (*tdm_pp_done_handler)(tdm_pp *pp, tbm_surface_h src,
+                                                                       tbm_surface_h dst, void *user_data);
+
+/**
+ * @brief The done handler of a capture object
+ */
+typedef void (*tdm_capture_done_handler)(tdm_capture *capture,
+                                                                                tbm_surface_h buffer, void *user_data);
+
+/**
+ * @brief The create handler of a vblank object
+ */
+typedef void (*tdm_vblank_create_handler)(tdm_vblank *vblank, void *user_data);
+
+/**
+ * @brief The hwc commit handler
+ * @see hwc_set_commit_handler() function of #tdm_func_hwc
+ */
+typedef void (*tdm_hwc_commit_handler)(tdm_hwc *hwc, unsigned int sequence,
+                                                                         unsigned int tv_sec, unsigned int tv_usec,
+                                                                         void *user_data);
+
+typedef void (*tdm_voutput_commit_handler)(tdm_voutput *voutput, unsigned int sequence,
+                                                                                  unsigned int tv_sec, unsigned int tv_usec,
+                                                                                  void *user_data);
+
+typedef void (*tdm_voutput_commit_func)(tdm_voutput *voutput, tbm_surface_h buffer);
 #ifdef __cplusplus
 }
 #endif