src/lib/image_proxy.h

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_IMAGE_PROXY_H
  22 #define DCPOMATIC_IMAGE_PROXY_H
  23
  24 /** @file  src/lib/image_proxy.h
  25  *  @brief ImageProxy and subclasses.
  26  */
  27
  28 extern "C" {
  29 #include <libavutil/pixfmt.h>
  30 }
  31 #include <dcp/types.h>
  32 #include <boost/shared_ptr.hpp>
  33 #include <boost/optional.hpp>
  34 #include <boost/utility.hpp>
  35
  36 class Image;
  37 class Socket;
  38
  39 namespace xmlpp {
  40         class Node;
  41 }
  42
  43 namespace cxml {
  44         class Node;
  45 }
  46
  47 /** @class ImageProxy
  48  *  @brief A class which holds an Image, and can produce it on request.
  49  *
  50  *  This is so that decoding of source images can be postponed until
  51  *  the encoder thread, where multi-threading is happening, instead
  52  *  of happening in a single-threaded decoder.
  53  *
  54  *  For example, large TIFFs are slow to decode, so this class will keep
  55  *  the TIFF data compressed until the decompressed image is needed.
  56  *  At this point, the class decodes the TIFF to an Image.
  57  */
  58 class ImageProxy : public boost::noncopyable
  59 {
  60 public:
  61         virtual ~ImageProxy () {}
  62
  63         struct Result {
  64                 Result (boost::shared_ptr<Image> image_, int log2_scaling_)
  65                         : image (image_)
  66                         , log2_scaling (log2_scaling_)
  67                         , error (false)
  68                 {}
  69
  70                 Result (boost::shared_ptr<Image> image_, int log2_scaling_, bool error_)
  71                         : image (image_)
  72                         , log2_scaling (log2_scaling_)
  73                         , error (error_)
  74                 {}
  75
  76                 /** Image (which will be aligned) */
  77                 boost::shared_ptr<Image> image;
  78                 /** log2 of any scaling down that has already been applied to the image;
  79                  *  e.g. if the image is already half the size of the original, this value
  80                  *  will be 1.
  81                  */
  82                 int log2_scaling;
  83                 /** true if there was an error during image decoding, otherwise false */
  84                 bool error;
  85         };
  86
  87         /** @param log Log to write to, or 0.
  88          *  @param size Size that the returned image will be scaled to, in case this
  89          *  can be used as an optimisation.
  90          */
  91         virtual Result image (
  92                 boost::optional<dcp::Size> size = boost::optional<dcp::Size> ()
  93                 ) const = 0;
  94
  95         virtual void add_metadata (xmlpp::Node *) const = 0;
  96         virtual void write_to_socket (boost::shared_ptr<Socket>) const = 0;
  97         /** @return true if our image is definitely the same as another, false if it is probably not */
  98         virtual bool same (boost::shared_ptr<const ImageProxy>) const = 0;
  99         /** Do any useful work that would speed up a subsequent call to ::image().
 100          *  This method may be called in a different thread to image().
 101          *  @return log2 of any scaling down that will be applied to the image.
 102          */
 103         virtual int prepare (boost::optional<dcp::Size> = boost::optional<dcp::Size>()) const { return 0; }
 104         virtual size_t memory_used () const = 0;
 105 };
 106
 107 boost::shared_ptr<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
 108
 109 #endif