summaryrefslogtreecommitdiff
path: root/src/reel_text_asset.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2024-06-28 19:27:50 +0200
committerCarl Hetherington <cth@carlh.net>2024-08-17 12:57:31 +0200
commitb64644327bff333569bf4a60f1d7c3d46f058b48 (patch)
treec7332cca06c2a171ce91c691760686d03882c919 /src/reel_text_asset.h
parent32f8cc149c8c78c82f9f7e3689e43c11da362968 (diff)
Reel{,Interop,SMPTE}SubtitleAsset -> Reel{,Interop,SMPTE}TextAsset.
Diffstat (limited to 'src/reel_text_asset.h')
-rw-r--r--src/reel_text_asset.h103
1 files changed, 103 insertions, 0 deletions
diff --git a/src/reel_text_asset.h b/src/reel_text_asset.h
new file mode 100644
index 00000000..63962155
--- /dev/null
+++ b/src/reel_text_asset.h
@@ -0,0 +1,103 @@
+/*
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
+
+ This file is part of libdcp.
+
+ libdcp 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.
+
+ libdcp 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 libdcp. If not, see <http://www.gnu.org/licenses/>.
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of portions of this program with the
+ OpenSSL library under certain conditions as described in each
+ individual source file, and distribute linked combinations
+ including the two.
+
+ You must obey the GNU General Public License in all respects
+ for all of the code used other than OpenSSL. If you modify
+ file(s) with this exception, you may extend this exception to your
+ version of the file(s), but you are not obligated to do so. If you
+ do not wish to do so, delete this exception statement from your
+ version. If you delete this exception statement from all source
+ files in the program, then also delete it here.
+*/
+
+
+/** @file src/reel_text_asset.h
+ * @brief ReelTextAsset class.
+ */
+
+
+#ifndef LIBDCP_REEL_TEXT_ASSET_H
+#define LIBDCP_REEL_TEXT_ASSET_H
+
+
+#include "language_tag.h"
+#include "reel_asset.h"
+#include "reel_file_asset.h"
+#include "subtitle_asset.h"
+
+
+struct verify_invalid_language1;
+
+
+namespace dcp {
+
+
+class SubtitleAsset;
+
+
+/** @class ReelTextAsset
+ * @brief Part of a Reel's description which refers to a subtitle or caption XML/MXF file
+ */
+class ReelTextAsset : public ReelFileAsset
+{
+public:
+ ReelTextAsset(std::shared_ptr<SubtitleAsset> asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point);
+ explicit ReelTextAsset(std::shared_ptr<const cxml::Node>);
+
+ std::shared_ptr<const SubtitleAsset> asset () const {
+ return asset_of_type<const SubtitleAsset>();
+ }
+
+ std::shared_ptr<SubtitleAsset> asset () {
+ return asset_of_type<SubtitleAsset>();
+ }
+
+ xmlpp::Element* write_to_cpl(xmlpp::Element* node, Standard standard) const override;
+
+ bool equals(std::shared_ptr<const ReelTextAsset>, EqualityOptions const&, NoteHandler) const;
+
+ void set_language (dcp::LanguageTag language);
+
+ boost::optional<std::string> language () const {
+ return _language;
+ }
+
+protected:
+ /** As in other places, this is stored and returned as a string so that
+ * we can tolerate non-RFC-5646 strings, but must be set as a dcp::LanguageTag
+ * to try to ensure that we create compliant output.
+ */
+ boost::optional<std::string> _language;
+
+private:
+ friend struct ::verify_invalid_language1;
+
+ std::string cpl_node_name (Standard standard) const override;
+};
+
+
+}
+
+
+#endif