Fix the build for older macOS.
[dcpomatic.git] / src / lib / dcp_video.cc
index cd7d5229e8878cd00f639ad6d611527778faeec8..3a85a5ac6acf553eb7adc8dadc66d8530671d216 100644 (file)
@@ -1,23 +1,24 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
-    Taken from code Copyright (C) 2010-2011 Terrence Meiczinger
+    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 DCP-o-matic.
+
+    DCP-o-matic 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,
+    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+
 /** @file  src/dcp_video_frame.cc
  *  @brief A single frame of video destined for a DCP.
  *
  *  of images that require encoding.
  */
 
-#include "dcp_video.h"
+
+#include "compose.hpp"
 #include "config.h"
-#include "exceptions.h"
-#include "encode_server_description.h"
+#include "cross.h"
+#include "dcp_video.h"
+#include "dcpomatic_log.h"
 #include "dcpomatic_socket.h"
+#include "encode_server_description.h"
+#include "exceptions.h"
 #include "image.h"
 #include "log.h"
-#include "cross.h"
 #include "player_video.h"
-#include "raw_convert.h"
-#include "compose.hpp"
+#include "rng.h"
+#include "warnings.h"
 #include <libcxml/cxml.h>
+#include <dcp/raw_convert.h>
 #include <dcp/openjpeg_image.h>
 #include <dcp/rgb_xyz.h>
-#include <dcp/j2k.h>
-#include <dcp/colour_matrix.h>
+#include <dcp/j2k_transcode.h>
+DCPOMATIC_DISABLE_WARNINGS
 #include <libxml++/libxml++.h>
+DCPOMATIC_ENABLE_WARNINGS
 #include <boost/asio.hpp>
 #include <boost/thread.hpp>
 #include <stdint.h>
 #include <iomanip>
 #include <iostream>
 
-#define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
-#define LOG_DEBUG_ENCODE(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
-#define LOG_TIMING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
-
 #include "i18n.h"
 
-using std::string;
+
 using std::cout;
-using boost::shared_ptr;
-using dcp::Size;
-using dcp::Data;
+using std::make_shared;
+using std::shared_ptr;
+using std::string;
+using dcp::ArrayData;
+using dcp::raw_convert;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
+
 
 #define DCI_COEFFICENT (48.0 / 52.37)
 
+
 /** Construct a DCP video frame.
  *  @param frame Input frame.
  *  @param index Index of the frame within the DCP.
  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
- *  @param l Log to write to.
  */
 DCPVideo::DCPVideo (
-       shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
+       shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r
        )
        : _frame (frame)
        , _index (index)
        , _frames_per_second (dcp_fps)
        , _j2k_bandwidth (bw)
        , _resolution (r)
-       , _log (l)
 {
 
 }
 
-DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
+DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node)
        : _frame (frame)
-       , _log (log)
 {
        _index = node->number_child<int> ("Index");
        _frames_per_second = node->number_child<int> ("FramesPerSecond");
        _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
-       _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
+       _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or(static_cast<int>(Resolution::TWO_K)));
 }
 
 shared_ptr<dcp::OpenJPEGImage>
@@ -99,7 +105,7 @@ DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler
 {
        shared_ptr<dcp::OpenJPEGImage> xyz;
 
-       shared_ptr<Image> image = frame->image (note);
+       auto image = frame->image (bind(&PlayerVideo::keep_xyz_or_rgb, _1), VideoRange::FULL, false);
        if (frame->colour_conversion()) {
                xyz = dcp::rgb_to_xyz (
                        image->data()[0],
@@ -109,7 +115,7 @@ DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler
                        note
                        );
        } else {
-               xyz = dcp::xyz_to_xyz (image->data()[0], image->size(), image->stride()[0]);
+               xyz = make_shared<dcp::OpenJPEGImage>(image->data()[0], image->size(), image->stride()[0]);
        }
 
        return xyz;
@@ -118,25 +124,71 @@ DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler
 /** J2K-encode this frame on the local host.
  *  @return Encoded data.
  */
-Data
-DCPVideo::encode_locally (dcp::NoteHandler note)
+ArrayData
+DCPVideo::encode_locally ()
 {
-       Data enc = compress_j2k (
-               convert_to_xyz (_frame, note),
-               _j2k_bandwidth,
-               _frames_per_second,
-               _frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT,
-               _resolution == RESOLUTION_4K
+       auto const comment = Config::instance()->dcp_j2k_comment();
+
+       ArrayData enc = {};
+       /* This was empirically derived by a user: see #1902 */
+       int const minimum_size = 16384;
+       LOG_GENERAL ("Using minimum frame size %1", minimum_size);
+
+       auto xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
+       int noise_amount = 2;
+       int pixel_skip = 16;
+       while (true) {
+               enc = dcp::compress_j2k (
+                       xyz,
+                       _j2k_bandwidth,
+                       _frames_per_second,
+                       _frame->eyes() == Eyes::LEFT || _frame->eyes() == Eyes::RIGHT,
+                       _resolution == Resolution::FOUR_K,
+                       comment.empty() ? "libdcp" : comment
                );
 
+               if (enc.size() >= minimum_size) {
+                       LOG_GENERAL (N_("Frame %1 encoded size was OK (%2)"), _index, enc.size());
+                       break;
+               }
+
+               LOG_GENERAL (N_("Frame %1 encoded size was small (%2); adding noise at level %3 with pixel skip %4"), _index, enc.size(), noise_amount, pixel_skip);
+
+               /* The JPEG2000 is too low-bitrate for some decoders <cough>DSS200</cough> so add some noise
+                * and try again.  This is slow but hopefully won't happen too often.  We have to do
+                * convert_to_xyz() again because compress_j2k() corrupts its xyz parameter.
+                */
+
+               xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
+               auto size = xyz->size ();
+               auto pixels = size.width * size.height;
+               dcpomatic::RNG rng(42);
+               for (auto c = 0; c < 3; ++c) {
+                       auto p = xyz->data(c);
+                       auto e = xyz->data(c) + pixels;
+                       while (p < e) {
+                               *p = std::min(4095, std::max(0, *p + (rng.get() % noise_amount)));
+                               p += pixel_skip;
+                       }
+               }
+
+               if (pixel_skip > 1) {
+                       --pixel_skip;
+               } else {
+                       ++noise_amount;
+               }
+               /* Something's gone badly wrong if this much noise doesn't help */
+               DCPOMATIC_ASSERT (noise_amount < 16);
+       }
+
        switch (_frame->eyes()) {
-       case EYES_BOTH:
+       case Eyes::BOTH:
                LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
                break;
-       case EYES_LEFT:
+       case Eyes::LEFT:
                LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
                break;
-       case EYES_RIGHT:
+       case Eyes::RIGHT:
                LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
                break;
        default:
@@ -148,45 +200,54 @@ DCPVideo::encode_locally (dcp::NoteHandler note)
 
 /** Send this frame to a remote server for J2K encoding, then read the result.
  *  @param serv Server to send to.
+ *  @param timeout timeout in seconds.
  *  @return Encoded data.
  */
-Data
+ArrayData
 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout)
 {
        boost::asio::io_service io_service;
        boost::asio::ip::tcp::resolver resolver (io_service);
-       boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
+       boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (ENCODE_FRAME_PORT));
        boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 
-       shared_ptr<Socket> socket (new Socket (timeout));
+       auto socket = make_shared<Socket>(timeout);
 
        socket->connect (*endpoint_iterator);
 
        /* Collect all XML metadata */
        xmlpp::Document doc;
-       xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
+       auto root = doc.create_root_node ("EncodingRequest");
        root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
        add_metadata (root);
 
        LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
 
-       /* Send XML metadata */
-       string xml = doc.write_to_string ("UTF-8");
-       socket->write (xml.length() + 1);
-       socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
+       {
+               Socket::WriteDigestScope ds (socket);
 
-       /* Send binary data */
-       LOG_TIMING("start-remote-send thread=%1", boost::this_thread::get_id());
-       _frame->send_binary (socket);
+               /* Send XML metadata */
+               auto xml = doc.write_to_string ("UTF-8");
+               socket->write (xml.length() + 1);
+               socket->write ((uint8_t *) xml.c_str(), xml.bytes() + 1);
+
+               /* Send binary data */
+               LOG_TIMING("start-remote-send thread=%1", thread_id ());
+               _frame->write_to_socket (socket);
+       }
 
        /* Read the response (JPEG2000-encoded data); this blocks until the data
           is ready and sent back.
        */
-       LOG_TIMING("start-remote-encode thread=%1", boost::this_thread::get_id ());
-       Data e (socket->read_uint32 ());
-       LOG_TIMING("start-remote-receive thread=%1", boost::this_thread::get_id ());
-       socket->read (e.data().get(), e.size());
-       LOG_TIMING("finish-remote-receive thread=%1", boost::this_thread::get_id ());
+       Socket::ReadDigestScope ds (socket);
+       LOG_TIMING("start-remote-encode thread=%1", thread_id ());
+       ArrayData e (socket->read_uint32 ());
+       LOG_TIMING("start-remote-receive thread=%1", thread_id ());
+       socket->read (e.data(), e.size());
+       LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
+       if (!ds.check()) {
+               throw NetworkError ("Checksums do not match");
+       }
 
        LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);