2 Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 libdcp is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
35 /** @file src/subtitle_image.h
36 * @brief SubtitleImage class
40 #ifndef LIBDCP_SUBTITLE_IMAGE_H
41 #define LIBDCP_SUBTITLE_IMAGE_H
44 #include "array_data.h"
47 #include <boost/optional.hpp>
54 /** @class SubtitleImage
55 * @brief A bitmap subtitle with all the associated attributes
57 class SubtitleImage : public Subtitle
87 ArrayData png_image () const {
91 void set_png_image (ArrayData png) {
95 void read_png_file (boost::filesystem::path file);
96 void write_png_file (boost::filesystem::path file) const;
98 std::string id () const {
102 /** @return the most recent disk file used to read or write this asset, if there is one */
103 boost::optional<boost::filesystem::path> file () const {
107 bool equals(std::shared_ptr<const dcp::Subtitle> other_sub, EqualityOptions const& options, NoteHandler note) const override;
110 ArrayData _png_image;
112 mutable boost::optional<boost::filesystem::path> _file;
116 bool operator== (SubtitleImage const & a, SubtitleImage const & b);
117 bool operator!= (SubtitleImage const & a, SubtitleImage const & b);
118 std::ostream& operator<< (std::ostream& s, SubtitleImage const & sub);