1 /*
2 * Copyright (c) 2019-2023, 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 //!
23 //! \file     encode_av1_basic_feature.h
24 //! \brief    Defines the common interface for encode av1 basic feature
25 //!
26 #ifndef __ENCODE_AV1_BASIC_FEATURE_H__
27 #define __ENCODE_AV1_BASIC_FEATURE_H__
28 
29 #include "encode_basic_feature.h"
30 #include "codec_def_encode_av1.h"
31 #include "encode_av1_reference_frames.h"
32 #include "encode_av1_stream_in.h"
33 #include "encode_av1_vdenc_feature_defs.h"
34 #include "mhw_vdbox_vdenc_itf.h"
35 #include "mhw_vdbox_avp_itf.h"
36 #include "mhw_vdbox_huc_itf.h"
37 #include "encode_mem_compression.h"
38 #if _MEDIA_RESERVED
39 #include "codec_def_encode_av1_ext.h"
40 #endif
41 
42 namespace encode
43 {
44 
DeltaQIsZero(CODEC_AV1_ENCODE_PICTURE_PARAMS const & picPar)45 inline bool DeltaQIsZero(CODEC_AV1_ENCODE_PICTURE_PARAMS const &picPar)
46 {
47     return (picPar.y_dc_delta_q == 0) &&
48            (picPar.u_ac_delta_q == 0) && (picPar.u_dc_delta_q == 0) &&
49            (picPar.v_ac_delta_q == 0) && (picPar.v_dc_delta_q == 0);
50 }
51 
IsFrameLossless(CODEC_AV1_ENCODE_PICTURE_PARAMS const & picPar)52 inline bool IsFrameLossless(CODEC_AV1_ENCODE_PICTURE_PARAMS const &picPar)
53 {
54     return (picPar.base_qindex == 0) && DeltaQIsZero(picPar);
55 }
56 
57 MOS_STATUS InitDefaultFrameContextBuffer(
58     uint16_t                 *ctxBuffer,
59     uint8_t                  index,
60     Av1CdfTableSyntaxElement begin = partition8x8,
61     Av1CdfTableSyntaxElement end   = syntaxElementMax);
62 
63 MOS_STATUS SyntaxElementCdfTableInit(
64     uint16_t                    *ctxBuffer,
65     SyntaxElementCdfTableLayout SyntaxElement);
66 
67 class Av1BasicFeature : public EncodeBasicFeature, public mhw::vdbox::vdenc::Itf::ParSetting, public mhw::vdbox::avp::Itf::ParSetting, public mhw::vdbox::huc::Itf::ParSetting, public mhw::mi::Itf::ParSetting
68 {
69 public:
Av1BasicFeature(EncodeAllocator * allocator,CodechalHwInterfaceNext * hwInterface,TrackedBuffer * trackedBuf,RecycleResource * recycleBuf,void * constSettings)70     Av1BasicFeature(EncodeAllocator * allocator,
71                      CodechalHwInterfaceNext *hwInterface,
72                      TrackedBuffer *trackedBuf,
73                      RecycleResource *recycleBuf,
74                      void *constSettings) :
75                      EncodeBasicFeature(allocator, hwInterface, trackedBuf, recycleBuf){m_constSettings = constSettings;};
76 
~Av1BasicFeature()77     virtual ~Av1BasicFeature() {};
78 
79     virtual MOS_STATUS Init(void *setting) override;
80 
81     virtual MOS_STATUS Update(void *params) override;
82 
83     MOS_STATUS UpdateTrackedBufferParameters() override;
84 
85     virtual MOS_STATUS UpdateFormat(void *params) override;
86 
87     virtual MOS_STATUS UpdateDefaultCdfTable();
88 
89     virtual MOS_STATUS GetTrackedBuffers() override;
90 
91     Av1StreamIn *GetStreamIn();
92 
93     MOS_STATUS GetSurfaceMmcInfo(PMOS_SURFACE surface, MOS_MEMCOMP_STATE& mmcState, uint32_t& compressionFormat) const;
94 
95     virtual uint32_t GetProfileLevelMaxFrameSize() override;
96 
97     uint32_t GetAppHdrSizeInBytes(bool excludeFrameHdr = false) const;
98 
99     MHW_SETPAR_DECL_HDR(VDENC_PIPE_MODE_SELECT);
100 
101     MHW_SETPAR_DECL_HDR(VDENC_SRC_SURFACE_STATE);
102 
103     MHW_SETPAR_DECL_HDR(VDENC_REF_SURFACE_STATE);
104 
105     MHW_SETPAR_DECL_HDR(VDENC_DS_REF_SURFACE_STATE);
106 
107     MHW_SETPAR_DECL_HDR(VDENC_PIPE_BUF_ADDR_STATE);
108 
109     MHW_SETPAR_DECL_HDR(VDENC_WEIGHTSOFFSETS_STATE);
110 
111     MHW_SETPAR_DECL_HDR(VDENC_CMD1);
112 
113     MHW_SETPAR_DECL_HDR(VDENC_HEVC_VP9_TILE_SLICE_STATE);
114 
115     MHW_SETPAR_DECL_HDR(VDENC_CMD2);
116 
117     MHW_SETPAR_DECL_HDR(AVP_PIC_STATE);
118 
119     MHW_SETPAR_DECL_HDR(AVP_INLOOP_FILTER_STATE);
120 
121     MHW_SETPAR_DECL_HDR(AVP_PIPE_MODE_SELECT);
122 
123     MHW_SETPAR_DECL_HDR(AVP_TILE_CODING);
124 
125     MHW_SETPAR_DECL_HDR(AVP_PIPE_BUF_ADDR_STATE);
126 
127     MHW_SETPAR_DECL_HDR(AVP_INTER_PRED_STATE);
128 
129     MHW_SETPAR_DECL_HDR(AVP_IND_OBJ_BASE_ADDR_STATE);
130 
131     MHW_SETPAR_DECL_HDR(AVP_SURFACE_STATE);
132 
133     MHW_SETPAR_DECL_HDR(HUC_PIPE_MODE_SELECT);
134 
135     MHW_SETPAR_DECL_HDR(MFX_WAIT);
136 
137     EncodeMemComp* m_mmcState = nullptr;
138 
139     // Parameters passed from application
140     PCODEC_AV1_ENCODE_SEQUENCE_PARAMS   m_av1SeqParams          = nullptr;                      //!< Pointer to sequence parameter
141     PCODEC_AV1_ENCODE_PICTURE_PARAMS    m_av1PicParams          = nullptr;                      //!< Pointer to picture parameter
142     Av1ReferenceFrames                  m_ref                   = {};                           //!< Reference List
143     Av1StreamIn                         m_streamIn              = {};                           //!< Stream In
144     AV1MetaDataOffset                   m_AV1metaDataOffset     = {};                           //!< AV1 Metadata Offset
145 
146     uint32_t            m_sizeOfSseSrcPixelRowStoreBufferPerLcu = 0;                            //!< Size of SSE row store buffer per LCU
147     static constexpr uint32_t  m_vdencBrcStatsBufferSize        = 1216;                         //!< Vdenc bitrate control buffer size
148     static constexpr uint32_t  m_vdencBrcPakStatsBufferSize     = 512;
149 
150     int16_t                            m_miCols = 0;
151     int16_t                            m_miRows = 0;
152     int32_t                            m_picWidthInSb = 0;
153     int32_t                            m_picHeightInSb = 0;
154     bool                               m_isSb128x128 = false;
155     static const uint32_t              m_cdfMaxNumBytes = 15104;                                //!< Max number of bytes for CDF tables buffer, which equals to 236*64 (236 Cache Lines)
156     PMOS_RESOURCE                      m_defaultCdfBuffers  = nullptr;                          //!< 4 default frame contexts per base_qindex
157     PMOS_RESOURCE                      m_defaultCdfBufferInUse = nullptr;                       //!< default cdf table used base on current base_qindex
158     uint32_t                           m_defaultCdfBufferInUseOffset = 0;
159     bool                               m_defaultFcInitialized = false;
160 
161     bool                               m_enableSWBackAnnotation = true;                        //!< indicate whether SW back annotation enabled or not
162     bool                               m_enableSWStitching = false;                             //!< indicate whether SW bitstream stitching enabled or not
163     bool                               m_enableNonDefaultMapping = false;                       //!< indicate whether Non-default mapping enabled or not
164 
165     RoundingMethod                     m_roundingMethod = fixedRounding;
166     bool                               m_enableCDEF = false;
167     bool                               m_postCdefReconSurfaceFlag = false;
168 
169     uint32_t                           m_vdencTileSliceStart[av1MaxTileNum] = { 0 };           //!< VDEnc TILE_SLICE buffer offset array for every tile
170 
171     enum FlushCmd
172     {
173         waitVdenc = 0,
174         waitAvp
175     };
176     FlushCmd                           m_flushCmd = waitVdenc;
177 
178 #define ASYNC_NUM 32
179 
180     uint32_t                           m_frameHdrOBUSizeByteOffset = 0;  //!< indicate current frame OBUFrame offset
181     uint16_t                           m_tileGroupHeaderSize = 0;
182     uint32_t                           m_encodedFrameNum = 0;                                   //!< Currently encoded frame number
183 
184     PMOS_RESOURCE                      m_resMvTemporalBuffer = nullptr;                         //!< Pointer to MOS_RESOURCE of MvTemporal Buffer
185 
186     PMOS_RESOURCE m_bitstreamDecoderEncoderLineRowstoreReadWriteBuffer     = nullptr;  //!< Handle of Bitstream Decode Line Rowstore buffer,
187     PMOS_RESOURCE m_bitstreamDecoderEncoderTileLineRowstoreReadWriteBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< Handle of Bitstream Decode Tile Line buffer
188     PMOS_RESOURCE m_intraPredictionTileLineRowstoreReadWriteBuffer         = nullptr;  //!< Handle of Intra Prediction Tile Line Rowstore Read/Write Buffer
189     PMOS_RESOURCE m_spatialMotionVectorLineReadWriteBuffer                 = nullptr;  //!< Handle of Spatial Motion Vector Line rowstore buffer, can be programmed to use Local Media Storage VMM instead of Memory
190     PMOS_RESOURCE m_spatialMotionVectorCodingTileLineReadWriteBuffer       = nullptr;  //!< Handle of Spatial Motion Vector Tile Line buffer
191     PMOS_RESOURCE m_loopRestorationMetaTileColumnReadWriteBuffer           = nullptr;  //!< DW80..81, Loop Restoration Meta Tile Column Read/Write Buffer Address
192     PMOS_RESOURCE m_loopRestorationFilterTileReadWriteLineYBuffer          = nullptr;  //!< DW83..84, Loop Restoration Filter Tile Read/Write Line Y Buffer Address
193     PMOS_RESOURCE m_loopRestorationFilterTileReadWriteLineUBuffer          = nullptr;  //!< DW86..87, Loop Restoration Filter Tile Read/Write Line U Buffer Address
194     PMOS_RESOURCE m_loopRestorationFilterTileReadWriteLineVBuffer          = nullptr;  //!< DW89..90, Loop Restoration Filter Tile Read/Write Line V Buffer Address
195     PMOS_RESOURCE m_deblockerFilterLineReadWriteYBuffer                    = nullptr;  //!< DW92..93, Deblocker Filter Line Read/Write Y Buffer Address
196     PMOS_RESOURCE m_deblockerFilterLineReadWriteUBuffer                    = nullptr;  //!< DW95..96, Deblocker Filter Line Read/Write U Buffer Address
197     PMOS_RESOURCE m_deblockerFilterLineReadWriteVBuffer                    = nullptr;  //!< DW98..99, Deblocker Filter Line Read/Write V Buffer Address
198     PMOS_RESOURCE m_deblockerFilterTileLineReadWriteYBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW101..102, Deblocker Filter Tile Line Read/Write Y Buffer Address
199     PMOS_RESOURCE m_deblockerFilterTileLineReadWriteVBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW104..105, Deblocker Filter Tile Line Read/Write V Buffer Address
200     PMOS_RESOURCE m_deblockerFilterTileLineReadWriteUBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW107..108, Deblocker Filter Tile Line Read/Write U Buffer Address
201     PMOS_RESOURCE m_deblockerFilterTileColumnReadWriteYBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW110..111, Deblocker Filter Tile Column Read/Write Y Buffer Address
202     PMOS_RESOURCE m_deblockerFilterTileColumnReadWriteUBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW113..114, Deblocker Filter Tile Column Read/Write U Buffer Address
203     PMOS_RESOURCE m_deblockerFilterTileColumnReadWriteVBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW116..117, Deblocker Filter Tile Column Read/Write V Buffer Address
204     PMOS_RESOURCE m_cdefFilterLineReadWriteBuffer[AV1_NUM_OF_DUAL_CTX]           = {};  //!< DW119..120, CDEF Filter Line Read/Write Y Buffer Address
205     PMOS_RESOURCE m_cdefFilterTileLineReadWriteBuffer[AV1_NUM_OF_DUAL_CTX]       = {};       //!< DW128..129, CDEF Filter Tile Line Read/Write Y Buffer Address
206     PMOS_RESOURCE m_cdefFilterTileColumnReadWriteBuffer[AV1_NUM_OF_DUAL_CTX]     = {};  //!< DW137..138, CDEF Filter Tile Column Read/Write Y Buffer Address
207     PMOS_RESOURCE m_cdefFilterMetaTileLineReadWriteBuffer[AV1_NUM_OF_DUAL_CTX]   = {};       //!< DW140..141, CDEF Filter Meta Tile Line Read/Write Buffer Address
208     PMOS_RESOURCE m_cdefFilterMetaTileColumnReadWriteBuffer[AV1_NUM_OF_DUAL_CTX] = {};  //!< DW143..144, CDEF Filter Meta Tile Column Read/Write Buffer Address
209     PMOS_RESOURCE m_cdefFilterTopLeftCornerReadWriteBuffer[AV1_NUM_OF_DUAL_CTX]  = {};       //!< DW146..147, CDEF Filter Top-Left Corner Read/Write Buffer Address
210     PMOS_RESOURCE m_superResTileColumnReadWriteYBuffer                     = nullptr;  //!< DW149..150, Super-Res Tile Column Read/Write Y Buffer Address
211     PMOS_RESOURCE m_superResTileColumnReadWriteUBuffer                     = nullptr;  //!< DW152..153, Super-Res Tile Column Read/Write U Buffer Address
212     PMOS_RESOURCE m_superResTileColumnReadWriteVBuffer                     = nullptr;  //!< DW155..156, Super-Res Tile Column Read/Write V Buffer Address
213     PMOS_RESOURCE m_loopRestorationFilterTileColumnReadWriteYBuffer        = nullptr;  //!< DW158..159, Loop Restoration Filter Tile Column Read/Write Y Buffer Address
214     PMOS_RESOURCE m_loopRestorationFilterTileColumnReadWriteUBuffer        = nullptr;  //!< DW161..162, Loop Restoration Filter Tile Column Read/Write U Buffer Address
215     PMOS_RESOURCE m_loopRestorationFilterTileColumnReadWriteVBuffer        = nullptr;  //!< DW164..165, Loop Restoration Filter Tile Column Read/Write V Buffer Address
216     PMOS_RESOURCE m_loopRestorationFilterTileColumnAlignmentBuf            = nullptr;  //!< DW170..171, Loop Restoration filter tile column alignment read/write buffer
217     PMOS_RESOURCE m_decodedFrameStatusErrorBuffer                          = nullptr;  //!< DW176..177, Decoded Frame Status/Error Buffer Base Address
218     PMOS_RESOURCE m_decodedBlockDataStreamoutBuffer                        = nullptr;  //!< DW179..180, Decoded Block Data Streamout Buffer Address
219     PMOS_RESOURCE m_tileStatisticsPakStreamoutBuffer                       = nullptr;  //!< Tile Statistics Pak Streamout Buffer
220     PMOS_RESOURCE m_cuStreamoutBuffer                                      = nullptr;  //!< CU Streamout Buffer
221     PMOS_RESOURCE m_sseLineReadWriteBuffer                                 = nullptr;  //!< SSE Line Read / Write Buffer
222     PMOS_RESOURCE m_sseTileLineReadWriteBuffer                             = nullptr;  //!< SSE Tile Line Read/Write Buffer
223     PMOS_RESOURCE m_resMfdIntraRowStoreScratchBuffer                       = nullptr;
224 
225 protected:
226     uint32_t m_appHdrSize                = 0;
227     uint32_t m_appHdrSizeExcludeFrameHdr = 0;
228 
229 MEDIA_CLASS_DEFINE_END(encode__Av1BasicFeature)
230 };
231 
232 }  // namespace encode
233 
234 #endif  // !__ENCODE_AV1_BASIC_FEATURE_H__
235