Some compilers don't like x = {} where x is a boost::optional<string>
[libdcp.git] / src / j2k.cc
index 13474f51641c2b3851b423f5e3046ae8454cdc74..c07bdccd3f0a5aaead7d70e9f1dacf7cb403db1c 100644 (file)
@@ -1,44 +1,70 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 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/j2k.cc
+ *  @brief Methods to encode and decode JPEG2000
+ */
+
+
+#include "array_data.h"
 #include "j2k.h"
 #include "exceptions.h"
 #include "openjpeg_image.h"
-#include "data.h"
 #include "dcp_assert.h"
 #include "compose.hpp"
 #include <openjpeg.h>
 #include <cmath>
 #include <iostream>
 
+
 using std::min;
 using std::pow;
-using boost::shared_ptr;
+using std::string;
+using std::shared_ptr;
 using boost::shared_array;
 using namespace dcp;
 
+
 shared_ptr<dcp::OpenJPEGImage>
-dcp::decompress_j2k (Data data, int reduce)
+dcp::decompress_j2k (ArrayData data, int reduce)
 {
-       return dcp::decompress_j2k (data.data().get(), data.size(), reduce);
+       return dcp::decompress_j2k (data.data(), data.size(), reduce);
 }
 
+
+#ifdef LIBDCP_OPENJPEG2
+
 class ReadBuffer
 {
 public:
@@ -62,30 +88,40 @@ private:
        OPJ_SIZE_T _offset;
 };
 
+
 static OPJ_SIZE_T
 read_function (void* buffer, OPJ_SIZE_T nb_bytes, void* data)
 {
        return reinterpret_cast<ReadBuffer*>(data)->read (buffer, nb_bytes);
 }
 
+
 static void
 read_free_function (void* data)
 {
        delete reinterpret_cast<ReadBuffer*>(data);
 }
 
-/** 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.
- */
+
+static void
+decompress_error_callback (char const * msg, void *)
+{
+       throw J2KDecompressionError (msg);
+}
+
+
+static void
+compress_error_callback (char const * msg, void *)
+{
+       throw MiscError (msg);
+}
+
+
 shared_ptr<dcp::OpenJPEGImage>
 dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
 {
+       DCP_ASSERT (reduce >= 0);
+
        uint8_t const jp2_magic[] = {
                0x00,
                0x00,
@@ -97,27 +133,29 @@ dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
                0x20
        };
 
-       OPJ_CODEC_FORMAT format = OPJ_CODEC_J2K;
+       auto format = OPJ_CODEC_J2K;
        if (size >= int (sizeof (jp2_magic)) && memcmp (data, jp2_magic, sizeof (jp2_magic)) == 0) {
                format = OPJ_CODEC_JP2;
        }
 
-       opj_codec_t* decoder = opj_create_decompress (format);
+       auto decoder = opj_create_decompress (format);
        if (!decoder) {
-               boost::throw_exception (DCPReadError ("could not create JPEG2000 decompresser"));
+               boost::throw_exception (ReadError ("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_stream_t* stream = opj_stream_default_create (OPJ_TRUE);
+       auto stream = opj_stream_default_create (OPJ_TRUE);
        if (!stream) {
                throw MiscError ("could not create JPEG2000 stream");
        }
 
+       opj_set_error_handler(decoder, decompress_error_callback, 00);
+
        opj_stream_set_read_function (stream, read_function);
-       ReadBuffer* buffer = new ReadBuffer (data, size);
+       auto buffer = new ReadBuffer (data, size);
        opj_stream_set_user_data (stream, buffer, read_free_function);
        opj_stream_set_user_data_length (stream, size);
 
@@ -127,9 +165,9 @@ dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
                opj_destroy_codec (decoder);
                opj_stream_destroy (stream);
                if (format == OPJ_CODEC_J2K) {
-                       boost::throw_exception (DCPReadError (String::compose ("could not decode JPEG2000 codestream of %1 bytes.", size)));
+                       boost::throw_exception (ReadError (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)));
+                       boost::throw_exception (ReadError (String::compose ("could not decode JP2 file of %1 bytes.", size)));
                }
        }
 
@@ -141,13 +179,46 @@ dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
        return shared_ptr<OpenJPEGImage> (new OpenJPEGImage (image));
 }
 
+#endif
+
+
+#ifdef LIBDCP_OPENJPEG1
+
+shared_ptr<dcp::OpenJPEGImage>
+dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
+{
+       auto 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);
+       auto cio = opj_cio_open ((opj_common_ptr) decoder, data, size);
+       auto image = opj_decode (decoder, cio);
+       if (!image) {
+               opj_destroy_decompress (decoder);
+               opj_cio_close (cio);
+               boost::throw_exception (ReadError (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));
+       image->y1 = rint (float(image->y1) / pow (2, reduce));
+       return shared_ptr<OpenJPEGImage> (new OpenJPEGImage (image));
+}
+#endif
+
+
+#ifdef LIBDCP_OPENJPEG2
+
 class WriteBuffer
 {
 public:
 /* XXX: is there a better strategy for this? */
 #define MAX_J2K_SIZE (1024 * 1024 * 2)
        WriteBuffer ()
-               : _data (shared_array<uint8_t> (new uint8_t[MAX_J2K_SIZE]), MAX_J2K_SIZE)
+               : _data (shared_array<uint8_t>(new uint8_t[MAX_J2K_SIZE]), MAX_J2K_SIZE)
                , _offset (0)
        {
                _data.set_size (0);
@@ -156,9 +227,9 @@ public:
        OPJ_SIZE_T write (void* buffer, OPJ_SIZE_T nb_bytes)
        {
                DCP_ASSERT ((_offset + nb_bytes) < MAX_J2K_SIZE);
-               memcpy (_data.data().get() + _offset, buffer, nb_bytes);
+               memcpy (_data.data() + _offset, buffer, nb_bytes);
                _offset += nb_bytes;
-               if (_offset > OPJ_SIZE_T (_data.size())) {
+               if (_offset > OPJ_SIZE_T(_data.size())) {
                        _data.set_size (_offset);
                }
                return nb_bytes;
@@ -170,56 +241,63 @@ public:
                return OPJ_TRUE;
        }
 
-       Data data () const
+       ArrayData data () const
        {
                return _data;
        }
 
 private:
-       Data _data;
+       ArrayData _data;
        OPJ_SIZE_T _offset;
 };
 
+
 static OPJ_SIZE_T
 write_function (void* buffer, OPJ_SIZE_T nb_bytes, void* data)
 {
-       return reinterpret_cast<WriteBuffer*>(data)->write (buffer, nb_bytes);
+       return reinterpret_cast<WriteBuffer*>(data)->write(buffer, nb_bytes);
 }
 
+
 static void
 write_free_function (void* data)
 {
        delete reinterpret_cast<WriteBuffer*>(data);
 }
 
+
 static OPJ_BOOL
 seek_function (OPJ_OFF_T nb_bytes, void* data)
 {
-       return reinterpret_cast<WriteBuffer*>(data)->seek (nb_bytes);
-}
+       return reinterpret_cast<WriteBuffer*>(data)->seek(nb_bytes);
 
-static void
-error_callback (char const * msg, void *)
-{
-       throw MiscError (msg);
 }
 
-Data
-dcp::compress_j2k (shared_ptr<const OpenJPEGImage> xyz, int bandwidth, int frames_per_second, bool threed, bool fourk)
+
+ArrayData
+dcp::compress_j2k (shared_ptr<const OpenJPEGImage> xyz, int bandwidth, int frames_per_second, bool threed, bool fourk, string comment)
 {
        /* get a J2K compressor handle */
-       opj_codec_t* encoder = opj_create_compress (OPJ_CODEC_J2K);
-       if (encoder == 0) {
+       auto encoder = opj_create_compress (OPJ_CODEC_J2K);
+       if (encoder == nullptr) {
                throw MiscError ("could not create JPEG2000 encoder");
        }
 
-       opj_set_error_handler (encoder, error_callback, 0);
+       if (comment.empty()) {
+               /* asdcplib complains with "Illegal data size" when reading frames encoded with an empty comment */
+               throw MiscError("compress_j2k comment can not be an empty string");
+       }
+
+       opj_set_error_handler (encoder, compress_error_callback, 0);
 
        /* Set encoding parameters to default values */
        opj_cparameters_t parameters;
        opj_set_default_encoder_parameters (&parameters);
+       if (fourk) {
+               parameters.numresolution = 7;
+       }
        parameters.rsiz = fourk ? OPJ_PROFILE_CINEMA_4K : OPJ_PROFILE_CINEMA_2K;
-       parameters.cp_comment = strdup ("libdcp");
+       parameters.cp_comment = strdup (comment.c_str());
 
        /* set max image */
        parameters.max_cs_size = (bandwidth / 8) / frames_per_second;
@@ -234,8 +312,10 @@ dcp::compress_j2k (shared_ptr<const OpenJPEGImage> xyz, int bandwidth, int frame
        /* Setup the encoder parameters using the current image and user parameters */
        opj_setup_encoder (encoder, &parameters, xyz->opj_image());
 
-       opj_stream_t* stream = opj_stream_default_create (OPJ_FALSE);
+       auto stream = opj_stream_default_create (OPJ_FALSE);
        if (!stream) {
+               opj_destroy_codec (encoder);
+               free (parameters.cp_comment);
                throw MiscError ("could not create JPEG2000 stream");
        }
 
@@ -245,26 +325,159 @@ dcp::compress_j2k (shared_ptr<const OpenJPEGImage> xyz, int bandwidth, int frame
        opj_stream_set_user_data (stream, buffer, write_free_function);
 
        if (!opj_start_compress (encoder, xyz->opj_image(), stream)) {
-               throw MiscError ("could not start JPEG2000 encoding");
+               opj_stream_destroy (stream);
+               opj_destroy_codec (encoder);
+               free (parameters.cp_comment);
+               if ((errno & 0x61500) == 0x61500) {
+                       /* We've had one of the magic error codes from our patched openjpeg */
+                       boost::throw_exception (StartCompressionError (errno & 0xff));
+               } else {
+                       boost::throw_exception (StartCompressionError ());
+               }
        }
 
        if (!opj_encode (encoder, stream)) {
-               opj_destroy_codec (encoder);
                opj_stream_destroy (stream);
+               opj_destroy_codec (encoder);
+               free (parameters.cp_comment);
                throw MiscError ("JPEG2000 encoding failed");
        }
 
        if (!opj_end_compress (encoder, stream)) {
-               opj_destroy_codec (encoder);
                opj_stream_destroy (stream);
+               opj_destroy_codec (encoder);
+               free (parameters.cp_comment);
                throw MiscError ("could not end JPEG2000 encoding");
        }
 
-       Data enc (buffer->data ());
+       ArrayData enc (buffer->data ());
 
-       free (parameters.cp_comment);
-       opj_destroy_codec (encoder);
        opj_stream_destroy (stream);
+       opj_destroy_codec (encoder);
+       free (parameters.cp_comment);
+
+       return enc;
+}
+
+#endif
+
+
+#ifdef LIBDCP_OPENJPEG1
+
+ArrayData
+dcp::compress_j2k (shared_ptr<const 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 */
+       auto cinfo = opj_create_compress (CODEC_J2K);
+       if (cinfo == nullptr) {
+               throw MiscError ("could not create JPEG2000 encoder");
+       }
+
+       /* Set encoding parameters to default values */
+       opj_cparameters_t parameters;
+       opj_set_default_encoder_parameters (&parameters);
+       if (fourk) {
+               parameters.numresolution = 7;
+       }
+
+       /* 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());
+
+       auto cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
+       if (cio == nullptr) {
+               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");
+       }
+
+       ArrayData enc (cio->buffer, cio_tell (cio));
+
+       opj_cio_close (cio);
+       free (parameters.cp_comment);
+       opj_destroy_compress (cinfo);
 
        return enc;
 }
+
+#endif