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

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     AlfParameters.h

    \brief    Define types for storing ALF parameters

*/

#pragma once

#include <vector>

#include "CommonDef.h"

//! \ingroup CommonLib

//! \{

namespace vvenc {

enum AlfFilterType

{

  ALF_FILTER_5,

  ALF_FILTER_7,

  CC_ALF,

  ALF_NUM_OF_FILTER_TYPES

};

static const int size_CC_ALF = -1;

struct AlfFilterShape

{

  AlfFilterShape( int size )

    : filterLength( size ),

    numCoeff( size * size / 4 + 1 ),

    filterSize( size * size / 2 + 1 )

  {

    if( size == 5 )

    {

      pattern = {

                 0,

             1,  2,  3,

         4,  5,  6,  5,  4,

             3,  2,  1,

                 0

      };

      weights = {

                 2,

              2, 2, 2,

           2, 2, 1, 1

      };

      filterType = ALF_FILTER_5;

    }

    else if( size == 7 )

    {

      pattern = {

                     0,

                 1,  2,  3,

             4,  5,  6,  7,  8,

         9, 10, 11, 12, 11, 10, 9,

             8,  7,  6,  5,  4,

                 3,  2,  1,

                     0

      };

      weights = {

                    2,

                2,  2,  2,

            2,  2,  2,  2,  2,

        2,  2,  2,  1,  1

      };

      filterType = ALF_FILTER_7;

    }

    else if (size == size_CC_ALF)

    {

      size = 4;

      filterLength = 8;

      numCoeff = 8;

      filterSize = 8;

      filterType   = CC_ALF;

    }

    else

    {

      filterType = ALF_NUM_OF_FILTER_TYPES;

      CHECK( 0, "Wrong ALF filter shape" );

    }

  }

  AlfFilterType     filterType;

  int               filterLength;

  int               numCoeff;      //TO DO: check whether we need both numCoeff and filterSize

  int               filterSize;

  std::vector<int>  pattern;

  std::vector<int>  weights;

};

struct AlfParam

{

  bool                         alfEnabled[MAX_NUM_COMP];                          // alf_slice_enable_flag, alf_chroma_idc

  bool                         nonLinearFlag[MAX_NUM_CH]; // alf_[luma/chroma]_clip_flag

  short                        lumaCoeff[MAX_NUM_ALF_CLASSES * MAX_NUM_ALF_LUMA_COEFF]; // alf_coeff_luma_delta[i][j]

  short                        lumaClipp[MAX_NUM_ALF_CLASSES * MAX_NUM_ALF_LUMA_COEFF]; // alf_clipp_luma_[i][j]

  int                          numAlternativesChroma;                                                  // alf_chroma_num_alts_minus_one + 1

  short                        chromaCoeff[VVENC_MAX_NUM_ALF_ALTERNATIVES_CHROMA][MAX_NUM_ALF_CHROMA_COEFF]; // alf_coeff_chroma[i]

  short                        chromaClipp[VVENC_MAX_NUM_ALF_ALTERNATIVES_CHROMA][MAX_NUM_ALF_CHROMA_COEFF]; // alf_clipp_chroma[i]

  short                        filterCoeffDeltaIdx[MAX_NUM_ALF_CLASSES];                // filter_coeff_delta[i]

  bool                         alfLumaCoeffFlag[MAX_NUM_ALF_CLASSES];                   // alf_luma_coeff_flag[i]

  int                          numLumaFilters;                                          // number_of_filters_minus1 + 1

  bool                         alfLumaCoeffDeltaFlag;                                   // alf_luma_coeff_delta_flag

  bool                         newFilterFlag[MAX_NUM_CH];

  AlfParam()

  {

    reset();

  }

  void reset()

  {

    std::memset( alfEnabled, false, sizeof( alfEnabled ) );

    std::memset( nonLinearFlag, false, sizeof( nonLinearFlag ) );

    std::memset( lumaCoeff, 0, sizeof( lumaCoeff ) );

    std::memset( lumaClipp, 0, sizeof( lumaClipp ) );

    numAlternativesChroma = 1;

    std::memset( chromaCoeff, 0, sizeof( chromaCoeff ) );

    std::memset( chromaClipp, 0, sizeof( chromaClipp ) );

    std::memset( filterCoeffDeltaIdx, 0, sizeof( filterCoeffDeltaIdx ) );

    std::memset( alfLumaCoeffFlag, true, sizeof( alfLumaCoeffFlag ) );

    numLumaFilters = 1;

    alfLumaCoeffDeltaFlag = false;

    memset(newFilterFlag, 0, sizeof(newFilterFlag));

  }

};

struct CcAlfFilterParam

{

  bool    ccAlfFilterEnabled[2];

  bool    ccAlfFilterIdxEnabled[2][MAX_NUM_CC_ALF_FILTERS];

  uint8_t ccAlfFilterCount[2];

  short   ccAlfCoeff[2][MAX_NUM_CC_ALF_FILTERS][MAX_NUM_CC_ALF_CHROMA_COEFF];

  int     newCcAlfFilter[2];

  int     numberValidComponents;

  CcAlfFilterParam()

  {

    reset();

  }

  void reset()

  {

    std::memset( ccAlfFilterEnabled, false, sizeof( ccAlfFilterEnabled ) );

    std::memset( ccAlfFilterIdxEnabled, false, sizeof( ccAlfFilterIdxEnabled ) );

    std::memset( ccAlfCoeff, 0, sizeof( ccAlfCoeff ) );

    ccAlfFilterCount[0] = ccAlfFilterCount[1] = MAX_NUM_CC_ALF_FILTERS;

    numberValidComponents = 3;

    newCcAlfFilter[0] = newCcAlfFilter[1] = 0;

  }

};

} // namespace vvenc

//! \}