2 Copyright (C) 2012-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/reel_subtitle_asset.h
36 * @brief ReelSubtitleAsset class.
40 #ifndef LIBDCP_REEL_SUBTITLE_ASSET_H
41 #define LIBDCP_REEL_SUBTITLE_ASSET_H
44 #include "language_tag.h"
45 #include "reel_asset.h"
46 #include "reel_file_asset.h"
47 #include "subtitle_asset.h"
50 struct verify_invalid_language1;
59 /** @class ReelSubtitleAsset
60 * @brief Part of a Reel's description which refers to a subtitle XML/MXF file
62 class ReelSubtitleAsset : public ReelFileAsset
65 ReelSubtitleAsset (std::shared_ptr<SubtitleAsset> asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point);
66 explicit ReelSubtitleAsset (std::shared_ptr<const cxml::Node>);
68 std::shared_ptr<const SubtitleAsset> asset () const {
69 return asset_of_type<const SubtitleAsset>();
72 std::shared_ptr<SubtitleAsset> asset () {
73 return asset_of_type<SubtitleAsset>();
76 xmlpp::Node* write_to_cpl (xmlpp::Node* node, Standard standard) const override;
78 bool equals(std::shared_ptr<const ReelSubtitleAsset>, EqualityOptions const&, NoteHandler) const;
80 void set_language (dcp::LanguageTag language);
82 boost::optional<std::string> language () const {
87 /** As in other places, this is stored and returned as a string so that
88 * we can tolerate non-RFC-5646 strings, but must be set as a dcp::LanguageTag
89 * to try to ensure that we create compliant output.
91 boost::optional<std::string> _language;
94 friend struct ::verify_invalid_language1;
96 std::string cpl_node_name (Standard standard) const override;