xref: /utopia/UTPA2-700.0.x/modules/vdec_v2/api/vdec_ex/vdec_ex_private.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 
78 #ifndef _API_VDEC_EX_V2_PRIV_H_
79 #define _API_VDEC_EX_V2_PRIV_H_
80 
81 #if !defined(MSOS_TYPE_NUTTX) || defined(SUPPORT_X_MODEL_FEATURE)
82 ////////////////////////////////////////////////////////////////////////////////
83 // Header Files
84 ////////////////////////////////////////////////////////////////////////////////
85 #ifdef __cplusplus
86 extern "C"
87 {
88 #endif
89 
90 #include "apiVDEC_EX.h"
91 #include "apiVDEC_EX_v2.h"
92 ////////////////////////////////////////////////////////////////////////////////
93 // Define for VDEC layer
94 ////////////////////////////////////////////////////////////////////////////////
95 
96 #define SUPPORT_DECODER_NUM_MAX     2
97 #define VDEC_EX_V2_BIT(_bit_)      (1 << (_bit_))
98 #define MAX_NUM_OF_STORE_USER_SET_CMD  100
99 #define MAX_NUM_OF_STORE_USER_SET_CMD_U32ARG 4
100 //#define MAX_NUM_OF_STORE_USER_SET_CMD_ARG MAX_NUM_OF_STORE_USER_SET_CMD_U32ARG+1
101 ////////////////////////////////////////////////////////////////////////////////
102 // Enum for VDEC layer
103 ////////////////////////////////////////////////////////////////////////////////
104 
105 enum
106 {
107     E_VDEC_EX_POOL_ID_INTERNAL = 0,
108     E_VDEC_EX_POOL_ID_MAX,
109 } E_VDEC_EX_POOL_ID;
110 
111 
112 ////////////////////////////////////////////////////////////////////////////////
113 // Function pointer for VDEC layer
114 ////////////////////////////////////////////////////////////////////////////////
115 typedef VDEC_EX_Result      (*IOCTL_VDEC_EX_GetFreeStream)        (void*,MS_U32,VDEC_EX_Stream,VDEC_EX_CodecType);
116 typedef VDEC_EX_Result      (*IOCTL_VDEC_EX_Init)                 (VDEC_StreamId*,VDEC_EX_InitParam*);
117 typedef VDEC_EX_Result      (*IOCTL_VDEC_EX_SetControl)           (VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**,MS_BOOL);
118 typedef VDEC_EX_Result      (*IOCTL_VDEC_EX_GetControl)           (VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**);
119 typedef VDEC_EX_Result      (*IOCTL_VDEC_EX_PreSetControl)        (VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**);
120 typedef VDEC_EX_Result      (*IOCTL_VDEC_EX_PostSetControl)       (VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**);
121 
122 ////////////////////////////////////////////////////////////////////////////////
123 // Structure for VDEC layer
124 ////////////////////////////////////////////////////////////////////////////////
125 
126 typedef struct
127 {
128     MS_U8 u8DecoderInUse[SUPPORT_DECODER_NUM_MAX];
129 }VDEC_EX_RESOURCE_PRIVATE;
130 
131 
132 typedef struct
133 {
134     // instance variable
135     MS_U8                                Index_of_decoder;
136     // Function pointer
137     IOCTL_VDEC_EX_GetFreeStream          fpVDEC_EX_GetFreeStream;
138     IOCTL_VDEC_EX_Init                   fpVDEC_EX_Init;
139     IOCTL_VDEC_EX_SetControl             fpVDEC_EX_SetControl;
140     IOCTL_VDEC_EX_GetControl             fpVDEC_EX_GetControl;
141     IOCTL_VDEC_EX_PreSetControl          fpVDEC_EX_PreSetControl;
142     IOCTL_VDEC_EX_PostSetControl         fpVDEC_EX_PostSetControl;
143 }VDEC_EX_INSTANCE_PRIVATE;
144 
145 
146 typedef struct
147 {
148     VDEC_EX_V2_User_Cmd cmd;
149     MS_VIRT              u32Arg[MAX_NUM_OF_STORE_USER_SET_CMD_U32ARG];
150     //void*               pStructArg;
151 }VDEC_EX_RECORD_SET_CMD;
152 
153 typedef struct
154 {
155     MS_U8 u8Idx;
156     VDEC_EX_V2_User_Cmd cmd_id;
157     void** param;
158     MS_U32  u32Arg_num;
159     MS_BOOL structArg_num;
160     //MS_U32 struct_size;
161     MS_U8  position[MAX_NUM_OF_STORE_USER_SET_CMD_U32ARG]; // index 0~4 for U32ARG position, index 5 for structARG position
162 }VDEC_EX_RESUME_SET_CMD;
163 
164 
165 
166 ////////////////////////////////////////////////////////////////////////////////
167 // Function for VDEC layer
168 ////////////////////////////////////////////////////////////////////////////////
169 
170 VDEC_EX_Result MApi_VDEC_EX_V2_GetControl(VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**);
171 VDEC_EX_Result MApi_VDEC_EX_V2_SetControl(VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**,MS_BOOL);
172 VDEC_EX_Result MApi_VDEC_EX_V2_GetFreeStream(void*,MS_U32,VDEC_EX_Stream,VDEC_EX_CodecType);
173 VDEC_EX_Result MApi_VDEC_EX_V2_Init(VDEC_StreamId*,VDEC_EX_InitParam*);
174 VDEC_EX_Result MApi_VDEC_EX_V2_PreSetControl(VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**);
175 VDEC_EX_Result MApi_VDEC_EX_V2_PostSetControl(VDEC_StreamId*,VDEC_EX_V2_User_Cmd,void**);
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 
181 #endif
182 #undef _API_VDEC_EX_V2_PRIV_H_
183 #endif // _API_VDEC_EX_V2_PRIV_H_
184