b751efaf9225fc50ccf8417680ef9739a58c5571
[libdcp.git] / src / reel_closed_caption_asset.cc
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
35 /** @file  src/reel_closed_caption_asset.cc
36  *  @brief ReelClosedCaptionAsset class
37  */
38
39
40 #include "subtitle_asset.h"
41 #include "reel_closed_caption_asset.h"
42 #include "smpte_subtitle_asset.h"
43 #include "dcp_assert.h"
44 #include <libxml++/libxml++.h>
45
46
47 using std::string;
48 using std::pair;
49 using std::make_pair;
50 using std::shared_ptr;
51 using std::dynamic_pointer_cast;
52 using boost::optional;
53 using namespace dcp;
54
55
56 ReelClosedCaptionAsset::ReelClosedCaptionAsset (std::shared_ptr<SubtitleAsset> asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
57         : ReelAsset (asset->id(), edit_rate, intrinsic_duration, entry_point)
58         , ReelFileAsset (asset)
59         , ReelEncryptableAsset (dynamic_pointer_cast<SMPTESubtitleAsset>(asset) ? dynamic_pointer_cast<SMPTESubtitleAsset>(asset)->key_id() : optional<string>())
60 {
61
62 }
63
64
65 ReelClosedCaptionAsset::ReelClosedCaptionAsset (std::shared_ptr<const cxml::Node> node)
66         : ReelAsset (node)
67         , ReelFileAsset (node)
68         , ReelEncryptableAsset (node)
69 {
70         _language = node->optional_string_child ("Language");
71         node->done ();
72 }
73
74
75 string
76 ReelClosedCaptionAsset::cpl_node_name (Standard standard) const
77 {
78         switch (standard) {
79         case Standard::INTEROP:
80                 return "cc-cpl:MainClosedCaption";
81         case Standard::SMPTE:
82                 return "tt:ClosedCaption";
83         }
84
85         DCP_ASSERT (false);
86 }
87
88
89 pair<string, string>
90 ReelClosedCaptionAsset::cpl_node_namespace (Standard standard) const
91 {
92         switch (standard) {
93         case Standard::INTEROP:
94                 return make_pair ("http://www.digicine.com/PROTO-ASDCP-CC-CPL-20070926#", "cc-cpl");
95         case Standard::SMPTE:
96                 return make_pair ("http://www.smpte-ra.org/schemas/429-12/2008/TT", "tt");
97         }
98
99         DCP_ASSERT (false);
100 }
101
102
103 string
104 ReelClosedCaptionAsset::key_type () const
105 {
106         return "MDSK";
107 }
108
109
110 xmlpp::Node *
111 ReelClosedCaptionAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
112 {
113         auto asset = write_to_cpl_asset (node, standard, hash());
114         write_to_cpl_encryptable (asset);
115
116         if (_language) {
117                 switch (standard) {
118                 case Standard::INTEROP:
119                         asset->add_child("Language")->add_child_text(*_language);
120                         break;
121                 case Standard::SMPTE:
122                         asset->add_child("Language", "tt")->add_child_text(*_language);
123                         break;
124                 }
125         }
126
127         return asset;
128 }
129
130
131 bool
132 ReelClosedCaptionAsset::equals (shared_ptr<const ReelClosedCaptionAsset> other, EqualityOptions opt, NoteHandler note) const
133 {
134         if (!asset_equals (other, opt, note)) {
135                 return false;
136         }
137         if (!file_asset_equals (other, opt, note)) {
138                 return false;
139         }
140
141         return true;
142 }