X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.cc;h=f775c5074d317907c96c6c41c21da7ed634f9592;hb=e668388d1a552c845dbe9ae3cdcdfd979f2da582;hp=1e32fbc9f6ce36ea95eaaa36b0751bc373a0c667;hpb=bfb33feb40c5b014e9eae3958b1ecb8161f1d090;p=libdcp.git diff --git a/src/util.cc b/src/util.cc index 1e32fbc9..f775c507 100644 --- a/src/util.cc +++ b/src/util.cc @@ -1,20 +1,34 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2020 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 @@ -22,16 +36,17 @@ */ #include "util.h" +#include "language_tag.h" #include "exceptions.h" #include "types.h" -#include "argb_frame.h" -#include "certificates.h" -#include "gamma_lut.h" -#include "xyz_frame.h" +#include "certificate.h" +#include "openjpeg_image.h" +#include "dcp_assert.h" #include "compose.hpp" -#include "KM_util.h" -#include "KM_fileio.h" -#include "AS_DCP.h" +#include +#include +#include +#include #include #include #include @@ -40,26 +55,35 @@ #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 std::ostream; -using boost::shared_ptr; +using std::shared_ptr; +using std::vector; +using boost::shared_array; using boost::optional; using boost::function; +using boost::algorithm::trim; using namespace dcp; + +/* Some ASDCP objects store this as a *&, for reasons which are not + * at all clear, so we have to keep this around forever. + */ +ASDCP::Dictionary const* dcp::asdcp_smpte_dict = 0; + + /** Create a UUID. * @return UUID. */ @@ -73,6 +97,17 @@ dcp::make_uuid () return string (buffer); } +string +dcp::make_digest (ArrayData data) +{ + SHA_CTX sha; + SHA1_Init (&sha); + SHA1_Update (&sha, data.data(), data.size()); + byte_t byte_buffer[SHA_DIGEST_LENGTH]; + SHA1_Final (byte_buffer, &sha); + char digest[64]; + return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); +} /** Create a digest for a file. * @param filename File name. @@ -88,7 +123,7 @@ dcp::make_digest (boost::filesystem::path filename, function progr if (ASDCP_FAILURE (r)) { boost::throw_exception (FileError ("could not open file to compute digest", filename, r)); } - + SHA_CTX sha; SHA1_Init (&sha); @@ -100,13 +135,13 @@ dcp::make_digest (boost::filesystem::path filename, function progr 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, r)); } - + SHA1_Update (&sha, read_buffer.Data(), read); if (progress) { @@ -122,108 +157,6 @@ dcp::make_digest (boost::filesystem::path filename, function progr return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); } -/** Convert a content kind to a string which can be used in a - * <ContentKind> node. - * @param kind ContentKind. - * @return string. - */ -string -dcp::content_kind_to_string (ContentKind kind) -{ - switch (kind) { - case FEATURE: - return "feature"; - case SHORT: - return "short"; - case TRAILER: - return "trailer"; - case TEST: - return "test"; - case TRANSITIONAL: - return "transitional"; - case RATING: - return "rating"; - case TEASER: - return "teaser"; - case POLICY: - return "policy"; - case PUBLIC_SERVICE_ANNOUNCEMENT: - return "psa"; - case ADVERTISEMENT: - return "advertisement"; - } - - assert (false); -} - -/** Convert a string from a <ContentKind> node to a libdcp ContentKind. - * Reasonably tolerant about varying case. - * @param kind Content kind string. - * @return libdcp ContentKind. - */ -dcp::ContentKind -dcp::content_kind_from_string (string kind) -{ - transform (kind.begin(), kind.end(), kind.begin(), ::tolower); - - if (kind == "feature") { - return FEATURE; - } else if (kind == "short") { - return SHORT; - } else if (kind == "trailer") { - return TRAILER; - } else if (kind == "test") { - return TEST; - } else if (kind == "transitional") { - return TRANSITIONAL; - } else if (kind == "rating") { - return RATING; - } else if (kind == "teaser") { - return TEASER; - } else if (kind == "policy") { - return POLICY; - } else if (kind == "psa") { - return PUBLIC_SERVICE_ANNOUNCEMENT; - } else if (kind == "advertisement") { - return ADVERTISEMENT; - } - - 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 XYZ image. - */ -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; - 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 (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 shared_ptr (new XYZFrame (image)); -} - /** @param s A string. * @return true if the string contains only space, newline or tab characters, or is empty. */ @@ -239,21 +172,25 @@ dcp::empty_or_white_space (string s) return true; } -/** Set up various bits that the library needs. Should be called one +/** Set up various bits that the library needs. Should be called once * by client applications. + * + * @param tags_directory Path to a copy of the tags directory from the source code; + * if none is specified libdcp will look for a tags directory inside the environment + * variable LIBDCP_SHARE_PREFIX or the LIBDCP_SHARE_PREFIX #defined during the build. */ void -dcp::init () +dcp::init (optional tags_directory) { 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"); + if (xmlSecCryptoDLLoadLibrary(BAD_CAST "openssl") < 0) { + throw MiscError ("unable to load openssl xmlsec-crypto library"); } -#endif +#endif if (xmlSecCryptoAppInit(0) < 0) { throw MiscError ("could not initialise crypto"); @@ -262,22 +199,21 @@ dcp::init () 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); -} + OpenSSL_add_all_algorithms(); -bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b) -{ - return !(a == b); -} + asdcp_smpte_dict = &ASDCP::DefaultSMPTEDict(); -ostream& dcp::operator<< (ostream& s, dcp::Size const & a) -{ - s << a.width << "x" << a.height; - return s; + if (!tags_directory) { + char* prefix = getenv("LIBDCP_SHARE_PREFIX"); + if (prefix) { + tags_directory = boost::filesystem::path(prefix) / "tags"; + } else { + tags_directory = LIBDCP_SHARE_PREFIX "/tags"; + } + } + + load_language_tag_lists (*tags_directory); } /** Decode a base64 string. The base64 decode routine in KM_util.cpp @@ -305,7 +241,7 @@ dcp::base64_decode (string const & in, unsigned char* out, int out_length) *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); @@ -314,66 +250,6 @@ dcp::base64_decode (string const & in, unsigned char* out, int out_length) return N; } -/** 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) -{ - 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); -} - -/** @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) -{ - 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. @@ -416,3 +292,179 @@ dcp::relative_to_root (boost::filesystem::path root, boost::filesystem::path fil return rel; } + +bool +dcp::ids_equal (string a, string b) +{ + 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())); + } + + 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; +} + +/** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...) + * @return SHA1 fingerprint of key + */ +string +dcp::private_key_fingerprint (string key) +{ + 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); +} + +xmlpp::Node * +dcp::find_child (xmlpp::Node const * node, string name) +{ + 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); +} + +string +dcp::openjpeg_version () +{ + return opj_version (); +} + +string +dcp::spaces (int n) +{ + string s = ""; + for (int i = 0; i < n; ++i) { + s += " "; + } + return s; +} + +void +dcp::indent (xmlpp::Element* element, int initial) +{ + xmlpp::Node* last = 0; + BOOST_FOREACH (xmlpp::Node * n, element->get_children()) { + xmlpp::Element* e = dynamic_cast(n); + if (e) { + element->add_child_text_before (e, "\n" + spaces(initial + 2)); + indent (e, initial + 2); + last = n; + } + } + if (last) { + element->add_child_text (last, "\n" + spaces(initial)); + } +} + +/** @return true if the day represented by \ref a is less than or + * equal to the one represented by \ref b, ignoring the time parts. + */ +bool +dcp::day_less_than_or_equal (LocalTime a, LocalTime b) +{ + if (a.year() != b.year()) { + return a.year() < b.year(); + } + + if (a.month() != b.month()) { + return a.month() < b.month(); + } + + return a.day() <= b.day(); +} + +/** @return true if the day represented by \ref a is greater than or + * equal to the one represented by \ref b, ignoring the time parts. + */ +bool +dcp::day_greater_than_or_equal (LocalTime a, LocalTime b) +{ + if (a.year() != b.year()) { + return a.year() > b.year(); + } + + if (a.month() != b.month()) { + return a.month() > b.month(); + } + + return a.day() >= b.day(); +} + +/** Try quite hard to find a string which starts with \ref base and is + * not in \ref existing. + */ +string +dcp::unique_string (vector existing, string base) +{ + int const max_tries = existing.size() + 1; + for (int i = 0; i < max_tries; ++i) { + string trial = String::compose("%1%2", base, i); + if (find(existing.begin(), existing.end(), trial) == existing.end()) { + return trial; + } + } + + DCP_ASSERT (false); +} + + +ASDCPErrorSuspender::ASDCPErrorSuspender () + : _old (Kumu::DefaultLogSink()) +{ + _sink = new Kumu::EntryListLogSink(_log); + Kumu::SetDefaultLogSink (_sink); +} + + +ASDCPErrorSuspender::~ASDCPErrorSuspender () +{ + Kumu::SetDefaultLogSink (&_old); + delete _sink; +} +