/*
- Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
- 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 <http://www.gnu.org/licenses/>.
+
+ 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.
+ * @brief Utility methods and classes
*/
-#include "util.h"
+
+#include "certificate.h"
+#include "compose.hpp"
+#include "dcp_assert.h"
#include "exceptions.h"
+#include "file.h"
+#include "filesystem.h"
+#include "language_tag.h"
+#include "openjpeg_image.h"
+#include "rating.h"
#include "types.h"
-#include "argb_image.h"
-#include "certificates.h"
-#include "xyz_image.h"
-#include "dcp_assert.h"
-#include "compose.hpp"
-#include "KM_util.h"
-#include "KM_fileio.h"
-#include "AS_DCP.h"
+#include "util.h"
+#include <openjpeg.h>
+#include <asdcp/KM_util.h>
+#include <asdcp/KM_fileio.h>
+#include <asdcp/AS_DCP.h>
#include <xmlsec/xmldsig.h>
#include <xmlsec/dl.h>
#include <xmlsec/app.h>
#include <libxml++/nodes/element.h>
#include <libxml++/document.h>
#include <openssl/sha.h>
-#include <boost/filesystem.hpp>
#include <boost/algorithm/string.hpp>
+#if BOOST_VERSION >= 106100
+#include <boost/dll/runtime_symbol_info.hpp>
+#endif
+#include <boost/filesystem.hpp>
#include <stdexcept>
-#include <sstream>
#include <iostream>
#include <iomanip>
+
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;
-/** Create a UUID.
- * @return UUID.
+
+/* 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 = nullptr;
+
+
string
dcp::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
-dcp::make_digest (boost::filesystem::path filename, function<void (float)> progress)
+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);
+}
+
+
+string
+dcp::make_digest(boost::filesystem::path filename, function<void (int64_t, int64_t)> progress)
{
Kumu::FileReader reader;
- 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));
+ auto r = reader.OpenRead(dcp::filesystem::fix_long_path(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::fsize_t done = 0;
Kumu::fsize_t const size = reader.Size ();
- while (1) {
+ while (true) {
ui32_t read = 0;
- Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read);
-
+ auto 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));
+ boost::throw_exception (FileError("could not read file to compute digest", filename, r));
}
-
+
SHA1_Update (&sha, read_buffer.Data(), read);
if (progress) {
- progress (float (done) / size);
+ progress(done, size);
done += read;
}
}
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";
- }
-
- DCP_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;
- }
-
- 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 XYZ image.
- */
-shared_ptr<dcp::XYZImage>
-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<XYZImage> (new XYZImage (image));
-}
-
-/** @param s A string.
- * @return true if the string contains only space, newline or tab characters, or is empty.
- */
-bool
-dcp::empty_or_white_space (string s)
-{
- 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 ()
+dcp::init (optional<boost::filesystem::path> given_resources_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");
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;
+ auto res = given_resources_directory.get_value_or(resources_directory());
+
+ load_language_tag_lists (res / "tags");
+ load_rating_list (res / "ratings");
}
-/** 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.
- */
+
int
dcp::base64_decode (string const & in, unsigned char* out, int out_length)
{
- BIO* b64 = BIO_new (BIO_f_base64 ());
+ auto b64 = BIO_new (BIO_f_base64());
/* This means the input should have no newlines */
BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL);
*p++ = in[i];
}
}
-
- BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer);
+
+ auto 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 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<boost::filesystem::path>
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 ();
+ auto i = root.begin ();
+ auto j = file.begin ();
while (i != root.end() && j != file.end() && *i == *j) {
++i;
++j;
}
- if (i != root.end ()) {
- return optional<boost::filesystem::path> ();
+ if (i != root.end()) {
+ return {};
}
boost::filesystem::path rel;
- while (j != file.end ()) {
+ while (j != file.end()) {
rel /= *j++;
}
return rel;
}
+
bool
dcp::ids_equal (string a, string 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);
+ auto len = filesystem::file_size(p);
if (len > max_length) {
- throw MiscError ("Unexpectedly long file");
+ throw MiscError (String::compose("Unexpectedly long file (%1)", p.string()));
}
-
- char* c = new char[len + 1];
-
- FILE* f = fopen_boost (p, "r");
+
+ File f(p, "r");
if (!f) {
- return "";
+ throw FileError ("could not open file", p, errno);
}
- fread (c, 1, len, f);
- fclose (f);
- c[len] = '\0';
+ std::vector<char> buffer(len);
+ /* This may read less than `len' if we are on Windows and we have CRLF in the file */
+ int const N = f.read(buffer.data(), 1, len);
+ return string(buffer.data(), N);
+}
- string s (c);
- delete[] c;
- return s;
+void
+dcp::write_string_to_file(string const& string, boost::filesystem::path const& path)
+{
+ File file(path, "w");
+ if (!file) {
+ throw FileError("could not open file", path, errno);
+ }
+
+ file.write(string.c_str(), string.length(), 1);
}
-/** @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", "");
+ boost::replace_all (key, "-----BEGIN PRIVATE KEY-----\n", "");
+ boost::replace_all (key, "\n-----END PRIVATE KEY-----\n", "");
unsigned char buffer[4096];
int const N = base64_decode (key, buffer, sizeof (buffer));
char digest_base64[64];
return Kumu::base64encode (digest, 20, digest_base64, 64);
}
+
+
+xmlpp::Node *
+dcp::find_child (xmlpp::Node const * node, string name)
+{
+ auto c = node->get_children ();
+ auto 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)
+{
+ if (raw.substr(0, 9) != "urn:uuid:") {
+ throw BadURNUUIDError(raw);
+ }
+
+ 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 = nullptr;
+ for (auto n: element->get_children()) {
+ auto e = dynamic_cast<xmlpp::Element*>(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));
+ }
+}
+
+
+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();
+}
+
+
+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();
+}
+
+
+string
+dcp::unique_string (vector<string> 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;
+}
+
+
+boost::filesystem::path dcp::directory_containing_executable ()
+{
+#if BOOST_VERSION >= 106100
+ return filesystem::canonical(boost::dll::program_location().parent_path());
+#else
+ char buffer[PATH_MAX];
+ ssize_t N = readlink ("/proc/self/exe", buffer, PATH_MAX);
+ return boost::filesystem::path(string(buffer, N)).parent_path();
+#endif
+}
+
+
+boost::filesystem::path dcp::resources_directory ()
+{
+ /* We need a way to specify the tags directory for running un-installed binaries */
+ char* prefix = getenv("LIBDCP_RESOURCES");
+ if (prefix) {
+ return prefix;
+ }
+
+#if defined(LIBDCP_OSX)
+ return directory_containing_executable().parent_path() / "Resources";
+#elif defined(LIBDCP_WINDOWS)
+ return directory_containing_executable().parent_path();
+#else
+ return directory_containing_executable().parent_path() / "share" / "libdcp";
+#endif
+}
+
+
projects / libdcp.git / blobdiff