Extract common code out into kdm_for_screen()

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

diff --git a/src/lib/image_proxy.h b/src/lib/image_proxy.h
index be053eed51392810abf1462e8b96f1203d2a6a77..08516e718bb4dbfe34ae5f07a81ef16abfe3265b 100644 (file)
--- a/src/lib/image_proxy.h
+++ b/src/lib/image_proxy.h
@@ -60,20 +60,40 @@ class ImageProxy : public boost::noncopyable
 public:
        virtual ~ImageProxy () {}
 
-       /** @param note Handler for any notes that occur.
+       struct Result {
+               Result (boost::shared_ptr<Image> image_, int log2_scaling_)
+                       : image (image_)
+                       , log2_scaling (log2_scaling_)
+                       , error (false)
+               {}
+
+               Result (boost::shared_ptr<Image> image_, int log2_scaling_, bool error_)
+                       : image (image_)
+                       , log2_scaling (log2_scaling_)
+                       , error (error_)
+               {}
+
+               /** Image (which will be aligned) */
+               boost::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.
-        *  @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::NoteHandler> note = boost::optional<dcp::NoteHandler> (),
+       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 (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;
        /** Do any useful work that would speed up a subsequent call to ::image().