Report errors passed back from DCP::read when exceptions aren't used.
[libdcp.git] / src / util.cc
index 139118ca427e660a2d4c35b4ecc98ca0d7f0e6dd..c6313b4c52acd445e21d98bf77a56cb92dfe9edd 100644 (file)
@@ -1,20 +1,34 @@
 /*
     Copyright (C) 2012-2014 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
 #include "util.h"
 #include "exceptions.h"
 #include "types.h"
-#include "certificates.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 <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 <openssl/sha.h>
 #include <boost/filesystem.hpp>
 #include <boost/algorithm/string.hpp>
+#include <boost/foreach.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;
@@ -56,6 +70,7 @@ using std::setw;
 using std::setfill;
 using std::ostream;
 using boost::shared_ptr;
+using boost::shared_array;
 using boost::optional;
 using boost::function;
 using boost::algorithm::trim;
@@ -74,6 +89,17 @@ dcp::make_uuid ()
        return string (buffer);
 }
 
+string
+dcp::make_digest (Data data)
+{
+       SHA_CTX sha;
+       SHA1_Init (&sha);
+       SHA1_Update (&sha, data.data().get(), 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.
@@ -123,134 +149,6 @@ dcp::make_digest (boost::filesystem::path filename, function<void (float)> progr
        return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64);
 }
 
-/** Convert a content kind to a string which can be used in a
- *  &lt;ContentKind&gt; 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 &lt;ContentKind&gt; 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 OpenJPEGImage.
- */
-shared_ptr<dcp::OpenJPEGImage>
-dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
-{
-       uint8_t const jp2_magic[] = {
-               0x00,
-               0x00,
-               0x00,
-               0x0c,
-               'j',
-               'P',
-               0x20,
-               0x20
-       };
-
-       OPJ_CODEC_FORMAT format = CODEC_J2K;
-       if (size >= int (sizeof (jp2_magic)) && memcmp (data, jp2_magic, sizeof (jp2_magic)) == 0) {
-               format = CODEC_JP2;
-       }
-
-       opj_dinfo_t* decoder = opj_create_decompress (format);
-       if (!decoder) {
-               boost::throw_exception (DCPReadError ("could not create JPEG2000 decompresser"));
-       }
-       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);
-       if (!cio) {
-               boost::throw_exception (DCPReadError ("could not create JPEG2000 memory stream"));
-       }
-       opj_image_t* image = opj_decode (decoder, cio);
-       if (!image) {
-               opj_destroy_decompress (decoder);
-               opj_cio_close (cio);
-               if (format == CODEC_J2K) {
-                       boost::throw_exception (DCPReadError (String::compose ("could not decode JPEG2000 codestream of %1 bytes.", size)));
-               } else {
-                       boost::throw_exception (DCPReadError (String::compose ("could not decode JP2 file 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<OpenJPEGImage> (new OpenJPEGImage (image));
-}
-
 /** @param s A string.
  *  @return true if the string contains only space, newline or tab characters, or is empty.
  */
@@ -289,22 +187,8 @@ 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);
-}
 
-bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b)
-{
-       return !(a == b);
-}
-
-ostream& dcp::operator<< (ostream& s, dcp::Size const & a)
-{
-       s << a.width << "x" << a.height;
-       return s;
+       OpenSSL_add_all_algorithms();
 }
 
 /** Decode a base64 string.  The base64 decode routine in KM_util.cpp
@@ -399,21 +283,20 @@ 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 ("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");
        if (!f) {
-               return "";
+               throw FileError ("could not open file", p, errno);
        }
 
-       fread (c, 1, len, f);
+       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);
-       c[len] = '\0';
 
-       string s (c);
+       string s (c, N);
        delete[] c;
 
        return s;
@@ -453,3 +336,77 @@ dcp::find_child (xmlpp::Node const * node, string name)
        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<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));
+       }
+}
+
+/** @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 (struct tm a, LocalTime b)
+{
+       if ((a.tm_year + 1900) != b.year()) {
+               return (a.tm_year + 1900) < b.year();
+       }
+
+       if ((a.tm_mon + 1) != b.month()) {
+               return (a.tm_mon + 1) < b.month();
+       }
+
+       return a.tm_mday <= 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 (struct tm a, LocalTime b)
+{
+       if ((a.tm_year + 1900) != b.year()) {
+               return (a.tm_year + 1900) > b.year();
+       }
+
+       if ((a.tm_mon + 1) != b.month()) {
+               return (a.tm_mon + 1) > b.month();
+       }
+
+       return a.tm_mday >= b.day();
+}