X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fimage_proxy.h;h=a37be580fcf062fbb247e1d02285e532d49279da;hb=182b9d2e2feb6545592868606aaf0f0146095481;hp=1f19a4160b312ce436994ba8aec6ecb53273c02d;hpb=8139c134b1c3e46d523e3ea9799dd33d8f05fb7a;p=dcpomatic.git diff --git a/src/lib/image_proxy.h b/src/lib/image_proxy.h index 1f19a4160..a37be580f 100644 --- a/src/lib/image_proxy.h +++ b/src/lib/image_proxy.h @@ -1,48 +1,54 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2021 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. */ + +#include "image.h" +extern "C" { +#include +} #include -#include -#include -#include #include -#include +#include + class Image; class Socket; -namespace cxml { +namespace xmlpp { class Node; } -namespace dcp { - class MonoPictureFrame; - class StereoPictureFrame; +namespace cxml { + class Node; } + /** @class ImageProxy * @brief A class which holds an Image, and can produce it on request. * @@ -54,19 +60,61 @@ namespace dcp { * 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 +class ImageProxy { public: + ImageProxy () {} virtual ~ImageProxy () {} - /** @return Image (which must be aligned) */ - virtual boost::shared_ptr image (boost::optional note = boost::optional ()) const = 0; + ImageProxy (ImageProxy const&) = delete; + ImageProxy& operator= (ImageProxy const&) = delete; + + struct Result { + Result (std::shared_ptr image_, int log2_scaling_) + : image (image_) + , log2_scaling (log2_scaling_) + , error (false) + {} + + Result (std::shared_ptr image_, int log2_scaling_, bool error_) + : image (image_) + , log2_scaling (log2_scaling_) + , error (error_) + {} + + std::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 ( + Image::Alignment alignment, + boost::optional size = boost::optional () + ) const = 0; + virtual void add_metadata (xmlpp::Node *) const = 0; - virtual void send_binary (boost::shared_ptr) const = 0; + virtual void write_to_socket (std::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; + virtual bool same (std::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 (Image::Alignment, boost::optional = boost::optional()) const { return 0; } + virtual size_t memory_used () const = 0; }; -boost::shared_ptr image_proxy_factory (boost::shared_ptr xml, boost::shared_ptr socket); + +std::shared_ptr image_proxy_factory (std::shared_ptr xml, std::shared_ptr socket); + #endif