cffa006d64f241041ae25e0bbe0413c47b57cdc8
[glsdk/libdce2.git] / libdce.h
1 /*
2  * Copyright (c) 2013, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
33 #ifndef __LIBDCE_H__
34 #define __LIBDCE_H__
36 #include <xdc/std.h>
37 #include <ti/sdo/ce/Engine.h>
38 #include <ti/sdo/ce/video3/viddec3.h>
39 #include <ti/sdo/ce/video2/videnc2.h>
41 #if defined(BUILDOS_LINUX)
42 /* avoid some messy stuff in xdc/std.h which leads to gcc issues */
43 #define xdc__ARGTOPTR
44 #define xdc__ARGTOFXN
45 #endif /* BUILDOS_LINUX */
47 /********************************** DCE Error Types **********************************/
48 typedef enum dce_error_status {
49     DCE_EOK = 0,
50     DCE_EXDM_FAIL = -1,
51     DCE_EOUT_OF_MEMORY = -2,
52     DCE_EXDM_UNSUPPORTED = -3,
53     DCE_EIPC_CREATE_FAIL = -4,
54     DCE_EIPC_CALL_FAIL = -5,
55     DCE_EINVALID_INPUT = -6,
56     DCE_EOMAPDRM_FAIL = -7,
57     DCE_ESEMAPHORE_FAIL = -8
58 } dce_error_status;
60 /***************************** Memory Allocation/Free APIs *****************************/
61 /*=====================================================================================*/
62 /** dce_alloc               : Allocate the Data structures passed to codec-engine APIs
63  *                             except Input/Output buffers.
64  *
65  * @ param sz    [in]       : Size of memory to be allocated.
66  * @ return                 : Pointer to allocated memory.
67  */
68 void *dce_alloc(int sz);
70 /*=====================================================================================*/
71 /** dce_free                : Free the Data structures passed to codec-engine APIs
72  *                             except Input/Output buffers.
73  *
74  * @ param ptr   [in]       : Pointer to allocated memory.
75  */
76 void dce_free(void *ptr);
79 /*********************************** APIs for Linux ***********************************/
80 /************************ Initialization/Deinitialization APIs ************************/
81 /*=====================================================================================*/
82 /** dce_init                : Initialize DCE. Only Linux applications are expected to call.
83  *
84  * @ return                 : Pointer to omap_device structure.
85  */
86 void *dce_init(void);
88 /*===============================================================*/
89 /** dce_deinit              : Deinitialize DCE. Only Linux applications are expected to call.
90  *
91  * @ param dev    [in]      : Pointer to omap_device structure.
92  */
93 void dce_deinit(void *dev);
95 /************************ Input/Output Buffer Lock/Unlock APIs ************************/
96 /*=====================================================================================*/
97 /** dce_buf_lock            : Pin or lock Tiler Buffers which would be used by the codec
98  *                            as reference buffers. API is specific to GLP.
99  *
100  * @ param num    [in]      : Number of buffers to be locked.
101  * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
102  * @ return                 : DCE error status is returned.
103  */
104 int dce_buf_lock(int num, size_t *handle);
106 /*=====================================================================================*/
107 /** dce_buf_unlock          : Unpin or unlock Tiler Buffers which were locked to be used
108  *                            by the codec as reference buffers. API is specific to GLP.
109  *
110  * @ param num    [in]      : Number of buffers to be locked.
111  * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
112  * @ return                 : DCE error status is returned.
113  */
114 int dce_buf_unlock(int num, size_t *handle);
116 /******************************* OMAPDRM Get/Set FD APIs *******************************/
117 /*=====================================================================================*/
118 /** dce_get_fd              : Get OMAP DRM File Descriptor.
119  *
120  * @ return                 : OMAP DRM File Descriptor.
121  */
122 int dce_get_fd();
124 /*=====================================================================================*/
125 /** dce_set_fd              : Set OMAP DRM File Descriptor.
126  *
127  * @ param fd     [in]      : OMAP DRM File Descriptor.
128  */
129 void dce_set_fd(int fd);
132 #endif /* __LIBDCE_H__ */