Fix missing version string when Popen communicate returns byte strings.
[libdcp.git] / src / util.cc
index 0b8cf6638977e10144746ade170671032f34afb4..3d90ccaa4fe7f6e1155c45cd8e2d6e7ec43e2c88 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 "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 <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;
 using std::max;
 using std::list;
@@ -57,6 +69,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;
@@ -75,6 +88,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.
@@ -193,178 +217,6 @@ dcp::content_kind_from_string (string kind)
        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));
-}
-
-Data
-dcp::compress_j2k (shared_ptr<OpenJPEGImage> xyz, int bandwidth, int frames_per_second, bool threed, bool fourk)
-{
-       /* Set the max image and component sizes based on frame_rate */
-       int max_cs_len = ((float) bandwidth) / 8 / frames_per_second;
-       if (threed) {
-               /* In 3D we have only half the normal bandwidth per eye */
-               max_cs_len /= 2;
-       }
-       int const max_comp_size = max_cs_len / 1.25;
-
-       /* get a J2K compressor handle */
-       opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
-       if (cinfo == 0) {
-               throw MiscError ("could not create JPEG2000 encoder");
-       }
-
-       /* Set encoding parameters to default values */
-       opj_cparameters_t parameters;
-       opj_set_default_encoder_parameters (&parameters);
-
-       /* Set default cinema parameters */
-       parameters.tile_size_on = false;
-       parameters.cp_tdx = 1;
-       parameters.cp_tdy = 1;
-
-       /* Tile part */
-       parameters.tp_flag = 'C';
-       parameters.tp_on = 1;
-
-       /* Tile and Image shall be at (0,0) */
-       parameters.cp_tx0 = 0;
-       parameters.cp_ty0 = 0;
-       parameters.image_offset_x0 = 0;
-       parameters.image_offset_y0 = 0;
-
-       /* Codeblock size = 32x32 */
-       parameters.cblockw_init = 32;
-       parameters.cblockh_init = 32;
-       parameters.csty |= 0x01;
-
-       /* The progression order shall be CPRL */
-       parameters.prog_order = CPRL;
-
-       /* No ROI */
-       parameters.roi_compno = -1;
-
-       parameters.subsampling_dx = 1;
-       parameters.subsampling_dy = 1;
-
-       /* 9-7 transform */
-       parameters.irreversible = 1;
-
-       parameters.tcp_rates[0] = 0;
-       parameters.tcp_numlayers++;
-       parameters.cp_disto_alloc = 1;
-       parameters.cp_rsiz = fourk ? CINEMA4K : CINEMA2K;
-       if (fourk) {
-               parameters.numpocs = 2;
-               parameters.POC[0].tile = 1;
-               parameters.POC[0].resno0 = 0;
-               parameters.POC[0].compno0 = 0;
-               parameters.POC[0].layno1 = 1;
-               parameters.POC[0].resno1 = parameters.numresolution - 1;
-               parameters.POC[0].compno1 = 3;
-               parameters.POC[0].prg1 = CPRL;
-               parameters.POC[1].tile = 1;
-               parameters.POC[1].resno0 = parameters.numresolution - 1;
-               parameters.POC[1].compno0 = 0;
-               parameters.POC[1].layno1 = 1;
-               parameters.POC[1].resno1 = parameters.numresolution;
-               parameters.POC[1].compno1 = 3;
-               parameters.POC[1].prg1 = CPRL;
-       }
-
-       parameters.cp_comment = strdup ("libdcp");
-       parameters.cp_cinema = fourk ? CINEMA4K_24 : CINEMA2K_24;
-
-       /* 3 components, so use MCT */
-       parameters.tcp_mct = 1;
-
-       /* set max image */
-       parameters.max_comp_size = max_comp_size;
-       parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
-
-       /* Set event manager to null (openjpeg 1.3 bug) */
-       cinfo->event_mgr = 0;
-
-       /* Setup the encoder parameters using the current image and user parameters */
-       opj_setup_encoder (cinfo, &parameters, xyz->opj_image ());
-
-       opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
-       if (cio == 0) {
-               opj_destroy_compress (cinfo);
-               throw MiscError ("could not open JPEG2000 stream");
-       }
-
-       int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
-       if (r == 0) {
-               opj_cio_close (cio);
-               opj_destroy_compress (cinfo);
-               throw MiscError ("JPEG2000 encoding failed");
-       }
-
-       Data enc (cio->buffer, cio_tell (cio));
-
-       opj_cio_close (cio);
-       free (parameters.cp_comment);
-       opj_destroy_compress (cinfo);
-
-       return enc;
-}
-
 /** @param s A string.
  *  @return true if the string contains only space, newline or tab characters, or is empty.
  */
@@ -403,22 +255,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
@@ -513,7 +351,7 @@ 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()));
        }
 
        FILE* f = fopen_boost (p, "r");
@@ -566,3 +404,16 @@ 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 ();
+}