1 /*
2 * Copyright (c) 2021, 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     decode_mpeg2_packet_xe_m_base.h
24 //! \brief    Defines the interface for mpeg2 decode packet for Xe_M_Base.
25 //!
26 
27 #ifndef __DECODE_MPEG2_PACKET_XE_M_BASE_H__
28 #define __DECODE_MPEG2_PACKET_XE_M_BASE_H__
29 
30 #include "media_cmd_packet.h"
31 #include "codechal_hw.h"
32 #include "decode_vdbox_mfx_common.h"
33 #include "decode_mpeg2_basic_feature.h"
34 #include "decode_mpeg2_pipeline.h"
35 #include "decode_utils.h"
36 #include "decode_mpeg2_picture_packet_xe_m_base.h"
37 #include "decode_mpeg2_slice_packet_xe_m_base.h"
38 #include "decode_mpeg2_mb_packet_xe_m_base.h"
39 
40 namespace decode {
41 
42     class Mpeg2DecodePktXe_M_Base : public CmdPacket, public MediaStatusReportObserver
43     {
44     public:
Mpeg2DecodePktXe_M_Base(MediaPipeline * pipeline,MediaTask * task,CodechalHwInterface * hwInterface)45         Mpeg2DecodePktXe_M_Base(MediaPipeline* pipeline, MediaTask* task, CodechalHwInterface* hwInterface)
46             : CmdPacket(task)
47         {
48             if (pipeline != nullptr)
49             {
50                 m_statusReport = pipeline->GetStatusReportInstance();
51                 m_featureManager = pipeline->GetFeatureManager();
52                 m_mpeg2Pipeline = dynamic_cast<Mpeg2Pipeline*>(pipeline);
53             }
54             if (hwInterface != nullptr)
55             {
56                 m_hwInterface = hwInterface;
57                 m_miInterface = hwInterface->GetMiInterface();
58                 m_osInterface = hwInterface->GetOsInterface();
59             }
60         }
~Mpeg2DecodePktXe_M_Base()61         virtual ~Mpeg2DecodePktXe_M_Base() {};
62 
63         //!
64         //! \brief  Initialize the media packet, allocate required resources
65         //! \return MOS_STATUS
66         //!         MOS_STATUS_SUCCESS if success, else fail reason
67         //!
68         virtual MOS_STATUS Init() override;
69 
70         //!
71         //! \brief  Prepare interal parameters, should be invoked for each frame
72         //! \return MOS_STATUS
73         //!         MOS_STATUS_SUCCESS if success, else fail reason
74         //!
75         virtual MOS_STATUS Prepare() override;
76 
77         //!
78         //! \brief  Destroy the media packet and release the resources
79         //! \return MOS_STATUS
80         //!         MOS_STATUS_SUCCESS if success, else fail reason
81         //!
82         virtual MOS_STATUS Destroy() override;
83 
84         //!
85         //! \brief  One frame is completed
86         //! \param  [in] mfxStatus
87         //!         pointer to status buffer which for mfx
88         //! \param  [in] rcsStatus
89         //!         pointer to status buffer which for RCS
90         //! \param  [in, out] statusReport
91         //!         pointer of DecoderStatusReport
92         //! \return MOS_STATUS
93         //!         MOS_STATUS_SUCCESS if success, else fail reason
94         //!
95         virtual MOS_STATUS Completed(void* mfxStatus, void* rcsStatus, void* statusReport) override;
96 
97         //!
98         //! \brief  Calculate Command Size
99         //!
100         //! \param  [in, out] commandBufferSize
101         //!         requested size
102         //! \param  [in, out] requestedPatchListSize
103         //!         requested size
104         //! \return MOS_STATUS
105         //!         status
106         //!
107         MOS_STATUS CalculateCommandSize(uint32_t& commandBufferSize, uint32_t& requestedPatchListSize) override;
108 
109         //!
110         //! \brief  Get Packet Name
111         //! \return std::string
112         //!
GetPacketName()113         virtual std::string GetPacketName() override
114         {
115             return "MPEG2_DECODE";
116         }
117 
118     protected:
119         //!
120         //! \brief  Calculate Command Buffer Size
121         //!
122         //! \return uint32_t
123         //!         Command buffer size calculated
124         //!
125         virtual uint32_t CalculateCommandBufferSize();
126 
127         //!
128         //! \brief  Calculate Patch List Size
129         //!
130         //! \return uint32_t
131         //!         Patchlist size calculated
132         //!
133         virtual uint32_t CalculatePatchListSize();
134 
135         void SetPerfTag(CODECHAL_MODE mode, uint16_t picCodingType);
136 
137         bool IsPrologRequired();
138 
139         MOS_STATUS SendPrologWithFrameTracking(MOS_COMMAND_BUFFER& cmdBuffer, bool frameTrackingRequested);
140 
141         MOS_STATUS MiFlush(MOS_COMMAND_BUFFER& cmdBuffer);
142 
143         MOS_STATUS AddForceWakeup(MOS_COMMAND_BUFFER& cmdBuffer);
144 
145         MOS_STATUS ReadMfxStatus(MediaStatusReport* statusReport, MOS_COMMAND_BUFFER& cmdBuffer);
146 
147         virtual MOS_STATUS StartStatusReport(uint32_t srType, MOS_COMMAND_BUFFER* cmdBuffer) override;
148         virtual MOS_STATUS EndStatusReport(uint32_t srType, MOS_COMMAND_BUFFER* cmdBuffer) override;
149 
150         MediaFeatureManager* m_featureManager = nullptr;
151         Mpeg2Pipeline* m_mpeg2Pipeline = nullptr;
152         DecodeAllocator* m_allocator = nullptr;
153         Mpeg2BasicFeature* m_mpeg2BasicFeature = nullptr;
154         CodechalHwInterface* m_hwInterface = nullptr;
155         DecodeMemComp* m_mmcState = nullptr;
156 
157         Mpeg2DecodePicPktXe_M_Base* m_picturePkt = nullptr;
158         Mpeg2DecodeSlcPktXe_M_Base* m_slicePkt = nullptr;
159         Mpeg2DecodeMbPktXe_M_Base* m_mbPkt = nullptr;
160 
161         // Parameters passed from application
162         const CodecDecodeMpeg2PicParams* m_mpeg2PicParams = nullptr;  //!< Pointer to picture parameter
163 
164         BatchBufferArray* m_secondLevelBBArray = nullptr; //!< Point to second level batch buffer array
165 
166         uint32_t m_pictureStatesSize = 0;
167         uint32_t m_picturePatchListSize = 0;
168         uint32_t m_sliceStatesSize = 0;
169         uint32_t m_slicePatchListSize = 0;
170         uint32_t m_mbStatesSize = 0;
171         uint32_t m_mbPatchListSize = 0;
172     MEDIA_CLASS_DEFINE_END(decode__Mpeg2DecodePktXe_M_Base)
173     };
174 
175 }
176 #endif // !__DECODE_MPEG2_PACKET_XE_M_BASE_H__
177