File: cm_vebox.h

package info (click to toggle)
intel-media-driver 18.4.1%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 77,144 kB
  • sloc: cpp: 784,288; ansic: 95,944; asm: 42,125; python: 353; sh: 156; makefile: 15
file content (197 lines) | stat: -rw-r--r-- 9,561 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
* Copyright (c) 2017, Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
//!
//! \file      cm_vebox.h 
//! \brief     Contains CmVebox declarations. 
//!

#ifndef MEDIADRIVER_AGNOSTIC_COMMON_CM_CMVEBOX_H_
#define MEDIADRIVER_AGNOSTIC_COMMON_CM_CMVEBOX_H_

#include "cm_def.h"

#define VEBOX_MAX_SURFACE_COUNT  (16)

namespace CMRT_UMD
{
class CmSurface2D;
class CmBufferUP;

//! \brief      CmVebox is an abstraction of the vebox hardware, 
//! \details    Details of vebox hardware be found at 
//!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
//!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf

class CmVebox
{
public:
    //! \brief      Set state for the vebox object
    //! \param      [in] veboxState
    //!             CM_VEBOX_STATE
    //! \returns    CM_SUCCESS
    CM_RT_API virtual int32_t SetState(CM_VEBOX_STATE &veboxState) = 0;

    //! \brief      Set the current frame input surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t SetCurFrameInputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits for the current frame input surface
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetCurFrameInputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the previous frame input surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t SetPrevFrameInputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits for the previous frame input surface
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetPrevFrameInputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the STMM input surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t SetSTMMInputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits the for STMM input surface
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetSTMMInputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the STMM output surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t SetSTMMOutputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits the for STMM output surface
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetSTMMOutputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the denoised current frame output surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetDenoisedCurFrameOutputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits for the denoised current frame output surface 
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetDenoisedCurOutputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the current frame output surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t SetCurFrameOutputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits for the current frame output surface 
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetCurFrameOutputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the previous frame output surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t SetPrevFrameOutputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits for the previous frame output surface 
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetPrevFrameOutputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set the statistics output surface for the vebox object
    //! \param      [in] surface
    //!             CmSurface2D
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetStatisticsOutputSurface(CmSurface2D *surface) = 0;

    //! \brief      Set the control bits for the statistics output surface 
    //! \details    Details of the control bits can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] ctrlBits
    //!             control bit value
    //! \retval     CM_SUCCESS
    CM_RT_API virtual int32_t
    SetStatisticsOutputSurfaceControlBits(const uint16_t ctrlBits) = 0;

    //! \brief      Set vebox parameters through a CmBufferUP.
    //! \details    The size of this  CmBufferUp is 4K. It contains VEBOX_DNDI_STATE, 
    //!             VEBOX_IECP_STATE, VEBOX_GAMUT_STATE, VEBOX_VERTEX_TABLE, and
    //!             VEBOX_CAPTURE_PIPE_STATE. Each state is 1K. The details of each state
    //!             can be found at 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-skl-vol09-media_vebox.pdf, or 
    //!             https://01.org/sites/default/files/documentation/intel-gfx-prm-osrc-kbl-vol09-media_vebox.pdf
    //! \param      [in] paramBuffer
    //!             CmBufferUP which contains all the vebox parameter.
    //! \returns    CM_SUCCESS.
    CM_RT_API virtual int32_t SetParam(CmBufferUP *paramBuffer) = 0;
};
};//namespace

#endif  // #ifndef MEDIADRIVER_AGNOSTIC_COMMON_CM_CMVEBOX_H_