Comments.
[libdcp.git] / src / mxf_asset.cc
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file  src/asset.cc
21  *  @brief Parent class for assets of DCPs made up of MXF files.
22  */
23
24 #include <iostream>
25 #include <fstream>
26 #include <boost/filesystem.hpp>
27 #include <boost/lexical_cast.hpp>
28 #include <libxml++/nodes/element.h>
29 #include "AS_DCP.h"
30 #include "KM_prng.h"
31 #include "KM_util.h"
32 #include "mxf_asset.h"
33 #include "util.h"
34 #include "metadata.h"
35 #include "exceptions.h"
36 #include "kdm.h"
37
38 using std::string;
39 using std::list;
40 using std::pair;
41 using boost::shared_ptr;
42 using boost::lexical_cast;
43 using boost::dynamic_pointer_cast;
44 using namespace libdcp;
45
46 MXFAsset::MXFAsset (string directory, string file_name)
47         : Asset (directory, file_name)
48         , _progress (0)
49         , _encrypted (false)
50         , _encryption_context (0)
51         , _decryption_context (0)
52 {
53
54 }
55
56 MXFAsset::MXFAsset (string directory, string file_name, boost::signals2::signal<void (float)>* progress, int edit_rate, int intrinsic_duration, bool encrypted)
57         : Asset (directory, file_name, edit_rate, intrinsic_duration)
58         , _progress (progress)
59         , _encrypted (encrypted)
60         , _encryption_context (0)
61         , _decryption_context (0)
62 {
63         if (_encrypted) {
64                 /* Generate an encryption key and a UUID for it */
65                 _key_id = make_uuid ();
66                 uint8_t key_buffer[ASDCP::KeyLen];
67                 Kumu::FortunaRNG rng;
68                 rng.FillRandom (key_buffer, ASDCP::KeyLen);
69                 char key_string[ASDCP::KeyLen * 4];
70                 Kumu::bin2hex (key_buffer, ASDCP::KeyLen, key_string, ASDCP::KeyLen * 4);
71                 _key_value = key_string;
72                         
73                 _encryption_context = new ASDCP::AESEncContext;
74                 if (ASDCP_FAILURE (_encryption_context->InitKey (key_buffer))) {
75                         throw MiscError ("could not set up encryption context");
76                 }
77
78                 uint8_t cbc_buffer[ASDCP::CBC_BLOCK_SIZE];
79                 
80                 if (ASDCP_FAILURE (_encryption_context->SetIVec (rng.FillRandom (cbc_buffer, ASDCP::CBC_BLOCK_SIZE)))) {
81                         throw MiscError ("could not set up CBC initialization vector");
82                 }
83         }
84 }
85
86 MXFAsset::~MXFAsset ()
87 {
88         delete _encryption_context;
89 }
90
91 void
92 MXFAsset::fill_writer_info (ASDCP::WriterInfo* writer_info, string uuid, bool interop, MXFMetadata const & metadata)
93 {
94         writer_info->ProductVersion = metadata.product_version;
95         writer_info->CompanyName = metadata.company_name;
96         writer_info->ProductName = metadata.product_name.c_str();
97
98         if (interop) {
99                 writer_info->LabelSetType = ASDCP::LS_MXF_INTEROP;
100         } else {
101                 writer_info->LabelSetType = ASDCP::LS_MXF_SMPTE;
102         }
103         unsigned int c;
104         Kumu::hex2bin (uuid.c_str(), writer_info->AssetUUID, Kumu::UUID_Length, &c);
105         assert (c == Kumu::UUID_Length);
106
107         if (_encrypted) {
108                 Kumu::GenRandomUUID (writer_info->ContextID);
109                 writer_info->EncryptedEssence = true;
110
111                 unsigned int c;
112                 Kumu::hex2bin (_key_id.c_str(), writer_info->CryptographicKeyID, Kumu::UUID_Length, &c);
113                 assert (c == Kumu::UUID_Length);
114         }
115 }
116
117 bool
118 MXFAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
119 {
120         if (!Asset::equals (other, opt, note)) {
121                 return false;
122         }
123         
124         shared_ptr<const MXFAsset> other_mxf = dynamic_pointer_cast<const MXFAsset> (other);
125         if (!other_mxf) {
126                 note (ERROR, "comparing an MXF asset with a non-MXF asset");
127                 return false;
128         }
129         
130         if (_file_name != other_mxf->_file_name) {
131                 note (ERROR, "MXF names differ");
132                 if (!opt.mxf_names_can_differ) {
133                         return false;
134                 }
135         }
136         
137         return true;
138 }
139
140 void
141 MXFAsset::add_typed_key_id (xmlpp::Element* parent) const
142 {
143         xmlpp::Element* typed_key_id = parent->add_child("TypedKeyId");
144         typed_key_id->add_child("KeyType")->add_child_text(key_type ());
145         typed_key_id->add_child("KeyId")->add_child_text("urn:uuid:" + _key_id);
146 }
147
148 void
149 MXFAsset::write_to_cpl (xmlpp::Element* node, bool interop) const
150 {
151         pair<string, string> const attr = cpl_node_attribute (interop);
152         xmlpp::Element* a = node->add_child (cpl_node_name ());
153         if (!attr.first.empty ()) {
154                 a->set_attribute (attr.first, attr.second);
155         }
156         a->add_child ("Id")->add_child_text ("urn:uuid:" + _uuid);
157         a->add_child ("AnnotationText")->add_child_text (_file_name);
158         a->add_child ("EditRate")->add_child_text (lexical_cast<string> (_edit_rate) + " 1");
159         a->add_child ("IntrinsicDuration")->add_child_text (lexical_cast<string> (_intrinsic_duration));
160         a->add_child ("EntryPoint")->add_child_text (lexical_cast<string> (_entry_point));
161         a->add_child ("Duration")->add_child_text (lexical_cast<string> (_duration));
162         if (_encrypted) {
163                 a->add_child("KeyId")->add_child_text ("urn:uuid:" + _key_id);
164         }
165 }
166
167 void
168 MXFAsset::set_kdm_cipher (KDMCipher cipher)
169 {
170         _decryption_context = new ASDCP::AESDecContext;
171         if (ASDCP_FAILURE (_decryption_context->InitKey (cipher.key_raw ()))) {
172                 throw MiscError ("could not set up decryption context");
173         }
174 }