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