X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.cc;h=15b833a1b01f7fff5dc6cbda54342845570832d0;hb=fe83eb5293fa4027856f6ee9faec7bfc8288badf;hp=2fae85611d7204ee7c54290f3b7c8409b10004bd;hpb=ab3163255b9713fc40a73fcfc3753b62ee084b8d;p=libdcp.git diff --git a/src/util.cc b/src/util.cc index 2fae8561..15b833a1 100644 --- a/src/util.cc +++ b/src/util.cc @@ -1,54 +1,84 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ /** @file src/util.cc * @brief Utility methods. */ -#include -#include -#include -#include -#include -#include -#include "KM_util.h" -#include "KM_fileio.h" -#include "AS_DCP.h" #include "util.h" #include "exceptions.h" #include "types.h" -#include "argb_frame.h" -#include "gamma_lut.h" -#include "xyz_srgb_lut.h" +#include "certificate.h" +#include "openjpeg_image.h" +#include "dcp_assert.h" +#include "compose.hpp" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include using std::string; -using std::stringstream; +using std::wstring; +using std::cout; using std::min; using std::max; +using std::list; +using std::setw; +using std::setfill; +using std::ostream; using boost::shared_ptr; -using namespace libdcp; +using boost::shared_array; +using boost::optional; +using boost::function; +using boost::algorithm::trim; +using namespace dcp; /** Create a UUID. * @return UUID. */ string -libdcp::make_uuid () +dcp::make_uuid () { char buffer[64]; Kumu::UUID id; @@ -60,50 +90,59 @@ libdcp::make_uuid () /** Create a digest for a file. * @param filename File name. + * @param progress Optional progress reporting function. The function will be called + * with a progress value between 0 and 1. * @return Digest. */ string -libdcp::make_digest (string filename) +dcp::make_digest (boost::filesystem::path filename, function progress) { Kumu::FileReader reader; - if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) { - boost::throw_exception (FileError ("could not open file to compute digest", filename)); + Kumu::Result_t r = reader.OpenRead (filename.string().c_str ()); + if (ASDCP_FAILURE (r)) { + boost::throw_exception (FileError ("could not open file to compute digest", filename, r)); } - + SHA_CTX sha; SHA1_Init (&sha); - - Kumu::ByteString read_buffer (65536); - int done = 0; + + int const buffer_size = 65536; + Kumu::ByteString read_buffer (buffer_size); + + Kumu::fsize_t done = 0; + Kumu::fsize_t const size = reader.Size (); while (1) { ui32_t read = 0; Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read); - + if (r == Kumu::RESULT_ENDOFFILE) { break; } else if (ASDCP_FAILURE (r)) { - boost::throw_exception (FileError ("could not read file to compute digest", filename)); + boost::throw_exception (FileError ("could not read file to compute digest", filename, r)); } - + SHA1_Update (&sha, read_buffer.Data(), read); - done += read; + + if (progress) { + progress (float (done) / size); + done += read; + } } - byte_t byte_buffer[20]; + byte_t byte_buffer[SHA_DIGEST_LENGTH]; SHA1_Final (byte_buffer, &sha); - stringstream s; char digest[64]; - return Kumu::base64encode (byte_buffer, 20, digest, 64); + return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); } /** Convert a content kind to a string which can be used in a - * node. + * <ContentKind> node. * @param kind ContentKind. * @return string. */ string -libdcp::content_kind_to_string (ContentKind kind) +dcp::content_kind_to_string (ContentKind kind) { switch (kind) { case FEATURE: @@ -128,176 +167,249 @@ libdcp::content_kind_to_string (ContentKind kind) return "advertisement"; } - assert (false); + DCP_ASSERT (false); } -/** Convert a string from a node to a libdcp ContentKind. +/** Convert a string from a <ContentKind> node to a libdcp ContentKind. * Reasonably tolerant about varying case. - * @param type Content kind string. + * @param kind Content kind string. * @return libdcp ContentKind. */ -libdcp::ContentKind -libdcp::content_kind_from_string (string type) +dcp::ContentKind +dcp::content_kind_from_string (string kind) { - /* XXX: should probably just convert type to lower-case and have done with it */ - - if (type == "feature") { + transform (kind.begin(), kind.end(), kind.begin(), ::tolower); + + if (kind == "feature") { return FEATURE; - } else if (type == "short") { + } else if (kind == "short") { return SHORT; - } else if (type == "trailer" || type == "Trailer") { + } else if (kind == "trailer") { return TRAILER; - } else if (type == "test") { + } else if (kind == "test") { return TEST; - } else if (type == "transitional") { + } else if (kind == "transitional") { return TRANSITIONAL; - } else if (type == "rating") { + } else if (kind == "rating") { return RATING; - } else if (type == "teaser" || type == "Teaser") { + } else if (kind == "teaser") { return TEASER; - } else if (type == "policy") { + } else if (kind == "policy") { return POLICY; - } else if (type == "psa") { + } else if (kind == "psa") { return PUBLIC_SERVICE_ANNOUNCEMENT; - } else if (type == "advertisement") { + } else if (kind == "advertisement") { return ADVERTISEMENT; } - assert (false); + DCP_ASSERT (false); } -/** Decompress a JPEG2000 image to a bitmap. - * @param data JPEG2000 data. - * @param size Size of data in bytes. - * @param reduce A power of 2 by which to reduce the size of the decoded image; - * e.g. 0 reduces by (2^0 == 1), ie keeping the same size. - * 1 reduces by (2^1 == 2), ie halving the size of the image. - * This is useful for scaling 4K DCP images down to 2K. - * @return openjpeg image, which the caller must call opj_image_destroy() on. +/** @param s A string. + * @return true if the string contains only space, newline or tab characters, or is empty. */ -opj_image_t * -libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce) +bool +dcp::empty_or_white_space (string s) { - opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K); - opj_dparameters_t parameters; - opj_set_default_decoder_parameters (¶meters); - parameters.cp_reduce = reduce; - opj_setup_decoder (decoder, ¶meters); - opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size); - opj_image_t* image = opj_decode (decoder, cio); - if (!image) { - opj_destroy_decompress (decoder); - opj_cio_close (cio); - boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream")); + for (size_t i = 0; i < s.length(); ++i) { + if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { + return false; + } + } + + return true; +} + +/** Set up various bits that the library needs. Should be called one + * by client applications. + */ +void +dcp::init () +{ + if (xmlSecInit() < 0) { + throw MiscError ("could not initialise xmlsec"); + } + +#ifdef XMLSEC_CRYPTO_DYNAMIC_LOADING + if (xmlSecCryptoDLLoadLibrary(BAD_CAST XMLSEC_CRYPTO) < 0) { + throw MiscError ("unable to load default xmlsec-crypto library"); } +#endif - opj_cio_close (cio); + if (xmlSecCryptoAppInit(0) < 0) { + throw MiscError ("could not initialise crypto"); + } + + if (xmlSecCryptoInit() < 0) { + throw MiscError ("could not initialise xmlsec-crypto"); + } +} + +bool dcp::operator== (dcp::Size const & a, dcp::Size const & b) +{ + return (a.width == b.width && a.height == b.height); +} + +bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b) +{ + return !(a == b); +} - image->x1 = rint (float(image->x1) / pow (2, reduce)); - image->y1 = rint (float(image->y1) / pow (2, reduce)); - return image; +ostream& dcp::operator<< (ostream& s, dcp::Size const & a) +{ + s << a.width << "x" << a.height; + return s; } -/** Convert an openjpeg XYZ image to RGB. - * @param xyz_frame Frame in XYZ. - * @return RGB image. +/** Decode a base64 string. The base64 decode routine in KM_util.cpp + * gives different values to both this and the command-line base64 + * for some inputs. Not sure why. + * + * @param in base64-encoded string. + * @param out Output buffer. + * @param out_length Length of output buffer. + * @return Number of characters written to the output buffer. */ -shared_ptr -libdcp::xyz_to_rgb (opj_image_t* xyz_frame, shared_ptr lut_in, shared_ptr lut_out) +int +dcp::base64_decode (string const & in, unsigned char* out, int out_length) { - float const dci_coefficient = 48.0 / 52.37; - - /* sRGB color matrix for XYZ -> RGB */ - - float const colour_matrix[3][3] = { - { 3.24096989631653, -1.5373831987381, -0.498610764741898 }, - { -0.96924364566803, 1.87596750259399, 0.0415550582110882 }, - { 0.0556300804018974, -0.203976958990097, 1.05697154998779 } - }; - - int const max_colour = pow (2, lut_out->bit_depth()) - 1; - - struct { - double x, y, z; - } s; - - struct { - double r, g, b; - } d; - - int* xyz_x = xyz_frame->comps[0].data; - int* xyz_y = xyz_frame->comps[1].data; - int* xyz_z = xyz_frame->comps[2].data; - - shared_ptr argb_frame (new ARGBFrame (Size (xyz_frame->x1, xyz_frame->y1))); - - uint8_t* argb = argb_frame->data (); - - for (int y = 0; y < xyz_frame->y1; ++y) { - uint8_t* argb_line = argb; - for (int x = 0; x < xyz_frame->x1; ++x) { - - assert (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_x < 4096 && *xyz_z < 4096); - - /* In gamma LUT */ - s.x = lut_in->lut()[*xyz_x++]; - s.y = lut_in->lut()[*xyz_y++]; - s.z = lut_in->lut()[*xyz_z++]; - - /* DCI companding */ - s.x /= dci_coefficient; - s.y /= dci_coefficient; - s.z /= dci_coefficient; - - /* XYZ to RGB */ - d.r = ((s.x * colour_matrix[0][0]) + (s.y * colour_matrix[0][1]) + (s.z * colour_matrix[0][2])); - d.g = ((s.x * colour_matrix[1][0]) + (s.y * colour_matrix[1][1]) + (s.z * colour_matrix[1][2])); - d.b = ((s.x * colour_matrix[2][0]) + (s.y * colour_matrix[2][1]) + (s.z * colour_matrix[2][2])); - - d.r = min (d.r, 1.0); - d.r = max (d.r, 0.0); - - d.g = min (d.g, 1.0); - d.g = max (d.g, 0.0); - - d.b = min (d.b, 1.0); - d.b = max (d.b, 0.0); - - /* Out gamma LUT */ - *argb_line++ = lut_out->lut()[(int) (d.b * max_colour)]; - *argb_line++ = lut_out->lut()[(int) (d.g * max_colour)]; - *argb_line++ = lut_out->lut()[(int) (d.r * max_colour)]; - *argb_line++ = 0xff; + BIO* b64 = BIO_new (BIO_f_base64 ()); + + /* This means the input should have no newlines */ + BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL); + + /* Copy our input string, removing newlines */ + char in_buffer[in.size() + 1]; + char* p = in_buffer; + for (size_t i = 0; i < in.size(); ++i) { + if (in[i] != '\n' && in[i] != '\r') { + *p++ = in[i]; } - - argb += argb_frame->stride (); } - return argb_frame; + BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer); + bmem = BIO_push (b64, bmem); + int const N = BIO_read (bmem, out, out_length); + BIO_free_all (bmem); + + return N; } -/** @param s A string. - * @return true if the string contains only space, newline or tab characters, or is empty. +/** @param p Path to open. + * @param t mode flags, as for fopen(3). + * @return FILE pointer or 0 on error. + * + * Apparently there is no way to create an ofstream using a UTF-8 + * filename under Windows. We are hence reduced to using fopen + * with this wrapper. */ +FILE * +dcp::fopen_boost (boost::filesystem::path p, string t) +{ +#ifdef LIBDCP_WINDOWS + wstring w (t.begin(), t.end()); + /* c_str() here should give a UTF-16 string */ + return _wfopen (p.c_str(), w.c_str ()); +#else + return fopen (p.c_str(), t.c_str ()); +#endif +} + +optional +dcp::relative_to_root (boost::filesystem::path root, boost::filesystem::path file) +{ + boost::filesystem::path::const_iterator i = root.begin (); + boost::filesystem::path::const_iterator j = file.begin (); + + while (i != root.end() && j != file.end() && *i == *j) { + ++i; + ++j; + } + + if (i != root.end ()) { + return optional (); + } + + boost::filesystem::path rel; + while (j != file.end ()) { + rel /= *j++; + } + + return rel; +} + bool -libdcp::empty_or_white_space (string s) +dcp::ids_equal (string a, string b) { - for (size_t i = 0; i < s.length(); ++i) { - if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { - return false; - } + transform (a.begin(), a.end(), a.begin(), ::tolower); + transform (b.begin(), b.end(), b.begin(), ::tolower); + trim (a); + trim (b); + return a == b; +} + +string +dcp::file_to_string (boost::filesystem::path p, uintmax_t max_length) +{ + uintmax_t len = boost::filesystem::file_size (p); + if (len > max_length) { + throw MiscError (String::compose ("Unexpectedly long file (%1)", p.string())); } - return true; + FILE* f = fopen_boost (p, "r"); + if (!f) { + throw FileError ("could not open file", p, errno); + } + + char* c = new char[len]; + /* This may read less than `len' if we are on Windows and we have CRLF in the file */ + int const N = fread (c, 1, len, f); + fclose (f); + + string s (c, N); + delete[] c; + + return s; } -bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b) +/** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...) + * @return SHA1 fingerprint of key + */ +string +dcp::private_key_fingerprint (string key) { - return (a.width == b.width && a.height == b.height); + boost::replace_all (key, "-----BEGIN RSA PRIVATE KEY-----\n", ""); + boost::replace_all (key, "\n-----END RSA PRIVATE KEY-----\n", ""); + + unsigned char buffer[4096]; + int const N = base64_decode (key, buffer, sizeof (buffer)); + + SHA_CTX sha; + SHA1_Init (&sha); + SHA1_Update (&sha, buffer, N); + uint8_t digest[20]; + SHA1_Final (digest, &sha); + + char digest_base64[64]; + return Kumu::base64encode (digest, 20, digest_base64, 64); } -bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b) +xmlpp::Node * +dcp::find_child (xmlpp::Node const * node, string name) { - return !(a == b); + xmlpp::Node::NodeList c = node->get_children (); + xmlpp::Node::NodeList::iterator i = c.begin(); + while (i != c.end() && (*i)->get_name() != name) { + ++i; + } + + DCP_ASSERT (i != c.end ()); + return *i; } +string +dcp::remove_urn_uuid (string raw) +{ + DCP_ASSERT (raw.substr(0, 9) == "urn:uuid:"); + return raw.substr (9); +}