Forward-port raw_convert precision parameter from v0.
[libdcp.git] / src / util.cc
index 8624ae5184e3273acbd9194fcf9bc785815d7a97..3d37454f58a8b0061d7c69972ae06fef4ac4c450 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 <boost/algorithm/string.hpp>
+#include <stdexcept>
+#include <sstream>
+#include <iostream>
+#include <iomanip>
 
 using std::string;
+using std::wstring;
 using std::cout;
 using std::stringstream;
 using std::min;
@@ -53,15 +55,18 @@ using std::max;
 using std::list;
 using std::setw;
 using std::setfill;
+using std::ostream;
 using boost::shared_ptr;
-using boost::lexical_cast;
-using namespace libdcp;
+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;
@@ -73,16 +78,17 @@ 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
+ *  @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, boost::function<void (float)>* progress)
+dcp::make_digest (boost::filesystem::path filename, 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,13 +106,13 @@ 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);
 
                if (progress) {
-                       (*progress) (float (done) / size);
+                       progress (float (done) / size);
                        done += read;
                }
        }
@@ -119,12 +125,12 @@ libdcp::make_digest (string filename, boost::function<void (float)>* progress)
 }
 
 /** 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 +158,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 +202,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,7 +215,7 @@ 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);
@@ -224,7 +230,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') {
@@ -235,8 +241,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");
@@ -257,21 +266,33 @@ 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.
+ostream& dcp::operator<< (ostream& s, dcp::Size const & a)
+{
+       s << a.width << "x" << a.height;
+       return s;
+}
+
+/** 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 ());
 
@@ -295,68 +316,55 @@ libdcp::base64_decode (string const & in, unsigned char* out, int out_length)
        return N;
 }
 
-string
-libdcp::tm_to_string (struct tm* 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)
 {
-       char buffer[64];
-       strftime (buffer, 64, "%Y-%m-%dT%H:%M:%S", tm);
-
-       int offset = 0;
-
-#ifdef LIBDCP_POSIX
-       offset = tm->tm_gmtoff / 60;
+#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
-       TIME_ZONE_INFORMATION tz;
-       GetTimeZoneInformation (&tz);
-       offset = tz.Bias;
+        return fopen (p.c_str(), t.c_str ());
 #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
-libdcp::utc_offset_to_string (int b)
+optional<boost::filesystem::path>
+dcp::relative_to_root (boost::filesystem::path root, boost::filesystem::path file)
 {
-       bool const negative = (b < 0);
-       b = negative ? -b : b;
+       boost::filesystem::path::const_iterator i = root.begin ();
+       boost::filesystem::path::const_iterator j = file.begin ();
 
-       int const hours = b / 60;
-       int const minutes = b % 60;
+       while (i != root.end() && j != file.end() && *i == *j) {
+               ++i;
+               ++j;
+       }
 
-       stringstream o;
-       if (negative) {
-               o << "-";
-       } else {
-               o << "+";
+       if (i != root.end ()) {
+               return optional<boost::filesystem::path> ();
        }
 
-       o << setw(2) << setfill('0') << hours << ":" << setw(2) << setfill('0') << minutes;
-       return o.str ();
-}
+       boost::filesystem::path rel;
+       while (j != file.end ()) {
+               rel /= *j++;
+       }
 
-string
-libdcp::ptime_to_string (boost::posix_time::ptime t)
-{
-       struct tm t_tm = boost::posix_time::to_tm (t);
-       return tm_to_string (&t_tm);
+       return rel;
 }
 
-
-/* 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 *
-libdcp::fopen_boost (boost::filesystem::path p, string t)
+bool
+dcp::ids_equal (string a, string b)
 {
-#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
+       transform (a.begin(), a.end(), a.begin(), ::tolower);
+       transform (b.begin(), b.end(), b.begin(), ::tolower);
+       trim (a);
+       trim (b);
+       return a == b;
 }