[LIBDCE] Mutual exclusion of Engine_open and Engine_close
[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__
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 */
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;
62 /* other than the codec-engine API, you must use the following two functions
63  * to allocate the data structures passed to codec-engine APIs (other than the
64  * raw input/output buffers which should be passed as virtual addresses in
65  * TILER space
66  */
67 void *dce_alloc(int sz);
68 void dce_free(void *ptr);
71 /*********************************** APIs for Linux ***********************************/
72 /************************ Initialization/Deinitialization APIs ************************/
73 /*=====================================================================================*/
74 /** dce_init                : Initialize DCE. Only Linux applications are expected to call.
75  *
76  * @ return                 : Pointer to omap_device structure.
77  */
78 void *dce_init(void);
80 /*===============================================================*/
81 /** dce_deinit              : Deinitialize DCE. Only Linux applications are expected to call.
82  *
83  * @ param dev    [in]      : Pointer to omap_device structure.
84  */
85 void dce_deinit(void *dev);
87 /************************ Input/Output Buffer Lock/Unlock APIs ************************/
88 /*=====================================================================================*/
89 /** dce_buf_lock            : Pin or lock Tiler Buffers which would be used by the codec
90  *                            as reference buffers. API is specific to GLP.
91  *
92  * @ param num    [in]      : Number of buffers to be locked.
93  * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
94  * @ return                 : DCE error status is returned.
95  */
96 int dce_buf_lock(int num, size_t *handle);
98 /*=====================================================================================*/
99 /** dce_buf_unlock          : Unpin or unlock Tiler Buffers which were locked to be used
100  *                            by the codec as reference buffers. API is specific to GLP.
101  *
102  * @ param num    [in]      : Number of buffers to be locked.
103  * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
104  * @ return                 : DCE error status is returned.
105  */
106 int dce_buf_unlock(int num, size_t *handle);
108 /******************************* OMAPDRM Get/Set FD APIs *******************************/
109 int dce_get_fd();
111 void dce_set_fd(int fd);
114 #endif /* __LIBDCE_H__ */