Remove in-place translations support.
[dcpomatic.git] / src / lib / writer.cc
index d42b23478f469e68e4c650f03b5606c918e2ec57..fbe2d248d5c952c3112f1e5f9f7184ae3b4073c3 100644 (file)
@@ -29,6 +29,7 @@
 #include "dcp_video.h"
 #include "dcpomatic_log.h"
 #include "film.h"
+#include "film_util.h"
 #include "job.h"
 #include "log.h"
 #include "ratio.h"
@@ -40,7 +41,9 @@
 #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 <dcp/reel_subtitle_asset.h>
 #include <cerrno>
 #include <cfloat>
 #include <set>
@@ -71,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)
@@ -453,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;
@@ -469,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 ();
                }
@@ -530,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 ();
 
@@ -571,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");
@@ -615,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") };
@@ -646,15 +665,18 @@ Writer::finish (boost::filesystem::path output_dcp)
        }
 
        dcp::MCASoundField field;
-       if (film()->audio_channels() <= 6) {
-               field = dcp::MCASoundField::FIVE_POINT_ONE;
-       } else {
+       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, MAX_DCP_AUDIO_CHANNELS);
+       auto const audio_channels = film()->audio_channels();
+       dcp::MainSoundConfiguration msc(field, audio_channels);
        for (auto i: film()->mapped_audio_channels()) {
-               msc.set_mapping(i, static_cast<dcp::Channel>(i));
+               if (i < audio_channels) {
+                       msc.set_mapping(i, static_cast<dcp::Channel>(i));
+               }
        }
 
        cpl->set_main_sound_configuration(msc);
@@ -697,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);
        }
 
@@ -727,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());
                }
        }
 
@@ -765,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());
 }
 
 
@@ -868,53 +890,9 @@ Writer::write (vector<shared_ptr<Font>> fonts)
                }
                _chosen_interop_font = fonts[0];
        } else {
-               set<string> used_ids;
-
-               /* Return the index of a _N at the end of a string, or string::npos */
-               auto underscore_number_position = [](string s) {
-                       auto last_underscore = s.find_last_of("_");
-                       if (last_underscore == string::npos) {
-                               return string::npos;
-                       }
-
-                       for (auto i = last_underscore + 1; i < s.size(); ++i) {
-                               if (!isdigit(s[i])) {
-                                       return string::npos;
-                               }
-                       }
-
-                       return last_underscore;
-               };
-
-               /* Write fonts to _fonts, changing any duplicate IDs so that they are unique */
                for (auto font: fonts) {
-                       auto id = fix_id(font->id());
-                       if (used_ids.find(id) == used_ids.end()) {
-                               /* This ID is unique so we can just use it as-is */
-                               _fonts.put(font, id);
-                               used_ids.insert(id);
-                       } else {
-                               auto end = underscore_number_position(id);
-                               if (end == string::npos) {
-                                       /* This string has no _N suffix, so add one */
-                                       id += "_0";
-                                       end = underscore_number_position(id);
-                               }
-
-                               ++end;
-
-                               /* Increment the suffix until we find a unique one */
-                               auto number = dcp::raw_convert<int>(id.substr(end));
-                               while (used_ids.find(id) != used_ids.end()) {
-                                       ++number;
-                                       id = String::compose("%1_%2", id.substr(0, end - 1), number);
-                               }
-                               used_ids.insert(id);
-                       }
-                       _fonts.put(font, id);
+                       _fonts.put(font, fix_id(font->id()));
                }
-
-               DCPOMATIC_ASSERT(_fonts.map().size() == used_ids.size());
        }
 }
 
@@ -954,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);
+               }
+       }
 }
 
 
@@ -961,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 ();
@@ -993,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());
                }
        }