Tweak formatting.
[dcpomatic.git] / src / lib / image_proxy.h
index b0ec161102d1f311e1e019c47793314c35166944..22946ed98a56b1272421e053ceae35df58cdf811 100644 (file)
@@ -29,7 +29,6 @@ extern "C" {
 #include <libavutil/pixfmt.h>
 }
 #include <dcp/types.h>
-#include <boost/shared_ptr.hpp>
 #include <boost/optional.hpp>
 #include <boost/utility.hpp>
 
@@ -55,20 +54,59 @@ namespace cxml {
  *  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> image (boost::optional<dcp::NoteHandler> note = boost::optional<dcp::NoteHandler> ()) const = 0;
+       ImageProxy (ImageProxy const&) = delete;
+       ImageProxy& operator= (ImageProxy const&) = delete;
+
+       struct Result {
+               Result (std::shared_ptr<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_)
+               {}
+
+               /** Image (which will be aligned) */
+               std::shared_ptr<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 (
+               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;
+       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 (boost::shared_ptr<const ImageProxy>) const = 0;
-       virtual AVPixelFormat pixel_format () const = 0;
+       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 (boost::optional<dcp::Size> = boost::optional<dcp::Size>()) const { return 0; }
+       virtual size_t memory_used () const = 0;
 };
 
-boost::shared_ptr<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);
+std::shared_ptr<ImageProxy> image_proxy_factory (std::shared_ptr<cxml::Node> xml, std::shared_ptr<Socket> socket);
 
 #endif