virtual: define functions and structure for supporting virtual output

[platform/core/uifw/libtdm.git] / include / tdm_backend.h

diff --git a/include/tdm_backend.h b/include/tdm_backend.h
index 033f803..675d9c4 100644 (file)
--- a/include/tdm_backend.h
+++ b/include/tdm_backend.h
@@ -335,7 +335,18 @@ typedef struct _tdm_func_display {
         */
        tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
 
-       void (*reserved1)(void);
+       /**
+        * @brief Create a virtual output object of a backend module
+        * @param[in] bdata The backend module data
+        * @param[in] name The output name
+        * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @return A tdm_voutput object
+        * @see voutput_destroy() function
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_voutput *(*voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
+
        void (*reserved2)(void);
        void (*reserved3)(void);
        void (*reserved4)(void);
@@ -548,12 +559,102 @@ typedef struct _tdm_func_output {
         */
        tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
 
+       void (*reserved3)(void);
+       void (*reserved4)(void);
        void (*reserved5)(void);
        void (*reserved6)(void);
        void (*reserved7)(void);
        void (*reserved8)(void);
 } tdm_func_output;
 
+typedef struct _tdm_func_voutput {
+       /**
+        * @brief Destroy a virtual output object of a backend module
+        * @param[in] voutput The voutput object
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @see voutput_create() function
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_error (*voutput_destroy)(tdm_voutput *voutput);
+
+       /**
+        * @brief Set available modes of a virtual output object
+        * @param[in] voutput A voutput object
+        * @param[in] modes Modes of voutput
+        * @param[in] count A count of modes
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
+
+       /**
+        * @brief Set physical size(mm) of a virtual output object
+        * @param[in] voutput A voutput object
+        * @param[in] mmwidth Width of voutput
+        * @param[in] mmheight Height of voutput
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
+
+       /**
+        * @brief Set connect status of a virtual output object
+        * @param[in] voutput A voutput object
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_error (*voutput_connect)(tdm_voutput *voutput);
+
+       /**
+        * @brief Set disconnect status of a virtual output object
+        * @param[in] voutput A voutput object
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
+
+       /**
+        * @brief Get output object from virtual output object
+        * @param[in] voutput A voutput object
+        * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @return A tdm_output object
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
+
+       /**
+        * @brief Set a user commit function
+        * @param[in] voutput A voutput object
+        * @param[in] func A user voutput commit function
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        * If virtual output's output_commit is executed, call this voutput commit func.
+        */
+       tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
+
+       /**
+        * @brief Notify commit done to backend
+        * @param[in] voutput A voutput object
+        * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+        * @remark
+        * A backend module doesn't need to implement this function if doesn't support virtual output.
+        */
+       tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
+
+       void (*reserved1)(void);
+       void (*reserved2)(void);
+       void (*reserved3)(void);
+       void (*reserved4)(void);
+       void (*reserved5)(void);
+       void (*reserved6)(void);
+} tdm_func_voutput;
 /**
  * @brief The layer functions for a backend module.
  */
@@ -1187,6 +1288,18 @@ tdm_backend_register_func_output(tdm_display *dpy,
                                                                 tdm_func_output *func_output);
 
 /**
+ * @brief Register the backend voutput functions to a display
+ * @param[in] dpy A display object
+ * @param[in] func_voutput voutput functions
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_register_func_display, tdm_backend_register_func_output
+ * @remarks
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+tdm_error
+tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
+
+/**
  * @brief Register the backend layer functions to a display
  * @param[in] dpy A display object
  * @param[in] func_layer layer functions
@@ -1252,6 +1365,26 @@ tdm_backend_register_func_capture(tdm_display *dpy,
                                                                  tdm_func_capture *func_capture);
 
 /**
+ * @brief Register the backend output to a display
+ * @param[in] dpy A display object
+ * @param[in] output A backend output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_unregister_output
+ */
+tdm_error
+tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
+
+/**
+ * @brief Unregister the backend output to a display
+ * @param[in] dpy A display object
+ * @param[in] output A backend output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_register_output
+ */
+void
+tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
+
+/**
  * @brief Increase the ref_count of a TDM buffer
  * @details
  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer