/* -----------------------------------------------------------------------------

The copyright in this software is being made available under the Clear BSD

License, included below. No patent rights, trademark rights and/or 

other Intellectual Property Rights other than the copyrights concerning 

the Software are granted under this license.

The Clear BSD License

Copyright (c) 2019-2026, Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. & The VVenC Authors.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,

are permitted (subject to the limitations in the disclaimer below) provided that

the following conditions are met:

     * Redistributions of source code must retain the above copyright notice,

     this list of conditions and the following disclaimer.

     * Redistributions in binary form must reproduce the above copyright

     notice, this list of conditions and the following disclaimer in the

     documentation and/or other materials provided with the distribution.

     * Neither the name of the copyright holder nor the names of its

     contributors may be used to endorse or promote products derived from this

     software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY

THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND

CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR

CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR

BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER

IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

------------------------------------------------------------------------------------------- */

/** \file     EncSlice.h

    \brief    slice encoder class (header)

*/

#pragma once

#include "EncCu.h"

#include "EncSampleAdaptiveOffset.h"

#include "CommonLib/CommonDef.h"

#include "CommonLib/Picture.h"

#include "InterSearch.h"

#include <atomic>

//! \ingroup EncoderLib

//! \{

namespace vvenc {

struct SAOStatData;

class EncSampleAdaptiveOffset;

class EncAdaptiveLoopFilter;

class EncPicture;

class NoMallocThreadPool;

struct WaitCounter;

// ====================================================================================================================

// Class definition

// ====================================================================================================================

struct TileLineEncRsrc;

struct PerThreadRsrc;

struct CtuEncParam;

enum TaskType {

  CTU_ENCODE     = 0,

  LF_VER,

  LF_HOR,

  SAO_FILTER,

  ALF_GET_STATISTICS,

  ALF_DERIVE_FILTER,

  ALF_RECONSTRUCT,

  CCALF_GET_STATISTICS,

  CCALF_DERIVE_FILTER,

  CCALF_RECONSTRUCT,

  FINISH_SLICE,

  PROCESS_DONE

};

using ProcessCtuState = std::atomic<TaskType>;

/// CU encoders and scratch buffers for CTU tasks, one set per worker thread.

/// A worker runs one task at a time, so the slice encoders of all pictures that are encoded in

/// parallel can share these sets instead of owning one each. A set takes about 12 MB with 128x128

/// CTUs at the medium preset, and sharing saves one set per thread for every extra parallel frame.

class ThreadRsrcPool

{

public:

  ThreadRsrcPool() = default;

  ~ThreadRsrcPool();

  ThreadRsrcPool( const ThreadRsrcPool& )            = delete;

  ThreadRsrcPool& operator=( const ThreadRsrcPool& ) = delete;

  void           init( const VVEncCfg& encCfg, const SPS& sps, const PPS& pps, std::vector<int>* const globalCtuQpVector, RateCtrl& rateCtrl, const int numSets );

  PerThreadRsrc& get ( const int threadIdx )

  {

    CHECK( threadIdx < 0 || threadIdx >= ( int ) m_sets.size(), "no thread resources for this worker thread" );

    return *m_sets[threadIdx];

  }

private:

  std::vector<PerThreadRsrc*> m_sets;

};

/// slice encoder class

class EncSlice

{

private:

  // encoder configuration

  const VVEncCfg*              m_pcEncCfg;                           ///< encoder configuration class

  ThreadRsrcPool*              m_threadRsrc;

  PicEncState                  m_picEncState;                        ///< state that worker threads apply to their CU encoders

  std::vector<int>*            m_globalCtuQpVector;

  std::vector<TileLineEncRsrc*>m_TileLineEncRsrc;

  NoMallocThreadPool*          m_threadPool;

  WaitCounter*                 m_ctuTasksDoneCounter;

  std::vector<ProcessCtuState> m_processStates;

  int                          m_ctuEncDelay;

  LoopFilter*                  m_pLoopFilter;

  EncAdaptiveLoopFilter*       m_pALF;

  RateCtrl*                    m_pcRateCtrl;

  BinEncoder                   m_BinEncoder;

  CABACWriter                  m_CABACWriter;

  Ctx                          m_entropyCodingSyncContextState;      ///< context storage for state of contexts at the wavefront/WPP/entropy-coding-sync second CTU of tile-row used for writing

  std::vector<Ctx>             m_syncPicCtx;                         ///< context storage for state of contexts at the wavefront/WPP/entropy-coding-sync second CTU of tile-row used for estimation

  SliceType                    m_encCABACTableIdx;

  unsigned                     m_alfDeriveCtu;

  unsigned                     m_ccalfDeriveCtu;

  double                       m_saoDisabledRate[ MAX_NUM_COMP ][ VVENC_MAX_TLAYER ];

  bool                         m_saoEnabled[ MAX_NUM_COMP ];

  bool                         m_saoAllDisabled;

  std::vector<SAOBlkParam>     m_saoReconParams;

  std::vector<SAOStatData**>   m_saoStatData;

  SaoPreFilterEdges            m_saoPreFilterEdges;

  std::vector<CtuEncParam>     ctuEncParams;

  std::vector<int>             m_ctuAddrMap;

public:

  EncSlice();

  virtual ~EncSlice();

  void    init                ( const VVEncCfg& encCfg,

                                const SPS& sps,

                                const PPS& pps,

                                std::vector<int>* const globalCtuQpVector,

                                LoopFilter& loopFilter,

                                EncAdaptiveLoopFilter& alf,

                                RateCtrl& rateCtrl,

                                NoMallocThreadPool* threadPool,

                                ThreadRsrcPool& threadRsrc,

                                WaitCounter* ctuTasksDoneCounter );

  void    initPic             ( Picture* pic );

  // compress and encode slice

  void    compressSlice       ( Picture* pic );      ///< analysis stage of slices

  void    encodeSliceData     ( Picture* pic );

  void    saoDisabledRate     ( CodingStructure& cs, SAOBlkParam* reconParams );

  void    finishCompressSlice ( Picture* pic, Slice& slice );

private:

  void    xInitSliceLambdaQP  ( Slice* slice );

  double  xCalculateLambda    ( const Slice* slice, const int depth, const double refQP, const double dQP, int& iQP );

  void    xProcessCtus        ( Picture* pic, const unsigned startCtuTsAddr, const unsigned boundingCtuTsAddr );

  template<bool checkReadyState=false>

  static bool xProcessCtuTask ( int taskIdx, void* taskParam );

  int     xGetQPForPicture    ( const Slice* slice );

};

} // namespace vvenc

//! \}