libdcp
reel_subtitle_asset.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
3 
4  This file is part of libdcp.
5 
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.
10 
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.
15 
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/>.
18 
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
23  including the two.
24 
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.
32 */
33 
34 
40 #ifndef LIBDCP_REEL_SUBTITLE_ASSET_H
41 #define LIBDCP_REEL_SUBTITLE_ASSET_H
42 
43 
44 #include "language_tag.h"
45 #include "reel_asset.h"
46 #include "reel_file_asset.h"
47 #include "subtitle_asset.h"
48 
49 
50 struct verify_invalid_language1;
51 
52 
53 namespace dcp {
54 
55 
56 class SubtitleAsset;
57 
58 
63 {
64 public:
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>);
67 
68  std::shared_ptr<const SubtitleAsset> asset () const {
69  return asset_of_type<const SubtitleAsset>();
70  }
71 
72  std::shared_ptr<SubtitleAsset> asset () {
73  return asset_of_type<SubtitleAsset>();
74  }
75 
76  xmlpp::Node* write_to_cpl (xmlpp::Node* node, Standard standard) const override;
77 
78  bool equals (std::shared_ptr<const ReelSubtitleAsset>, EqualityOptions, NoteHandler) const;
79 
80  void set_language (dcp::LanguageTag language);
81 
82  boost::optional<std::string> language () const {
83  return _language;
84  }
85 
86 protected:
91  boost::optional<std::string> _language;
92 
93 private:
94  friend struct ::verify_invalid_language1;
95 
96  std::string cpl_node_name (Standard standard) const override;
97 };
98 
99 
100 }
101 
102 
103 #endif
A fraction (i.e. a thing with an integer numerator and an integer denominator).
Definition: types.h:214
Part of a Reel's description which refers to a subtitle XML/MXF file.
std::string cpl_node_name(Standard standard) const override
boost::optional< std::string > _language
Namespace for everything in libdcp.
Definition: array_data.h:50
ReelAsset class.
ReelFileAsset class.
A class to describe what "equality" means for a particular test.
Definition: types.h:249
SubtitleAsset class.