1 /*
2 * Copyright (c) 2018-2020, 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_avc_vdenc_pipeline.h
24 //! \brief    Defines the interface for avc vdenc encode pipeline
25 //!
26 #ifndef __ENCODE_AVC_VDENC_PIPELINE_H__
27 #define __ENCODE_AVC_VDENC_PIPELINE_H__
28 
29 #include "encode_pipeline.h"
30 
31 namespace encode {
32 
33 class AvcVdencPipeline : public EncodePipeline
34 {
35 public:
36     //!
37     //! \brief  EncodePipeline constructor
38     //! \param  [in] hwInterface
39     //!         Pointer to CodechalHwInterface
40     //! \param  [in] debugInterface
41     //!         Pointer to CodechalDebugInterface
42     //!
43     AvcVdencPipeline(
44         CodechalHwInterfaceNext *   hwInterface,
45         CodechalDebugInterface *debugInterface);
46 
~AvcVdencPipeline()47     virtual ~AvcVdencPipeline() {}
48 
49     virtual MOS_STATUS Prepare(void *params) override;
50 
51     virtual MOS_STATUS Execute() override;
52 
53     virtual MOS_STATUS GetStatusReport(void *status, uint16_t numStatus) override;
54 
55     virtual MOS_STATUS Destroy() override;
56 
57     enum PacketIds
58     {
59         HucBrcInit = CONSTRUCTPACKETID(PACKET_COMPONENT_ENCODE, PACKET_SUBCOMPONENT_AVC, 0),
60         HucBrcUpdate,
61         VdencPacket
62     };
63 
64 protected:
65     virtual MOS_STATUS Initialize(void *settings) override;
66     virtual MOS_STATUS Uninitialize() override;
67     virtual MOS_STATUS UserFeatureReport() override;
68     virtual MOS_STATUS CreateBufferTracker() override;
69     virtual MOS_STATUS CreateStatusReport() override;
70     virtual MOS_STATUS SwitchContext(uint8_t outputChromaFormat);
71 
72     //!
73     //! \brief  Activate necessary packets
74     //!
75     //! \return MOS_STATUS
76     //!         MOS_STATUS_SUCCESS if success, else fail reason
77     //!
78     virtual MOS_STATUS ActivateVdencVideoPackets();
79 
80     //!
81     //! \brief  Reset parameters after execute active packets
82     //!
83     //! \return MOS_STATUS
84     //!         MOS_STATUS_SUCCESS if success, else fail reason
85     //!
86     virtual MOS_STATUS ResetParams();
87 
88     virtual MOS_STATUS InitUserSetting(MediaUserSettingSharedPtr userSettingPtr) override;
89 
90 #if USE_CODECHAL_DEBUG_TOOL
91     //! \brief    Dump the Sequense parameters
92     //!
93     //! \param    [in] seqParams
94     //!           Pointer to CODEC_AVC_ENCODE_SEQUENCE_PARAMS
95     //! \param    [in] matrixParams
96     //!           Pointer to CODEC_AVC_IQ_MATRIX_PARAMS
97     //!
98     //! \return   MOS_STATUS
99     //!           MOS_STATUS_SUCCESS if success, else fail reason
100     //!
101     MOS_STATUS DumpSeqParams(
102         const CODEC_AVC_ENCODE_SEQUENCE_PARAMS *seqParams,
103         const CODEC_AVC_IQ_MATRIX_PARAMS       *matrixParams);
104 
105     //! \brief    Dump the picture parameters
106     //!
107     //! \param    [in] picParams
108     //!           Pointer to CODEC_AVC_ENCODE_PIC_PARAMS
109     //! \param    [in] matrixParams
110     //!           Pointer to CODEC_AVC_IQ_MATRIX_PARAMS
111     //!
112     //! \return   MOS_STATUS
113     //!           MOS_STATUS_SUCCESS if success, else fail reason
114     //!
115     MOS_STATUS DumpPicParams(
116         const CODEC_AVC_ENCODE_PIC_PARAMS *picParams,
117         const CODEC_AVC_IQ_MATRIX_PARAMS  *matrixParams);
118 
119     //! \brief    Dump the slice parameters
120     //!
121     //! \param    [in] sliceParams
122     //!           Pointer to CODEC_AVC_ENCODE_SLICE_PARAMS
123     //! \param    [in] picParams
124     //!           Pointer to CODEC_AVC_ENCODE_PIC_PARAMS
125     //!
126     //! \return   MOS_STATUS
127     //!           MOS_STATUS_SUCCESS if success, else fail reason
128     //!
129     MOS_STATUS DumpSliceParams(
130         const CODEC_AVC_ENCODE_SLICE_PARAMS *sliceParams,
131         const CODEC_AVC_ENCODE_PIC_PARAMS   *picParams);
132 
133     //! \brief    Dump VUI parameters
134     //!
135     //! \param    [in] avcVuiParams
136     //!           Pointer to CODECHAL_ENCODE_AVC_VUI_PARAMS
137     //!
138     //! \return   MOS_STATUS
139     //!           MOS_STATUS_SUCCESS if success, else fail reason
140     //!
141     MOS_STATUS DumpVuiParams(
142         const CODECHAL_ENCODE_AVC_VUI_PARAMS *avcVuiParams);
143 
144     MOS_STATUS DumpEncodePicReorder(
145         std::ostringstream       &oss,
146         uint32_t                  x,
147         uint32_t                  y,
148         const CODEC_PIC_REORDER * picReorder);
149 
150     MOS_STATUS PopulateTargetUsage();
151 
152     MOS_STATUS PopulateQuantPrecision();
153 #endif
154 
155     bool m_isConstDumped = false;
156 
157     bool     m_preEncEnabled = false;
158     uint32_t m_encodeMode    = 0;
159 
160 MEDIA_CLASS_DEFINE_END(encode__AvcVdencPipeline)
161 };
162 
163 }
164 #endif // !__ENCODE_AVC_VDENC_PIPELINE_H__
165