2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
21 * @brief Utility methods.
28 #include <boost/filesystem.hpp>
29 #include <openssl/sha.h>
30 #include <libxml++/nodes/element.h>
31 #include <libxml++/document.h>
32 #include <xmlsec/xmldsig.h>
33 #include <xmlsec/dl.h>
34 #include <xmlsec/app.h>
36 #include "KM_fileio.h"
39 #include "exceptions.h"
41 #include "argb_frame.h"
43 #include "certificates.h"
47 using std::stringstream;
51 using boost::shared_ptr;
52 using namespace libdcp;
62 Kumu::GenRandomValue (id);
63 id.EncodeHex (buffer, 64);
64 return string (buffer);
68 /** Create a digest for a file.
69 * @param filename File name.
73 libdcp::make_digest (string filename)
75 Kumu::FileReader reader;
76 if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) {
77 throw FileError ("could not open file to compute digest", filename);
83 Kumu::ByteString read_buffer (65536);
87 Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read);
89 if (r == Kumu::RESULT_ENDOFFILE) {
91 } else if (ASDCP_FAILURE (r)) {
92 throw FileError ("could not read file to compute digest", filename);
95 SHA1_Update (&sha, read_buffer.Data(), read);
99 byte_t byte_buffer[20];
100 SHA1_Final (byte_buffer, &sha);
103 return Kumu::base64encode (byte_buffer, 20, digest, 64);
106 /** Convert a content kind to a string which can be used in a
107 * <ContentKind> node.
108 * @param kind ContentKind.
112 libdcp::content_kind_to_string (ContentKind kind)
124 return "transitional";
131 case PUBLIC_SERVICE_ANNOUNCEMENT:
134 return "advertisement";
140 /** Convert a string from a <ContentKind> node to a libdcp ContentKind.
141 * Reasonably tolerant about varying case.
142 * @param type Content kind string.
143 * @return libdcp ContentKind.
146 libdcp::content_kind_from_string (string type)
148 /* XXX: should probably just convert type to lower-case and have done with it */
150 if (type == "feature") {
152 } else if (type == "short") {
154 } else if (type == "trailer" || type == "Trailer") {
156 } else if (type == "test") {
158 } else if (type == "transitional") {
160 } else if (type == "rating") {
162 } else if (type == "teaser" || type == "Teaser") {
164 } else if (type == "policy") {
166 } else if (type == "psa") {
167 return PUBLIC_SERVICE_ANNOUNCEMENT;
168 } else if (type == "advertisement") {
169 return ADVERTISEMENT;
175 /** Decompress a JPEG2000 image to a bitmap.
176 * @param data JPEG2000 data.
177 * @param size Size of data in bytes.
178 * @param reduce A power of 2 by which to reduce the size of the decoded image;
179 * e.g. 0 reduces by (2^0 == 1), ie keeping the same size.
180 * 1 reduces by (2^1 == 2), ie halving the size of the image.
181 * This is useful for scaling 4K DCP images down to 2K.
182 * @return openjpeg image, which the caller must call opj_image_destroy() on.
185 libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
187 opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K);
188 opj_dparameters_t parameters;
189 opj_set_default_decoder_parameters (¶meters);
190 parameters.cp_reduce = reduce;
191 opj_setup_decoder (decoder, ¶meters);
192 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size);
193 opj_image_t* image = opj_decode (decoder, cio);
195 opj_destroy_decompress (decoder);
197 throw DCPReadError ("could not decode JPEG2000 codestream");
202 image->x1 = rint (float(image->x1) / pow (2, reduce));
203 image->y1 = rint (float(image->y1) / pow (2, reduce));
207 /** Convert an openjpeg XYZ image to RGB.
208 * @param xyz_frame Frame in XYZ.
211 shared_ptr<ARGBFrame>
212 libdcp::xyz_to_rgb (opj_image_t* xyz_frame)
222 int* xyz_x = xyz_frame->comps[0].data;
223 int* xyz_y = xyz_frame->comps[1].data;
224 int* xyz_z = xyz_frame->comps[2].data;
226 shared_ptr<ARGBFrame> argb_frame (new ARGBFrame (xyz_frame->x1, xyz_frame->y1));
228 uint8_t* argb = argb_frame->data ();
230 for (int y = 0; y < xyz_frame->y1; ++y) {
231 uint8_t* argb_line = argb;
232 for (int x = 0; x < xyz_frame->x1; ++x) {
234 assert (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_x < 4096 && *xyz_z < 4096);
237 s.x = lut_in[*xyz_x++];
238 s.y = lut_in[*xyz_y++];
239 s.z = lut_in[*xyz_z++];
242 s.x /= DCI_COEFFICIENT;
243 s.y /= DCI_COEFFICIENT;
244 s.z /= DCI_COEFFICIENT;
247 d.r = ((s.x * color_matrix[0][0]) + (s.y * color_matrix[0][1]) + (s.z * color_matrix[0][2]));
248 d.g = ((s.x * color_matrix[1][0]) + (s.y * color_matrix[1][1]) + (s.z * color_matrix[1][2]));
249 d.b = ((s.x * color_matrix[2][0]) + (s.y * color_matrix[2][1]) + (s.z * color_matrix[2][2]));
251 d.r = min (d.r, 1.0);
252 d.r = max (d.r, 0.0);
254 d.g = min (d.g, 1.0);
255 d.g = max (d.g, 0.0);
257 d.b = min (d.b, 1.0);
258 d.b = max (d.b, 0.0);
261 *argb_line++ = lut_out[(int) (d.b * COLOR_DEPTH)];
262 *argb_line++ = lut_out[(int) (d.g * COLOR_DEPTH)];
263 *argb_line++ = lut_out[(int) (d.r * COLOR_DEPTH)];
267 argb += argb_frame->stride ();
273 /** @param s A string.
274 * @return true if the string contains only space, newline or tab characters, or is empty.
277 libdcp::empty_or_white_space (string s)
279 for (size_t i = 0; i < s.length(); ++i) {
280 if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') {
291 if (xmlSecInit() < 0) {
292 throw MiscError ("could not initialise xmlsec");
295 #ifdef XMLSEC_CRYPTO_DYNAMIC_LOADING
296 if (xmlSecCryptoDLLoadLibrary (BAD_CAST XMLSEC_CRYPTO) < 0) {
297 throw MiscError ("unable to load default xmlsec-crypto library");
301 if (xmlSecCryptoAppInit (0) < 0) {
302 throw MiscError ("could not initialise crypto library");
305 if (xmlSecCryptoInit() < 0) {
306 throw MiscError ("could not initialise xmlsec-crypto");
311 libdcp::add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key, string const & ns)
313 parent->add_child("SignatureValue", ns);
315 xmlpp::Element* key_info = parent->add_child("KeyInfo", ns);
316 list<shared_ptr<Certificate> > c = certificates.leaf_to_root ();
317 for (list<shared_ptr<Certificate> >::iterator i = c.begin(); i != c.end(); ++i) {
318 xmlpp::Element* data = key_info->add_child("X509Data", ns);
321 xmlpp::Element* serial = data->add_child("X509IssuerSerial", ns);
322 serial->add_child("X509IssuerName", ns)->add_child_text(
323 Certificate::name_for_xml ((*i)->issuer())
325 serial->add_child("X509SerialNumber", ns)->add_child_text((*i)->serial());
328 data->add_child("X509Certificate", ns)->add_child_text((*i)->certificate());
331 xmlSecKeysMngrPtr keys_manager = xmlSecKeysMngrCreate();
333 throw MiscError ("could not create keys manager");
335 if (xmlSecCryptoAppDefaultKeysMngrInit (keys_manager) < 0) {
336 throw MiscError ("could not initialise keys manager");
339 xmlSecKeyPtr const key = xmlSecCryptoAppKeyLoad (signer_key.c_str(), xmlSecKeyDataFormatPem, 0, 0, 0);
341 throw MiscError ("could not load signer key");
344 if (xmlSecCryptoAppDefaultKeysMngrAdoptKey (keys_manager, key) < 0) {
345 xmlSecKeyDestroy (key);
346 throw MiscError ("could not use signer key");
349 xmlSecDSigCtx signature_context;
351 if (xmlSecDSigCtxInitialize (&signature_context, keys_manager) < 0) {
352 throw MiscError ("could not initialise XMLSEC context");
355 if (xmlSecDSigCtxSign (&signature_context, parent->cobj()) < 0) {
356 throw MiscError ("could not sign");
359 xmlSecDSigCtxFinalize (&signature_context);
360 xmlSecKeysMngrDestroy (keys_manager);
365 libdcp::add_signer (xmlpp::Element* parent, CertificateChain const & certificates, string const & ns)
367 xmlpp::Element* signer = parent->add_child("Signer");
370 xmlpp::Element* data = signer->add_child("X509Data", ns);
373 xmlpp::Element* serial_element = data->add_child("X509IssuerSerial", ns);
374 serial_element->add_child("X509IssuerName", ns)->add_child_text (
375 Certificate::name_for_xml (certificates.leaf()->issuer())
377 serial_element->add_child("X509SerialNumber", ns)->add_child_text (
378 certificates.leaf()->serial()
382 data->add_child("X509SubjectName", ns)->add_child_text (Certificate::name_for_xml (certificates.leaf()->subject()));
387 libdcp::sign (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key)
389 add_signer (parent, certificates, "dsig");
391 xmlpp::Element* signature = parent->add_child("Signature", "dsig");
394 xmlpp::Element* signed_info = signature->add_child ("SignedInfo", "dsig");
395 signed_info->add_child("CanonicalizationMethod", "dsig")->set_attribute ("Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315");
396 signed_info->add_child("SignatureMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
398 xmlpp::Element* reference = signed_info->add_child("Reference", "dsig");
399 reference->set_attribute ("URI", "");
401 xmlpp::Element* transforms = reference->add_child("Transforms", "dsig");
402 transforms->add_child("Transform", "dsig")->set_attribute (
403 "Algorithm", "http://www.w3.org/2000/09/xmldsig#enveloped-signature"
406 reference->add_child("DigestMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
407 /* This will be filled in by the signing later */
408 reference->add_child("DigestValue", "dsig");
412 add_signature_value (signature, certificates, signer_key, "dsig");