Accessor for ClosedCaptionsDialog.

[dcpomatic.git] / src / lib / image_proxy.h

diff --git a/src/lib/image_proxy.h b/src/lib/image_proxy.h
index fcbda7dd1f6695f5c29c6f0623eb619991e5eeb5..b6fe877321ecc06d460faf283522997d4a22c8dc 100644 (file)
--- a/src/lib/image_proxy.h
+++ b/src/lib/image_proxy.h
@@ -1,34 +1,44 @@
 /*
     Copyright (C) 2014 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.
  */
 
+extern "C" {
+#include <libavutil/pixfmt.h>
+}
+#include <dcp/types.h>
 #include <boost/shared_ptr.hpp>
-#include <boost/filesystem.hpp>
-#include <Magick++.h>
-#include <libxml++/libxml++.h>
+#include <boost/optional.hpp>
+#include <boost/utility.hpp>
 
 class Image;
 class Socket;
-class Log;
+
+namespace xmlpp {
+       class Node;
+}
 
 namespace cxml {
        class Node;
@@ -42,49 +52,37 @@ 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
+class ImageProxy : public boost::noncopyable
 {
 public:
-       ImageProxy (boost::shared_ptr<Log> log);
-       
-       virtual boost::shared_ptr<Image> image () const = 0;
+       virtual ~ImageProxy () {}
+
+       /** @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.
+        *  @return Image (which must be aligned) and log2 of any scaling down that has
+        *  already been applied to the image; e.g. if the the image is already half the size
+        *  of the original, the second part of the return value will be 1.
+        */
+       virtual std::pair<boost::shared_ptr<Image>, int> image (
+               boost::optional<dcp::Size> size = boost::optional<dcp::Size> ()
+               ) const = 0;
+
        virtual void add_metadata (xmlpp::Node *) const = 0;
        virtual void send_binary (boost::shared_ptr<Socket>) const = 0;
-
-protected:
-       boost::shared_ptr<Log> _log;
+       /** @return true if our image is definitely the same as another, false if it is probably not */
+       virtual bool same (boost::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 (boost::optional<dcp::Size> = boost::optional<dcp::Size>()) const { return 0; }
+       virtual size_t memory_used () const = 0;
 };
 
-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;
-};
-
-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;
-
-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<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket, boost::shared_ptr<Log> log);
+#endif