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 <boost/lexical_cast.hpp>
30 #include <openssl/sha.h>
31 #include <libxml++/nodes/element.h>
32 #include <libxml++/document.h>
33 #include <xmlsec/xmldsig.h>
34 #include <xmlsec/dl.h>
35 #include <xmlsec/app.h>
37 #include "KM_fileio.h"
40 #include "exceptions.h"
42 #include "argb_frame.h"
43 #include "certificates.h"
44 #include "gamma_lut.h"
48 using std::stringstream;
52 using boost::shared_ptr;
53 using boost::lexical_cast;
54 using namespace libdcp;
64 Kumu::GenRandomValue (id);
65 id.EncodeHex (buffer, 64);
66 return string (buffer);
70 /** Create a digest for a file.
71 * @param filename File name.
75 libdcp::make_digest (string filename)
77 Kumu::FileReader reader;
78 if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) {
79 boost::throw_exception (FileError ("could not open file to compute digest", filename));
85 Kumu::ByteString read_buffer (65536);
89 Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read);
91 if (r == Kumu::RESULT_ENDOFFILE) {
93 } else if (ASDCP_FAILURE (r)) {
94 boost::throw_exception (FileError ("could not read file to compute digest", filename));
97 SHA1_Update (&sha, read_buffer.Data(), read);
101 byte_t byte_buffer[20];
102 SHA1_Final (byte_buffer, &sha);
105 return Kumu::base64encode (byte_buffer, 20, digest, 64);
108 /** Convert a content kind to a string which can be used in a
109 * <ContentKind> node.
110 * @param kind ContentKind.
114 libdcp::content_kind_to_string (ContentKind kind)
126 return "transitional";
133 case PUBLIC_SERVICE_ANNOUNCEMENT:
136 return "advertisement";
142 /** Convert a string from a <ContentKind> node to a libdcp ContentKind.
143 * Reasonably tolerant about varying case.
144 * @param type Content kind string.
145 * @return libdcp ContentKind.
148 libdcp::content_kind_from_string (string type)
150 /* XXX: should probably just convert type to lower-case and have done with it */
152 if (type == "feature") {
154 } else if (type == "short") {
156 } else if (type == "trailer" || type == "Trailer") {
158 } else if (type == "test") {
160 } else if (type == "transitional") {
162 } else if (type == "rating") {
164 } else if (type == "teaser" || type == "Teaser") {
166 } else if (type == "policy") {
168 } else if (type == "psa") {
169 return PUBLIC_SERVICE_ANNOUNCEMENT;
170 } else if (type == "advertisement") {
171 return ADVERTISEMENT;
177 /** Decompress a JPEG2000 image to a bitmap.
178 * @param data JPEG2000 data.
179 * @param size Size of data in bytes.
180 * @param reduce A power of 2 by which to reduce the size of the decoded image;
181 * e.g. 0 reduces by (2^0 == 1), ie keeping the same size.
182 * 1 reduces by (2^1 == 2), ie halving the size of the image.
183 * This is useful for scaling 4K DCP images down to 2K.
184 * @return openjpeg image, which the caller must call opj_image_destroy() on.
187 libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
189 opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K);
190 opj_dparameters_t parameters;
191 opj_set_default_decoder_parameters (¶meters);
192 parameters.cp_reduce = reduce;
193 opj_setup_decoder (decoder, ¶meters);
194 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size);
195 opj_image_t* image = opj_decode (decoder, cio);
197 opj_destroy_decompress (decoder);
199 boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream of " + lexical_cast<string> (size) + " bytes."));
204 image->x1 = rint (float(image->x1) / pow (2, reduce));
205 image->y1 = rint (float(image->y1) / pow (2, reduce));
209 /** Convert an openjpeg XYZ image to RGB.
210 * @param xyz_frame Frame in XYZ.
213 shared_ptr<ARGBFrame>
214 libdcp::xyz_to_rgb (opj_image_t* xyz_frame, shared_ptr<const GammaLUT> lut_in, shared_ptr<const GammaLUT> lut_out)
216 float const dci_coefficient = 48.0 / 52.37;
218 /* sRGB color matrix for XYZ -> RGB. This is the same as the one used by the Fraunhofer
219 EasyDCP player, I think.
222 float const colour_matrix[3][3] = {
223 { 3.24096989631653, -1.5373831987381, -0.498610764741898 },
224 { -0.96924364566803, 1.87596750259399, 0.0415550582110882 },
225 { 0.0556300804018974, -0.203976958990097, 1.05697154998779 }
228 int const max_colour = pow (2, lut_out->bit_depth()) - 1;
238 int* xyz_x = xyz_frame->comps[0].data;
239 int* xyz_y = xyz_frame->comps[1].data;
240 int* xyz_z = xyz_frame->comps[2].data;
242 shared_ptr<ARGBFrame> argb_frame (new ARGBFrame (Size (xyz_frame->x1, xyz_frame->y1)));
244 uint8_t* argb = argb_frame->data ();
246 for (int y = 0; y < xyz_frame->y1; ++y) {
247 uint8_t* argb_line = argb;
248 for (int x = 0; x < xyz_frame->x1; ++x) {
250 assert (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_x < 4096 && *xyz_z < 4096);
253 s.x = lut_in->lut()[*xyz_x++];
254 s.y = lut_in->lut()[*xyz_y++];
255 s.z = lut_in->lut()[*xyz_z++];
258 s.x /= dci_coefficient;
259 s.y /= dci_coefficient;
260 s.z /= dci_coefficient;
263 d.r = ((s.x * colour_matrix[0][0]) + (s.y * colour_matrix[0][1]) + (s.z * colour_matrix[0][2]));
264 d.g = ((s.x * colour_matrix[1][0]) + (s.y * colour_matrix[1][1]) + (s.z * colour_matrix[1][2]));
265 d.b = ((s.x * colour_matrix[2][0]) + (s.y * colour_matrix[2][1]) + (s.z * colour_matrix[2][2]));
267 d.r = min (d.r, 1.0);
268 d.r = max (d.r, 0.0);
270 d.g = min (d.g, 1.0);
271 d.g = max (d.g, 0.0);
273 d.b = min (d.b, 1.0);
274 d.b = max (d.b, 0.0);
277 *argb_line++ = lut_out->lut()[(int) (d.b * max_colour)] * 0xff;
278 *argb_line++ = lut_out->lut()[(int) (d.g * max_colour)] * 0xff;
279 *argb_line++ = lut_out->lut()[(int) (d.r * max_colour)] * 0xff;
283 argb += argb_frame->stride ();
289 /** @param s A string.
290 * @return true if the string contains only space, newline or tab characters, or is empty.
293 libdcp::empty_or_white_space (string s)
295 for (size_t i = 0; i < s.length(); ++i) {
296 if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') {
307 if (xmlSecInit() < 0) {
308 throw MiscError ("could not initialise xmlsec");
311 #ifdef XMLSEC_CRYPTO_DYNAMIC_LOADING
312 if (xmlSecCryptoDLLoadLibrary (BAD_CAST XMLSEC_CRYPTO) < 0) {
313 throw MiscError ("unable to load default xmlsec-crypto library");
317 if (xmlSecCryptoAppInit (0) < 0) {
318 throw MiscError ("could not initialise crypto library");
321 if (xmlSecCryptoInit() < 0) {
322 throw MiscError ("could not initialise xmlsec-crypto");
327 libdcp::add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key, string const & ns)
329 parent->add_child("SignatureValue", ns);
331 xmlpp::Element* key_info = parent->add_child("KeyInfo", ns);
332 list<shared_ptr<Certificate> > c = certificates.leaf_to_root ();
333 for (list<shared_ptr<Certificate> >::iterator i = c.begin(); i != c.end(); ++i) {
334 xmlpp::Element* data = key_info->add_child("X509Data", ns);
337 xmlpp::Element* serial = data->add_child("X509IssuerSerial", ns);
338 serial->add_child("X509IssuerName", ns)->add_child_text(
339 Certificate::name_for_xml ((*i)->issuer())
341 serial->add_child("X509SerialNumber", ns)->add_child_text((*i)->serial());
344 data->add_child("X509Certificate", ns)->add_child_text((*i)->certificate());
347 xmlSecKeysMngrPtr keys_manager = xmlSecKeysMngrCreate();
349 throw MiscError ("could not create keys manager");
351 if (xmlSecCryptoAppDefaultKeysMngrInit (keys_manager) < 0) {
352 throw MiscError ("could not initialise keys manager");
355 xmlSecKeyPtr const key = xmlSecCryptoAppKeyLoad (signer_key.c_str(), xmlSecKeyDataFormatPem, 0, 0, 0);
357 throw MiscError ("could not load signer key");
360 if (xmlSecCryptoAppDefaultKeysMngrAdoptKey (keys_manager, key) < 0) {
361 xmlSecKeyDestroy (key);
362 throw MiscError ("could not use signer key");
365 xmlSecDSigCtx signature_context;
367 if (xmlSecDSigCtxInitialize (&signature_context, keys_manager) < 0) {
368 throw MiscError ("could not initialise XMLSEC context");
371 if (xmlSecDSigCtxSign (&signature_context, parent->cobj()) < 0) {
372 throw MiscError ("could not sign");
375 xmlSecDSigCtxFinalize (&signature_context);
376 xmlSecKeysMngrDestroy (keys_manager);
381 libdcp::add_signer (xmlpp::Element* parent, CertificateChain const & certificates, string const & ns)
383 xmlpp::Element* signer = parent->add_child("Signer");
386 xmlpp::Element* data = signer->add_child("X509Data", ns);
389 xmlpp::Element* serial_element = data->add_child("X509IssuerSerial", ns);
390 serial_element->add_child("X509IssuerName", ns)->add_child_text (
391 Certificate::name_for_xml (certificates.leaf()->issuer())
393 serial_element->add_child("X509SerialNumber", ns)->add_child_text (
394 certificates.leaf()->serial()
398 data->add_child("X509SubjectName", ns)->add_child_text (Certificate::name_for_xml (certificates.leaf()->subject()));
403 libdcp::sign (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key)
405 add_signer (parent, certificates, "dsig");
407 xmlpp::Element* signature = parent->add_child("Signature", "dsig");
410 xmlpp::Element* signed_info = signature->add_child ("SignedInfo", "dsig");
411 signed_info->add_child("CanonicalizationMethod", "dsig")->set_attribute ("Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315");
412 signed_info->add_child("SignatureMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
414 xmlpp::Element* reference = signed_info->add_child("Reference", "dsig");
415 reference->set_attribute ("URI", "");
417 xmlpp::Element* transforms = reference->add_child("Transforms", "dsig");
418 transforms->add_child("Transform", "dsig")->set_attribute (
419 "Algorithm", "http://www.w3.org/2000/09/xmldsig#enveloped-signature"
422 reference->add_child("DigestMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
423 /* This will be filled in by the signing later */
424 reference->add_child("DigestValue", "dsig");
428 add_signature_value (signature, certificates, signer_key, "dsig");
431 bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b)
433 return (a.width == b.width && a.height == b.height);
436 bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b)