Fix some spelling mistakes (mostly in comments).
[dcpomatic.git] / src / lib / writer.cc
index 7208402e45704002fc3f635bd2d3e16755ff47b4..2dd46f0b2324f4516364b319ab2a1561542cba26 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 "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 "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_file_asset.h>
-#include <fstream>
 #include <cerrno>
-#include <iostream>
 #include <cfloat>
+#include <set>
 
 #include "i18n.h"
 
 
 using std::cout;
 using std::dynamic_pointer_cast;
-using std::list;
-using std::make_pair;
 using std::make_shared;
-using std::map;
 using std::max;
 using std::min;
-using std::pair;
 using std::shared_ptr;
+using std::set;
 using std::string;
 using std::vector;
 using std::weak_ptr;
@@ -74,14 +70,6 @@ using dcp::ArrayData;
 using namespace dcpomatic;
 
 
-static
-void
-ignore_progress (float)
-{
-
-}
-
-
 /** @param j Job to report progress to, or 0.
  *  @param text_only true to enable only the text (subtitle/ccap) parts of the writer.
  */
@@ -315,12 +303,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 ();
                        }
@@ -535,36 +523,9 @@ Writer::terminate_thread (bool can_throw)
 }
 
 
-/** @param output_dcp Path to DCP folder to write */
 void
-Writer::finish (boost::filesystem::path output_dcp)
+Writer::calculate_digests ()
 {
-       if (_thread.joinable()) {
-               LOG_GENERAL_NC ("Terminating writer thread");
-               terminate_thread (true);
-       }
-
-       LOG_GENERAL_NC ("Finishing ReelWriters");
-
-       for (auto& i: _reels) {
-               write_hanging_text (i);
-               i.finish (output_dcp);
-       }
-
-       LOG_GENERAL_NC ("Writing XML");
-
-       dcp::DCP dcp (output_dcp);
-
-       auto cpl = make_shared<dcp::CPL>(
-               film()->dcp_name(),
-               film()->dcp_content_type()->libdcp_kind(),
-               film()->interop() ? dcp::Standard::INTEROP : dcp::Standard::SMPTE
-               );
-
-       dcp.add (cpl);
-
-       /* Calculate digests for each reel in parallel */
-
        auto job = _job.lock ();
        if (job) {
                job->sub (_("Computing digests"));
@@ -575,17 +536,19 @@ Writer::finish (boost::filesystem::path output_dcp)
 
        auto work = make_shared<boost::asio::io_service::work>(service);
 
-       int const threads = max (1, Config::instance()->master_encoding_threads ());
+       int const threads = max (1, Config::instance()->master_encoding_threads());
 
        for (int i = 0; i < threads; ++i) {
                pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
        }
 
-       boost::function<void (float)> set_progress;
+       std::function<void (float)> set_progress;
        if (job) {
                set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
        } else {
-               set_progress = &ignore_progress;
+               set_progress = [](float) {
+                       boost::this_thread::interruption_point();
+               };
        }
 
        for (auto& i: _reels) {
@@ -594,13 +557,55 @@ Writer::finish (boost::filesystem::path output_dcp)
        service.post (boost::bind (&Writer::calculate_referenced_digests, this, set_progress));
 
        work.reset ();
-       pool.join_all ();
+
+       try {
+               pool.join_all ();
+       } catch (boost::thread_interrupted) {
+               /* join_all was interrupted, so we need to interrupt the threads
+                * in our pool then try again to join them.
+                */
+               pool.interrupt_all ();
+               pool.join_all ();
+       }
+
        service.stop ();
+}
+
+
+/** @param output_dcp Path to DCP folder to write */
+void
+Writer::finish (boost::filesystem::path output_dcp)
+{
+       if (_thread.joinable()) {
+               LOG_GENERAL_NC ("Terminating writer thread");
+               terminate_thread (true);
+       }
+
+       LOG_GENERAL_NC ("Finishing ReelWriters");
+
+       for (auto& i: _reels) {
+               write_hanging_text (i);
+               i.finish (output_dcp);
+       }
+
+       LOG_GENERAL_NC ("Writing XML");
+
+       dcp::DCP dcp (output_dcp);
+
+       auto cpl = make_shared<dcp::CPL>(
+               film()->dcp_name(),
+               film()->dcp_content_type()->libdcp_kind(),
+               film()->interop() ? dcp::Standard::INTEROP : dcp::Standard::SMPTE
+               );
+
+       dcp.add (cpl);
+
+       calculate_digests ();
 
        /* 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, _fonts, _chosen_interop_font, output_dcp, _have_subtitles, _have_closed_captions));
        }
 
        /* Add metadata */
@@ -615,12 +620,18 @@ Writer::finish (boost::filesystem::path output_dcp)
                issuer = String::compose("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
        }
 
+       cpl->set_creator (creator);
+       cpl->set_issuer (issuer);
+
        cpl->set_ratings (film()->ratings());
 
        vector<dcp::ContentVersion> cv;
        for (auto i: film()->content_versions()) {
                cv.push_back (dcp::ContentVersion(i));
        }
+       if (cv.empty()) {
+               cv = { dcp::ContentVersion("1") };
+       }
        cpl->set_content_versions (cv);
 
        cpl->set_full_content_title_text (film()->name());
@@ -642,6 +653,9 @@ Writer::finish (boost::filesystem::path output_dcp)
        if (film()->luminance()) {
                cpl->set_luminance (*film()->luminance());
        }
+       if (film()->sign_language_video_language()) {
+               cpl->set_sign_language_video_language (*film()->sign_language_video_language());
+       }
 
        auto ac = film()->mapped_audio_channels();
        dcp::MCASoundField field = (
@@ -678,14 +692,11 @@ Writer::finish (boost::filesystem::path output_dcp)
                throw InvalidSignerError (reason);
        }
 
-       dcp.write_xml (
-               issuer,
-               creator,
-               dcp::LocalTime().as_string(),
-               film()->dcp_name(),
-               signer,
-               Config::instance()->dcp_metadata_filename_format()
-               );
+       dcp.set_issuer(issuer);
+       dcp.set_creator(creator);
+       dcp.set_annotation_text(film()->dcp_name());
+
+       dcp.write_xml (signer, 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
@@ -699,19 +710,23 @@ void
 Writer::write_cover_sheet (boost::filesystem::path output_dcp)
 {
        auto const cover = film()->file("COVER_SHEET.txt");
-       auto f = fopen_boost (cover, "w");
+       dcp::File f(cover, "w");
        if (!f) {
                throw OpenFileError (cover, errno, OpenFileError::WRITE);
        }
 
        auto text = Config::instance()->cover_sheet ();
        boost::algorithm::replace_all (text, "$CPL_NAME", film()->name());
+       auto cpls = film()->cpls();
+       if (!cpls.empty()) {
+               boost::algorithm::replace_all (text, "$CPL_FILENAME", cpls[0].cpl_file.filename().string());
+       }
        boost::algorithm::replace_all (text, "$TYPE", film()->dcp_content_type()->pretty_name());
        boost::algorithm::replace_all (text, "$CONTAINER", film()->container()->container_nickname());
 
-       auto audio_languages = film()->audio_languages();
-       if (!audio_languages.empty()) {
-               boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", audio_languages.front().description());
+       auto audio_language = film()->audio_language();
+       if (audio_language) {
+               boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", audio_language->description());
        } else {
                boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _("None"));
        }
@@ -763,8 +778,7 @@ Writer::write_cover_sheet (boost::filesystem::path output_dcp)
 
        boost::algorithm::replace_all (text, "$LENGTH", length);
 
-       checked_fwrite (text.c_str(), text.length(), f, cover);
-       fclose (f);
+       f.checked_write(text.c_str(), text.length());
 }
 
 
@@ -787,7 +801,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());
 }
 
 
@@ -841,26 +855,79 @@ 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);
 }
 
 
 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 (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 {
+               set<string> used_ids;
 
-               if (!got) {
-                       _fonts.push_back (i);
+               /* 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);
                }
+
+               DCPOMATIC_ASSERT(_fonts.map().size() == used_ids.size());
        }
 }
 
@@ -932,12 +999,15 @@ Writer::set_digest_progress (Job* job, float progress)
 
        Waker waker;
        waker.nudge ();
+
+       boost::this_thread::interruption_point();
 }
 
 
 /** Calculate hashes for any referenced MXF assets which do not already have one */
 void
-Writer::calculate_referenced_digests (boost::function<void (float)> set_progress)
+Writer::calculate_referenced_digests (std::function<void (float)> set_progress)
+try
 {
        for (auto const& i: _reel_assets) {
                auto file = dynamic_pointer_cast<dcp::ReelFileAsset>(i.asset);
@@ -946,6 +1016,10 @@ Writer::calculate_referenced_digests (boost::function<void (float)> set_progress
                        file->set_hash (file->asset_ref().asset()->hash());
                }
        }
+} catch (boost::thread_interrupted) {
+       /* set_progress contains an interruption_point, so any of these methods
+        * may throw thread_interrupted, at which point we just give up.
+        */
 }
 
 
@@ -955,7 +1029,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);
                } else {
                        new_hanging_texts.push_back (i);
                }