Merge remote-tracking branch 'other/master'
[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 #define xdc_target_types__ gnu/targets/std.h
37 #include <xdc/std.h>
38 #include <ti/sdo/ce/Engine.h>
39 #include <ti/sdo/ce/video3/viddec3.h>
40 #include <ti/sdo/ce/video2/videnc2.h>
42 #if defined(BUILDOS_LINUX)
43 /* avoid some messy stuff in xdc/std.h which leads to gcc issues */
44 #define xdc__ARGTOPTR
45 #define xdc__ARGTOFXN
46 #endif /* BUILDOS_LINUX */
48 /********************************** DCE Error Types **********************************/
49 typedef enum dce_error_status {
50     DCE_EOK = 0,
51     DCE_EXDM_FAIL = -1,
52     DCE_EOUT_OF_MEMORY = -2,
53     DCE_EXDM_UNSUPPORTED = -3,
54     DCE_EIPC_CREATE_FAIL = -4,
55     DCE_EIPC_CALL_FAIL = -5,
56     DCE_EINVALID_INPUT = -6,
57     DCE_EOMAPDRM_FAIL = -7,
58     DCE_ESEMAPHORE_FAIL = -8
59 } dce_error_status;
61 /***************************** Memory Allocation/Free APIs *****************************/
62 /*=====================================================================================*/
63 /** dce_alloc               : Allocate the Data structures passed to codec-engine APIs
64  *                             except Input/Output buffers.
65  *
66  * @ param sz    [in]       : Size of memory to be allocated.
67  * @ return                 : Pointer to allocated memory.
68  */
69 void *dce_alloc(int sz);
71 /*=====================================================================================*/
72 /** dce_free                : Free the Data structures passed to codec-engine APIs
73  *                             except Input/Output buffers.
74  *
75  * @ param ptr   [in]       : Pointer to allocated memory.
76  */
77 void dce_free(void *ptr);
80 /*********************************** APIs for Linux ***********************************/
81 /************************ Initialization/Deinitialization APIs ************************/
82 /*=====================================================================================*/
83 /** dce_init                : Initialize DCE. Only Linux applications are expected to call.
84  *
85  * @ return                 : Pointer to omap_device structure.
86  */
87 void *dce_init(void);
89 /*===============================================================*/
90 /** dce_deinit              : Deinitialize DCE. Only Linux applications are expected to call.
91  *
92  * @ param dev    [in]      : Pointer to omap_device structure.
93  */
94 void dce_deinit(void *dev);
96 /************************ Input/Output Buffer Lock/Unlock APIs ************************/
97 /*=====================================================================================*/
98 /** dce_buf_lock            : Pin or lock Tiler Buffers which would be used by the codec
99  *                            as reference buffers. API is specific to GLP.
100  *
101  * @ param num    [in]      : Number of buffers to be locked.
102  * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
103  * @ return                 : DCE error status is returned.
104  */
105 int dce_buf_lock(int num, size_t *handle);
107 /*=====================================================================================*/
108 /** dce_buf_unlock          : Unpin or unlock Tiler Buffers which were locked to be used
109  *                            by the codec as reference buffers. API is specific to GLP.
110  *
111  * @ param num    [in]      : Number of buffers to be locked.
112  * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
113  * @ return                 : DCE error status is returned.
114  */
115 int dce_buf_unlock(int num, size_t *handle);
117 /******************************* OMAPDRM Get/Set FD APIs *******************************/
118 /*=====================================================================================*/
119 /** dce_get_fd              : Get OMAP DRM File Descriptor.
120  *
121  * @ return                 : OMAP DRM File Descriptor.
122  */
123 int dce_get_fd();
125 /*=====================================================================================*/
126 /** dce_set_fd              : Set OMAP DRM File Descriptor.
127  *
128  * @ param fd     [in]      : OMAP DRM File Descriptor.
129  */
130 void dce_set_fd(int fd);
133 #endif /* __LIBDCE_H__ */