AVIFCompressor.h

/*  AVIF Compressor Class:
    Handles alpha channels, ICC profiles and XMP metadata
 
    Copyright (C) 2024-2025 Ruven Pillay
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 
*/
 
 
#ifndef _AVIFCOMPRESSOR_H
#define _AVIFCOMPRESSOR_H
 
 
#include "Compressor.h"
#include <avif/avif.h>
 
 
 
class AVIFCompressor : public Compressor {
 
 private:
 
  avifEncoder *encoder;
  avifImage *avif;
  avifCodecChoice codec;
 
 
  RawTile tile;                   
  unsigned int chunk_size;        
  size_t current_chunk;           
 
 
  void writeICCProfile();
 
  void writeXMPMetadata();
 
  void writeExifMetadata();
 
 
 public:
 
 
  AVIFCompressor( int quality ) : Compressor(quality) {};
 
  ~AVIFCompressor(){};
 
 
 
  void InitCompression( const RawTile& rawtile, unsigned int strip_height );
 
 
 
  unsigned int CompressStrip( unsigned char* source, unsigned char* output, unsigned int tile_height );
 
 
 
  unsigned int Finish( unsigned char* output );
 
 
 
  unsigned int Compress( RawTile& t );
 
 
  inline unsigned int getHeaderSize() const { return header_size; }
 
  inline unsigned char* getHeader() { return header; }
 
  inline const char* getMimeType() const { return "image/avif"; }
 
  inline const char* getSuffix() const { return "avif"; }
 
  inline ImageEncoding getImageEncoding() const { return ImageEncoding::AVIF; };
 
 
 
  inline int getQuality() const { return Q; }
 
 
 
  inline void setQuality( int quality ){
 
    // AVIF quality ranges from 0 (best compression - smallest size) to 100 (worst compression - largest size)
    this->Q = quality;
 
    // AVIF compression level
    if( Q < -1 ) Q = -1;         // Lossless
    else if( Q > 100 ) Q = 100;
 
  }
 
 
 
  inline void setCodec( unsigned int codec )
  {
    this->codec = AVIFCompressor::getCodecChoice( codec );
  }
 
 
 
  inline static avifCodecChoice getCodecChoice( unsigned int codec )
  {
    if( codec == 1 ) return AVIF_CODEC_CHOICE_AOM;
    else if( codec == 2 ) return AVIF_CODEC_CHOICE_RAV1E;
    else if( codec == 3 ) return AVIF_CODEC_CHOICE_SVT;
    else return AVIF_CODEC_CHOICE_AUTO;
  }
 
 
 
  inline static const char* getCodecName( unsigned int codec )
  {
    avifCodecChoice choice = AVIFCompressor::getCodecChoice( codec );
    const char* name = avifCodecName( choice, AVIF_CODEC_FLAG_CAN_ENCODE );
    if( name == NULL ) return "unsupported codec - will not be able to encode to avif";
    else return name;
  }
 
};
 
#endif