/*
* Copyright (c) 2021-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     decode_vp9_picture_packet_xe2_lpm_base.h
//! \brief    Defines the implementation of vp9 decode picture packet on Xe2_LPM+
//!

#ifndef __DECODE_VP9_PICTURE_PACKET_XE2_LPM_BASE_H__
#define __DECODE_VP9_PICTURE_PACKET_XE2_LPM_BASE_H__

#include "decode_vp9_picture_packet.h"

namespace decode
{
class Vp9DecodePicPktXe2_Lpm_Base : public Vp9DecodePicPkt
    {
    public:
        Vp9DecodePicPktXe2_Lpm_Base(Vp9Pipeline *pipeline, CodechalHwInterfaceNext *hwInterface)
            : Vp9DecodePicPkt(pipeline, hwInterface)
        {
        }
        virtual ~Vp9DecodePicPktXe2_Lpm_Base(){};

        //!
        //! \brief  Initialize the media packet, allocate required resources
        //! \return MOS_STATUS
        //!         MOS_STATUS_SUCCESS if success, else fail reason
        //!
        virtual MOS_STATUS Init() override;

        //!
        //! \brief  Execute hevc picture packet
        //! \return MOS_STATUS
        //!         MOS_STATUS_SUCCESS if success, else fail reason
        //!
        virtual MOS_STATUS Execute(MOS_COMMAND_BUFFER& cmdBuffer) override;

        //!
        //! \brief  End batch buffer execution if cabac stream out overflow
        //! \return MOS_STATUS
        //!         MOS_STATUS_SUCCESS if success, else fail reason
        //!
        MOS_STATUS ValidateCabacStreamOutSize(MOS_COMMAND_BUFFER &cmdBuffer);

        //!
        //! \brief  Initialize the 2nd level command buffer structure
        //! \param  [in] batchBuffer
        //!         Batch buffer structure to initialize
        //! \param  [in] batchBufBase
        //!         CPU pointer to batch buffer memory
        //! \return MOS_STATUS
        //!         MOS_STATUS_SUCCESS if success, else fail reason
        //!
        MOS_STATUS Init2ndLevelCmdBuffer(MHW_BATCH_BUFFER &batchBuffer, uint8_t *batchBufBase);

        //!
        //! \brief  Pack HCP commands into 2nd level batch buffer
        //! \param  [in] cmdBuffer
        //!         The 2nd level command buffer to pack commands into
        //! \param  [in] bIsKeyFrame
        //!         Indicates if constructing for key frame (true) or non-key frame (false)
        //! \return MOS_STATUS
        //!         MOS_STATUS_SUCCESS if success, else fail reason
        //!
        MOS_STATUS PackPicState2ndLevelCmds(MOS_COMMAND_BUFFER &cmdBuffer, bool bLastIsKeyFrame);

        MOS_STATUS PackMvBufAddrCmds(MOS_COMMAND_BUFFER &cmdBuffer, bool isPing);

        // Builds a copy-state 2nd-level BB: COND_BB_END(skip-if nextState==skipIfValue)
        // + STORE_DATA_IMM(stateBuffer = writeValue).
        MOS_STATUS BuildCopyStateBB(MOS_COMMAND_BUFFER &cmdBuffer, uint32_t skipIfValue, uint32_t writeValue);

    protected:
        virtual MOS_STATUS VdInit(MOS_COMMAND_BUFFER &cmdBuffer);

        virtual MOS_STATUS VdScalabPipeLock(MOS_COMMAND_BUFFER &cmdBuffer);

        //!
        //! \brief    Calculate picture state command size
        //!
        //! \return   MOS_STATUS
        //!           MOS_STATUS_SUCCESS if success, else fail reason
        //!
        MOS_STATUS CalculatePictureStateCommandSize();

        MOS_STATUS AddAllCmds_HCP_PIPE_MODE_SELECT(MOS_COMMAND_BUFFER &cmdBuffer);
        MHW_SETPAR_DECL_HDR(HCP_PIPE_MODE_SELECT);
        MHW_SETPAR_DECL_HDR(HCP_PIPE_BUF_ADDR_STATE);
        MHW_SETPAR_DECL_HDR(HCP_VP9_PIC_STATE);

    MEDIA_CLASS_DEFINE_END(decode__Vp9DecodePicPktXe2_Lpm_Base)
    };
}  // namespace decode
#endif
