More enum class additions.
[dcpomatic.git] / src / lib / writer.cc
index 7d1088276995a242300402684facbf0290e3876f..e47fa973b8841b21c5cfdebdba8784f770b51123 100644 (file)
 #include "cross.h"
 #include "audio_buffers.h"
 #include "version.h"
-#include "font.h"
+#include "font_data.h"
 #include "util.h"
 #include "reel_writer.h"
 #include "text_content.h"
 #include <dcp/cpl.h>
 #include <dcp/locale_convert.h>
-#include <boost/foreach.hpp>
+#include <dcp/reel_file_asset.h>
 #include <fstream>
 #include <cerrno>
 #include <iostream>
@@ -58,15 +58,31 @@ using std::map;
 using std::min;
 using std::max;
 using std::vector;
-using boost::shared_ptr;
-using boost::weak_ptr;
-using boost::dynamic_pointer_cast;
+using std::shared_ptr;
+using std::weak_ptr;
+using std::dynamic_pointer_cast;
 using boost::optional;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
 using dcp::Data;
+using dcp::ArrayData;
 using namespace dcpomatic;
 
-Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
-       : _film (film)
+
+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.
+ */
+Writer::Writer (weak_ptr<const Film> weak_film, weak_ptr<Job> j, bool text_only)
+       : WeakConstFilm (weak_film)
        , _job (j)
        , _finish (false)
        , _queued_full_in_memory (0)
@@ -77,14 +93,15 @@ Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
        , _fake_written (0)
        , _repeat_written (0)
        , _pushed_to_disk (0)
+       , _text_only (text_only)
+       , _have_subtitles (false)
 {
        shared_ptr<Job> job = _job.lock ();
-       DCPOMATIC_ASSERT (job);
 
        int reel_index = 0;
-       list<DCPTimePeriod> const reels = _film->reels ();
-       BOOST_FOREACH (DCPTimePeriod p, reels) {
-               _reels.push_back (ReelWriter (film, p, job, reel_index++, reels.size(), _film->content_summary(p)));
+       auto const reels = film()->reels();
+       for (auto p: reels) {
+               _reels.push_back (ReelWriter(weak_film, p, job, reel_index++, reels.size(), text_only));
        }
 
        _last_written.resize (reels.size());
@@ -94,7 +111,7 @@ Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
        */
        _audio_reel = _reels.begin ();
        _subtitle_reel = _reels.begin ();
-       BOOST_FOREACH (DCPTextTrack i, _film->closed_caption_tracks()) {
+       for (auto i: film()->closed_caption_tracks()) {
                _caption_reels[i] = _reels.begin ();
        }
        _atmos_reel = _reels.begin ();
@@ -109,15 +126,19 @@ Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
 void
 Writer::start ()
 {
-       _thread = boost::thread (boost::bind(&Writer::thread, this));
+       if (!_text_only) {
+               _thread = boost::thread (boost::bind(&Writer::thread, this));
 #ifdef DCPOMATIC_LINUX
-       pthread_setname_np (_thread.native_handle(), "writer");
+               pthread_setname_np (_thread.native_handle(), "writer");
 #endif
+       }
 }
 
 Writer::~Writer ()
 {
-       terminate_thread (false);
+       if (!_text_only) {
+               terminate_thread (false);
+       }
 }
 
 /** Pass a video frame to the writer for writing to disk at some point.
@@ -127,7 +148,7 @@ Writer::~Writer ()
  *  @param eyes Eyes that this frame image is for.
  */
 void
-Writer::write (Data encoded, Frame frame, Eyes eyes)
+Writer::write (shared_ptr<const Data> encoded, Frame frame, Eyes eyes)
 {
        boost::mutex::scoped_lock lock (_state_mutex);
 
@@ -144,12 +165,12 @@ Writer::write (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) {
+       if (film()->three_d() && eyes == Eyes::BOTH) {
                /* 2D material in a 3D DCP; fake the 3D */
-               qi.eyes = EYES_LEFT;
+               qi.eyes = Eyes::LEFT;
                _queue.push_back (qi);
                ++_queued_full_in_memory;
-               qi.eyes = EYES_RIGHT;
+               qi.eyes = Eyes::RIGHT;
                _queue.push_back (qi);
                ++_queued_full_in_memory;
        } else {
@@ -189,10 +210,10 @@ Writer::repeat (Frame frame, Eyes eyes)
        qi.type = QueueItem::REPEAT;
        qi.reel = video_reel (frame);
        qi.frame = frame - _reels[qi.reel].start ();
-       if (_film->three_d() && eyes == EYES_BOTH) {
-               qi.eyes = EYES_LEFT;
+       if (film()->three_d() && eyes == Eyes::BOTH) {
+               qi.eyes = Eyes::LEFT;
                _queue.push_back (qi);
-               qi.eyes = EYES_RIGHT;
+               qi.eyes = Eyes::RIGHT;
                _queue.push_back (qi);
        } else {
                qi.eyes = eyes;
@@ -223,16 +244,16 @@ Writer::fake_write (Frame frame, Eyes eyes)
        qi.type = QueueItem::FAKE;
 
        {
-               shared_ptr<InfoFileHandle> info_file = _film->info_file_handle(_reels[reel].period(), true);
+               shared_ptr<InfoFileHandle> info_file = film()->info_file_handle(_reels[reel].period(), true);
                qi.size = _reels[reel].read_frame_info(info_file, frame_in_reel, eyes).size;
        }
 
        qi.reel = reel;
        qi.frame = frame_in_reel;
-       if (_film->three_d() && eyes == EYES_BOTH) {
-               qi.eyes = EYES_LEFT;
+       if (film()->three_d() && eyes == Eyes::BOTH) {
+               qi.eyes = Eyes::LEFT;
                _queue.push_back (qi);
-               qi.eyes = EYES_RIGHT;
+               qi.eyes = Eyes::RIGHT;
                _queue.push_back (qi);
        } else {
                qi.eyes = eyes;
@@ -253,7 +274,7 @@ Writer::write (shared_ptr<const AudioBuffers> audio, DCPTime const time)
 {
        DCPOMATIC_ASSERT (audio);
 
-       int const afr = _film->audio_frame_rate();
+       int const afr = film()->audio_frame_rate();
 
        DCPTime const end = time + DCPTime::from_frames(audio->frames(), afr);
 
@@ -334,18 +355,18 @@ Writer::have_sequenced_image_at_queue_head ()
 bool
 Writer::LastWritten::next (QueueItem qi) const
 {
-       if (qi.eyes == EYES_BOTH) {
+       if (qi.eyes == Eyes::BOTH) {
                /* 2D */
                return qi.frame == (_frame + 1);
        }
 
        /* 3D */
 
-       if (_eyes == EYES_LEFT && qi.frame == _frame && qi.eyes == EYES_RIGHT) {
+       if (_eyes == Eyes::LEFT && qi.frame == _frame && qi.eyes == Eyes::RIGHT) {
                return true;
        }
 
-       if (_eyes == EYES_RIGHT && qi.frame == (_frame + 1) && qi.eyes == EYES_LEFT) {
+       if (_eyes == Eyes::RIGHT && qi.frame == (_frame + 1) && qi.eyes == Eyes::LEFT) {
                return true;
        }
 
@@ -382,10 +403,6 @@ try
                        LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
                }
 
-               if (_finish && _queue.empty()) {
-                       return;
-               }
-
                /* We stop here if we have been asked to finish, and if either the queue
                   is empty or we do not have a sequenced image at its head (if this is the
                   case we will never terminate as no new frames will be sent once
@@ -395,7 +412,7 @@ try
                        /* (Hopefully temporarily) log anything that was not written */
                        if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
                                LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
-                               BOOST_FOREACH (QueueItem const& i, _queue) {
+                               for (auto const& i: _queue) {
                                        if (i.type == QueueItem::FULL) {
                                                LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i.frame, (int) i.eyes);
                                        } else {
@@ -423,7 +440,7 @@ try
                        case QueueItem::FULL:
                                LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
                                if (!qi.encoded) {
-                                       qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
+                                       qi.encoded.reset (new ArrayData(film()->j2c_path(qi.reel, qi.frame, qi.eyes, false)));
                                }
                                reel.write (qi.encoded, qi.frame, qi.eyes);
                                ++_full_written;
@@ -470,8 +487,8 @@ try
                        LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->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)
+                               film()->j2c_path(i->reel, i->frame, i->eyes, true),
+                               film()->j2c_path(i->reel, i->frame, i->eyes, false)
                                );
 
                        lock.lock ();
@@ -489,48 +506,48 @@ catch (...)
 void
 Writer::terminate_thread (bool can_throw)
 {
+       boost::this_thread::disable_interruption dis;
+
        boost::mutex::scoped_lock lock (_state_mutex);
-       if (!_thread.joinable()) {
-               return;
-       }
 
        _finish = true;
        _empty_condition.notify_all ();
        _full_condition.notify_all ();
        lock.unlock ();
 
-       _thread.join ();
+       try {
+               _thread.join ();
+       } catch (...) {}
 
        if (can_throw) {
                rethrow ();
        }
 }
 
+
+/** @param output_dcp Path to DCP folder to write */
 void
-Writer::finish ()
+Writer::finish (boost::filesystem::path output_dcp)
 {
-       if (!_thread.joinable()) {
-               return;
+       if (_thread.joinable()) {
+               LOG_GENERAL_NC ("Terminating writer thread");
+               terminate_thread (true);
        }
 
-       LOG_GENERAL_NC ("Terminating writer thread");
-
-       terminate_thread (true);
-
        LOG_GENERAL_NC ("Finishing ReelWriters");
 
-       BOOST_FOREACH (ReelWriter& i, _reels) {
-               i.finish ();
+       for (auto& i: _reels) {
+               i.finish (output_dcp);
        }
 
        LOG_GENERAL_NC ("Writing XML");
 
-       dcp::DCP dcp (_film->dir (_film->dcp_name()));
+       dcp::DCP dcp (output_dcp);
 
        shared_ptr<dcp::CPL> cpl (
                new dcp::CPL (
-                       _film->dcp_name(),
-                       _film->dcp_content_type()->libdcp_kind ()
+                       film()->dcp_name(),
+                       film()->dcp_content_type()->libdcp_kind ()
                        )
                );
 
@@ -539,7 +556,9 @@ Writer::finish ()
        /* Calculate digests for each reel in parallel */
 
        shared_ptr<Job> job = _job.lock ();
-       job->sub (_("Computing digests"));
+       if (job) {
+               job->sub (_("Computing digests"));
+       }
 
        boost::asio::io_service service;
        boost::thread_group pool;
@@ -552,36 +571,80 @@ Writer::finish ()
                pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
        }
 
-       BOOST_FOREACH (ReelWriter& i, _reels) {
-               boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
+       boost::function<void (float)> set_progress;
+       if (job) {
+               set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
+       } else {
+               set_progress = &ignore_progress;
+       }
+
+       for (auto& i: _reels) {
                service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
        }
+       service.post (boost::bind (&Writer::calculate_referenced_digests, this, set_progress));
 
        work.reset ();
        pool.join_all ();
        service.stop ();
 
-       /* Add reels to CPL */
+       /* Add reels */
 
-       BOOST_FOREACH (ReelWriter& i, _reels) {
-               cpl->add (i.create_reel (_reel_assets, _fonts));
+       for (auto& i: _reels) {
+               cpl->add (i.create_reel(_reel_assets, _fonts, output_dcp, _have_subtitles, _have_closed_captions));
        }
 
-       dcp::XMLMetadata meta;
-       meta.annotation_text = cpl->annotation_text ();
-       meta.creator = Config::instance()->dcp_creator ();
-       if (meta.creator.empty ()) {
-               meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
+       /* Add metadata */
+
+       string creator = Config::instance()->dcp_creator();
+       if (creator.empty()) {
+               creator = String::compose("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
        }
-       meta.issuer = Config::instance()->dcp_issuer ();
-       if (meta.issuer.empty ()) {
-               meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
+
+       string issuer = Config::instance()->dcp_issuer();
+       if (issuer.empty()) {
+               issuer = String::compose("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
+       }
+
+       cpl->set_ratings (film()->ratings());
+
+       vector<dcp::ContentVersion> cv;
+       for (auto i: film()->content_versions()) {
+               cv.push_back (dcp::ContentVersion(i));
+       }
+       cpl->set_content_versions (cv);
+
+       cpl->set_full_content_title_text (film()->name());
+       cpl->set_full_content_title_text_language (film()->name_language());
+       cpl->set_release_territory (film()->release_territory());
+       cpl->set_version_number (film()->version_number());
+       cpl->set_status (film()->status());
+       cpl->set_chain (film()->chain());
+       cpl->set_distributor (film()->distributor());
+       cpl->set_facility (film()->facility());
+       cpl->set_luminance (film()->luminance());
+
+       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::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));
+               }
        }
-       meta.set_issue_date_now ();
 
-       cpl->set_metadata (meta);
-       cpl->set_ratings (vector_to_list(_film->ratings()));
-       cpl->set_content_version_label_text (_film->content_version());
+       cpl->set_main_sound_configuration (msc.to_string());
+       cpl->set_main_sound_sample_rate (film()->audio_frame_rate());
+       cpl->set_main_picture_stored_area (film()->frame_size());
+       cpl->set_main_picture_active_area (film()->active_area());
+
+       vector<dcp::LanguageTag> sl = film()->subtitle_languages();
+       if (sl.size() > 1) {
+               cpl->set_additional_subtitle_languages(std::vector<dcp::LanguageTag>(sl.begin() + 1, sl.end()));
+       }
 
        shared_ptr<const dcp::CertificateChain> signer;
        signer = Config::instance()->signer_chain ();
@@ -591,43 +654,48 @@ Writer::finish ()
                throw InvalidSignerError (reason);
        }
 
-       dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
+       dcp.write_xml (
+               film()->interop() ? dcp::Standard::INTEROP : dcp::Standard::SMPTE,
+               issuer,
+               creator,
+               dcp::LocalTime().as_string(),
+               film()->dcp_name(),
+               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
                );
 
-       write_cover_sheet ();
+       write_cover_sheet (output_dcp);
 }
 
 void
-Writer::write_cover_sheet ()
+Writer::write_cover_sheet (boost::filesystem::path output_dcp)
 {
-       boost::filesystem::path const cover = _film->file ("COVER_SHEET.txt");
+       boost::filesystem::path const cover = film()->file("COVER_SHEET.txt");
        FILE* f = fopen_boost (cover, "w");
        if (!f) {
                throw OpenFileError (cover, errno, OpenFileError::WRITE);
        }
 
        string text = Config::instance()->cover_sheet ();
-       boost::algorithm::replace_all (text, "$CPL_NAME", _film->name());
-       boost::algorithm::replace_all (text, "$TYPE", _film->dcp_content_type()->pretty_name());
-       boost::algorithm::replace_all (text, "$CONTAINER", _film->container()->container_nickname());
-       boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _film->isdcf_metadata().audio_language);
-
-       optional<string> subtitle_language;
-       BOOST_FOREACH (shared_ptr<Content> i, _film->content()) {
-               BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
-                       if (j->type() == TEXT_OPEN_SUBTITLE && j->use()) {
-                               subtitle_language = j->language ();
-                       }
-               }
+       boost::algorithm::replace_all (text, "$CPL_NAME", film()->name());
+       boost::algorithm::replace_all (text, "$TYPE", film()->dcp_content_type()->pretty_name());
+       boost::algorithm::replace_all (text, "$CONTAINER", film()->container()->container_nickname());
+       boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", film()->isdcf_metadata().audio_language);
+
+       vector<dcp::LanguageTag> subtitle_languages = film()->subtitle_languages();
+       if (subtitle_languages.empty()) {
+               boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", "None");
+       } else {
+               boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", subtitle_languages.front().description());
        }
-       boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", subtitle_language.get_value_or("None"));
 
        boost::uintmax_t size = 0;
        for (
-               boost::filesystem::recursive_directory_iterator i = boost::filesystem::recursive_directory_iterator(_film->dir(_film->dcp_name()));
+               boost::filesystem::recursive_directory_iterator i = boost::filesystem::recursive_directory_iterator(output_dcp);
                i != boost::filesystem::recursive_directory_iterator();
                ++i) {
                if (boost::filesystem::is_regular_file (i->path ())) {
@@ -641,7 +709,7 @@ Writer::write_cover_sheet ()
                boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1MB", dcp::locale_convert<string> (size / 1000000.0, 1, true)));
        }
 
-       pair<int, int> ch = audio_channel_types (_film->mapped_audio_channels(), _film->audio_channels());
+       pair<int, int> ch = audio_channel_types (film()->mapped_audio_channels(), film()->audio_channels());
        string description = String::compose("%1.%2", ch.first, ch.second);
 
        if (description == "0.0") {
@@ -654,7 +722,7 @@ Writer::write_cover_sheet ()
        boost::algorithm::replace_all (text, "$AUDIO", description);
 
        int h, m, s, fr;
-       _film->length().split (_film->video_frame_rate(), h, m, s, fr);
+       film()->length().split(film()->video_frame_rate(), h, m, s, fr);
        string length;
        if (h == 0 && m == 0) {
                length = String::compose("%1s", s);
@@ -676,7 +744,7 @@ Writer::write_cover_sheet ()
 bool
 Writer::can_fake_write (Frame frame) const
 {
-       if (_film->encrypted()) {
+       if (film()->encrypted()) {
                /* We need to re-write the frame because the asset ID is embedded in the HMAC... I think... */
                return false;
        }
@@ -692,20 +760,22 @@ Writer::can_fake_write (Frame frame) const
        return (frame != 0 && frame < reel.first_nonexistant_frame());
 }
 
-/** @param track Closed caption track if type == TEXT_CLOSED_CAPTION */
+/** @param track Closed caption track if type == TextType::CLOSED_CAPTION */
 void
 Writer::write (PlayerText text, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
 {
-       vector<ReelWriter>::iterator* reel = 0;
+       vector<ReelWriter>::iterator* reel = nullptr;
 
        switch (type) {
-       case TEXT_OPEN_SUBTITLE:
+       case TextType::OPEN_SUBTITLE:
                reel = &_subtitle_reel;
+               _have_subtitles = true;
                break;
-       case TEXT_CLOSED_CAPTION:
+       case TextType::CLOSED_CAPTION:
                DCPOMATIC_ASSERT (track);
                DCPOMATIC_ASSERT (_caption_reels.find(*track) != _caption_reels.end());
                reel = &_caption_reels[*track];
+               _have_closed_captions.insert (*track);
                break;
        default:
                DCPOMATIC_ASSERT (false);
@@ -721,14 +791,14 @@ Writer::write (PlayerText text, TextType type, optional<DCPTextTrack> track, DCP
 }
 
 void
-Writer::write (list<shared_ptr<Font> > fonts)
+Writer::write (vector<FontData> fonts)
 {
        /* Just keep a list of unique fonts and we'll deal with them in ::finish */
 
-       BOOST_FOREACH (shared_ptr<Font> i, fonts) {
+       for (auto const& i: fonts) {
                bool got = false;
-               BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
-                       if (*i == *j) {
+               for (auto& j: _fonts) {
+                       if (i == j) {
                                got = true;
                        }
                }
@@ -776,7 +846,7 @@ Writer::write (ReferencedReelAsset asset)
 size_t
 Writer::video_reel (int frame) const
 {
-       DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
+       auto t = DCPTime::from_frames (frame, film()->video_frame_rate());
        size_t i = 0;
        while (i < _reels.size() && !_reels[i].period().contains (t)) {
                ++i;
@@ -793,8 +863,8 @@ Writer::set_digest_progress (Job* job, float progress)
 
        _digest_progresses[boost::this_thread::get_id()] = progress;
        float min_progress = FLT_MAX;
-       for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
-               min_progress = min (min_progress, i->second);
+       for (auto const& i: _digest_progresses) {
+               min_progress = min (min_progress, i.second);
        }
 
        job->set_progress (min_progress);
@@ -802,3 +872,18 @@ Writer::set_digest_progress (Job* job, float progress)
        Waker waker;
        waker.nudge ();
 }
+
+
+/** Calculate hashes for any referenced MXF assets which do not already have one */
+void
+Writer::calculate_referenced_digests (boost::function<void (float)> set_progress)
+{
+       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->set_hash (file->asset_ref().asset()->hash());
+               }
+       }
+}
+