Remove in-place translations support.
[dcpomatic.git] / src / lib / writer.cc
index 3aca2ab89c96328445907dbbd88ae64156b722ac..fbe2d248d5c952c3112f1e5f9f7184ae3b4073c3 100644 (file)
 */
 
 
-#include "writer.h"
-#include "compose.hpp"
-#include "film.h"
-#include "ratio.h"
-#include "log.h"
-#include "dcpomatic_log.h"
-#include "dcp_video.h"
-#include "dcp_content_type.h"
+#include "audio_buffers.h"
 #include "audio_mapping.h"
+#include "compose.hpp"
 #include "config.h"
-#include "job.h"
+#include "constants.h"
 #include "cross.h"
-#include "audio_buffers.h"
-#include "version.h"
-#include "font_data.h"
-#include "util.h"
+#include "dcp_content_type.h"
+#include "dcp_video.h"
+#include "dcpomatic_log.h"
+#include "film.h"
+#include "film_util.h"
+#include "job.h"
+#include "log.h"
+#include "ratio.h"
 #include "reel_writer.h"
 #include "text_content.h"
+#include "util.h"
+#include "version.h"
+#include "writer.h"
 #include <dcp/cpl.h>
 #include <dcp/locale_convert.h>
+#include <dcp/raw_convert.h>
+#include <dcp/reel_closed_caption_asset.h>
 #include <dcp/reel_file_asset.h>
-#include <fstream>
+#include <dcp/reel_subtitle_asset.h>
 #include <cerrno>
-#include <iostream>
 #include <cfloat>
+#include <set>
 
 #include "i18n.h"
 
@@ -58,6 +61,7 @@ using std::make_shared;
 using std::max;
 using std::min;
 using std::shared_ptr;
+using std::set;
 using std::string;
 using std::vector;
 using std::weak_ptr;
@@ -70,12 +74,12 @@ using dcp::ArrayData;
 using namespace dcpomatic;
 
 
-/** @param j Job to report progress to, or 0.
+/** @param weak_job Job to report progress to, or 0.
  *  @param text_only true to enable only the text (subtitle/ccap) parts of the writer.
  */
-Writer::Writer (weak_ptr<const Film> weak_film, weak_ptr<Job> j, bool text_only)
+Writer::Writer(weak_ptr<const Film> weak_film, weak_ptr<Job> weak_job, bool text_only)
        : WeakConstFilm (weak_film)
-       , _job (j)
+       , _job(weak_job)
        /* These will be reset to sensible values when J2KEncoder is created */
        , _maximum_frames_in_memory (8)
        , _maximum_queue_size (8)
@@ -153,19 +157,11 @@ Writer::write (shared_ptr<const Data> encoded, Frame frame, Eyes eyes)
        qi.reel = video_reel (frame);
        qi.frame = frame - _reels[qi.reel].start ();
 
-       if (film()->three_d() && eyes == Eyes::BOTH) {
-               /* 2D material in a 3D DCP; fake the 3D */
-               qi.eyes = Eyes::LEFT;
-               _queue.push_back (qi);
-               ++_queued_full_in_memory;
-               qi.eyes = Eyes::RIGHT;
-               _queue.push_back (qi);
-               ++_queued_full_in_memory;
-       } else {
-               qi.eyes = eyes;
-               _queue.push_back (qi);
-               ++_queued_full_in_memory;
-       }
+       DCPOMATIC_ASSERT((film()->three_d() && eyes != Eyes::BOTH) || (!film()->three_d() && eyes == Eyes::BOTH));
+
+       qi.eyes = eyes;
+       _queue.push_back(qi);
+       ++_queued_full_in_memory;
 
        /* Now there's something to do: wake anything wait()ing on _empty_condition */
        _empty_condition.notify_all ();
@@ -239,17 +235,12 @@ Writer::fake_write (Frame frame, Eyes eyes)
                qi.size = _reels[reel].read_frame_info(info_file, frame_in_reel, eyes).size;
        }
 
+       DCPOMATIC_ASSERT((film()->three_d() && eyes != Eyes::BOTH) || (!film()->three_d() && eyes == Eyes::BOTH));
+
        qi.reel = reel;
        qi.frame = frame_in_reel;
-       if (film()->three_d() && eyes == Eyes::BOTH) {
-               qi.eyes = Eyes::LEFT;
-               _queue.push_back (qi);
-               qi.eyes = Eyes::RIGHT;
-               _queue.push_back (qi);
-       } else {
-               qi.eyes = eyes;
-               _queue.push_back (qi);
-       }
+       qi.eyes = eyes;
+       _queue.push_back(qi);
 
        /* Now there's something to do: wake anything wait()ing on _empty_condition */
        _empty_condition.notify_all ();
@@ -303,12 +294,12 @@ Writer::write (shared_ptr<const AudioBuffers> audio, DCPTime const time)
                        DCPOMATIC_ASSERT ((part_frames[0] + part_frames[1]) <= audio->frames());
 
                        if (part_frames[0]) {
-                               shared_ptr<AudioBuffers> part (new AudioBuffers(audio, part_frames[0], 0));
+                               auto part = make_shared<AudioBuffers>(audio, part_frames[0], 0);
                                _audio_reel->write (part);
                        }
 
                        if (part_frames[1]) {
-                               audio.reset (new AudioBuffers(audio, part_frames[1], part_frames[0]));
+                               audio = make_shared<AudioBuffers>(audio, part_frames[1], part_frames[0]);
                        } else {
                                audio.reset ();
                        }
@@ -465,12 +456,12 @@ try
 
                        /* Find one from the back of the queue */
                        _queue.sort ();
-                       auto i = _queue.rbegin ();
-                       while (i != _queue.rend() && (i->type != QueueItem::Type::FULL || !i->encoded)) {
-                               ++i;
+                       auto item = _queue.rbegin();
+                       while (item != _queue.rend() && (item->type != QueueItem::Type::FULL || !item->encoded)) {
+                               ++item;
                        }
 
-                       DCPOMATIC_ASSERT (i != _queue.rend());
+                       DCPOMATIC_ASSERT(item != _queue.rend());
                        ++_pushed_to_disk;
                        /* For the log message below */
                        int const awaiting = _last_written[_queue.front().reel].frame() + 1;
@@ -481,15 +472,15 @@ try
                           thread could erase the last item in the list.
                        */
 
-                       LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting);
+                       LOG_GENERAL("Writer full; pushes %1 to disk while awaiting %2", item->frame, awaiting);
 
-                       i->encoded->write_via_temp (
-                               film()->j2c_path(i->reel, i->frame, i->eyes, true),
-                               film()->j2c_path(i->reel, i->frame, i->eyes, false)
+                       item->encoded->write_via_temp(
+                               film()->j2c_path(item->reel, item->frame, item->eyes, true),
+                               film()->j2c_path(item->reel, item->frame, item->eyes, false)
                                );
 
                        lock.lock ();
-                       i->encoded.reset ();
+                       item->encoded.reset();
                        --_queued_full_in_memory;
                        _full_condition.notify_all ();
                }
@@ -542,19 +533,32 @@ Writer::calculate_digests ()
                pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
        }
 
-       std::function<void (float)> set_progress;
+       std::function<void (int, int64_t, int64_t)> set_progress;
        if (job) {
-               set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
+               set_progress = boost::bind(&Writer::set_digest_progress, this, job.get(), _1, _2, _3);
        } else {
-               set_progress = [](float) {
+               set_progress = [](int, int64_t, int64_t) {
                        boost::this_thread::interruption_point();
                };
        }
 
+       int index = 0;
+
        for (auto& i: _reels) {
-               service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
+               service.post(
+                       boost::bind(
+                               &ReelWriter::calculate_digests,
+                               &i,
+                               std::function<void (int64_t, int64_t)>(boost::bind(set_progress, index, _1, _2))
+                               ));
+               ++index;
        }
-       service.post (boost::bind (&Writer::calculate_referenced_digests, this, set_progress));
+       service.post(
+               boost::bind(
+                       &Writer::calculate_referenced_digests,
+                       this,
+                       std::function<void (int64_t, int64_t)>(boost::bind(set_progress, index, _1, _2))
+                       ));
 
        work.reset ();
 
@@ -583,9 +587,9 @@ Writer::finish (boost::filesystem::path output_dcp)
 
        LOG_GENERAL_NC ("Finishing ReelWriters");
 
-       for (auto& i: _reels) {
-               write_hanging_text (i);
-               i.finish (output_dcp);
+       for (auto& reel: _reels) {
+               write_hanging_text(reel);
+               reel.finish(output_dcp);
        }
 
        LOG_GENERAL_NC ("Writing XML");
@@ -605,7 +609,7 @@ Writer::finish (boost::filesystem::path output_dcp)
        /* Add reels */
 
        for (auto& i: _reels) {
-               cpl->add (i.create_reel(_reel_assets, _fonts, output_dcp, _have_subtitles, _have_closed_captions));
+               cpl->add(i.create_reel(_reel_assets, output_dcp, _have_subtitles, _have_closed_captions));
        }
 
        /* Add metadata */
@@ -627,7 +631,10 @@ Writer::finish (boost::filesystem::path output_dcp)
 
        vector<dcp::ContentVersion> cv;
        for (auto i: film()->content_versions()) {
-               cv.push_back (dcp::ContentVersion(i));
+               /* Make sure we don't end up writing an empty <LabelText> node as some validators
+                * complain about that.
+                */
+               cv.push_back(!i.empty() ? dcp::ContentVersion(i) : dcp::ContentVersion("1"));
        }
        if (cv.empty()) {
                cv = { dcp::ContentVersion("1") };
@@ -657,27 +664,29 @@ Writer::finish (boost::filesystem::path output_dcp)
                cpl->set_sign_language_video_language (*film()->sign_language_video_language());
        }
 
-       auto ac = film()->mapped_audio_channels();
-       dcp::MCASoundField field = (
-               find(ac.begin(), ac.end(), static_cast<int>(dcp::Channel::BSL)) != ac.end() ||
-               find(ac.begin(), ac.end(), static_cast<int>(dcp::Channel::BSR)) != ac.end()
-               ) ? dcp::MCASoundField::SEVEN_POINT_ONE : dcp::MCASoundField::FIVE_POINT_ONE;
+       dcp::MCASoundField field;
+       if (channel_is_mapped(film(), dcp::Channel::BSL) || channel_is_mapped(film(), dcp::Channel::BSR)) {
+               field = dcp::MCASoundField::SEVEN_POINT_ONE;
+       } else {
+               field = dcp::MCASoundField::FIVE_POINT_ONE;
+       }
 
-       dcp::MainSoundConfiguration msc (field, film()->audio_channels());
-       for (auto i: ac) {
-               if (static_cast<int>(i) < film()->audio_channels()) {
-                       msc.set_mapping (i, static_cast<dcp::Channel>(i));
+       auto const audio_channels = film()->audio_channels();
+       dcp::MainSoundConfiguration msc(field, audio_channels);
+       for (auto i: film()->mapped_audio_channels()) {
+               if (i < audio_channels) {
+                       msc.set_mapping(i, static_cast<dcp::Channel>(i));
                }
        }
 
-       cpl->set_main_sound_configuration (msc.to_string());
+       cpl->set_main_sound_configuration(msc);
        cpl->set_main_sound_sample_rate (film()->audio_frame_rate());
        cpl->set_main_picture_stored_area (film()->frame_size());
 
        auto active_area = film()->active_area();
        if (active_area.width > 0 && active_area.height > 0) {
-               /* It's not allowed to have a zero active area width or height */
-               cpl->set_main_picture_active_area (active_area);
+               /* It's not allowed to have a zero active area width or height, and the sizes must be multiples of 2 */
+               cpl->set_main_picture_active_area({ active_area.width & ~1, active_area.height & ~1});
        }
 
        auto sl = film()->subtitle_languages().second;
@@ -696,7 +705,7 @@ Writer::finish (boost::filesystem::path output_dcp)
        dcp.set_creator(creator);
        dcp.set_annotation_text(film()->dcp_name());
 
-       dcp.write_xml (signer, Config::instance()->dcp_metadata_filename_format());
+       dcp.write_xml(signer, !film()->limit_to_smpte_bv20(), Config::instance()->dcp_metadata_filename_format());
 
        LOG_GENERAL (
                N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
@@ -710,8 +719,8 @@ void
 Writer::write_cover_sheet (boost::filesystem::path output_dcp)
 {
        auto const cover = film()->file("COVER_SHEET.txt");
-       dcp::File f(cover, "w");
-       if (!f) {
+       dcp::File file(cover, "w");
+       if (!file) {
                throw OpenFileError (cover, errno, OpenFileError::WRITE);
        }
 
@@ -740,11 +749,11 @@ Writer::write_cover_sheet (boost::filesystem::path output_dcp)
 
        boost::uintmax_t size = 0;
        for (
-               auto i = boost::filesystem::recursive_directory_iterator(output_dcp);
-               i != boost::filesystem::recursive_directory_iterator();
+               auto i = dcp::filesystem::recursive_directory_iterator(output_dcp);
+               i != dcp::filesystem::recursive_directory_iterator();
                ++i) {
-               if (boost::filesystem::is_regular_file (i->path())) {
-                       size += boost::filesystem::file_size (i->path());
+               if (dcp::filesystem::is_regular_file(i->path())) {
+                       size += dcp::filesystem::file_size(i->path());
                }
        }
 
@@ -778,7 +787,7 @@ Writer::write_cover_sheet (boost::filesystem::path output_dcp)
 
        boost::algorithm::replace_all (text, "$LENGTH", length);
 
-       f.checked_write(text.c_str(), text.length());
+       file.checked_write(text.c_str(), text.length());
 }
 
 
@@ -801,7 +810,7 @@ Writer::can_fake_write (Frame frame) const
 
        /* Make frame relative to the start of the reel */
        frame -= reel.start ();
-       return (frame != 0 && frame < reel.first_nonexistant_frame());
+       return (frame != 0 && frame < reel.first_nonexistent_frame());
 }
 
 
@@ -855,25 +864,34 @@ Writer::write (PlayerText text, TextType type, optional<DCPTextTrack> track, DCP
                period = back_off(period);
        }
 
-       (*reel)->write (text, type, track, period);
+       (*reel)->write(text, type, track, period, _fonts, _chosen_interop_font);
 }
 
 
 void
-Writer::write (vector<FontData> fonts)
+Writer::write (vector<shared_ptr<Font>> fonts)
 {
-       /* Just keep a list of unique fonts and we'll deal with them in ::finish */
+       if (fonts.empty()) {
+               return;
+       }
 
-       for (auto const& i: fonts) {
-               bool got = false;
-               for (auto& j: _fonts) {
-                       if (i == j) {
-                               got = true;
-                       }
-               }
+       /* Fonts may come in with empty IDs but we don't want to put those in the DCP */
+       auto fix_id = [](string id) {
+               return id.empty() ? "font" : id;
+       };
 
-               if (!got) {
-                       _fonts.push_back (i);
+       if (film()->interop()) {
+               /* Interop will ignore second and subsequent <LoadFont>s so we don't want to
+                * even write them as they upset some validators.  Set up _fonts so that every
+                * font used by any subtitle will be written with the same ID.
+                */
+               for (size_t i = 0; i < fonts.size(); ++i) {
+                       _fonts.put(fonts[i], fix_id(fonts[0]->id()));
+               }
+               _chosen_interop_font = fonts[0];
+       } else {
+               for (auto font: fonts) {
+                       _fonts.put(font, fix_id(font->id()));
                }
        }
 }
@@ -914,6 +932,22 @@ void
 Writer::write (ReferencedReelAsset asset)
 {
        _reel_assets.push_back (asset);
+
+       if (dynamic_pointer_cast<dcp::ReelSubtitleAsset>(asset.asset)) {
+               _have_subtitles = true;
+       } else if (auto ccap = dynamic_pointer_cast<dcp::ReelClosedCaptionAsset>(asset.asset)) {
+               /* This feels quite fragile. We have a referenced reel and want to know if it's
+                * part of a given closed-caption track so that we can fill if it has any
+                * missing reels.  I guess for that purpose almost any DCPTextTrack values are
+                * fine so long as they are consistent.
+                */
+               DCPTextTrack track;
+               track.name = ccap->annotation_text().get_value_or("");
+               track.language = dcp::LanguageTag(ccap->language().get_value_or("en-US"));
+               if (_have_closed_captions.find(track) == _have_closed_captions.end()) {
+                       _have_closed_captions.insert(track);
+               }
+       }
 }
 
 
@@ -921,28 +955,39 @@ size_t
 Writer::video_reel (int frame) const
 {
        auto t = DCPTime::from_frames (frame, film()->video_frame_rate());
-       size_t i = 0;
-       while (i < _reels.size() && !_reels[i].period().contains (t)) {
-               ++i;
+       size_t reel_index = 0;
+       while (reel_index < _reels.size() && !_reels[reel_index].period().contains(t)) {
+               ++reel_index;
        }
 
-       DCPOMATIC_ASSERT (i < _reels.size ());
-       return i;
+       DCPOMATIC_ASSERT(reel_index < _reels.size ());
+       return reel_index;
 }
 
 
+/** Update job progress with information about the progress of a single digest calculation
+ *  thread.
+ *  @param id Unique identifier for the thread whose progress has changed.
+ *  @param done Number of bytes that this thread has processed.
+ *  @param size Total number of bytes that this thread must process.
+ */
 void
-Writer::set_digest_progress (Job* job, float progress)
+Writer::set_digest_progress(Job* job, int id, int64_t done, int64_t size)
 {
        boost::mutex::scoped_lock lm (_digest_progresses_mutex);
 
-       _digest_progresses[boost::this_thread::get_id()] = progress;
-       float min_progress = FLT_MAX;
+       /* Update the progress for this thread */
+       _digest_progresses[id] = std::make_pair(done, size);
+
+       /* Get the total progress across all threads and use it to set job progress */
+       int64_t total_done = 0;
+       int64_t total_size = 0;
        for (auto const& i: _digest_progresses) {
-               min_progress = min (min_progress, i.second);
+               total_done += i.second.first;
+               total_size += i.second.second;
        }
 
-       job->set_progress (min_progress);
+       job->set_progress(float(total_done) / total_size);
 
        Waker waker;
        waker.nudge ();
@@ -953,13 +998,27 @@ Writer::set_digest_progress (Job* job, float progress)
 
 /** Calculate hashes for any referenced MXF assets which do not already have one */
 void
-Writer::calculate_referenced_digests (std::function<void (float)> set_progress)
+Writer::calculate_referenced_digests(std::function<void (int64_t, int64_t)> set_progress)
 try
 {
+       int64_t total_size = 0;
+       for (auto const& i: _reel_assets) {
+               auto file = dynamic_pointer_cast<dcp::ReelFileAsset>(i.asset);
+               if (file && !file->hash()) {
+                       auto filename = file->asset_ref().asset()->file();
+                       DCPOMATIC_ASSERT(filename);
+                       total_size += boost::filesystem::file_size(*filename);
+               }
+       }
+
+       int64_t total_done = 0;
        for (auto const& i: _reel_assets) {
                auto file = dynamic_pointer_cast<dcp::ReelFileAsset>(i.asset);
                if (file && !file->hash()) {
-                       file->asset_ref().asset()->hash (set_progress);
+                       file->asset_ref().asset()->hash([&total_done, total_size, set_progress](int64_t done, int64_t) {
+                               set_progress(total_done + done, total_size);
+                       });
+                       total_done += boost::filesystem::file_size(*file->asset_ref().asset()->file());
                        file->set_hash (file->asset_ref().asset()->hash());
                }
        }
@@ -976,7 +1035,7 @@ Writer::write_hanging_text (ReelWriter& reel)
        vector<HangingText> new_hanging_texts;
        for (auto i: _hanging_texts) {
                if (i.period.from == reel.period().from) {
-                       reel.write (i.text, i.type, i.track, i.period);
+                       reel.write(i.text, i.type, i.track, i.period, _fonts, _chosen_interop_font);
                } else {
                        new_hanging_texts.push_back (i);
                }