Task.h

/*
    IIP Session & Generic Task Classes
 
    Copyright (C) 2006-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 _TASK_H
#define _TASK_H
 
 
#include <string>
 
#include "IIPImage.h"
#include "IIPResponse.h"
#include "View.h"
#include "TileManager.h"
#include "Timer.h"
#include "Writer.h"
#include "Cache.h"
#include "Watermark.h"
#include "Transforms.h"
#include "Logger.h"
 
 
 
#ifdef HAVE_EXT_POOL_ALLOCATOR
#include <ext/pool_allocator.h>
typedef HASHMAP < std::string, IIPImage,
                              __gnu_cxx::hash< const std::string >,
                              std::equal_to< const std::string >,
                              __gnu_cxx::__pool_alloc< std::pair<const std::string,IIPImage> >
                              > imageCacheMapType;
#else
typedef HASHMAP <std::string,IIPImage> imageCacheMapType;
#endif
 
 
 
 
struct Session {
  IIPImage **image;
  JPEGCompressor* jpeg;
  TIFFCompressor* tiff;
#ifdef HAVE_PNG
  PNGCompressor* png;
#endif
#ifdef HAVE_WEBP
  WebPCompressor* webp;
#endif
#ifdef HAVE_AVIF
  AVIFCompressor* avif;
#endif
  View* view;
  IIPResponse* response;
  Watermark* watermark;
  Transform* processor;
  int loglevel;
  Logger* logfile;
  std::map <const std::string, std::string> headers;
  std::map <const std::string, unsigned int> codecOptions;
 
  imageCacheMapType *imageCache;
  Cache* tileCache;
 
#ifdef DEBUG
  FileWriter* out;
#else
  FCGIWriter* out;
#endif
 
};
 
 
 
 
class Task {
 
 protected:
 
  Timer command_timer;
 
  Session* session;
 
  std::string argument;
 
 
 public:
 
  virtual ~Task() {};
 
  virtual void run( Session* session, const std::string& argument ) {};
 
 
  static Task* factory( const std::string& type );
 
  void checkImage();
 
};
 
 
 
 
class OBJ : public Task {
 
 public:
 
  void run( Session* session, const std::string& argument );
 
  void iip();
  void iip_server();
  void max_size();
  void resolution_number();
  void colorspace( std::string arg );
  void tile_size();
  void bits_per_channel();
  void horizontal_views();
  void vertical_views();
  void min_max_values();
  void resolutions();
  void dpi();
  void metadata( std::string field );
  void stack();
 
};
 
 
class QLT : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class SDS : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class MINMAX : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class CNT : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class GAM : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class WID : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class HEI : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class RGN : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class ROT : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class FIF : public Task {
 public:
  static long max_metadata_cache_size;          
  static std::string filesystem_prefix;         
  static std::string filesystem_suffix;         
  static std::string filename_pattern;          
  void run( Session* session, const std::string& argument );
};
 
 
class JTL : public Task {
 public:
  void run( Session* session, const std::string& argument );
 
 
  void send( Session* session, int resolution, int tile );
};
 
 
class PTL : public JTL {
 public:
  void run( Session* session, const std::string& argument ){
    // Set our encoding format and call JTL::run
    session->view->output_format = ImageEncoding::PNG;
    JTL::run( session, argument );
  };
};
 
 
class WTL : public JTL {
public:
  void run( Session* session, const std::string& argument ){
    // Set our encoding format and call JTL::run
    session->view->output_format = ImageEncoding::WEBP;
    JTL::run( session, argument );
  };
};
 
 
class ATL : public JTL {
public:
  void run( Session* session, const std::string& argument ){
    // Set our encoding format and call JTL::run
    session->view->output_format = ImageEncoding::AVIF;
    JTL::run( session, argument );
  };
};
 
 
class TTL : public JTL {
public:
  void run( Session* session, const std::string& argument ){
    // Set our encoding format and call JTL::run
    session->view->output_format = ImageEncoding::TIFF;
    JTL::run( session, argument );
  };
};
 
 
class JTLS : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class TIL : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class CVT : public Task {
 public:
  void run( Session* session, const std::string& argument );
 
 
  void send( Session* session );
};
 
 
class ICC : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class SHD : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class CMP : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class INV : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class Zoomify : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class SPECTRA : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class PFL : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class LYR : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class DeepZoom : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class IIIF : public Task {
 public:
 
  static unsigned int version;
 
  static std::string delimiter;
 
  static std::string extra_info;
 
  static bool extensions;
 
  void run( Session* session, const std::string& argument );
};
 
 
class CTW : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class COL : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
class CNV : public Task {
 public:
  void run( Session* session, const std::string& argument );
};
 
 
#endif