2 Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef DCPOMATIC_IMAGE_PROXY_H
21 #define DCPOMATIC_IMAGE_PROXY_H
23 /** @file src/lib/image_proxy.h
24 * @brief ImageProxy and subclasses.
27 #include <dcp/types.h>
28 #include <boost/shared_ptr.hpp>
29 #include <boost/optional.hpp>
30 #include <boost/utility.hpp>
44 * @brief A class which holds an Image, and can produce it on request.
46 * This is so that decoding of source images can be postponed until
47 * the encoder thread, where multi-threading is happening, instead
48 * of happening in a single-threaded decoder.
50 * For example, large TIFFs are slow to decode, so this class will keep
51 * the TIFF data compressed until the decompressed image is needed.
52 * At this point, the class decodes the TIFF to an Image.
54 class ImageProxy : public boost::noncopyable
57 virtual ~ImageProxy () {}
59 /** @return Image (which must be aligned) */
60 virtual boost::shared_ptr<Image> image (boost::optional<dcp::NoteHandler> note = boost::optional<dcp::NoteHandler> ()) const = 0;
61 virtual void add_metadata (xmlpp::Node *) const = 0;
62 virtual void send_binary (boost::shared_ptr<Socket>) const = 0;
63 /** @return true if our image is definitely the same as another, false if it is probably not */
64 virtual bool same (boost::shared_ptr<const ImageProxy>) const = 0;
67 boost::shared_ptr<ImageProxy> image_proxy_factory (boost::shared_ptr<cxml::Node> xml, boost::shared_ptr<Socket> socket);