Merge remote-tracking branch 'other/master'
[glsdk/libdce2.git] / libdce.h
index fdf2c7f715b23625000df97bb63c95ff6952c23c..ea63e66938bc522cbe2d9a284b237a6047cc74ac 100644 (file)
--- a/libdce.h
+++ b/libdce.h
@@ -33,7 +33,8 @@
 #ifndef __LIBDCE_H__
 #define __LIBDCE_H__
 
-
+#define xdc_target_types__ gnu/targets/std.h
+#include <xdc/std.h>
 #include <ti/sdo/ce/Engine.h>
 #include <ti/sdo/ce/video3/viddec3.h>
 #include <ti/sdo/ce/video2/videnc2.h>
@@ -44,8 +45,7 @@
 #define xdc__ARGTOFXN
 #endif /* BUILDOS_LINUX */
 
-
-/* DCE Error Types */
+/********************************** DCE Error Types **********************************/
 typedef enum dce_error_status {
     DCE_EOK = 0,
     DCE_EXDM_FAIL = -1,
@@ -53,16 +53,27 @@ typedef enum dce_error_status {
     DCE_EXDM_UNSUPPORTED = -3,
     DCE_EIPC_CREATE_FAIL = -4,
     DCE_EIPC_CALL_FAIL = -5,
-    DCE_EINVALID_INPUT = -6
+    DCE_EINVALID_INPUT = -6,
+    DCE_EOMAPDRM_FAIL = -7,
+    DCE_ESEMAPHORE_FAIL = -8
 } dce_error_status;
 
-
-/* other than the codec-engine API, you must use the following two functions
- * to allocate the data structures passed to codec-engine APIs (other than the
- * raw input/output buffers which should be passed as virtual addresses in
- * TILER space
+/***************************** Memory Allocation/Free APIs *****************************/
+/*=====================================================================================*/
+/** dce_alloc               : Allocate the Data structures passed to codec-engine APIs
+ *                             except Input/Output buffers.
+ *
+ * @ param sz    [in]       : Size of memory to be allocated.
+ * @ return                 : Pointer to allocated memory.
  */
 void *dce_alloc(int sz);
+
+/*=====================================================================================*/
+/** dce_free                : Free the Data structures passed to codec-engine APIs
+ *                             except Input/Output buffers.
+ *
+ * @ param ptr   [in]       : Pointer to allocated memory.
+ */
 void dce_free(void *ptr);
 
 
@@ -104,8 +115,18 @@ int dce_buf_lock(int num, size_t *handle);
 int dce_buf_unlock(int num, size_t *handle);
 
 /******************************* OMAPDRM Get/Set FD APIs *******************************/
+/*=====================================================================================*/
+/** dce_get_fd              : Get OMAP DRM File Descriptor.
+ *
+ * @ return                 : OMAP DRM File Descriptor.
+ */
 int dce_get_fd();
 
+/*=====================================================================================*/
+/** dce_set_fd              : Set OMAP DRM File Descriptor.
+ *
+ * @ param fd     [in]      : OMAP DRM File Descriptor.
+ */
 void dce_set_fd(int fd);