Use better J2KImageProxy::same() method.
[dcpomatic.git] / src / lib / image_proxy.h
index 792fa004aea931e3d3a4041822571a4c89ec3633..1f19a4160b312ce436994ba8aec6ecb53273c02d 100644 (file)
 
 */
 
+#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 <dcp/types.h>
 #include <Magick++.h>
 #include <libxml++/libxml++.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
 
 class Image;
 class Socket;
@@ -33,6 +38,11 @@ namespace cxml {
        class Node;
 }
 
+namespace dcp {
+       class MonoPictureFrame;
+       class StereoPictureFrame;
+}
+
 /** @class ImageProxy
  *  @brief A class which holds an Image, and can produce it on request.
  *
@@ -41,44 +51,22 @@ 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:
-       virtual boost::shared_ptr<Image> image () const = 0;
+       virtual ~ImageProxy () {}
+
+       /** @return Image (which must be aligned) */
+       virtual boost::shared_ptr<Image> image (boost::optional<dcp::NoteHandler> note = boost::optional<dcp::NoteHandler> ()) const = 0;
        virtual void add_metadata (xmlpp::Node *) const = 0;
        virtual void send_binary (boost::shared_ptr<Socket>) const = 0;
-};
-
-class RawImageProxy : public ImageProxy
-{
-public:
-       RawImageProxy (boost::shared_ptr<Image>);
-       RawImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
-
-       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);
-       MagickImageProxy (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
-
-       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;
+       /** @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;
 };
 
 boost::shared_ptr<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
+
+#endif