src/lib/image_proxy.h

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/image_proxy.h
  21  *  @brief ImageProxy and subclasses.
  22  */
  23
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/filesystem.hpp>
  26 #include <Magick++.h>
  27 #include <libxml++/libxml++.h>
  28
  29 class Image;
  30 class Socket;
  31
  32 namespace cxml {
  33         class Node;
  34 }
  35
  36 /** @class ImageProxy
  37  *  @brief A class which holds an Image, and can produce it on request.
  38  *
  39  *  This is so that decoding of source images can be postponed until
  40  *  the encoder thread, where multi-threading is happening, instead
  41  *  of happening in a single-threaded decoder.
  42  *
  43  *  For example, large TIFFs are slow to decode, so this class will keep
  44  *  the TIFF data TIFF until such a time that the actual image is needed.
  45  *  At this point, the class decodes the TIFF to an Image.
  46  */
  47 class ImageProxy
  48 {
  49 public:
  50         virtual boost::shared_ptr<Image> image () const = 0;
  51         virtual void add_metadata (xmlpp::Node *) const = 0;
  52         virtual void send_binary (boost::shared_ptr<Socket>) const = 0;
  53 };
  54
  55 class RawImageProxy : public ImageProxy
  56 {
  57 public:
  58         RawImageProxy (boost::shared_ptr<Image>);
  59         RawImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
  60
  61         boost::shared_ptr<Image> image () const;
  62         void add_metadata (xmlpp::Node *) const;
  63         void send_binary (boost::shared_ptr<Socket>) const;
  64
  65 private:
  66         boost::shared_ptr<Image> _image;
  67 };
  68
  69 class MagickImageProxy : public ImageProxy
  70 {
  71 public:
  72         MagickImageProxy (boost::filesystem::path);
  73         MagickImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
  74
  75         boost::shared_ptr<Image> image () const;
  76         void add_metadata (xmlpp::Node *) const;
  77         void send_binary (boost::shared_ptr<Socket>) const;
  78
  79 private:
  80         Magick::Blob _blob;
  81         mutable boost::shared_ptr<Image> _image;
  82 };
  83
  84 boost::shared_ptr<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);