X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fimage_proxy.h;h=08516e718bb4dbfe34ae5f07a81ef16abfe3265b;hb=fa5f3a8bf77209da27acc33cf144e2e4500a2600;hp=9807d027d59bd2da88eb12684a54f2f1a3006454;hpb=424f9d0c70ff0832da0509776da939b2f855cdc1;p=dcpomatic.git diff --git a/src/lib/image_proxy.h b/src/lib/image_proxy.h index 9807d027d..08516e718 100644 --- a/src/lib/image_proxy.h +++ b/src/lib/image_proxy.h @@ -1,42 +1,47 @@ /* Copyright (C) 2014 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic 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 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic 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., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ +#ifndef DCPOMATIC_IMAGE_PROXY_H +#define DCPOMATIC_IMAGE_PROXY_H + /** @file src/lib/image_proxy.h * @brief ImageProxy and subclasses. */ +extern "C" { +#include +} +#include #include -#include -#include -#include +#include +#include class Image; class Socket; -class Log; -namespace cxml { +namespace xmlpp { class Node; } -namespace dcp { - class MonoPictureFrame; - class StereoPictureFrame; +namespace cxml { + class Node; } /** @class ImageProxy @@ -47,68 +52,58 @@ namespace dcp { * of happening in a single-threaded decoder. * * For example, large TIFFs are slow to decode, so this class will keep - * the TIFF data TIFF until such a time that the actual image is needed. + * the TIFF data compressed until the decompressed image is needed. * At this point, the class decodes the TIFF to an Image. */ class ImageProxy : public boost::noncopyable { public: - ImageProxy (boost::shared_ptr log); + virtual ~ImageProxy () {} + + struct Result { + Result (boost::shared_ptr image_, int log2_scaling_) + : image (image_) + , log2_scaling (log2_scaling_) + , error (false) + {} + + Result (boost::shared_ptr image_, int log2_scaling_, bool error_) + : image (image_) + , log2_scaling (log2_scaling_) + , error (error_) + {} + + /** Image (which will be aligned) */ + boost::shared_ptr image; + /** log2 of any scaling down that has already been applied to the image; + * e.g. if the image is already half the size of the original, this value + * will be 1. + */ + int log2_scaling; + /** true if there was an error during image decoding, otherwise false */ + bool error; + }; + + /** @param log Log to write to, or 0. + * @param size Size that the returned image will be scaled to, in case this + * can be used as an optimisation. + */ + virtual Result image ( + boost::optional size = boost::optional () + ) const = 0; - /** @return Image (which must be aligned) */ - virtual boost::shared_ptr image () const = 0; virtual void add_metadata (xmlpp::Node *) const = 0; - virtual void send_binary (boost::shared_ptr) const = 0; - -protected: - boost::shared_ptr _log; -}; - -class RawImageProxy : public ImageProxy -{ -public: - RawImageProxy (boost::shared_ptr, boost::shared_ptr log); - RawImageProxy (boost::shared_ptr xml, boost::shared_ptr socket, boost::shared_ptr log); - - boost::shared_ptr image () const; - void add_metadata (xmlpp::Node *) const; - void send_binary (boost::shared_ptr) const; - -private: - boost::shared_ptr _image; -}; - -class MagickImageProxy : public ImageProxy -{ -public: - MagickImageProxy (boost::filesystem::path, boost::shared_ptr log); - MagickImageProxy (boost::shared_ptr xml, boost::shared_ptr socket, boost::shared_ptr log); - - boost::shared_ptr image () const; - void add_metadata (xmlpp::Node *) const; - void send_binary (boost::shared_ptr) const; - -private: - Magick::Blob _blob; - mutable boost::shared_ptr _image; + virtual void write_to_socket (boost::shared_ptr) const = 0; + /** @return true if our image is definitely the same as another, false if it is probably not */ + virtual bool same (boost::shared_ptr) const = 0; + /** Do any useful work that would speed up a subsequent call to ::image(). + * This method may be called in a different thread to image(). + * @return log2 of any scaling down that will be applied to the image. + */ + virtual int prepare (boost::optional = boost::optional()) const { return 0; } + virtual size_t memory_used () const = 0; }; -class J2KImageProxy : public ImageProxy -{ -public: - J2KImageProxy (boost::shared_ptr frame, dcp::Size, boost::shared_ptr log); - J2KImageProxy (boost::shared_ptr frame, dcp::Size, dcp::Eye, boost::shared_ptr log); - J2KImageProxy (boost::shared_ptr xml, boost::shared_ptr socket, boost::shared_ptr log); - - boost::shared_ptr image () const; - void add_metadata (xmlpp::Node *) const; - void send_binary (boost::shared_ptr) const; - -private: - boost::shared_ptr _mono; - boost::shared_ptr _stereo; - dcp::Size _size; - dcp::Eye _eye; -}; +boost::shared_ptr image_proxy_factory (boost::shared_ptr xml, boost::shared_ptr socket); -boost::shared_ptr image_proxy_factory (boost::shared_ptr xml, boost::shared_ptr socket, boost::shared_ptr log); +#endif