X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fimage_proxy.h;h=be053eed51392810abf1462e8b96f1203d2a6a77;hb=72b11d5eb036651b6ff68edf3ed270e8fc52960f;hp=7ff28e174ec092afdbc832ec6b07fb40c7f47c37;hpb=c6c082c4a8016f85ba4207f4b8ccee1d5770e4a4;p=dcpomatic.git diff --git a/src/lib/image_proxy.h b/src/lib/image_proxy.h index 7ff28e174..be053eed5 100644 --- a/src/lib/image_proxy.h +++ b/src/lib/image_proxy.h @@ -1,19 +1,20 @@ /* Copyright (C) 2014 Carl Hetherington - 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 . */ @@ -24,22 +25,23 @@ * @brief ImageProxy and subclasses. */ +extern "C" { +#include +} +#include #include -#include -#include -#include +#include +#include class Image; class Socket; -class Log; -namespace cxml { +namespace xmlpp { class Node; } -namespace dcp { - class MonoPictureFrame; - class StereoPictureFrame; +namespace cxml { + class Node; } /** @class ImageProxy @@ -56,22 +58,32 @@ namespace dcp { class ImageProxy : public boost::noncopyable { public: - ImageProxy (boost::shared_ptr log); virtual ~ImageProxy () {} - /** @return Image (which must be aligned) */ - virtual boost::shared_ptr image () const = 0; + /** @param note Handler for any notes that occur. + * @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, int> image ( + boost::optional note = boost::optional (), + boost::optional size = boost::optional () + ) const = 0; + virtual void add_metadata (xmlpp::Node *) const = 0; virtual void send_binary (boost::shared_ptr) 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 { - return false; - } - -protected: - boost::shared_ptr _log; + virtual bool same (boost::shared_ptr) 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 = boost::optional()) const { return 0; } + virtual size_t memory_used () const = 0; }; -boost::shared_ptr image_proxy_factory (boost::shared_ptr xml, boost::shared_ptr socket, boost::shared_ptr log); +boost::shared_ptr image_proxy_factory (boost::shared_ptr xml, boost::shared_ptr socket); #endif