Simplify KDM API slightly.
[libdcp.git] / src / util.cc
index 2968ef55f49885fb4a488f9db5bc54fc52735532..4bcc61fb615789cbbeee94776ed621c4af33a88a 100644 (file)
 #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 "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_frame.h"
 
-using namespace std;
-using namespace boost;
+using std::string;
+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 boost::lexical_cast;
+using namespace libdcp;
 
+/** Create a UUID.
+ *  @return UUID.
+ */
 string
 libdcp::make_uuid ()
 {
@@ -45,21 +69,29 @@ libdcp::make_uuid ()
        return string (buffer);
 }
 
+
+/** 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, sigc::signal1<void, float>* progress)
+libdcp::make_digest (string filename, boost::function<void (float)>* progress)
 {
-       int const file_size = filesystem::file_size (filename);
-       
        Kumu::FileReader reader;
        if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) {
-               throw runtime_error ("could not open file to compute digest");
+               boost::throw_exception (FileError ("could not open file to compute digest", filename));
        }
        
        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);
@@ -67,21 +99,245 @@ libdcp::make_digest (string filename, sigc::signal1<void, float>* progress)
                if (r == Kumu::RESULT_ENDOFFILE) {
                        break;
                } else if (ASDCP_FAILURE (r)) {
-                       throw runtime_error ("could not read file to compute digest");
+                       boost::throw_exception (FileError ("could not read file to compute digest", filename));
                }
                
                SHA1_Update (&sha, read_buffer.Data(), read);
-               done += read;
 
                if (progress) {
-                       (*progress) (0.5 + (0.5 * done / file_size));
+                       (*progress) (float (done) / size);
+                       done += read;
                }
        }
 
        byte_t byte_buffer[20];
        SHA1_Final (byte_buffer, &sha);
 
-       stringstream s;
        char digest[64];
        return Kumu::base64encode (byte_buffer, 20, digest, 64);
 }
+
+/** Convert a content kind to a string which can be used in a
+ *  <ContentKind> node.
+ *  @param kind ContentKind.
+ *  @return string.
+ */
+string
+libdcp::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 type Content kind string.
+ *  @return libdcp ContentKind.
+ */
+libdcp::ContentKind
+libdcp::content_kind_from_string (string type)
+{
+       /* XXX: should probably just convert type to lower-case and have done with it */
+       
+       if (type == "feature") {
+               return FEATURE;
+       } else if (type == "short") {
+               return SHORT;
+       } else if (type == "trailer" || type == "Trailer") {
+               return TRAILER;
+       } else if (type == "test") {
+               return TEST;
+       } else if (type == "transitional") {
+               return TRANSITIONAL;
+       } else if (type == "rating") {
+               return RATING;
+       } else if (type == "teaser" || type == "Teaser") {
+               return TEASER;
+       } else if (type == "policy") {
+               return POLICY;
+       } else if (type == "psa") {
+               return PUBLIC_SERVICE_ANNOUNCEMENT;
+       } else if (type == "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<libdcp::XYZFrame>
+libdcp::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 (&parameters);
+       parameters.cp_reduce = reduce;
+       opj_setup_decoder (decoder, &parameters);
+       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 ("could not decode JPEG2000 codestream of " + lexical_cast<string> (size) + " bytes."));
+       }
+
+       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<XYZFrame> (new XYZFrame (image));
+}
+
+/** @param s A string.
+ *  @return true if the string contains only space, newline or tab characters, or is empty.
+ */
+bool
+libdcp::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;
+}
+
+void
+libdcp::init ()
+{
+       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");
+       }
+#endif 
+
+       if (xmlSecCryptoAppInit(0) < 0) {
+               throw MiscError ("could not initialise crypto");
+       }
+
+       if (xmlSecCryptoInit() < 0) {
+               throw MiscError ("could not initialise xmlsec-crypto");
+       }
+}
+
+bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b)
+{
+       return (a.width == b.width && a.height == b.height);
+}
+
+bool libdcp::operator!= (libdcp::Size const & a, libdcp::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.
+ */
+int
+libdcp::base64_decode (string const & in, unsigned char* out, int out_length)
+{
+       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 N;
+}
+
+string
+libdcp::tm_to_string (struct tm* tm)
+{
+       char buffer[64];
+       strftime (buffer, 64, "%Y-%m-%dT%I:%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
+libdcp::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 ();
+}
+
+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);
+}