ImageSharp/src/ImageSharp/Formats/WebP/WebpConstants.cs

// Copyright (c) Six Labors.
// Licensed under the Apache License, Version 2.0.

using System.Collections.Generic;

namespace SixLabors.ImageSharp.Formats.Webp
{
    /// <summary>
    /// Constants used for encoding and decoding VP8 and VP8L bitstreams.
    /// </summary>
    internal static class WebpConstants
    {
        /// <summary>
        /// The list of file extensions that equate to WebP.
        /// </summary>
        public static readonly IEnumerable<string> FileExtensions = new[] { "webp" };

        /// <summary>
        /// The list of mimetypes that equate to a jpeg.
        /// </summary>
        public static readonly IEnumerable<string> MimeTypes = new[] { "image/webp", };

        /// <summary>
        /// Signature which identifies a VP8 header.
        /// </summary>
        public static readonly byte[] Vp8HeaderMagicBytes =
        {
            0x9D,
            0x01,
            0x2A
        };

        /// <summary>
        /// Signature byte which identifies a VP8L header.
        /// </summary>
        public const byte Vp8LHeaderMagicByte = 0x2F;

        /// <summary>
        /// Signature bytes identifying a lossy image.
        /// </summary>
        public static readonly byte[] Vp8MagicBytes =
        {
            0x56, // V
            0x50, // P
            0x38, // 8
            0x20 // ' '
        };

        /// <summary>
        /// Signature bytes identifying a lossless image.
        /// </summary>
        public static readonly byte[] Vp8LMagicBytes =
        {
            0x56, // V
            0x50, // P
            0x38, // 8
            0x4C // L
        };

        /// <summary>
        /// Signature bytes identifying a VP8X header.
        /// </summary>
        public static readonly byte[] Vp8XMagicBytes =
        {
            0x56, // V
            0x50, // P
            0x38, // 8
            0x58 // X
        };

        /// <summary>
        /// The header bytes identifying RIFF file.
        /// </summary>
        public static readonly byte[] RiffFourCc =
        {
            0x52, // R
            0x49, // I
            0x46, // F
            0x46 // F
        };

        /// <summary>
        /// The header bytes identifying a WebP.
        /// </summary>
        public static readonly byte[] WebPHeader =
        {
            0x57, // W
            0x45, // E
            0x42, // B
            0x50 // P
        };

        /// <summary>
        /// 3 bits reserved for version.
        /// </summary>
        public const int Vp8LVersionBits = 3;

        /// <summary>
        /// Bits for width and height infos of a VPL8 image.
        /// </summary>
        public const int Vp8LImageSizeBits = 14;

        /// <summary>
        /// Size of the frame header within VP8 data.
        /// </summary>
        public const int Vp8FrameHeaderSize = 10;

        /// <summary>
        /// Size of a VP8X chunk in bytes.
        /// </summary>
        public const int Vp8XChunkSize = 10;

        /// <summary>
        /// Size of a chunk header.
        /// </summary>
        public const int ChunkHeaderSize = 8;

        /// <summary>
        /// Size of the RIFF header ("RIFFnnnnWEBP").
        /// </summary>
        public const int RiffHeaderSize = 12;

        /// <summary>
        /// Size of a chunk tag (e.g. "VP8L").
        /// </summary>
        public const int TagSize = 4;

        /// <summary>
        /// The Vp8L version 0.
        /// </summary>
        public const int Vp8LVersion = 0;

        /// <summary>
        /// Maximum number of histogram images (sub-blocks).
        /// </summary>
        public const int MaxHuffImageSize = 2600;

        /// <summary>
        /// Minimum number of Huffman bits.
        /// </summary>
        public const int MinHuffmanBits = 2;

        /// <summary>
        /// Maximum number of Huffman bits.
        /// </summary>
        public const int MaxHuffmanBits = 9;

        /// <summary>
        /// The maximum number of colors for a paletted images.
        /// </summary>
        public const int MaxPaletteSize = 256;

        /// <summary>
        /// Maximum number of color cache bits is 10.
        /// </summary>
        public const int MaxColorCacheBits = 10;

        /// <summary>
        /// The maximum number of allowed transforms in a VP8L bitstream.
        /// </summary>
        public const int MaxNumberOfTransforms = 4;

        /// <summary>
        /// Maximum value of transformBits in VP8LEncoder.
        /// </summary>
        public const int MaxTransformBits = 6;

        /// <summary>
        /// The bit to be written when next data to be read is a transform.
        /// </summary>
        public const int TransformPresent = 1;

        /// <summary>
        /// The maximum allowed width or height of a webp image.
        /// </summary>
        public const int MaxDimension = 16383;

        public const int MaxAllowedCodeLength = 15;

        public const int DefaultCodeLength = 8;

        public const int HuffmanCodesPerMetaCode = 5;

        public const uint ArgbBlack = 0xff000000;

        public const int NumArgbCacheRows = 16;

        public const int NumLiteralCodes = 256;

        public const int NumLengthCodes = 24;

        public const int NumDistanceCodes = 40;

        public const int CodeLengthCodes = 19;

        public const int LengthTableBits = 7;

        public const uint CodeLengthLiterals = 16;

        public const int CodeLengthRepeatCode = 16;

        public static readonly int[] CodeLengthExtraBits = { 2, 3, 7 };

        public static readonly int[] CodeLengthRepeatOffsets = { 3, 3, 11 };

        public static readonly int[] AlphabetSize =
        {
            NumLiteralCodes + NumLengthCodes,
            NumLiteralCodes, NumLiteralCodes, NumLiteralCodes,
            NumDistanceCodes
        };

        public const int NumMbSegments = 4;

        public const int MaxNumPartitions = 8;

        public const int NumTypes = 4;

        public const int NumBands = 8;

        public const int NumProbas = 11;

        public const int NumPredModes = 4;

        public const int NumBModes = 10;

        public const int NumCtx = 3;

        public const int MaxVariableLevel = 67;

        public const int FlatnessLimitI16 = 0;

        public const int FlatnessLimitIUv = 2;

        public const int FlatnessLimitI4 = 3;

        public const int FlatnessPenality = 140;

        // This is the common stride for enc/dec.
        public const int Bps = 32;

        // gamma-compensates loss of resolution during chroma subsampling.
        public const double Gamma = 0.80d;

        public const int GammaFix = 12; // Fixed-point precision for linear values.

        public const int GammaScale = (1 << GammaFix) - 1;

        public const int GammaTabFix = 7; // Fixed-point fractional bits precision.

        public const int GammaTabSize = 1 << (GammaFix - GammaTabFix);

        public const int GammaTabScale = 1 << GammaTabFix;

        public const int GammaTabRounder = GammaTabScale >> 1;

        public const int AlphaFix = 19;

        /// <summary>
        /// 8b of precision for susceptibilities.
        /// </summary>
        public const int MaxAlpha = 255;

        /// <summary>
        /// Scaling factor for alpha.
        /// </summary>
        public const int AlphaScale = 2 * MaxAlpha;

        /// <summary>
        /// Neutral value for susceptibility.
        /// </summary>
        public const int QuantEncMidAlpha = 64;

        /// <summary>
        /// Lowest usable value for susceptibility.
        /// </summary>
        public const int QuantEncMinAlpha = 30;

        /// <summary>
        /// Higher meaningful value for susceptibility.
        /// </summary>
        public const int QuantEncMaxAlpha = 100;

        /// <summary>
        /// Scaling constant between the sns (Spatial Noise Shaping) value and the QP power-law modulation. Must be strictly less than 1.
        /// </summary>
        public const double SnsToDq = 0.9;

        public const int QuantEncMaxDqUv = 6;

        public const int QuantEncMinDqUv = -4;

        public const int QFix = 17;

        public const int MaxDelzaSize = 64;

        /// <summary>
        /// Very small filter-strength values have close to no visual effect. So we can
        /// save a little decoding-CPU by turning filtering off for these.
        /// </summary>
        public const int FilterStrengthCutoff = 2;

        /// <summary>
        /// Max size of mode partition.
        /// </summary>
        public const int Vp8MaxPartition0Size = 1 << 19;

        public static readonly short[] Vp8FixedCostsUv = { 302, 984, 439, 642 };

        public static readonly short[] Vp8FixedCostsI16 = { 663, 919, 872, 919 };

        /// <summary>
        /// Distortion multiplier (equivalent of lambda).
        /// </summary>
        public const int RdDistoMult = 256;

        /// <summary>
        /// How many extra lines are needed on the MB boundary for caching, given a filtering level.
        /// Simple filter(1):  up to 2 luma samples are read and 1 is written.
        /// Complex filter(2): up to 4 luma samples are read and 3 are written. Same for U/V, so it's 8 samples total (because of the 2x upsampling).
        /// </summary>
        public static readonly byte[] FilterExtraRows = { 0, 2, 8 };

        // Paragraph 9.9
        public static readonly int[] Vp8EncBands =
        {
            0, 1, 2, 3, 6, 4, 5, 6, 6, 6, 6, 6, 6, 6, 6, 7, 0
        };

        public static readonly short[] Scan =
        {
            0 + (0 * Bps), 4 + (0 * Bps), 8 + (0 * Bps), 12 + (0 * Bps),
            0 + (4 * Bps), 4 + (4 * Bps), 8 + (4 * Bps), 12 + (4 * Bps),
            0 + (8 * Bps), 4 + (8 * Bps), 8 + (8 * Bps), 12 + (8 * Bps),
            0 + (12 * Bps), 4 + (12 * Bps), 8 + (12 * Bps), 12 + (12 * Bps)
        };

        // Residual decoding (Paragraph 13.2 / 13.3)
        public static readonly byte[] Cat3 = { 173, 148, 140 };
        public static readonly byte[] Cat4 = { 176, 155, 140, 135 };
        public static readonly byte[] Cat5 = { 180, 157, 141, 134, 130 };
        public static readonly byte[] Cat6 = { 254, 254, 243, 230, 196, 177, 153, 140, 133, 130, 129 };
        public static readonly byte[] Zigzag = { 0, 1, 4, 8, 5, 2, 3, 6, 9, 12, 13, 10, 7, 11, 14, 15 };

        public static readonly sbyte[] YModesIntra4 =
        {
            -0, 1,
            -1, 2,
            -2, 3,
            4, 6,
            -3, 5,
            -4, -5,
            -6, 7,
            -7, 8,
            -8, -9
        };
    }
}