Debian Codegraph @

media_softlet/agnostic/common/vp/hal/utils/vp_utils.h

raw
1 /*
2 * Copyright (c) 2018-2025, Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included
12 * in all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 */
22 #ifndef __VP_UTILS_H__
23 #define __VP_UTILS_H__
24
25 #include "mos_util_debug.h"
26 #include "vp_common.h"
27
28 using MosFormatArray = std::vector<MOS_FORMAT>;
29
30 #define VP_UNUSED(param) (void)(param)
31 //------------------------------------------------------------------------------
32 // Macros specific to MOS_VP_SUBCOMP_ENCODE sub-comp
33 //------------------------------------------------------------------------------
34 #define VP_HW_ASSERT(_expr) \
35 MOS_ASSERT(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _expr)
36
37 #define VP_HW_ASSERTMESSAGE(_message, ...) \
38 MOS_ASSERTMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _message, ##__VA_ARGS__)
39
40 #define VP_HW_WARNINGMESSAGE(_message, ...) \
41 MOS_WARNINGMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _message, ##__VA_ARGS__)
42
43 #define VP_HW_NORMALMESSAGE(_message, ...) \
44 MOS_NORMALMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _message, ##__VA_ARGS__)
45
46 #define VP_HW_VERBOSEMESSAGE(_message, ...) \
47 MOS_VERBOSEMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _message, ##__VA_ARGS__)
48
49 #define VP_HW_FUNCTION_ENTER \
50 MOS_FUNCTION_ENTER(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW)
51
52 #define VP_HW_CHK_STATUS(_stmt) \
53 MOS_CHK_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _stmt)
54
55 #define VP_HW_CHK_NULL(_ptr) \
56 MOS_CHK_NULL(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _ptr)
57
58 #define VP_HW_CHK_NULL_RETURN(_ptr) \
59 MOS_CHK_NULL_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
60
61 #define VP_HW_CHK_NULL_NO_STATUS(_ptr) \
62 MOS_CHK_NULL_NO_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_HW, _ptr)
63
64 //------------------------------------------------------------------------------
65 // Macros specific to MOS_VP_SUBCOMP_PUBLIC sub-comp
66 //------------------------------------------------------------------------------
67 #define VP_PUBLIC_ASSERT(_expr) \
68 MOS_ASSERT(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _expr)
69
70 #if (_DEBUG || _RELEASE_INTERNAL)
71 #define VP_PUBLIC_ASSERTMESSAGE(_message, ...) \
72 MOS_ASSERTMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _message, ##__VA_ARGS__)
73 #else
74 #define VP_PUBLIC_ASSERTMESSAGE(_message, ...) \
75 OcaOnMosCriticalMessage(MOS_FUNCTION, __LINE__);
76 #endif
77
78 #define VP_PUBLIC_WARNINGMESSAGE(_message, ...) \
79 MOS_WARNINGMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _message, ##__VA_ARGS__)
80
81 #define VP_PUBLIC_NORMALMESSAGE(_message, ...) \
82 MOS_NORMALMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _message, ##__VA_ARGS__)
83
84 #define VP_PUBLIC_VERBOSEMESSAGE(_message, ...) \
85 MOS_VERBOSEMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _message, ##__VA_ARGS__)
86
87 #define VP_PUBLIC_FUNCTION_ENTER \
88 MOS_FUNCTION_ENTER(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC)
89
90 #define VP_PUBLIC_CHK_STATUS(_stmt) \
91 MOS_CHK_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _stmt)
92
93 #define VP_PUBLIC_CHK_STATUS_RETURN(_stmt) \
94 MOS_CHK_STATUS_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _stmt)
95
96 #define VP_PUBLIC_CHK_VALUE_RETURN(_value, _expect_value) \
97 MOS_CHK_STATUS_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, \
98 ((_value) == (_expect_value)) ? MOS_STATUS_SUCCESS : MOS_STATUS_INVALID_PARAMETER)
99
100 #define VP_PUBLIC_CHK_NULL(_ptr) \
101 MOS_CHK_NULL(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
102
103 #define VP_PUBLIC_CHK_NULL_RETURN(_ptr) \
104 MOS_CHK_NULL_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
105
106 #define VP_PUBLIC_CHK_NULL_NO_STATUS(_ptr) \
107 MOS_CHK_NULL_NO_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
108
109 #define VP_PUBLIC_CHK_NULL_NO_STATUS_RETURN(_ptr) \
110 MOS_CHK_NULL_NO_STATUS_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
111
112 #define VP_CHK_SPACE_NULL_RETURN(_ptr) \
113 { \
114 if ((_ptr) == nullptr) \
115 { \
116 MOS_ASSERTMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, "Invalid (nullptr) Pointer."); \
117 return MOS_STATUS_NO_SPACE; \
118 } \
119 }
120
121 #define VP_PUBLIC_CHK_NOT_FOUND_RETURN(_handle, _group) \
122 { \
123 if (_handle == (_group)->end()) \
124 { \
125 VP_PUBLIC_CHK_STATUS_RETURN(MOS_STATUS_NULL_POINTER); \
126 } \
127 }
128 //------------------------------------------------------------------------------
129 // Macros specific to MOS_VP_SUBCOMP_DEBUG sub-comp
130 //------------------------------------------------------------------------------
131 #define VP_DEBUG_ASSERT(_expr) \
132 MOS_ASSERT(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _expr)
133
134 #define VP_DEBUG_ASSERTMESSAGE(_message, ...) \
135 MOS_ASSERTMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _message, ##__VA_ARGS__)
136
137 #define VP_DEBUG_WARNINGMESSAGE(_message, ...) \
138 MOS_WARNINGMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _message, ##__VA_ARGS__)
139
140 #define VP_DEBUG_NORMALMESSAGE(_message, ...) \
141 MOS_NORMALMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _message, ##__VA_ARGS__)
142
143 #define VP_DEBUG_VERBOSEMESSAGE(_message, ...) \
144 MOS_VERBOSEMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _message, ##__VA_ARGS__)
145
146 #define VP_FUNCTION_VERBOSEMESSAGE(_message, ...) \
147 MOS_DEBUGMESSAGE(MOS_MESSAGE_LVL_FUNCTION_ENTRY_VERBOSE, MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _message, ##__VA_ARGS__)
148
149 #define VP_DEBUG_FUNCTION_ENTER \
150 MOS_FUNCTION_ENTER(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG)
151
152 #define VP_DEBUG_CHK_STATUS(_stmt) \
153 MOS_CHK_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _stmt)
154
155 #define VP_DEBUG_CHK_STATUS_RETURN(_stmt) \
156 MOS_CHK_STATUS_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _stmt)
157
158 #define VP_DEBUG_CHK_NULL(_ptr) \
159 MOS_CHK_NULL(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _ptr)
160
161 #define VP_DEBUG_CHK_NULL_RETURN(_ptr) \
162 MOS_CHK_NULL_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
163
164 #define VP_DEBUG_CHK_NULL_NO_STATUS(_ptr) \
165 MOS_CHK_NULL_NO_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DEBUG, _ptr)
166
167 //------------------------------------------------------------------------------
168 // Macros specific to MOS_VP_SUBCOMP_RENDER sub-comp
169 //------------------------------------------------------------------------------
170 #define VP_RENDER_ASSERT(_expr) \
171 MOS_ASSERT(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _expr)
172
173 #if (_DEBUG || _RELEASE_INTERNAL)
174 #define VP_RENDER_ASSERTMESSAGE(_message, ...) \
175 MOS_ASSERTMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _message, ##__VA_ARGS__)
176 #else
177 #define VP_RENDER_ASSERTMESSAGE(_message, ...) \
178 OcaOnMosCriticalMessage(MOS_FUNCTION, __LINE__);
179 #endif
180
181 #define VP_RENDER_WARNINGMESSAGE(_message, ...) \
182 MOS_WARNINGMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _message, ##__VA_ARGS__)
183
184 #define VP_RENDER_NORMALMESSAGE(_message, ...) \
185 MOS_NORMALMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _message, ##__VA_ARGS__)
186
187 #define VP_RENDER_VERBOSEMESSAGE(_message, ...) \
188 MOS_VERBOSEMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _message, ##__VA_ARGS__)
189
190 #define VP_RENDER_FUNCTION_ENTER \
191 MOS_FUNCTION_ENTER(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER)
192
193 #define VP_RENDER_EXITMESSAGE(_message, ...) \
194 MOS_DEBUGMESSAGE(MOS_MESSAGE_LVL_FUNCTION_EXIT, MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _message, ##__VA_ARGS__)
195
196 #define VP_RENDER_CHK_STATUS(_stmt) \
197 MOS_CHK_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _stmt)
198
199 #define VP_RENDER_CHK_STATUS_RETURN(_stmt) \
200 MOS_CHK_STATUS_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _stmt)
201
202 #define VP_RENDER_CHK_STATUS_MESSAGE(_stmt, _message, ...) \
203 MOS_CHK_STATUS_MESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _stmt, _message, ##__VA_ARGS__)
204
205 #define VP_RENDER_CHK_NULL(_ptr) \
206 MOS_CHK_NULL(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _ptr)
207
208 #define VP_RENDER_CHK_NULL_RETURN(_ptr) \
209 MOS_CHK_NULL_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _ptr)
210
211 #define VP_RENDER_CHK_NULL_NO_STATUS(_ptr) \
212 MOS_CHK_NULL_NO_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_RENDER, _ptr)
213
214 //------------------------------------------------------------------------------
215 // Macros specific to MOS_VP_SUBCOMP_DDI sub-comp
216 //------------------------------------------------------------------------------
217 #define VP_DDI_ASSERT(_expr) \
218 MOS_ASSERT(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _expr)
219
220 #define VP_DDI_ASSERTMESSAGE(_message, ...) \
221 MOS_ASSERTMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _message, ##__VA_ARGS__)
222
223 #define VP_DDI_WARNINGMESSAGE(_message, ...) \
224 MOS_WARNINGMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _message, ##__VA_ARGS__)
225
226 #define VP_DDI_NORMALMESSAGE(_message, ...) \
227 MOS_NORMALMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _message, ##__VA_ARGS__)
228
229 #define VP_DDI_VERBOSEMESSAGE(_message, ...) \
230 MOS_VERBOSEMESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _message, ##__VA_ARGS__)
231
232 #define VP_DDI_FUNCTION_ENTER \
233 MOS_FUNCTION_ENTER(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI)
234
235 #define VP_DDI_CHK_STATUS(_stmt) \
236 MOS_CHK_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _stmt)
237
238 #define VP_DDI_CHK_STATUS_MESSAGE(_stmt, _message, ...) \
239 MOS_CHK_STATUS_MESSAGE(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _stmt, _message, ##__VA_ARGS__)
240
241 #define VP_DDI_CHK_NULL(_ptr) \
242 MOS_CHK_NULL(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _ptr)
243
244 #define VP_DDI_CHK_NULL_RETURN(_ptr) \
245 MOS_CHK_NULL_RETURN(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_PUBLIC, _ptr)
246
247 #define VP_DDI_CHK_NULL_NO_STATUS(_ptr) \
248 MOS_CHK_NULL_NO_STATUS(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _ptr)
249
250 #define VPHAL_DDI_CHK_HR(_ptr) \
251 MOS_CHK_HR(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _ptr)
252
253 #define VPHAL_DDI_CHK_NULL_WITH_HR(_ptr) \
254 MOS_CHK_NULL_WITH_HR(MOS_COMPONENT_VP, MOS_VP_SUBCOMP_DDI, _ptr)
255 namespace vp
256 {
257 class Trace
258 {
259 public:
260 Trace(const char* name) : m_name(name)
261 {
262 if (g_perfutility && (g_perfutility->dwPerfUtilityIsEnabled & VP_HAL))
263 {
264 g_perfutility->startTick(name);
265 m_enablePerfMeasure = true;
266 }
267 else // Always bypass function trace for perf measurement case.
268 {
269 VP_FUNCTION_VERBOSEMESSAGE("Enter function:%s\r\n", name);
270 }
271 }
272
273 ~Trace()
274 {
275 if (m_enablePerfMeasure && g_perfutility)
276 {
277 g_perfutility->stopTick(m_name);
278 }
279 else
280 {
281 VP_FUNCTION_VERBOSEMESSAGE("Exit function:%s\r\n", m_name);
282 }
283 }
284
285 protected:
286 const char* m_name = nullptr;
287 bool m_enablePerfMeasure = false;
288 };
289 }
290
291 #if MOS_MESSAGES_ENABLED
292 // Function trace for vp hal layer.
293 #define VP_FUNC_CALL() vp::Trace trace(__FUNCTION__);
294 #else
295 #define VP_FUNC_CALL()
296 #endif
297
298 #define __VPHAL_VEBOX_OUTPUTPIPE_MODE "VPOutputPipe Mode"
299 #define __VPHAL_VEBOX_FEATURE_INUSE "VeBox Feature In use"
300 #define __VPHAL_VEBOX_DISABLE_SFC "Disable SFC"
301 #define __MEDIA_USER_FEATURE_VALUE_SFC_OUTPUT_DTR_DISABLE "Disable SFC DTR"
302 #define __MEDIA_USER_FEATURE_VALUE_SFC_OUTPUT_CENTERING_DISABLE "SFC Output Centering Disable"
303 #define __VPHAL_BYPASS_COMPOSITION "Bypass Composition"
304 #define __MEDIA_USER_FEATURE_VALUE_VEBOX_TGNE_ENABLE_VP "Enable Vebox GNE"
305
306 #define __VPHAL_RNDR_SSD_CONTROL "SSD Control"
307 #define __MEDIA_USER_FEATURE_VALUE_CSC_COEFF_PATCH_MODE_DISABLE "CSC Patch Mode Disable"
308 #define __MEDIA_USER_FEATURE_VALUE_DISABLE_DN "Disable Dn"
309 #define __MEDIA_USER_FEATURE_VALUE_DISABLE_PACKET_REUSE "Disable PacketReuse"
310 #define __MEDIA_USER_FEATURE_VALUE_ENABLE_PACKET_REUSE_TEAMS_ALWAYS "Enable PacketReuse Teams mode Always"
311 #define __MEDIA_USER_FEATURE_VALUE_FORCE_ENABLE_VEBOX_OUTPUT_SURF "Force Enable Vebox Output Surf"
312
313 #define __VPHAL_HDR_LUT_MODE "HDR Lut Mode"
314 #define __VPHAL_HDR_GPU_GENERTATE_3DLUT "HDR GPU generate 3DLUT"
315 #define __VPHAL_HDR_DISABLE_AUTO_MODE "Disable HDR Auto Mode"
316 #define __VPHAL_HDR_SPLIT_FRAME_PORTIONS "VPHAL HDR Split Frame Portions"
317 #define __MEDIA_USER_FEATURE_VALUE_VPP_APOGEIOS_ENABLE "VP Apogeios Enabled"
318 #define __VPHAL_PRIMARY_MMC_COMPRESSMODE "VP Primary Surface Compress Mode"
319 #define __VPHAL_RT_MMC_COMPRESSMODE "VP RT Compress Mode"
320 #define __VPHAL_RT_Cache_Setting "VP RT Cache Setting"
321
322 #if (_DEBUG || _RELEASE_INTERNAL)
323 #define __VPHAL_RT_Old_Cache_Setting "VP RT Old Cache Setting"
324 #define __VPHAL_ENABLE_COMPUTE_CONTEXT "VP Enable Compute Context"
325 #define __VPHAL_RNDR_SCOREBOARD_CONTROL "SCOREBOARD Control"
326 #define __VPHAL_RNDR_CMFC_CONTROL "CMFC Control"
327 #define __VPHAL_ENABLE_1K_1DLUT "Enable 1K 1DLUT"
328 #define __VPHAL_FORCE_3DLUT_INTERPOLATION "VPHAL Force 3DLUT Interpolation"
329 #define __VPHAL_VEBOX_HDR_MODE "VeboxHDRMode"
330 #define __VPHAL_HDR_ENABLE_QUALITY_TUNING "VPHAL HDR Enable Quality Tuning"
331 #define __VPHAL_HDR_ENABLE_KERNEL_DUMP "VPHAL HDR Enable Kernel Dump"
332 #define __VPHAL_HDR_H2S_RGB_TM "VPHAL H2S TM RGB Based"
333 #define __VPHAL_HDR_3DLUT_CPU_PATH "HDR 3DLut Table Use CPU Caculate"
334 #define __VPHAL_FORCE_VP_3DLUT_KERNEL_ONLY "Force VP 3DLut Kernel Only"
335 #define __VPHAL_3DLUT_FILE_PATH "3DLUT File Path"
336
337 // Compression
338 #define __VPHAL_MMC_ENABLE "VP MMC In Use"
339 #define __VPHAL_RT_MMC_COMPRESSIBLE "VP RT Compressible"
340 #define __VPHAL_PRIMARY_MMC_COMPRESSIBLE "VP Primary Surface Compressible"
341
342 #define __VPHAL_RNDR_FORCE_VP_DECOMPRESSED_OUTPUT "FORCE VP DECOMPRESSED OUTPUT"
343 #define __VPHAL_COMP_8TAP_ADAPTIVE_ENABLE "8-TAP Enable"
344 #define __VPHAL_VEBOX_FORCE_VP_MEMCOPY_OUTPUTCOMPRESSED "Force VP Memorycopy Outputcompressed"
345 #define __VPHAL_ENABLE_SFC_NV12_P010_LINEAR_OUTPUT "Enable SFC NV12 P010 Linear Output"
346 #define __VPHAL_ENABLE_SFC_RGBP_RGB24_OUTPUT "Enable SFC RGBP RGB24 Output"
347
348 #define __VPHAL_DBG_PARAM_DUMP_OUTFILE_KEY_NAME "outxmlLocation"
349 #define __VPHAL_DBG_PARAM_DUMP_START_FRAME_KEY_NAME "startxmlFrame"
350 #define __VPHAL_DBG_PARAM_DUMP_END_FRAME_KEY_NAME "endxmlFrame"
351 #define __VPHAL_DBG_DUMP_OUTPUT_DIRECTORY "Vphal Debug Dump Output Directory"
352 #define __VPHAL_DBG_PARA_DUMP_ENABLE_SKUWA_DUMP "enableSkuWaDump"
353
354 #define __MEDIA_USER_FEATURE_VALUE_INTER_FRAME_MEMORY_NINJA_START_COUNTER "InterFrameNinjaStartCounter"
355 #define __MEDIA_USER_FEATURE_VALUE_INTER_FRAME_MEMORY_NINJA_END_COUNTER "InterFrameNinjaEndCounter"
356 #define __MEDIA_USER_FEATURE_VALUE_ENABLE_IFNCC "EnableIFNCC"
357 // For OCL 3DLut
358 #define __MEDIA_USER_FEATURE_VALUE_ENABLE_VP_OCL_3DLUT "Enable OCL 3DLUT"
359 #define __MEDIA_USER_FEATURE_VALUE_VP_OCL_3DLUT_ENABLED "OCL 3DLUT Enabled"
360
361 // For OCL FC
362 #define __MEDIA_USER_FEATURE_VALUE_ENABLE_VP_OCL_FC "Enable OCL FC"
363 #define __MEDIA_USER_FEATURE_VALUE_DISABLE_VP_OCL_FC_FP "Disable OCL FC FP"
364 #define __MEDIA_USER_FEATURE_VALUE_VP_OCL_FC_SUPPORTED "OCL FC Supported"
365 #define __MEDIA_USER_FEATURE_VALUE_VP_OCL_FC_FEATURE_REPORT "OCL FC Feature Report"
366 #define __MEDIA_USER_FEATURE_VALUE_VP_OCL_FC_REPORT "OCL FC Diff Report"
367 #define __MEDIA_USER_FEATURE_VALUE_VP_LEGACY_FC_IN_USE "Legacy FC In Use"
368
369 #define __MEDIA_USER_FEATURE_VALUE_ENABLE_VESFC_LINEAR_OUTPUT_BY_TILECONVERT "Enable VESFC Linearoutput By TileConvert"
370
371 #define __MEDIA_USER_FEATURE_VALUE_ENABLE_VEBOX_ID_REPORT "Enable VEBOX ID REPORT"
372 #define __MEDIA_USER_FEATURE_VALUE_USED_VEBOX_ID "USED VEBOX ID"
373 #define __MEDIA_USER_FEATURE_VALUE_FALLBACK_SCALING_TO_RENDER_8K "VP Fallback Scaling To Render 8k"
374 #define __MEDIA_USER_FEATURE_VALUE_FALLBACK_SCALING_TO_RENDER_8K_REPORT "VP Fallback Scaling To Render 8k Report"
375 #endif //(_DEBUG || _RELEASE_INTERNAL)
376
377 class VpUtils
378 {
379 public:
380 //!
381 //! \brief Allocates the Surface
382 //! \details Allocates the Surface
383 //! - if the surface is not already allocated OR
384 //! - resource dimenisions OR format changed
385 //! \param [in] pOsInterface
386 //! Pointer to MOS_INTERFACE
387 //! \param [in,out] pSurface
388 //! Pointer to VPHAL_SURFACE
389 //! \param [in] pSurfaceName
390 //! Pointer to surface name
391 //! \param [in] format
392 //! Expected MOS_FORMAT
393 //! \param [in] DefaultResType
394 //! Expected Resource Type
395 //! \param [in] DefaultTileType
396 //! Expected Surface Tile Type
397 //! \param [in] dwWidth
398 //! Expected Surface Width
399 //! \param [in] dwHeight
400 //! Expected Surface Height
401 //! \param [in] bCompressible
402 //! Surface being compressible or not
403 //! \param [in] CompressionMode
404 //! Compression Mode
405 //! \param [out] pbAllocated
406 //! true if allocated, false for not
407 //! \param [in] resUsageType
408 //! resource usage type for caching
409 //! \param [in] tileModeByForce
410 //! Forced tile mode
411 //! \param [in] memType
412 //! vidoe memory location
413 //! \param [in] isNotLockable
414 //! Flag to indicate whether resource being not lockable
415 //! \return MOS_STATUS
416 //! MOS_STATUS_SUCCESS if success. Error code otherwise
417 //!
418 static MOS_STATUS ReAllocateSurface(
419 PMOS_INTERFACE osInterface,
420 PVPHAL_SURFACE surface,
421 PCCHAR surfaceName,
422 MOS_FORMAT format,
423 MOS_GFXRES_TYPE defaultResType,
424 MOS_TILE_TYPE defaultTileType,
425 uint32_t dwWidth,
426 uint32_t dwHeight,
427 bool bCompressible,
428 MOS_RESOURCE_MMC_MODE compressionMode,
429 bool *bAllocated,
430 MOS_HW_RESOURCE_DEF resUsageType = MOS_HW_RESOURCE_DEF_MAX,
431 MOS_TILE_MODE_GMM tileModeByForce = MOS_TILE_UNSET_GMM,
432 Mos_MemPool memType = MOS_MEMPOOL_VIDEOMEMORY,
433 bool isNotLockable = false);
434
435 //!
436 //! \brief
437 //! \details Get CSC matrix in a form usable by Vebox, SFC and IECP kernels
438 //! \param [in] SrcCspace
439 //! Source Cspace
440 //! \param [in] DstCspace
441 //! Destination Cspace
442 //! \param [out] pfCscCoeff
443 //! [3x3] Coefficients matrix
444 //! \param [out] pfCscInOffset
445 //! [3x1] Input Offset matrix
446 //! \param [out] pfCscOutOffset
447 //! [3x1] Output Offset matrix
448 //! \return void
449 //!
450 static void GetCscMatrixForVeSfc8Bit(
451 VPHAL_CSPACE srcCspace,
452 VPHAL_CSPACE dstCspace,
453 float *fCscCoeff,
454 float *fCscInOffset,
455 float *fCscOutOffset);
456
457 //!
458 //! \brief Performs Color Space Convert for Sample 8 bit
459 //! \details Performs Color Space Convert from Src Color Spase to Dst Color Spase
460 //! \param [out] pOutput
461 //! Pointer to VPHAL_COLOR_SAMPLE_8
462 //! \param [in] pInput
463 //! Pointer to VPHAL_COLOR_SAMPLE_8
464 //! \param [in] srcCspace
465 //! Source Color Space
466 //! \param [in] dstCspace
467 //! Dest Color Space
468 //! \return bool
469 //! Return true if successful, otherwise false
470 //!
471 static bool GetCscMatrixForRender8Bit(
472 VPHAL_COLOR_SAMPLE_8 *output,
473 VPHAL_COLOR_SAMPLE_8 *input,
474 VPHAL_CSPACE srcCspace,
475 VPHAL_CSPACE dstCspace);
476
477 static bool IsSyncFreeNeededForMMCSurface(PVPHAL_SURFACE surface, PMOS_INTERFACE osInterface);
478
479 static bool IsVerticalRotation(VPHAL_ROTATION rotation);
480
481 //!
482 //! \brief Performs Color Space Convert for Sample Pixel
483 //! \details Performs Color Space Convert from Src Color Spase to Dst Color Spase
484 //! \param [out] pOutput
485 //! Pointer to float
486 //! \param [in] pInput
487 //! Pointer to VPHAL_COLOR_SAMPLE_8
488 //! \param [in] srcCspace
489 //! Source Color Space
490 //! \param [in] dstCspace
491 //! Dest Color Space
492 //! \return MOS_STATUS
493 //! Return MOS_STATUS_SUCCESS if successful
494 //!
495 static MOS_STATUS GetPixelWithCSCForColorFill(
496 VPHAL_COLOR_SAMPLE_8 &input,
497 float output[4],
498 VPHAL_CSPACE srcCspace,
499 VPHAL_CSPACE dstCspace);
500
501 //!
502 //! \brief Performs Color Space Convert for Sample Pixel Float
503 //! \details Performs Color Space Convert from Src Color Spase to Dst Color Spase
504 //! \param [out] pOutput
505 //! Pointer to float
506 //! \param [in] pInput
507 //! Pointer to VPHAL_COLOR_SAMPLE_8
508 //! \param [in] srcCspace
509 //! Source Color Space
510 //! \param [in] dstCspace
511 //! Dest Color Space
512 //! \return MOS_STATUS
513 //! Return MOS_STATUS_SUCCESS if successful
514 //!
515 static MOS_STATUS GetPixelWithCSCForColorFillFloat(
516 float input[4],
517 float output[4],
518 VPHAL_CSPACE srcCspace,
519 VPHAL_CSPACE dstCspace);
520
521 //!
522 //! \brief Get Color Space Convert Normalized Matrix
523 //! \details Get Color Space Convert Normalized Matrix
524 //! \param [out] pCSC_Matrix
525 //! Pointer to float
526 //! \param [in] src
527 //! Source Color Space
528 //! \param [in] dst
529 //! Target Color Space
530 //! \return MOS_STATUS
531 //! Return MOS_STATUS_SUCCESS if successful
532 //!
533 static MOS_STATUS GetNormalizedCSCMatrix(
534 MEDIA_CSPACE src,
535 MEDIA_CSPACE dst,
536 float cscMatrix[12]);
537
538 //!
539 //! \brief Get RGB Range and Offset
540 //! \details Get RGB Range and Offset
541 //! \param [in] cspace
542 //! Color Space
543 //! \param [out] rgbOffset
544 //! Offset
545 //! \param [out] rgbExcursion
546 //! Range
547 //! \return MOS_STATUS
548 //! Return MOS_STATUS_SUCCESS if successful
549 //!
550 static MOS_STATUS GetRgbRangeAndOffset(
551 VPHAL_CSPACE cspace,
552 float &rgbOffset,
553 float &rgbExcursion);
554
555 //!
556 //! \brief Get YUV Range and Offset
557 //! \details Get YUV Range and Offset
558 //! \param [in] cspace
559 //! Color Space
560 //! \param [out] lumaOffset
561 //! Offset
562 //! \param [out] lumaExcursion
563 //! Range
564 //! \param [out] chromaZero
565 //! Offset
566 //! \param [out] chromaExcursion
567 //! Range
568 //! \return MOS_STATUS
569 //! Return MOS_STATUS_SUCCESS if successful
570 //!
571 static MOS_STATUS GetYuvRangeAndOffset(
572 VPHAL_CSPACE cspace,
573 float &lumaOffset,
574 float &lumaExcursion,
575 float &chromaZero,
576 float &chromaExcursion);
577
578 //!
579 //! \brief Get CSC Matrix for HDR
580 //! \details Get CSC Matrix for HDR
581 //! \param [in] src
582 //! Color Space
583 //! \param [in] dst
584 //! Color Space
585 //! \param [in] swapChannel
586 //! Swap Channel or not
587 //! \param [out] outMatrix
588 //! CSC Matrix
589 //! \return MOS_STATUS
590 //! Return MOS_STATUS_SUCCESS if successful
591 //!
592 static MOS_STATUS GetCscMatrixForHDR(
593 VPHAL_CSPACE src,
594 VPHAL_CSPACE dst,
595 bool swapChannel,
596 float *outMatrix);
597
598 private:
599 //!
600 //! \brief Performs Color Space Convert for Sample 8 bit Using Specified Coeff Matrix
601 //! \details Performs Color Space Convert from Src Color Spase to Dst Color Spase
602 // Using Secified input CSC Coeff Matrix
603 //! \param [out] output
604 //! Pointer to VPHAL_COLOR_SAMPLE_8
605 //! \param [in] input
606 //! Pointer to VPHAL_COLOR_SAMPLE_8
607 //! \param [in] srcCspace
608 //! Source Color Space
609 //! \param [in] dstCspace
610 //! Dest Color Space
611 //! \param [in] iCscMatrix
612 //! input CSC coeff Matrxi
613 //! \return bool
614 //! Return true if successful, otherwise false
615 //!
616 static bool GetCscMatrixForRender8BitWithCoeff(
617 VPHAL_COLOR_SAMPLE_8 *output,
618 VPHAL_COLOR_SAMPLE_8 *input,
619 VPHAL_CSPACE srcCspace,
620 VPHAL_CSPACE dstCspace,
621 int32_t *iCscMatrix);
622
623 MEDIA_CLASS_DEFINE_END(VpUtils)
624 };
625
626 #endif // !__VP_UTILS_H__