Comments / tweaks.
[libdcp.git] / src / util.cc
index 11052df6be293e1ab9008d1b3b6a9d49928937d1..4be026d28f0c35d9c0c0d3123a36bc752bf16162 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     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
  *  @brief Utility methods.
  */
 
-#include <stdexcept>
-#include <sstream>
-#include <iostream>
-#include <iomanip>
-#include <boost/filesystem.hpp>
-#include <boost/lexical_cast.hpp>
-#include <openssl/sha.h>
-#include <libxml++/nodes/element.h>
-#include <libxml++/document.h>
-#include <xmlsec/xmldsig.h>
-#include <xmlsec/dl.h>
-#include <xmlsec/app.h>
-#include <xmlsec/crypto.h>
-#include "KM_util.h"
-#include "KM_fileio.h"
-#include "AS_DCP.h"
 #include "util.h"
 #include "exceptions.h"
 #include "types.h"
 #include "certificates.h"
 #include "gamma_lut.h"
 #include "xyz_frame.h"
+#include "compose.hpp"
+#include "KM_util.h"
+#include "KM_fileio.h"
+#include "AS_DCP.h"
+#include <xmlsec/xmldsig.h>
+#include <xmlsec/dl.h>
+#include <xmlsec/app.h>
+#include <xmlsec/crypto.h>
+#include <libxml++/nodes/element.h>
+#include <libxml++/document.h>
+#include <openssl/sha.h>
+#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;
@@ -54,14 +55,13 @@ using std::list;
 using std::setw;
 using std::setfill;
 using boost::shared_ptr;
-using boost::lexical_cast;
-using namespace libdcp;
+using namespace dcp;
 
 /** Create a UUID.
  *  @return UUID.
  */
 string
-libdcp::make_uuid ()
+dcp::make_uuid ()
 {
        char buffer[64];
        Kumu::UUID id;
@@ -78,11 +78,12 @@ libdcp::make_uuid ()
  *  @return Digest.
  */
 string
-libdcp::make_digest (string filename, boost::function<void (float)>* progress)
+dcp::make_digest (boost::filesystem::path filename, boost::function<void (float)>* 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;
@@ -100,7 +101,7 @@ libdcp::make_digest (string filename, boost::function<void (float)>* progress)
                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);
@@ -111,20 +112,20 @@ libdcp::make_digest (string filename, boost::function<void (float)>* progress)
                }
        }
 
-       byte_t byte_buffer[20];
+       byte_t byte_buffer[SHA_DIGEST_LENGTH];
        SHA1_Final (byte_buffer, &sha);
 
        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
- *  <ContentKind> node.
+ *  &lt;ContentKind&gt; 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:
@@ -152,35 +153,35 @@ libdcp::content_kind_to_string (ContentKind kind)
        assert (false);
 }
 
-/** Convert a string from a <ContentKind> node to a libdcp ContentKind.
+/** Convert a string from a &lt;ContentKind&gt; 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;
        }
 
@@ -196,8 +197,8 @@ libdcp::content_kind_from_string (string type)
  *  This is useful for scaling 4K DCP images down to 2K.
  *  @return XYZ image.
  */
-shared_ptr<libdcp::XYZFrame>
-libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
+shared_ptr<dcp::XYZFrame>
+dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
 {
        opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K);
        opj_dparameters_t parameters;
@@ -209,9 +210,10 @@ 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 of " + lexical_cast<string> (size) + " bytes."));
+               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));
@@ -223,7 +225,7 @@ libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
  *  @return true if the string contains only space, newline or tab characters, or is empty.
  */
 bool
-libdcp::empty_or_white_space (string s)
+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') {
@@ -234,8 +236,11 @@ libdcp::empty_or_white_space (string s)
        return true;
 }
 
+/** Set up various bits that the library needs.  Should be called one
+ *  by client applications.
+ */
 void
-libdcp::init ()
+dcp::init ()
 {
        if (xmlSecInit() < 0) {
                throw MiscError ("could not initialise xmlsec");
@@ -256,21 +261,27 @@ libdcp::init ()
        }
 }
 
-bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b)
+bool dcp::operator== (dcp::Size const & a, dcp::Size const & b)
 {
        return (a.width == b.width && a.height == b.height);
 }
 
-bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b)
+bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b)
 {
        return !(a == b);
 }
 
-/** 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.
+/** 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
-libdcp::base64_decode (string const & in, unsigned char* out, int out_length)
+dcp::base64_decode (string const & in, unsigned char* out, int out_length)
 {
        BIO* b64 = BIO_new (BIO_f_base64 ());
 
@@ -294,11 +305,16 @@ libdcp::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
-libdcp::tm_to_string (struct tm* tm)
+dcp::tm_to_string (struct tm* tm)
 {
        char buffer[64];
-       strftime (buffer, 64, "%Y-%m-%dT%I:%M:%S", tm);
+       strftime (buffer, 64, "%Y-%m-%dT%H:%M:%S", tm);
 
        int offset = 0;
 
@@ -317,7 +333,7 @@ libdcp::tm_to_string (struct tm* tm)
  *  @return string of the form e.g. -01:00.
  */
 string
-libdcp::utc_offset_to_string (int b)
+dcp::utc_offset_to_string (int b)
 {
        bool const negative = (b < 0);
        b = negative ? -b : b;
@@ -336,9 +352,58 @@ libdcp::utc_offset_to_string (int b)
        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
-libdcp::ptime_to_string (boost::posix_time::ptime t)
+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<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 ();
+
+       while (i != root.end() && j != file.end() && *i == *j) {
+               ++i;
+               ++j;
+       }
+
+       if (i != root.end ()) {
+               return boost::optional<boost::filesystem::path> ();
+       }
+
+       boost::filesystem::path rel;
+       while (j != file.end ()) {
+               rel /= *j++;
+       }
+
+       return rel;
+}