/* * Copyright (c) 2022, 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 vp_common_defs.h //! \brief clarify common utilities for vphal //! \details clarify common utilities for vphal including: //! some marcro, enum, union, structure, function //! #ifndef __VP_COMMON_DEFS_H__ #define __VP_COMMON_DEFS_H__ #include #include "mos_defs.h" #include "media_common_defs.h" #define ADDRESS_PAGE_ALIGNMENT_MASK_X64 0xFFFFFFFFFFFFF000ULL #define ADDRESS_PAGE_ALIGNMENT_MASK_X86 0xFFFFF000 //! //! \def OUT_OF_BOUNDS(a, min, max) //! Calcualte if \a a out the range of [\a min, \a max]. //! #define OUT_OF_BOUNDS(a, min, max) (((a) < (min)) || ((a) > (max))) //! //! \def RECT1_CONTAINS_RECT2(rect1, rect2) //! Compare if rectangle \a rect1 contains rectangle \a rect2 in coordinate //! #define RECT1_CONTAINS_RECT2(rect1, rect2) \ (((rect1).left <= (rect2).left) && ((rect1).top <= (rect2).top) && \ ((rect1).right >= (rect2).right) && ((rect1).bottom >= (rect2).bottom)) //! //! \def RECT1_CONTAINS_RECT2_ONEPIXELBIAS(rect1, rect2) //! Compare if rectangle \a rect1 contains rectangle \a rect2 in coordinate, One pixel bias is allowed //! #define RECT1_CONTAINS_RECT2_ONEPIXELBIAS(rect1, rect2) \ (((rect1).left <= ((rect2).left + 1)) && ((rect1).top <= ((rect2).top + 1)) && \ (((rect1).right + 1) >= (rect2).right) && (((rect1).bottom + 1) >= (rect2).bottom)) #define VPHAL_MEMORY_OBJECT_CONTROL uint32_t // YUV input ranges #define YUV_RANGE_16_235 1 #define YUV_RANGE_0_255 2 // ProcAmp Default Values #define PROCAMP_BRIGHTNESS_MIN -100.0F #define PROCAMP_BRIGHTNESS_MAX 100.0F #define PROCAMP_BRIGHTNESS_DEFAULT 0.0F #define PROCAMP_BRIGHTNESS_STEP 0.1F #define PROCAMP_CONTRAST_MIN 0.0F #define PROCAMP_CONTRAST_MAX 10.0F #define PROCAMP_CONTRAST_DEFAULT 1.0F #define PROCAMP_CONTRAST_STEP 0.01F #define PROCAMP_HUE_MIN -180.0F #define PROCAMP_HUE_MAX 180.0F #define PROCAMP_HUE_DEFAULT 0.0F #define PROCAMP_HUE_STEP 0.1F #define PROCAMP_SATURATION_MIN 0.0F #define PROCAMP_SATURATION_MAX 10.0F #define PROCAMP_SATURATION_DEFAULT 1.0F #define PROCAMP_SATURATION_STEP 0.01F // Denoise Default Values #define NOISEREDUCTION_MIN 0.0F #define NOISEREDUCTION_MAX 64.0F #define NOISEREDUCTION_DEFAULT 0.0F #define NOISEREDUCTION_STEP 1.0F // Skin Tone Detection/Enhancement values #define STE_MIN 0.0F #define STE_MAX 9.0F #define STE_DEFAULT 3.0F #define STE_STEP 1.0F // Total Color Correction values #define TCC_MIN 0.0F #define TCC_MAX 255.0F #define TCC_DEFAULT 160.0F #define TCC_STEP 1.0F // Adaptive Contrast Enhancement values #define ACE_LEVEL_DEFAULT 5 #define ACE_STRENGTH_DEFAULT 1 // Sharpness Values #define EDGEENHANCEMENT_MIN 0.0F #define EDGEENHANCEMENT_MAX 64.0F #define EDGEENHANCEMENT_DEFAULT 44.0F #define EDGEENHANCEMENT_STEP 1.0F #define IEF_STRONG_EDGE_WEIGHT 7 #define IEF_REGULAR_WEIGHT 2 #define IEF_STRONG_EDGE_THRESHOLD 8 #define VPHAL_MAX_SOURCES 65 //!< worst case: 64 sub-streams + 1 pri video #define VPHAL_MAX_TARGETS 8 //!< multi output support #define VPHAL_TOP_FIELD 0 #define VPHAL_BOTTOM_FIELD 1 #define VPHAL_TOP_FIELD_FIRST 0 #define VPHAL_BOTTOM_FIELD_FIRST 1 //*----------------------------------------------------------------------------- //| DEFINITIONS //*----------------------------------------------------------------------------- // Incremental size for allocating/reallocating resource #define VPHAL_BUFFER_SIZE_INCREMENT 128 // VPP internal resource NotLockable flag macro #define VPP_INTER_RESOURCE_NOTLOCKABLE true #define VPP_INTER_RESOURCE_LOCKABLE false // Media Features width #define VPHAL_RNDR_8K_WIDTH (7680) #define VPHAL_RNDR_16K_HEIGHT_LIMIT (16352) // Media Features height #define VPHAL_RNDR_2K_HEIGHT 1080 // The reason that the definition is not (VPHAL_RNDR_2K_HEIGHT*2) is because some 4K clips have 1200 height. #define VPHAL_RNDR_4K_HEIGHT 1200 #define VPHAL_RNDR_4K_MAX_HEIGHT 3112 #define VPHAL_RNDR_4K_MAX_WIDTH 4096 #define VPHAL_RNDR_6K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 3) #define VPHAL_RNDR_8K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 4) #define VPHAL_RNDR_10K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 5) #define VPHAL_RNDR_12K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 6) #define VPHAL_RNDR_14K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 7) #define VPHAL_RNDR_16K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 8) #define VPHAL_RNDR_18K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 9) #define VPHAL_RNDR_20K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 10) #define VPHAL_RNDR_22K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 11) #define VPHAL_RNDR_24K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 12) #define VPHAL_RNDR_26K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 13) #define VPHAL_RNDR_28K_HEIGHT (VPHAL_RNDR_2K_HEIGHT * 14) //! //! \def MEDIA_IS_HDCONTENT(dwWidth, dwHeight) //! Determine if the size of content is HD //! #define MEDIA_SDCONTENT_MAX_WIDTH 720 #define MEDIA_SDCONTENT_MAX_PAL_HEIGHT 576 #define MEDIA_SDCONTENT_MAX_SW_WIDTH 768 #define MEDIA_IS_HDCONTENT(dwWidth, dwHeight) ((dwWidth > MEDIA_SDCONTENT_MAX_SW_WIDTH) || (dwHeight > MEDIA_SDCONTENT_MAX_PAL_HEIGHT)) //! //! \brief Base VP kernel list //! enum VpKernelID { // FC kernelCombinedFc = 0, // 2 VEBOX KERNELS kernelVeboxSecureBlockCopy, kernelVeboxUpdateDnState, // User Ptr kernelUserPtr, // Fast 1toN kernelFast1toN, // HDR kernelHdrMandatory, kernelHdrPreprocess, // mediacopy-render copy kernelRenderCopy, kernelOclFcCommon, kernelOclFcFP, kernelOclFc444PL3Input, kernelOclFc444PL3Output, kernelOclFc420PL3Input, kernelOclFc420PL3Output, kernelOclFc422HVInput, baseKernelMaxNumID }; enum VpKernelIDNext { vpKernelIDNextBase = 0x200, kernelHdr3DLutCalc = vpKernelIDNextBase, kernelHdr3DLutCalcOcl, kernelHVSCalc, kernelHdrMandatoryLite, //Add New Kernel ID Here // AI Common kernelAiCommon, kernelAiCommonEnd = kernelAiCommon + 0x1000, vpKernelIDNextMax }; C_ASSERT(kernelAiCommonEnd == vpKernelIDNextMax - 1); //! //! \brief Base VP graph list //! enum VP_GRAPH_ID { VP_GRAPH_ID_INVALID = 0, VP_GRAPH_ID_BASE_MAX }; typedef struct _VPHAL_COMPOSITE_CACHE_CNTL { bool bL3CachingEnabled; VPHAL_MEMORY_OBJECT_CONTROL PrimaryInputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL InputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL TargetSurfMemObjCtl; } VPHAL_COMPOSITE_CACHE_CNTL, *PVPHAL_COMPOSITE_CACHE_CNTL; //! //! \brief Vphal Output chroma configuration enum //! typedef enum _VPHAL_CHROMA_SUBSAMPLING { CHROMA_SUBSAMPLING_TOP_CENTER = 0, CHROMA_SUBSAMPLING_CENTER_CENTER, CHROMA_SUBSAMPLING_BOTTOM_CENTER, CHROMA_SUBSAMPLING_TOP_LEFT, CHROMA_SUBSAMPLING_CENTER_LEFT, CHROMA_SUBSAMPLING_BOTTOM_LEFT } VPHAL_CHROMA_SUBSAMPLING; //! //! \brief Vphal Gamma Values configuration enum //! typedef enum _VPHAL_GAMMA_VALUE { GAMMA_1P0 = 0, GAMMA_2P2, GAMMA_2P6 } VPHAL_GAMMA_VALUE; typedef struct _VPHAL_DNDI_CACHE_CNTL { bool bL3CachingEnabled; VPHAL_MEMORY_OBJECT_CONTROL CurrentInputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL PreviousInputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL STMMInputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL STMMOutputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL DnOutSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL CurrentOutputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL StatisticsOutputSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL LaceOrAceOrRgbHistogramSurfCtrl; VPHAL_MEMORY_OBJECT_CONTROL AlphaOrVignetteSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL SkinScoreSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL LaceLookUpTablesSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL Vebox3DLookUpTablesSurfMemObjCtl; } VPHAL_DNDI_CACHE_CNTL, *PVPHAL_DNDI_CACHE_CNTL; typedef struct _VPHAL_LACE_CACHE_CNTL { // LACE would reuse the bL3CachingEnabled of VEBOX's cache control VPHAL_MEMORY_OBJECT_CONTROL FrameHistogramSurfaceMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL AggregatedHistogramSurfaceMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL StdStatisticsSurfaceMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL PwlfInSurfaceMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL PwlfOutSurfaceMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL WeitCoefSurfaceMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL GlobalToneMappingCurveLUTSurfaceMemObjCtl; } VPHAL_LACE_CACHE_CNTL, *PVPHAL_LACE_CACHE_CNTL; typedef struct _VPHAL_16_ALIGN_CACHE_CNTL { bool bL3CachingEnabled; VPHAL_MEMORY_OBJECT_CONTROL SourceSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL TargetSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL SamplerParamsSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL SamplerParamsStatsSurfMemObjCtl; } VPHAL_16_ALIGN_CACHE_CNTL, *PVPHAL_16_ALIGN_CACHE_CNTL; typedef struct _VPHAL_FAST1TON_CACHE_CNTL { bool bL3CachingEnabled; VPHAL_MEMORY_OBJECT_CONTROL SourceSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL TargetSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL SamplerParamsSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL SamplerParamsStatsSurfMemObjCtl; } VPHAL_FAST1TON_CACHE_CNTL, *PVPHAL_FAST1TON_CACHE_CNTL; typedef struct _VPHAL_HDR_CACHE_CNTL { bool bL3CachingEnabled; VPHAL_MEMORY_OBJECT_CONTROL SourceSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL TargetSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL Lut2DSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL Lut3DSurfMemObjCtl; VPHAL_MEMORY_OBJECT_CONTROL CoeffSurfMemObjCtl; } VPHAL_HDR_CACHE_CNTL, *PVPHAL_HDR_CACHE_CNTL; //! //! \brief Feature specific cache control settings //! typedef struct _VPHAL_RENDER_CACHE_CNTL { // Input bool bDnDi; bool bCompositing; bool bLace; // Output VPHAL_DNDI_CACHE_CNTL DnDi; VPHAL_COMPOSITE_CACHE_CNTL Composite; VPHAL_LACE_CACHE_CNTL Lace; } VPHAL_RENDER_CACHE_CNTL, *PVPHAL_RENDER_CACHE_CNTL; //! //! \brief Vphal Palette Type Mode enum //! typedef enum _VPHAL_PALETTE_TYPE { VPHAL_PALETTE_NONE = 0, VPHAL_PALETTE_YCbCr_8, //!< 8-bit depth - AYUV palette VPHAL_PALETTE_ARGB_8, //!< 8-bit depth - ARGB palette VPHAL_PALETTE_AVYU_8 //!< 8-bit depth - YUY2 palette } VPHAL_PALETTE_TYPE; //! //! \brief Vphal Chroma Siting enum //! typedef enum _VPHAL_CHROMA_SITING { CHROMA_SITING_NONE = 0, CHROMA_SITING_HORZ_LEFT = 1 << 0, CHROMA_SITING_HORZ_CENTER = 1 << 1, CHROMA_SITING_HORZ_RIGHT = 1 << 2, CHROMA_SITING_VERT_TOP = 1 << 4, CHROMA_SITING_VERT_CENTER = 1 << 5, CHROMA_SITING_VERT_BOTTOM = 1 << 6, } VPHAL_CHROMA_SITING; //! //! \brief Vphal Rotation Mode enum //! typedef enum _VPHAL_ROTATION { VPHAL_ROTATION_IDENTITY = ROTATION_IDENTITY, //!< Rotation 0 degrees VPHAL_ROTATION_90 = ROTATION_90, //!< Rotation 90 degrees VPHAL_ROTATION_180 = ROTATION_180, //!< Rotation 180 degrees VPHAL_ROTATION_270 = ROTATION_270, //!< Rotation 270 degrees VPHAL_MIRROR_HORIZONTAL = ROTATION_MIRROR_HORIZONTAL, //!< Horizontal Mirror VPHAL_MIRROR_VERTICAL = ROTATION_MIRROR_VERTICAL, //!< Vertical Mirror VPHAL_ROTATE_90_MIRROR_VERTICAL = ROTATION_90_MIRROR_VERTICAL, //!< 90 + V Mirror VPHAL_ROTATE_90_MIRROR_HORIZONTAL = ROTATION_90_MIRROR_HORIZONTAL //!< 90 + H Mirror } VPHAL_ROTATION; //! //! \brief Color Spaces enum //! typedef MEDIA_CSPACE VPHAL_CSPACE; //! //! \brief Surface types enum //! IMPORTANT : SurfaceType_Layer[] must be updated to match this enum type //! typedef enum _VPHAL_SURFACE_TYPE { SURF_NONE = 0, SURF_IN_BACKGROUND, SURF_IN_PRIMARY, SURF_IN_SUBSTREAM, SURF_IN_REFERENCE, SURF_OUT_RENDERTARGET, SURF_TYPE_COUNT //!< Keep this line at the end } VPHAL_SURFACE_TYPE; C_ASSERT(SURF_TYPE_COUNT == 6); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! Structure VPHAL_GAMMA_TYPE //! \brief GAMMA Function type //! typedef enum _VPHAL_GAMMA_TYPE { VPHAL_GAMMA_NONE = 0, VPHAL_GAMMA_TRADITIONAL_GAMMA, VPHAL_GAMMA_SMPTE_ST2084, VPHAL_GAMMA_BT1886, VPHAL_GAMMA_SRGB, VPHAL_GAMMA_Count } VPHAL_GAMMA_TYPE; C_ASSERT(VPHAL_GAMMA_Count == 5); //!< When adding, update assert //! //! \def IS_COLOR_SPACE_BT2020_YUV(_a) //! Check if the color space is BT2020 YUV //! #define IS_COLOR_SPACE_BT2020_YUV(_a) (_a == CSpace_BT2020 || \ _a == CSpace_BT2020_FullRange) //! //! \def IS_COLOR_SPACE_BT2020_RGB(_a) //! Check if the color space is BT2020 RGB //! #define IS_COLOR_SPACE_BT2020_RGB(_a) (_a == CSpace_BT2020_RGB || \ _a == CSpace_BT2020_stRGB) #define IS_COLOR_SPACE_BT709_RGB(_a) (_a == CSpace_sRGB || \ _a == CSpace_stRGB) //! //! \def IS_COLOR_SPACE_BT2020(_a) //! Check if the color space is BT2020 //! #define IS_COLOR_SPACE_BT2020(_a) (IS_COLOR_SPACE_BT2020_YUV(_a) || \ IS_COLOR_SPACE_BT2020_RGB(_a)) //! //! \def IS_COLOR_SPACE_RGB(_a) //! Check if the color space is RGB //! #define IS_COLOR_SPACE_RGB(_a) (IS_COLOR_SPACE_BT2020_RGB(_a) || \ IS_COLOR_SPACE_BT709_RGB(_a)) //! //! \brief Sample Type enum //! typedef enum _VPHAL_SAMPLE_TYPE { SAMPLE_PROGRESSIVE, SAMPLE_SINGLE_TOP_FIELD, SAMPLE_SINGLE_BOTTOM_FIELD, SAMPLE_INTERLEAVED_EVEN_FIRST_TOP_FIELD, SAMPLE_INTERLEAVED_EVEN_FIRST_BOTTOM_FIELD, SAMPLE_INTERLEAVED_ODD_FIRST_TOP_FIELD, SAMPLE_INTERLEAVED_ODD_FIRST_BOTTOM_FIELD, SAMPLE_INVALID } VPHAL_SAMPLE_TYPE; C_ASSERT(SAMPLE_INVALID == 7); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! \brief Frame Format enum //! typedef enum _VPHAL_FRAME_FORMAT { FRAME_FORMAT_PROGRESSIVE, FRAME_FORMAT_INTERLEAVED, FRAME_FORMAT_FIELD } VPHAL_FRAME_FORMAT; //! //! \brief Interlaced Scaling Mode enum //! typedef enum _VPHAL_ISCALING_TYPE { ISCALING_NONE, ISCALING_INTERLEAVED_TO_INTERLEAVED, ISCALING_INTERLEAVED_TO_FIELD, ISCALING_FIELD_TO_INTERLEAVED, ISCALING_FIELD_TO_FIELD } VPHAL_ISCALING_TYPE; C_ASSERT(ISCALING_FIELD_TO_FIELD == 4); //! //! \ brief HVS DN Mode enum //! typedef enum _VPHAL_HVSDN_MODE { HVSDENOISE_AUTO_BDRATE = 0, HVSDENOISE_AUTO_SUBJECTIVE, HVSDENOISE_MANUAL } VPHAL_HVSDN_MODE; //! //! \brief DI Mode enum //! typedef enum _VPHAL_DI_MODE { DI_MODE_BOB, DI_MODE_ADI } VPHAL_DI_MODE; C_ASSERT(DI_MODE_ADI == 1); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! \brief Blend Type enum //! typedef enum _VPHAL_BLEND_TYPE { BLEND_NONE = 0, BLEND_SOURCE, BLEND_PARTIAL, BLEND_CONSTANT, BLEND_CONSTANT_SOURCE, BLEND_CONSTANT_PARTIAL, BLEND_XOR_MONO } VPHAL_BLEND_TYPE; C_ASSERT(BLEND_CONSTANT == 3); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! \brief Scaling Mode enum //! typedef enum _VPHAL_SCALING_MODE { VPHAL_SCALING_NEAREST = 0, VPHAL_SCALING_BILINEAR, VPHAL_SCALING_AVS, VPHAL_SCALING_ADV_QUALITY // !< Advance Perf mode } VPHAL_SCALING_MODE; C_ASSERT(VPHAL_SCALING_ADV_QUALITY == 3); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! \brief Composition Report Mode enum //! typedef enum _VPHAL_COMPOSITION_REPORT_MODE { VPHAL_NO_COMPOSITION, //!< No composition , Error Reporting cases VPHAL_INPLACE_COMPOSITION, //!< Inplace Composition VPHAL_LEGACY_COMPOSITION //!< Legacy Composition } VPHAL_COMPOSITION_REPORT_MODE; typedef enum _VPHAL_DI_REPORT_MODE { VPHAL_DI_REPORT_PROGRESSIVE, //!< Progressive output VPHAL_DI_REPORT_BOB, //!< True BOB output VPHAL_DI_REPORT_ADI_BOB, //!< DNDI BOB output VPHAL_DI_REPORT_ADI, //!< ADI output VPHAL_DI_REPORT_FMD //!< FMD output } VPHAL_DI_REPORT_MODE; //! //! \brief Colorpack enum //! typedef enum _VPHAL_COLORPACK { VPHAL_COLORPACK_400 = 0, VPHAL_COLORPACK_420, VPHAL_COLORPACK_411, VPHAL_COLORPACK_422, VPHAL_COLORPACK_444, VPHAL_COLORPACK_UNKNOWN } VPHAL_COLORPACK, *PVPHAL_COLORPACK; //! //! \brief VEBOX 3DLut interpolation mode //! typedef enum _VPHAL_3DLUT_INTERPOLATION { VPHAL_3DLUT_INTERPOLATION_DEFAULT = 0, //!< Default 3DLUT interpolation method. VPHAL_3DLUT_INTERPOLATION_TRILINEAR = 1, //!< 3DLUT trilinear interpolation method. VPHAL_3DLUT_INTERPOLATION_TETRAHEDRAL = 2 //!< 3DLUT tetrahedral interpolation method. } VPHAL_3DLUT_INTERPOLATION; //! //! \brief Output Pipe Mode enum //! \details The output pipe that writes the RenderTarget surface //! typedef enum _VPHAL_OUTPUT_PIPE_MODE { VPHAL_OUTPUT_PIPE_MODE_INVALID = -1, //!< None output pipe selected. This is an invalid state VPHAL_OUTPUT_PIPE_MODE_COMP = 0, //!< Composition output pipe. RenderTarget will be written by Composition VPHAL_OUTPUT_PIPE_MODE_SFC = 1, //!< SFC output pipe. RenderTarget will be written by SFC VPHAL_OUTPUT_PIPE_MODE_VEBOX = 2, //!< Vebox output pipe. RenderTarget will be written by Vebox VPHAL_OUTPUT_PIPE_MODE_NPU = 3 } VPHAL_OUTPUT_PIPE_MODE, *PVPHAL_OUTPUT_PIPE_MODE; typedef enum _VPHAL_SCALING_PREFERENCE { VPHAL_SCALING_PREFER_SFC = 0, // SFC is default VPHAL_SCALING_PREFER_COMP, // For Gen9/10, Composition AVS get better quality than SFC AVS VPHAL_SCALING_PREFER_SFC_FOR_VEBOX // if VEBOX is required, use VEBOX + SFC, otherwise use Composistion } VPHAL_SCALING_PREFERENCE; C_ASSERT(VPHAL_SCALING_PREFER_SFC_FOR_VEBOX == 2); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! \brief Gamut Mode enum //! typedef enum _VPHAL_GAMUT_MODE { GAMUT_MODE_NONE, GAMUT_MODE_BASIC, GAMUT_MODE_ADVANCED } VPHAL_GAMUT_MODE; C_ASSERT(GAMUT_MODE_ADVANCED == 2); //!< When adding, update assert & vphal_solo_scenario.cpp //----------------------------------------------------------------------------- // Forward declaration - // IMPORTANT - DDI interfaces are NOT to access internal VPHAL states //----------------------------------------------------------------------------- typedef struct _RENDERHAL_INTERFACE *PRENDERHAL_INTERFACE; typedef class MhwVeboxInterface *PMHW_VEBOX_INTERFACE; typedef class MhwSfcInterface *PMHW_SFC_INTERFACE; typedef struct VPHAL_SURFACE *PVPHAL_SURFACE; class VphalRenderer; class MhwCpInterface; //! //! Union VPHAL_COLOR_SAMPLE_8 //! \brief Vphal Color Sample 8 bit //! typedef union _VPHAL_COLOR_SAMPLE_8 { // ARGB struct { uint8_t B; uint8_t G; uint8_t R; uint8_t A; }; // AVYU (YUY2 samples) struct { uint8_t U; uint8_t Y; uint8_t V; uint8_t a; }; // AYCbCr (NV12 samples) struct { uint8_t Cr; //!< V uint8_t Cb; //!< U uint8_t YY; //!< Y uint8_t Alpha; }; uint32_t dwValue; } VPHAL_COLOR_SAMPLE_8, *PVPHAL_COLOR_SAMPLE_8; //! //! Union VPHAL_COLOR_SAMPLE_16 //! \brief Vphal Color Sample 16 bit //! typedef union _VPHAL_COLOR_SAMPLE_16 { // ARGB struct { int16_t B; int16_t G; int16_t R; int16_t A; }; // AVYU struct { int16_t U; int16_t Y; int16_t V; int16_t a; }; // AYCbCr struct { int16_t Cr; //!< V int16_t Cb; //!< U int16_t YY; //!< Y int16_t Alpha; }; uint32_t Value; } VPHAL_COLOR_SAMPLE_16, *PVPHAL_COLOR_SAMPLE_16; //! //! Structure VPHAL_PLANE_OFFSET //! \brief Vphal Plane OffSet //! typedef struct _VPHAL_PLANE_OFFSET { int iLockSurfaceOffset; //!< Locked surface offset int iSurfaceOffset; //!< Plane surface offset int iXOffset; //!< X offset - horizontal offset in pixels int iYOffset; //!< Y offset - vertical offset in pixels } VPHAL_PLANE_OFFSET, *PVPHAL_PLANE_OFFSET; //! //! Union VPHAL_HALF_PRECISION_FLOAT //! \brief Vphal half precision float type //! typedef union _VPHAL_HALF_PRECISION_FLOAT { struct { uint16_t Mantissa : 10; uint16_t Exponent : 5; uint16_t Sign : 1; }; uint16_t value; } VPHAL_HALF_PRECISION_FLOAT, PVPHAL_HALF_PRECISION_FLOAT; //! //! Structure VPHAL_PALETTE //! \brief Vphal Palette //! \details Palette entries: //! - 0 : empty palette //! - -1 : palette allocated but not loaded //! - >0 : palette in use //! typedef struct _VPHAL_PALETTE { VPHAL_PALETTE_TYPE PaletteType; //!< Type of palette VPHAL_CSPACE ColorSpace; //!< ColorSpace of Palette bool bHasAlpha; //!< Alpha is valid int32_t iTotalEntries; //!< Palette entries allocated int32_t iNumEntries; //!< Palette entries in use union { PVPHAL_COLOR_SAMPLE_8 pPalette8; PVPHAL_COLOR_SAMPLE_16 pPalette16; }; } VPHAL_PALETTE, *PVPHAL_PALETTE; //! //! Structure VPHAL_BLENDING_PARAMS //! \brief Layer Blending parameters //! typedef struct _VPHAL_BLENDING_PARAMS { VPHAL_BLEND_TYPE BlendType = BLEND_NONE; float fAlpha = 0.0; } VPHAL_BLENDING_PARAMS, *PVPHAL_BLENDING_PARAMS; //! //! Structure VPHAL_LUMAKEY_PARAMS //! \brief Luma Keying parameters //! typedef struct _VPHAL_LUMAKEY_PARAMS { int16_t LumaLow = 0; int16_t LumaHigh = 0; } VPHAL_LUMAKEY_PARAMS, *PVPHAL_LUMAKEY_PARAMS; //! //! Structure VPHAL_PROCAMP_PARAMS //! \brief Procamp parameters //! typedef struct _VPHAL_PROCAMP_PARAMS { bool bEnabled = false; float fBrightness = 0.0; float fContrast = 0.0; float fHue = 0.0; float fSaturation = 0.0; } VPHAL_PROCAMP_PARAMS, *PVPHAL_PROCAMP_PARAMS; //! //! Structure VPHAL_IEF_PARAMS //! \brief IEF parameters - Image Enhancement (Detail) Filter //! typedef struct _VPHAL_IEF_PARAMS { bool bEnabled = false; bool bSmoothMode = false; bool bSkintoneTuned = false; bool bEmphasizeSkinDetail = false; float fIEFFactor = 0.0; uint16_t StrongEdgeWeight = 0; uint16_t RegularWeight = 0; uint16_t StrongEdgeThreshold = 0; void *pExtParam = nullptr; } VPHAL_IEF_PARAMS, *PVPHAL_IEF_PARAMS; //! //! Structure VPHAL_DI_PARAMS //! \brief Deinterlacing parameters //! typedef struct _VPHAL_DI_PARAMS { VPHAL_DI_MODE DIMode = DI_MODE_BOB; //!< DeInterlacing mode bool bEnableFMD = false; //!< FMD bool bSingleField = false; //!< Used in frame Recon - if 30fps (one call per sample pair) bool bSCDEnable = false; //!< Scene change detection } VPHAL_DI_PARAMS, *PVPHAL_DI_PARAMS; //! //! \brief Noise Level Enumeration //! typedef enum _VPHAL_NOISELEVEL { NOISELEVEL_DEFAULT, NOISELEVEL_VC1_HD } VPHAL_NOISELEVEL; C_ASSERT(NOISELEVEL_VC1_HD == 1); //!< When adding, update assert & vphal_solo_scenario.cpp //! //! Structure VPHAL_HVSDENOISE_PARAMS //! \brief HVS Denoise Parameters - Human Vision System Based Denoise //! typedef struct _VPHAL_HVSDENOISE_PARAMS { uint16_t QP = 0; uint16_t Strength = 0; VPHAL_HVSDN_MODE Mode = HVSDENOISE_AUTO_BDRATE; void *pHVSDenoiseParam = nullptr; uint32_t dwDenoiseParamSize = 0; uint32_t dwGlobalNoiseLevel = 0; //!< Global Noise Level for Y uint32_t dwGlobalNoiseLevelU = 0; //!< Global Noise Level for U uint32_t dwGlobalNoiseLevelV = 0; //!< Global Noise Level for V uint16_t TgneEnable = 0; uint16_t FirstFrame = 0; uint16_t TgneFirstFrame = 0; uint16_t Fallback = 0; uint16_t EnableChroma = 0; uint16_t EnableTemporalGNE = 0; uint16_t RCMethod = 0; uint16_t TgtKbps = 0; uint16_t Width = 0; uint16_t Height = 0; uint32_t Sgne_Level = 0; uint32_t Sgne_LevelU = 0; uint32_t Sgne_LevelV = 0; uint32_t Sgne_Count = 0; uint32_t Sgne_CountU = 0; uint32_t Sgne_CountV = 0; uint32_t PrevNslvTemporal = 0; uint32_t PrevNslvTemporalU = 0; uint32_t PrevNslvTemporalV = 0; } VPHAL_HVSDENOISE_PARAMS, *PVPHAL_HVSDENOISE_PARAMS; //! //! Structure VPHAL_SLIMIPU_DENOISE_PARAM //! \brief SLIMIPU Denoise Parameters //! typedef struct _VPHAL_SLIMIPU_DENOISE_PARAM { uint32_t MemSizeInBytes; void *pSystemMem; } VPHAL_SLIMIPU_DENOISE_PARAM, *PVPHAL_SLIMIPU_DENOISE_PARAM; //! //! Structure VPHAL_DENOISE_PARAMS //! \brief Denoise parameters //! typedef struct _VPHAL_DENOISE_PARAMS { bool bEnableChroma = false; bool bEnableLuma = false; bool bAutoDetect = false; float fDenoiseFactor = 0.0; VPHAL_NOISELEVEL NoiseLevel = NOISELEVEL_DEFAULT; bool bEnableHVSDenoise = false; VPHAL_HVSDENOISE_PARAMS HVSDenoise = {}; bool bEnableSlimIPUDenoise = false; VPHAL_SLIMIPU_DENOISE_PARAM SlimIPUDenoise = {}; bool operator==(const struct _VPHAL_DENOISE_PARAMS &b) { return bEnableChroma == b.bEnableChroma && bEnableLuma == b.bEnableLuma && bAutoDetect == b.bAutoDetect && bEnableHVSDenoise == false && b.bEnableHVSDenoise == false && bEnableSlimIPUDenoise == false && b.bEnableSlimIPUDenoise == false; } } VPHAL_DENOISE_PARAMS, *PVPHAL_DENOISE_PARAMS; //! //! Structure VPHAL_STE_PARAMS //! \brief STE parameters - Skin Tone Enhancement //! typedef struct _VPHAL_STE_PARAMS { uint32_t dwSTEFactor = 0; } VPHAL_STE_PARAMS, *PVPHAL_STE_PARAMS; //! //! Structure VPHAL_STE_PARAMS //! \brief STE parameters - Skin Tone Enhancement //! typedef struct _VPHAL_STD_PARAMS { uint32_t paraSizeInBytes = 0; void *param = nullptr; unsigned long long sysMem = 0; bool bOutputSkinScore = false; } VPHAL_STD_PARAMS, *PVPHAL_STD_PARAMS; //! //! Structure VPHAL_TCC_PARAMS //! \brief TCC parameters - Total Color Control //! typedef struct _VPHAL_TCC_PARAMS { uint8_t Red = 0; uint8_t Green = 0; uint8_t Blue = 0; uint8_t Cyan = 0; uint8_t Magenta = 0; uint8_t Yellow = 0; } VPHAL_TCC_PARAMS, *PVPHAL_TCC_PARAMS; //! //! Structure VPHAL_COLORPIPE_PARAMS //! \brief IECP Parameters - Color Pipe //! typedef struct _VPHAL_COLORPIPE_PARAMS { bool bEnableACE = false; bool bEnableSTE = false; bool bEnableSTD = false; // Is vebox STD alone enabled bool bEnableTCC = false; bool bAceLevelChanged = false; uint32_t dwAceLevel = 0; uint32_t dwAceStrength = 0; VPHAL_STE_PARAMS SteParams = {}; VPHAL_STD_PARAMS StdParams = {}; VPHAL_TCC_PARAMS TccParams = {}; } VPHAL_COLORPIPE_PARAMS, *PVPHAL_COLORPIPE_PARAMS; //! //! Structure VPHAL_3DLUT_PARAMS //! \brief 3DLUT parameters - 3DLUT //! typedef struct _VPHAL_3DLUT_PARAMS { PVPHAL_SURFACE pExt3DLutSurface = nullptr; // Pointer to the 3DLUT surface which app passes to driver. uint32_t LutSize = 0; // Size of 3DLUT, i.e, how many entries LUT has. uint32_t ChannelMapping = 0; // Channel Mapping for the 3DLUT input to 3DLUT output. uint16_t BitDepthPerChannel = 0; // Bit Depth Per Channel(4 channels for 3DLUT). uint16_t ByteCountPerEntry = 0; // Byte Count Per Entry including reserved bytes. uint16_t MappingMode = 0; // Mapping Mode VPHAL_3DLUT_INTERPOLATION InterpolationMethod = VPHAL_3DLUT_INTERPOLATION_DEFAULT; // VEBox 3DLut interpolation mode } VPHAL_3DLUT_PARAMS, *PVPHAL_3DLUT_PARAMS; //! //! Structure VPHAL_GAMUT_PARAMS //! \brief IECP Gamut Mapping Parameters //! typedef struct _VPHAL_GAMUT_PARAMS { VPHAL_GAMUT_MODE GCompMode; VPHAL_GAMUT_MODE GExpMode; VPHAL_GAMMA_VALUE GammaValue; uint32_t dwAttenuation; //!< U2.10 [0, 1024] 0 = No down scaling, 1024 = Full down scaling float displayRGBW_x[4]; float displayRGBW_y[4]; bool bColorBalance; int32_t colorBalanceMatrix[3][3]; } VPHAL_GAMUT_PARAMS, *PVPHAL_GAMUT_PARAMS; //! //! Structure VPHAL_NLAS_PARAMS //! \brief NLAS parameters - Non-Anamorphic Scaling //! typedef struct _VPHAL_NLAS_PARAMS { float fVerticalCrop; float fHLinearRegion; float fNonLinearCrop; } VPHAL_NLAS_PARAMS, *PVPHAL_NLAS_PARAMS; typedef struct _VPHAL_VIDEO_COLOR_RGBA { float R; float G; float B; float A; } VPHAL_VIDEO_COLOR_RGBA; //! //! Structure VPHAL_COLORFILL_PARAMS //! \brief ColorFill parameters //! typedef struct _VPHAL_COLORFILL_PARAMS { bool bYCbCr = false; bool isFloat = false; uint32_t Color = 0; float ColorFloat[4] = {0.0f}; VPHAL_VIDEO_COLOR_RGBA Color1 = {}; VPHAL_CSPACE CSpace = CSpace_None; bool bDisableColorfillinSFC = false; bool bOnePixelBiasinSFC = false; } VPHAL_COLORFILL_PARAMS, *PVPHAL_COLORFILL_PARAMS; //! //! Structure VPHAL_ALPHA_FILL_MODE //! \brief Alpha mode //! typedef enum _VPHAL_ALPHA_FILL_MODE { VPHAL_ALPHA_FILL_MODE_NONE = 0, VPHAL_ALPHA_FILL_MODE_OPAQUE, VPHAL_ALPHA_FILL_MODE_BACKGROUND, VPHAL_ALPHA_FILL_MODE_SOURCE_STREAM, } VPHAL_ALPHA_FILL_MODE; //! //! Structure VPHAL_ALPHA_PARAMS //! \brief Alpha parameters //! typedef struct _VPHAL_ALPHA_PARAMS { float fAlpha; VPHAL_ALPHA_FILL_MODE AlphaMode; } VPHAL_ALPHA_PARAMS, *PVPHAL_ALPHA_PARAMS; //! //! Structure VPHAL_SPLIT_SCREEN_DEMO_POSITION //! \brief Split-Screen Demo Mode Position //! typedef enum _VPHAL_SPLIT_SCREEN_DEMO_POSITION { SPLIT_SCREEN_DEMO_DISABLED = 0, SPLIT_SCREEN_DEMO_LEFT, SPLIT_SCREEN_DEMO_RIGHT, SPLIT_SCREEN_DEMO_TOP, SPLIT_SCREEN_DEMO_BOTTOM, SPLIT_SCREEN_DEMO_END_POS_LIST } VPHAL_SPLIT_SCREEN_DEMO_POSITION; //! //! Structure VPHAL_RENDER_COMMAND_STREAM_TYPE //! \brief RCS or CCS //! typedef enum _VPHAL_RENDER_COMMAND_STREAM_TYPE { VPHAL_RENDER_COMMAND_STREAM_DEFAULT = 0, VPHAL_RENDER_COMMAND_STREAM_CCS = 1, VPHAL_RENDER_COMMAND_STREAM_RCS = 2 } VPHAL_RENDER_COMMAND_STREAM_TYPE; //! //! Structure VPHAL_SPLIT_SCREEN_DEMO_MODE_PARAMS //! \brief Split-Screen Demo Mode Parameters //! typedef struct _VPHAL_SPLIT_SCREEN_DEMO_MODE_PARAMS { VPHAL_SPLIT_SCREEN_DEMO_POSITION Position; //!< Position of split mode area (disable features) bool bDisableACE : 1; //!< Disable ACE bool bDisableAVS : 1; //!< Disable AVS bool bDisableDN : 1; //!< Disable DN bool bDisableFMD : 1; //!< Disable FMD bool bDisableIEF : 1; //!< Disable IEF bool bDisableProcamp : 1; //!< Disable Procamp bool bDisableSTE : 1; //!< Disable STE bool bDisableTCC : 1; //!< Disable TCC bool bDisableIS : 1; //!< Disable IS bool bDisableDrDb : 1; //!< Disable DRDB bool bDisableDNUV : 1; //!< Disable DNUV bool bDisableFRC : 1; //!< Disable FRC bool bDisableLACE : 1; //!< Disable LACE } VPHAL_SPLIT_SCREEN_DEMO_MODE_PARAMS, *PVPHAL_SPLIT_SCREEN_DEMO_MODE_PARAMS; //! //! Structure VPHAL_RENDER_PARAMS //! \brief VPHAL Rendering Parameters //! struct VPHAL_RENDER_PARAMS { // Input/output surfaces uint32_t uSrcCount = 0; //!< Num sources VPHAL_SURFACE *pSrc[VPHAL_MAX_SOURCES] = {}; //!< Source Samples uint32_t uDstCount = 0; //!< Num Targets VPHAL_SURFACE *pTarget[VPHAL_MAX_TARGETS] = {}; //!< Render Target // Additional parameters not included in PVPHAL_SURFACE PRECT pConstriction = nullptr; //!< Constriction rectangle PVPHAL_COLORFILL_PARAMS pColorFillParams = nullptr; //!< ColorFill - BG only bool bTurboMode = false; //!< Enable Media Turbo Mode bool bStereoMode = false; //!< Stereo BLT mode PVPHAL_ALPHA_PARAMS pCompAlpha = nullptr; //!< Alpha for composited surfaces bool bDisableDemoMode = false; //!< Enable/Disable demo mode function calls PVPHAL_SPLIT_SCREEN_DEMO_MODE_PARAMS pSplitScreenDemoModeParams = nullptr; //!< Split-screen demo mode for VP features bool bIsDefaultStream = false; //!< Identifier to differentiate default stream // Debugging parameters MOS_COMPONENT Component = COMPONENT_UNKNOWN; //!< DDI component (for DEBUGGING only) // Status Report bool bReportStatus = false; //!< Report current media BB status (Pre-Processing) uint32_t StatusFeedBackID = 0; //!< Unique Staus ID; #if (_DEBUG || _RELEASE_INTERNAL) bool bTriggerGPUHang = false; //!< Trigger GPU HANG #endif bool bCalculatingAlpha = false; //!< Alpha calculation parameters // extension parameters void *pExtensionData = nullptr; //!< Extension data bool bPathKernel = false; // HDR path config if use kernel bool bAPGWorkloadEnable = false; //!< Identify Whether APG workload Enabled or not bool bDisableVeboxFor8K = false; bool bUseVEHdrSfc = false; // use SFC for to perform CSC/Scaling/RGBSwap of HDR streaming; if false, use composite render. bool bNonFirstFrame = false; // first frame or not: first frame false, otherwise true considering zeromemory parameters. bool bOptimizeCpuTiming = false; //!< Optimize Cpu Timing bool bForceToRender = false; // Force to render to perform scaling. VPHAL_RENDER_COMMAND_STREAM_TYPE renderCommandStreamType = VPHAL_RENDER_COMMAND_STREAM_DEFAULT; // CCS or RCS to Use HANDLE gpuAppTaskEvent; //!< GPU App task event VPHAL_RENDER_PARAMS() : uSrcCount(0), pSrc(), uDstCount(0), pTarget(), pConstriction(nullptr), pColorFillParams(nullptr), bTurboMode(false), bStereoMode(false), pCompAlpha(nullptr), bDisableDemoMode(false), pSplitScreenDemoModeParams(nullptr), bIsDefaultStream(false), Component(), bReportStatus(false), StatusFeedBackID(0), #if (_DEBUG || _RELEASE_INTERNAL) bTriggerGPUHang(false), #endif bCalculatingAlpha(false), pExtensionData(nullptr), bPathKernel(false), bUseVEHdrSfc(false), bNonFirstFrame(false), gpuAppTaskEvent(nullptr) { } }; typedef VPHAL_RENDER_PARAMS *PVPHAL_RENDER_PARAMS; typedef const VPHAL_RENDER_PARAMS *PCVPHAL_RENDER_PARAMS; //! //! Structure VPHAL_GET_SURFACE_INFO //! \brief VPHAL Get Surface Infomation Parameters //! typedef struct VPHAL_GET_SURFACE_INFO *PVPHAL_GET_SURFACE_INFO; struct VPHAL_GET_SURFACE_INFO { uint32_t ArraySlice; uint32_t MipSlice; MOS_S3D_CHANNEL S3dChannel; }; #endif // __VP_COMMON_DEFS_H__