X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.cc;h=4be026d28f0c35d9c0c0d3123a36bc752bf16162;hb=f9862aff32f7ea5aa10f9362d7598480b1c9cf28;hp=d5565245726ca43ae17483b6c9bdf1938277baf0;hpb=1c4257eacfe62f30f3e08edfe049a954cd7b43a3;p=libdcp.git diff --git a/src/util.cc b/src/util.cc index d5565245..4be026d2 100644 --- a/src/util.cc +++ b/src/util.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -21,34 +21,47 @@ * @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 "certificates.h" #include "gamma_lut.h" -#include "xyz_srgb_lut.h" +#include "xyz_frame.h" +#include "compose.hpp" +#include "KM_util.h" +#include "KM_fileio.h" +#include "AS_DCP.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include using std::string; +using std::wstring; +using std::cout; using std::stringstream; using std::min; using std::max; +using std::list; +using std::setw; +using std::setfill; using boost::shared_ptr; -using namespace libdcp; +using namespace dcp; /** Create a UUID. * @return UUID. */ string -libdcp::make_uuid () +dcp::make_uuid () { char buffer[64]; Kumu::UUID id; @@ -60,21 +73,27 @@ libdcp::make_uuid () /** Create a digest for a file. * @param filename File name. + * @param progress Pointer to a progress reporting function, or 0. 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, boost::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); @@ -82,28 +101,31 @@ libdcp::make_digest (string filename) 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: @@ -131,35 +153,35 @@ libdcp::content_kind_to_string (ContentKind kind) 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 */ + transform (kind.begin(), kind.end(), kind.begin(), ::tolower); - if (type == "feature") { + 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; } @@ -173,10 +195,10 @@ libdcp::content_kind_from_string (string type) * 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. + * @return XYZ image. */ -opj_image_t * -libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce) +shared_ptr +dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce) { opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K); opj_dparameters_t parameters; @@ -188,117 +210,200 @@ libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce) if (!image) { opj_destroy_decompress (decoder); opj_cio_close (cio); - boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream")); + boost::throw_exception (DCPReadError (String::compose ("could not decode JPEG2000 codestream of %1 bytes.", size))); } + opj_destroy_decompress (decoder); opj_cio_close (cio); image->x1 = rint (float(image->x1) / pow (2, reduce)); image->y1 = rint (float(image->y1) / pow (2, reduce)); - return image; + return shared_ptr (new XYZFrame (image)); } -/** Convert an openjpeg XYZ image to RGB. - * @param xyz_frame Frame in XYZ. - * @return RGB image. +/** @param s A string. + * @return true if the string contains only space, newline or tab characters, or is empty. */ -shared_ptr -libdcp::xyz_to_rgb (opj_image_t* xyz_frame, shared_ptr lut_in, shared_ptr lut_out) +bool +dcp::empty_or_white_space (string s) { - float const dci_coefficient = 48.0 / 52.37; + for (size_t i = 0; i < s.length(); ++i) { + if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { + return false; + } + } - /* sRGB color matrix for XYZ -> RGB */ - float const colour_matrix[3][3] = { - { 3.240454836, -1.537138850, -0.498531547}, - {-0.969266390, 1.876010929, 0.041556082}, - { 0.055643420, -0.204025854, 1.057225162} - }; + return true; +} - int const max_colour = pow (2, lut_out->bit_depth()) - 1; +/** 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"); + } - 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; +#ifdef XMLSEC_CRYPTO_DYNAMIC_LOADING + if (xmlSecCryptoDLLoadLibrary(BAD_CAST XMLSEC_CRYPTO) < 0) { + throw MiscError ("unable to load default xmlsec-crypto library"); + } +#endif - shared_ptr argb_frame (new ARGBFrame (Size (xyz_frame->x1, xyz_frame->y1))); + if (xmlSecCryptoAppInit(0) < 0) { + throw MiscError ("could not initialise crypto"); + } - 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++]; - -#if 0 - /* DCI companding */ - s.x /= dci_coefficient; - s.y /= dci_coefficient; - s.z /= dci_coefficient; -#endif - - /* 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; - } - - argb += argb_frame->stride (); + if (xmlSecCryptoInit() < 0) { + throw MiscError ("could not initialise xmlsec-crypto"); } +} - return argb_frame; +bool dcp::operator== (dcp::Size const & a, dcp::Size const & b) +{ + return (a.width == b.width && a.height == b.height); } -/** @param s A string. - * @return true if the string contains only space, newline or tab characters, or is empty. +bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b) +{ + return !(a == b); +} + +/** 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. */ -bool -libdcp::empty_or_white_space (string s) +int +dcp::base64_decode (string const & in, unsigned char* out, int out_length) { - for (size_t i = 0; i < s.length(); ++i) { - if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { - return false; + 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]; } } + + 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 true; + return N; } -bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b) +/** Convert a struct tm to a string of the form + * 2014-01-26T21:39:00+01:00 + * @param tm struct tm. + * @return Time as a string. + */ +string +dcp::tm_to_string (struct tm* tm) { - return (a.width == b.width && a.height == b.height); + char buffer[64]; + strftime (buffer, 64, "%Y-%m-%dT%H:%M:%S", tm); + + int offset = 0; + +#ifdef LIBDCP_POSIX + offset = tm->tm_gmtoff / 60; +#else + TIME_ZONE_INFORMATION tz; + GetTimeZoneInformation (&tz); + offset = tz.Bias; +#endif + + return string (buffer) + utc_offset_to_string (offset); } -bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b) +/** @param b Offset from UTC to local time in minutes. + * @return string of the form e.g. -01:00. + */ +string +dcp::utc_offset_to_string (int b) { - return !(a == b); + bool const negative = (b < 0); + b = negative ? -b : b; + + int const hours = b / 60; + int const minutes = b % 60; + + stringstream o; + if (negative) { + o << "-"; + } else { + o << "+"; + } + + o << setw(2) << setfill('0') << hours << ":" << setw(2) << setfill('0') << minutes; + return o.str (); +} + +/** Convert a boost::posix_time::ptime to a string of the form + * 2014-01-26T21:39:00+01:00. + * @param t boost::posix_time::ptime. + * @return Time as a string. + */ +string +dcp::ptime_to_string (boost::posix_time::ptime t) +{ + struct tm t_tm = boost::posix_time::to_tm (t); + return tm_to_string (&t_tm); } + +/** @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 +} + +boost::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 boost::optional (); + } + + boost::filesystem::path rel; + while (j != file.end ()) { + rel /= *j++; + } + + return rel; +}