Accessor for ClosedCaptionsDialog.
[dcpomatic.git] / src / lib / image_proxy.h
index b0ec161102d1f311e1e019c47793314c35166944..b6fe877321ecc06d460faf283522997d4a22c8dc 100644 (file)
@@ -60,13 +60,27 @@ class ImageProxy : public boost::noncopyable
 public:
        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;
+       /** @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;
        /** @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;
+       /** 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);