X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fimage_proxy.h;h=a37be580fcf062fbb247e1d02285e532d49279da;hb=0330b684fe616b465e65b67f7d995e659fa83fca;hp=b499b329283362788c778b40ccb33769f3e36ea8;hpb=c38648f30eb24c88e2af2927ba60acbf7e353fe8;p=dcpomatic.git

diff --git a/src/lib/image_proxy.h b/src/lib/image_proxy.h
index b499b3292..a37be580f 100644
--- a/src/lib/image_proxy.h
+++ b/src/lib/image_proxy.h
@@ -1,39 +1,54 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
 
 */
 
+
+#ifndef DCPOMATIC_IMAGE_PROXY_H
+#define DCPOMATIC_IMAGE_PROXY_H
+
+
 /** @file  src/lib/image_proxy.h
  *  @brief ImageProxy and subclasses.
  */
 
-#include <boost/shared_ptr.hpp>
-#include <boost/filesystem.hpp>
-#include <Magick++.h>
-#include <libxml++/libxml++.h>
+
+#include "image.h"
+extern "C" {
+#include <libavutil/pixfmt.h>
+}
+#include <dcp/types.h>
+#include <boost/optional.hpp>
+#include <boost/utility.hpp>
+
 
 class Image;
 class Socket;
-class Log;
+
+namespace xmlpp {
+	class Node;
+}
 
 namespace cxml {
 	class Node;
 }
 
+
 /** @class ImageProxy
  *  @brief A class which holds an Image, and can produce it on request.
  *
@@ -42,49 +57,64 @@ namespace cxml {
  *  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
+class ImageProxy
 {
 public:
-	ImageProxy (boost::shared_ptr<Log> log);
-	
-	virtual boost::shared_ptr<Image> image () const = 0;
-	virtual void add_metadata (xmlpp::Node *) const = 0;
-	virtual void send_binary (boost::shared_ptr<Socket>) const = 0;
+	ImageProxy () {}
+	virtual ~ImageProxy () {}
+
+	ImageProxy (ImageProxy const&) = delete;
+	ImageProxy& operator= (ImageProxy const&) = delete;
+
+	struct Result {
+		Result (std::shared_ptr<const Image> image_, int log2_scaling_)
+			: image (image_)
+			, log2_scaling (log2_scaling_)
+			, error (false)
+		{}
+
+		Result (std::shared_ptr<Image> image_, int log2_scaling_, bool error_)
+			: image (image_)
+			, log2_scaling (log2_scaling_)
+			, error (error_)
+		{}
+
+		std::shared_ptr<const Image> 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<dcp::Size> size = boost::optional<dcp::Size> ()
+		) const = 0;
 
-protected:
-	boost::shared_ptr<Log> _log;
-};
-
-class RawImageProxy : public ImageProxy
-{
-public:
-	RawImageProxy (boost::shared_ptr<Image>, boost::shared_ptr<Log> log);
-	RawImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket, boost::shared_ptr<Log> log);
-
-	boost::shared_ptr<Image> image () const;
-	void add_metadata (xmlpp::Node *) const;
-	void send_binary (boost::shared_ptr<Socket>) const;
-	
-private:
-	boost::shared_ptr<Image> _image;
+	virtual void add_metadata (xmlpp::Node *) const = 0;
+	virtual void write_to_socket (std::shared_ptr<Socket>) const = 0;
+	/** @return true if our image is definitely the same as another, false if it is probably not */
+	virtual bool same (std::shared_ptr<const ImageProxy>) 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<dcp::Size> = boost::optional<dcp::Size>()) const { return 0; }
+	virtual size_t memory_used () const = 0;
 };
 
-class MagickImageProxy : public ImageProxy
-{
-public:
-	MagickImageProxy (boost::filesystem::path, boost::shared_ptr<Log> log);
-	MagickImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket, boost::shared_ptr<Log> log);
 
-	boost::shared_ptr<Image> image () const;
-	void add_metadata (xmlpp::Node *) const;
-	void send_binary (boost::shared_ptr<Socket>) const;
+std::shared_ptr<ImageProxy> image_proxy_factory (std::shared_ptr<cxml::Node> xml, std::shared_ptr<Socket> socket);
 
-private:	
-	Magick::Blob _blob;
-	mutable boost::shared_ptr<Image> _image;
-};
 
-boost::shared_ptr<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket, boost::shared_ptr<Log> log);
+#endif