Fix DCP content font ID allocation to cope with DCPs that have multiple fonts
[dcpomatic.git] / src / lib / writer.cc
index 2e732c280277fd44938ff75482c7eaad87e8759a..9ab3d4e1edaf3be63d2f335b16677b96f09685b4 100644 (file)
 #include "audio_mapping.h"
 #include "compose.hpp"
 #include "config.h"
+#include "constants.h"
 #include "cross.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"
@@ -70,12 +72,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 +155,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 +233,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 ();
@@ -465,12 +454,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 +470,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 ();
                }
@@ -583,9 +572,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 +594,7 @@ Writer::finish (boost::filesystem::path output_dcp)
        /* Add reels */
 
        for (auto& i: _reels) {
-               cpl->add (i.create_reel(_reel_assets, _fonts, _chosen_interop_font, 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 +616,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,20 +649,22 @@ 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());
 
@@ -696,7 +690,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 +704,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 +734,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 +772,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());
 }
 
 
@@ -855,7 +849,7 @@ Writer::write (PlayerText text, TextType type, optional<DCPTextTrack> track, DCP
                period = back_off(period);
        }
 
-       (*reel)->write(text, type, track, period, _fonts);
+       (*reel)->write(text, type, track, period, _fonts, _chosen_interop_font);
 }
 
 
@@ -881,53 +875,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());
        }
 }
 
@@ -974,13 +924,13 @@ 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;
 }
 
 
@@ -1029,7 +979,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, _fonts);
+                       reel.write(i.text, i.type, i.track, i.period, _fonts, _chosen_interop_font);
                } else {
                        new_hanging_texts.push_back (i);
                }