Store subtitle language(s) in Film, and allow setup of those
[dcpomatic.git] / src / lib / reel_writer.cc
index 116761dab857b269528fb1b7f558ec1abc587964..a927770a5858e55698dc83a86df8787f2860475f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "digester.h"
 #include "font.h"
 #include "compose.hpp"
+#include "config.h"
 #include "audio_buffers.h"
 #include "image.h"
+#include <dcp/atmos_asset.h>
+#include <dcp/atmos_asset_writer.h>
 #include <dcp/mono_picture_asset.h>
 #include <dcp/stereo_picture_asset.h>
 #include <dcp/sound_asset.h>
 #include <dcp/sound_asset_writer.h>
 #include <dcp/reel.h>
+#include <dcp/reel_atmos_asset.h>
 #include <dcp/reel_mono_picture_asset.h>
 #include <dcp/reel_stereo_picture_asset.h>
 #include <dcp/reel_sound_asset.h>
@@ -56,23 +60,43 @@ using std::string;
 using std::cout;
 using std::exception;
 using std::map;
+using std::vector;
 using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
+using dcp::ArrayData;
 using dcp::Data;
 using dcp::raw_convert;
 using namespace dcpomatic;
 
 int const ReelWriter::_info_size = 48;
 
+static dcp::MXFMetadata
+mxf_metadata ()
+{
+       dcp::MXFMetadata meta;
+       Config* config = Config::instance();
+       if (!config->dcp_company_name().empty()) {
+               meta.company_name = config->dcp_company_name ();
+       }
+       if (!config->dcp_product_name().empty()) {
+               meta.product_name = config->dcp_product_name ();
+       }
+       if (!config->dcp_product_version().empty()) {
+               meta.product_version = config->dcp_product_version ();
+       }
+       return meta;
+}
+
 /** @param job Related job, or 0 */
 ReelWriter::ReelWriter (
        shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
        )
        : _film (film)
        , _period (period)
-       , _last_written_video_frame (-1)
-       , _last_written_eyes (EYES_RIGHT)
        , _reel_index (reel_index)
        , _reel_count (reel_count)
        , _content_summary (content_summary)
@@ -115,6 +139,7 @@ ReelWriter::ReelWriter (
                }
 
                _picture_asset->set_size (_film->frame_size());
+               _picture_asset->set_metadata (mxf_metadata());
 
                if (_film->encrypted ()) {
                        _picture_asset->set_key (_film->key());
@@ -135,20 +160,29 @@ ReelWriter::ReelWriter (
 
        if (_film->audio_channels ()) {
                _sound_asset.reset (
-                       new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
+                       new dcp::SoundAsset (dcp::Fraction(_film->video_frame_rate(), 1), _film->audio_frame_rate(), _film->audio_channels(), _film->audio_language(), standard)
                        );
 
+               _sound_asset->set_metadata (mxf_metadata());
+
                if (_film->encrypted ()) {
                        _sound_asset->set_key (_film->key ());
                }
 
                DCPOMATIC_ASSERT (_film->directory());
 
+               vector<dcp::Channel> active;
+               BOOST_FOREACH (int i, _film->mapped_audio_channels()) {
+                       active.push_back (static_cast<dcp::Channel>(i));
+               }
+
                /* Write the sound asset into the film directory so that we leave the creation
                   of the DCP directory until the last minute.
                */
                _sound_asset_writer = _sound_asset->start_write (
-                       _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
+                       _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary),
+                       active,
+                       _film->contains_atmos_content()
                        );
        }
 }
@@ -219,7 +253,7 @@ ReelWriter::check_existing_picture_asset (boost::filesystem::path asset)
 
        try {
                info_file = _film->info_file_handle (_period, true);
-       } catch (OpenFileError) {
+       } catch (OpenFileError &) {
                LOG_GENERAL_NC ("Could not open film info file");
                fclose (asset_file);
                return 0;
@@ -256,22 +290,37 @@ ReelWriter::check_existing_picture_asset (boost::filesystem::path asset)
 }
 
 void
-ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
+ReelWriter::write (shared_ptr<const Data> encoded, Frame frame, Eyes eyes)
 {
        if (!_picture_asset_writer) {
                /* We're not writing any data */
                return;
        }
 
-       dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
+       dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data(), encoded->size());
        write_frame_info (frame, eyes, fin);
        _last_written[eyes] = encoded;
-       _last_written_video_frame = frame;
-       _last_written_eyes = eyes;
 }
 
+
+void
+ReelWriter::write (shared_ptr<const dcp::AtmosFrame> atmos, AtmosMetadata metadata)
+{
+       if (!_atmos_asset) {
+               _atmos_asset = metadata.create (dcp::Fraction(_film->video_frame_rate(), 1));
+               if (_film->encrypted()) {
+                       _atmos_asset->set_key(_film->key());
+               }
+               _atmos_asset_writer = _atmos_asset->start_write (
+                       _film->directory().get() / atmos_asset_filename (_atmos_asset, _reel_index, _reel_count, _content_summary)
+                       );
+       }
+       _atmos_asset_writer->write (atmos);
+}
+
+
 void
-ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
+ReelWriter::fake_write (int size)
 {
        if (!_picture_asset_writer) {
                /* We're not writing any data */
@@ -279,8 +328,6 @@ ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
        }
 
        _picture_asset_writer->fake_write (size);
-       _last_written_video_frame = frame;
-       _last_written_eyes = eyes;
 }
 
 void
@@ -292,12 +339,10 @@ ReelWriter::repeat_write (Frame frame, Eyes eyes)
        }
 
        dcp::FrameInfo fin = _picture_asset_writer->write (
-               _last_written[eyes]->data().get(),
+               _last_written[eyes]->data(),
                _last_written[eyes]->size()
                );
        write_frame_info (frame, eyes, fin);
-       _last_written_video_frame = frame;
-       _last_written_eyes = eyes;
 }
 
 void
@@ -368,6 +413,24 @@ ReelWriter::finish ()
 
                _sound_asset->set_file (audio_to);
        }
+
+       if (_atmos_asset) {
+               _atmos_asset_writer->finalize ();
+               boost::filesystem::path atmos_to;
+               atmos_to /= _film->dir (_film->dcp_name());
+               string const aaf = atmos_asset_filename (_atmos_asset, _reel_index, _reel_count, _content_summary);
+               atmos_to /= aaf;
+
+               boost::system::error_code ec;
+               boost::filesystem::rename (_film->file(aaf), atmos_to, ec);
+               if (ec) {
+                       throw FileError (
+                               String::compose (_("could not move atmos asset into the DCP (%1)"), ec.value ()), aaf
+                               );
+               }
+
+               _atmos_asset->set_file (atmos_to);
+       }
 }
 
 template <class T>
@@ -387,24 +450,9 @@ maybe_add_text (
        shared_ptr<T> reel_asset;
 
        if (asset) {
-               boost::filesystem::path liberation_normal;
-               try {
-                       liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
-                       if (!boost::filesystem::exists (liberation_normal)) {
-                               /* Hack for unit tests */
-                               liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
-                       }
-               } catch (boost::filesystem::filesystem_error& e) {
-
-               }
-
-               if (!boost::filesystem::exists(liberation_normal)) {
-                       liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
-               }
-
                /* Add the font to the subtitle content */
                BOOST_FOREACH (shared_ptr<Font> j, fonts) {
-                       asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
+                       asset->add_font (j->id(), j->file().get_value_or(default_font_file()));
                }
 
                if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
@@ -462,6 +510,8 @@ maybe_add_text (
 shared_ptr<dcp::Reel>
 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
 {
+       LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
+
        shared_ptr<dcp::Reel> reel (new dcp::Reel ());
 
        shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
@@ -491,8 +541,6 @@ ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr
                }
        }
 
-       LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
-
        Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
 
        DCPOMATIC_ASSERT (reel_picture_asset);
@@ -515,9 +563,13 @@ ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr
                /* We have made a sound asset of our own.  Put it into the reel */
                reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
        } else {
+               LOG_GENERAL ("no sound asset of our own; look through %1", refs.size());
                /* We don't have a sound asset of our own; hopefully we have one to reference */
                BOOST_FOREACH (ReferencedReelAsset j, refs) {
                        shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
+                       if (k) {
+                               LOG_GENERAL ("candidate sound asset period is %1-%2", j.period.from.get(), j.period.to.get());
+                       }
                        if (k && j.period == _period) {
                                reel_sound_asset = k;
                                /* If we have a hash for this asset in the CPL, assume that it is correct */
@@ -554,9 +606,10 @@ ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr
                a->set_language (i->first.language);
        }
 
-       map<dcp::Marker, DCPTime> markers = _film->markers ();
-       map<dcp::Marker, DCPTime> reel_markers;
-       for (map<dcp::Marker, DCPTime>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
+       Film::Markers markers = _film->markers ();
+       _film->add_ffoc_lfoc (markers);
+       Film::Markers reel_markers;
+       for (Film::Markers::const_iterator i = markers.begin(); i != markers.end(); ++i) {
                if (_period.contains(i->second)) {
                        reel_markers[i->first] = i->second;
                }
@@ -573,6 +626,10 @@ ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr
                reel->add (ma);
        }
 
+       if (_atmos_asset) {
+               reel->add (shared_ptr<dcp::ReelAtmosAsset>(new dcp::ReelAtmosAsset(_atmos_asset, 0)));
+       }
+
        return reel;
 }
 
@@ -586,6 +643,10 @@ ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
        if (_sound_asset) {
                _sound_asset->hash (set_progress);
        }
+
+       if (_atmos_asset) {
+               _atmos_asset->hash (set_progress);
+       }
 }
 
 Frame
@@ -624,12 +685,12 @@ ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track,
        }
 
        if (!asset) {
-               string lang = _film->subtitle_language ();
+               vector<dcp::LanguageTag> lang = _film->subtitle_languages ();
                if (_film->interop ()) {
                        shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
                        s->set_movie_title (_film->name ());
                        if (type == TEXT_OPEN_SUBTITLE) {
-                               s->set_language (lang.empty() ? "Unknown" : lang);
+                               s->set_language (lang.empty() ? "Unknown" : lang.front().to_string());
                        } else {
                                s->set_language (track->language);
                        }
@@ -638,8 +699,9 @@ ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track,
                } else {
                        shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
                        s->set_content_title_text (_film->name ());
+                       s->set_metadata (mxf_metadata());
                        if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
-                               s->set_language (lang);
+                               s->set_language (lang.front().to_string());
                        } else {
                                s->set_language (track->language);
                        }
@@ -702,15 +764,15 @@ ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr<InfoFileHand
 
        /* Read the data from the asset and hash it */
        dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
-       Data data (info.size);
-       size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
+       ArrayData data (info.size);
+       size_t const read = fread (data.data(), 1, data.size(), asset_file);
        LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
        if (read != static_cast<size_t> (data.size ())) {
                LOG_GENERAL ("Existing frame %1 is incomplete", frame);
                ok = false;
        } else {
                Digester digester;
-               digester.add (data.data().get(), data.size());
+               digester.add (data.data(), data.size());
                LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
                if (digester.get() != info.hash) {
                        LOG_GENERAL ("Existing frame %1 failed hash check", frame);