/*
* Copyright (c) 2017-2019, 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     codechal_decode_jpeg_g12.h
//! \brief    Defines the decode interface extension for JPEG.
//! \details  Defines all types, macros, and functions required by CodecHal for JPEG decoding. Definitions are not externally facing.
//!

#ifndef __CODECHAL_DECODER_JPEG_G12_H__
#define __CODECHAL_DECODER_JPEG_G12_H__

#include "codechal_decode_jpeg.h"
#include "codechal_decode_singlepipe_virtualengine.h"

//!
//! \class CodechalDecodeJpegG12
//! \brief This class defines the member fields, functions etc used by GEN11 JPEG decoder.
//!
class CodechalDecodeJpegG12 : public CodechalDecodeJpeg
{
public:
    //!
    //! \brief  Constructor
    //! \param    [in] hwInterface
    //!           Hardware interface
    //! \param    [in] debugInterface
    //!           Debug interface
    //! \param    [in] standardInfo
    //!           The information of decode standard for this instance
    //!
    CodechalDecodeJpegG12(
        CodechalHwInterface   *hwInterface,
        CodechalDebugInterface* debugInterface,
        PCODECHAL_STANDARD_INFO standardInfo);

    //!
    //! \brief    Copy constructor
    //!
    CodechalDecodeJpegG12(const CodechalDecodeJpegG12&) = delete;

    //!
    //! \brief    Copy assignment operator
    //!
    CodechalDecodeJpegG12& operator=(const CodechalDecodeJpegG12&) = delete;

    //!
    //! \brief    Destructor
    //!
    ~CodechalDecodeJpegG12();

    MOS_STATUS  AllocateStandard (
        CodechalSetting *          settings) override;

    //!
    //! \brief  Set states for each frame to prepare for GEN12 JPEG decode
    //! \return MOS_STATUS
    //!         MOS_STATUS_SUCCESS if success, else fail reason
    //!
    MOS_STATUS  SetFrameStates() override;

    MOS_STATUS  DecodeStateLevel() override;

    MOS_STATUS  DecodePrimitiveLevel() override;

    MOS_STATUS  InitMmcState() override;
    void CalcRequestedSpace(
        uint32_t &requestedSize,
        uint32_t &additionalSizeNeeded,
        uint32_t &requestedPatchListSize) override;

#ifdef _DECODE_PROCESSING_SUPPORTED
    MOS_STATUS  InitSfcState() override;
#endif

    MOS_STATUS SetGpuCtxCreatOption(CodechalSetting *settings) override;

private:
    PCODECHAL_DECODE_SINGLEPIPE_VIRTUALENGINE_STATE m_veState = nullptr;  //!< single pipe virtual engine state
    //! \Huc state level command buffer size is required
    uint32_t m_HucStateCmdBufferSizeNeeded = 0;
    //! \Huc state level patch list size is required
    uint32_t m_HucPatchListSizeNeeded = 0;
};

#endif  // __CODECHAL_DECODER_JPEG_G12_H__
