Merge master.
[dcpomatic.git] / src / lib / writer.cc
index 5f94d5d6bc65e1f95f13ee730a5af12c579ee286..8508a07163218a8e16b446640007e9431956fc18 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include <fstream>
 #include <cerrno>
-#include <libdcp/picture_asset.h>
-#include <libdcp/sound_asset.h>
-#include <libdcp/picture_frame.h>
-#include <libdcp/reel.h>
-#include <libdcp/dcp.h>
-#include <libdcp/cpl.h>
+#include <dcp/mono_picture_mxf.h>
+#include <dcp/stereo_picture_mxf.h>
+#include <dcp/sound_mxf.h>
+#include <dcp/sound_mxf_writer.h>
+#include <dcp/reel.h>
+#include <dcp/reel_mono_picture_asset.h>
+#include <dcp/reel_stereo_picture_asset.h>
+#include <dcp/reel_sound_asset.h>
+#include <dcp/dcp.h>
+#include <dcp/cpl.h>
 #include "writer.h"
 #include "compose.hpp"
 #include "film.h"
 #include "audio_mapping.h"
 #include "config.h"
 #include "job.h"
+#include "cross.h"
+#include "audio_buffers.h"
 
 #include "i18n.h"
 
+/* OS X strikes again */
+#undef set_key
+
 using std::make_pair;
 using std::pair;
 using std::string;
-using std::ifstream;
 using std::list;
 using std::cout;
+using std::stringstream;
 using boost::shared_ptr;
+using boost::weak_ptr;
+using boost::dynamic_pointer_cast;
 
-int const Writer::_maximum_frames_in_memory = 8;
+int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
 
-Writer::Writer (shared_ptr<const Film> f, shared_ptr<Job> j)
+Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
        : _film (f)
        , _job (j)
        , _first_nonexistant_frame (0)
@@ -60,58 +71,61 @@ Writer::Writer (shared_ptr<const Film> f, shared_ptr<Job> j)
        , _last_written_eyes (EYES_RIGHT)
        , _full_written (0)
        , _fake_written (0)
-       , _repeat_written (0)
        , _pushed_to_disk (0)
 {
        /* Remove any old DCP */
        boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
-       
+
+       shared_ptr<Job> job = _job.lock ();
+       assert (job);
+
+       job->sub (_("Checking existing image data"));
        check_existing_picture_mxf ();
-       
+
        /* Create our picture asset in a subdirectory, named according to those
           film's parameters which affect the video output.  We will hard-link
           it into the DCP later.
        */
 
-       if (f->three_d ()) {
-               _picture_asset.reset (
-                       new libdcp::StereoPictureAsset (
-                               _film->internal_video_mxf_dir (),
-                               _film->internal_video_mxf_filename (),
-                               _film->video_frame_rate (),
-                               _film->container()->size (_film->full_frame ())
-                               )
-                       );
-               
+       if (_film->three_d ()) {
+               _picture_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
        } else {
-               _picture_asset.reset (
-                       new libdcp::MonoPictureAsset (
-                               _film->internal_video_mxf_dir (),
-                               _film->internal_video_mxf_filename (),
-                               _film->video_frame_rate (),
-                               _film->container()->size (_film->full_frame ())
-                               )
-                       );
-
+               _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
        }
 
-       _picture_asset_writer = _picture_asset->start_write (_first_nonexistant_frame > 0, _film->interop ());
+       _picture_mxf->set_size (_film->frame_size ());
+
+       if (_film->encrypted ()) {
+               _picture_mxf->set_key (_film->key ());
+       }
        
-       _sound_asset.reset (
-               new libdcp::SoundAsset (
-                       _film->dir (_film->dcp_name()),
-                       _film->audio_mxf_filename (),
-                       _film->video_frame_rate (),
-                       _film->audio_channels (),
-                       _film->audio_frame_rate ()
-                       )
+       _picture_mxf_writer = _picture_mxf->start_write (
+               _film->internal_video_mxf_dir() / _film->internal_video_mxf_filename(),
+               _film->interop() ? dcp::INTEROP : dcp::SMPTE,
+               _first_nonexistant_frame > 0
                );
+
+       if (_film->audio_channels ()) {
+               _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
+
+               if (_film->encrypted ()) {
+                       _sound_mxf->set_key (_film->key ());
+               }
        
-       _sound_asset_writer = _sound_asset->start_write (_film->interop ());
+               /* Write the sound MXF into the film directory so that we leave the creation
+                  of the DCP directory until the last minute.
+               */
+               _sound_mxf_writer = _sound_mxf->start_write (_film->directory() / _film->audio_mxf_filename(), _film->interop() ? dcp::INTEROP : dcp::SMPTE);
+       }
 
        _thread = new boost::thread (boost::bind (&Writer::thread, this));
 
-       _job->descend (0.9);
+       job->sub (_("Encoding image data"));
+}
+
+Writer::~Writer ()
+{
+       terminate_thread (false);
 }
 
 void
@@ -119,6 +133,10 @@ Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
 {
        boost::mutex::scoped_lock lock (_mutex);
 
+       while (_queued_full_in_memory > _maximum_frames_in_memory) {
+               _full_condition.wait (lock);
+       }
+
        QueueItem qi;
        qi.type = QueueItem::FULL;
        qi.encoded = encoded;
@@ -138,7 +156,7 @@ Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
                ++_queued_full_in_memory;
        }
        
-       _condition.notify_all ();
+       _empty_condition.notify_all ();
 }
 
 void
@@ -146,8 +164,13 @@ Writer::fake_write (int frame, Eyes eyes)
 {
        boost::mutex::scoped_lock lock (_mutex);
 
-       ifstream ifi (_film->info_path (frame, eyes).c_str());
-       libdcp::FrameInfo info (ifi);
+       while (_queued_full_in_memory > _maximum_frames_in_memory) {
+               _full_condition.wait (lock);
+       }
+       
+       FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
+       dcp::FrameInfo info (ifi);
+       fclose (ifi);
        
        QueueItem qi;
        qi.type = QueueItem::FAKE;
@@ -163,26 +186,28 @@ Writer::fake_write (int frame, Eyes eyes)
                _queue.push_back (qi);
        }
 
-       _condition.notify_all ();
+       _empty_condition.notify_all ();
 }
 
 /** This method is not thread safe */
 void
 Writer::write (shared_ptr<const AudioBuffers> audio)
 {
-       _sound_asset_writer->write (audio->data(), audio->frames());
+       if (_sound_mxf_writer) {
+               _sound_mxf_writer->write (audio->data(), audio->frames());
+       }
 }
 
-/** This must be called from Writer::thread() with an appropriate lock held,
- *  and with _queue sorted.
- */
+/** This must be called from Writer::thread() with an appropriate lock held */
 bool
-Writer::have_sequenced_image_at_queue_head () const
+Writer::have_sequenced_image_at_queue_head ()
 {
        if (_queue.empty ()) {
                return false;
        }
 
+       _queue.sort ();
+
        /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
 
        if (_queue.front().eyes == EYES_BOTH) {
@@ -213,14 +238,12 @@ try
 
                while (1) {
                        
-                       _queue.sort ();
-                       
                        if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
                                break;
                        }
 
                        TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
-                       _condition.wait (lock);
+                       _empty_condition.wait (lock);
                        TIMING (N_("writer wakes with a queue of %1"), _queue.size());
                }
 
@@ -228,7 +251,7 @@ try
                        return;
                }
 
-               /* Write any frames that we can write; i.e. those that are in sequence */
+               /* Write any frames that we can write; i.e. those that are in sequence. */
                while (have_sequenced_image_at_queue_head ()) {
                        QueueItem qi = _queue.front ();
                        _queue.pop_front ();
@@ -245,7 +268,7 @@ try
                                        qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
                                }
 
-                               libdcp::FrameInfo fin = _picture_asset_writer->write (qi.encoded->data(), qi.encoded->size());
+                               dcp::FrameInfo fin = _picture_mxf_writer->write (qi.encoded->data(), qi.encoded->size());
                                qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
                                _last_written[qi.eyes] = qi.encoded;
                                ++_full_written;
@@ -253,32 +276,27 @@ try
                        }
                        case QueueItem::FAKE:
                                _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
-                               _picture_asset_writer->fake_write (qi.size);
+                               _picture_mxf_writer->fake_write (qi.size);
                                _last_written[qi.eyes].reset ();
                                ++_fake_written;
                                break;
-                       case QueueItem::REPEAT:
-                       {
-                               _film->log()->log (String::compose (N_("Writer REPEAT-writes %1 to MXF"), qi.frame));
-                               libdcp::FrameInfo fin = _picture_asset_writer->write (
-                                       _last_written[qi.eyes]->data(),
-                                       _last_written[qi.eyes]->size()
-                                       );
-                               
-                               _last_written[qi.eyes]->write_info (_film, qi.frame, qi.eyes, fin);
-                               ++_repeat_written;
-                               break;
-                       }
                        }
                        lock.lock ();
 
                        _last_written_frame = qi.frame;
                        _last_written_eyes = qi.eyes;
                        
-                       if (_film->length()) {
-                               _job->set_progress (
-                                       float (_full_written + _fake_written + _repeat_written) / _film->time_to_video_frames (_film->length())
-                                       );
+                       shared_ptr<Job> job = _job.lock ();
+                       assert (job);
+                       int64_t total = _film->length().frames (_film->video_frame_rate ());
+                       if (_film->three_d ()) {
+                               /* _full_written and so on are incremented for each eye, so we need to double the total
+                                  frames to get the correct progress.
+                               */
+                               total *= 2;
+                       }
+                       if (total) {
+                               job->set_progress (float (_full_written + _fake_written) / total);
                        }
                }
 
@@ -287,7 +305,8 @@ try
                           Write some FULL frames to disk.
                        */
 
-                       /* Find one */
+                       /* Find one from the back of the queue */
+                       _queue.sort ();
                        list<QueueItem>::reverse_iterator i = _queue.rbegin ();
                        while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
                                ++i;
@@ -312,6 +331,8 @@ try
                        qi.encoded.reset ();
                        --_queued_full_in_memory;
                }
+
+               _full_condition.notify_all ();
        }
 }
 catch (...)
@@ -320,131 +341,139 @@ catch (...)
 }
 
 void
-Writer::finish ()
+Writer::terminate_thread (bool can_throw)
 {
-       if (!_thread) {
+       boost::mutex::scoped_lock lock (_mutex);
+       if (_thread == 0) {
                return;
        }
        
-       boost::mutex::scoped_lock lock (_mutex);
        _finish = true;
-       _condition.notify_all ();
+       _empty_condition.notify_all ();
+       _full_condition.notify_all ();
        lock.unlock ();
 
-       _thread->join ();
-       if (thrown ()) {
+       _thread->join ();
+       if (can_throw) {
                rethrow ();
        }
        
        delete _thread;
        _thread = 0;
+}      
 
-       _picture_asset_writer->finalize ();
-       _sound_asset_writer->finalize ();
+void
+Writer::finish ()
+{
+       if (!_thread) {
+               return;
+       }
        
-       int const frames = _last_written_frame + 1;
-
-       _picture_asset->set_duration (frames);
+       terminate_thread (true);
 
+       _picture_mxf_writer->finalize ();
+       if (_sound_mxf_writer) {
+               _sound_mxf_writer->finalize ();
+       }
+       
        /* Hard-link the video MXF into the DCP */
-
-       boost::filesystem::path from;
-       from /= _film->internal_video_mxf_dir();
-       from /= _film->internal_video_mxf_filename();
+       boost::filesystem::path video_from;
+       video_from /= _film->internal_video_mxf_dir();
+       video_from /= _film->internal_video_mxf_filename();
        
-       boost::filesystem::path to;
-       to /= _film->dir (_film->dcp_name());
-       to /= _film->video_mxf_filename ();
+       boost::filesystem::path video_to;
+       video_to /= _film->dir (_film->dcp_name());
+       video_to /= _film->video_mxf_filename ();
 
        boost::system::error_code ec;
-       boost::filesystem::create_hard_link (from, to, ec);
+       boost::filesystem::create_hard_link (video_from, video_to, ec);
        if (ec) {
                /* hard link failed; copy instead */
-               boost::filesystem::copy_file (from, to);
+               boost::filesystem::copy_file (video_from, video_to);
                _film->log()->log ("Hard-link failed; fell back to copying");
        }
 
-       /* And update the asset */
+       /* Move the audio MXF into the DCP */
 
-       _picture_asset->set_directory (_film->dir (_film->dcp_name ()));
-       _picture_asset->set_file_name (_film->video_mxf_filename ());
-       _sound_asset->set_duration (frames);
-       
-       libdcp::DCP dcp (_film->dir (_film->dcp_name()));
+       if (_sound_mxf) {
+               boost::filesystem::path audio_to;
+               audio_to /= _film->dir (_film->dcp_name ());
+               audio_to /= _film->audio_mxf_filename ();
+               
+               boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
+               if (ec) {
+                       throw FileError (
+                               String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
+                               );
+               }
+       }
+
+       dcp::DCP dcp (_film->dir (_film->dcp_name()));
 
-       shared_ptr<libdcp::CPL> cpl (
-               new libdcp::CPL (
-                       _film->dir (_film->dcp_name()),
+       shared_ptr<dcp::CPL> cpl (
+               new dcp::CPL (
                        _film->dcp_name(),
-                       _film->dcp_content_type()->libdcp_kind (),
-                       frames,
-                       _film->video_frame_rate ()
+                       _film->dcp_content_type()->libdcp_kind ()
                        )
                );
        
-       dcp.add_cpl (cpl);
-
-       cpl->add_reel (shared_ptr<libdcp::Reel> (new libdcp::Reel (
-                                                        _picture_asset,
-                                                        _sound_asset,
-                                                        shared_ptr<libdcp::SubtitleAsset> ()
-                                                        )
-                              ));
+       dcp.add (cpl);
 
-       /* Compute the digests for the assets now so that we can keep track of progress.
-          We did _job->descend (0.9) in our constructor */
-       _job->ascend ();
+       shared_ptr<dcp::Reel> reel (new dcp::Reel ());
 
-       _job->descend (0.1);
-       _picture_asset->compute_digest (boost::bind (&Job::set_progress, _job.get(), _1));
-       _job->ascend ();
+       shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (_picture_mxf);
+       if (mono) {
+               reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
+       }
 
-       _job->descend (0.1);
-       _sound_asset->compute_digest (boost::bind (&Job::set_progress, _job.get(), _1));
-       _job->ascend ();
+       shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (_picture_mxf);
+       if (stereo) {
+               reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
+       }
 
-       libdcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
-       meta.set_issue_date_now ();
-       dcp.write_xml (_film->interop (), meta);
+       reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
+       
+       cpl->add (reel);
 
-       _film->log()->log (String::compose (N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT; %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk));
-}
+       shared_ptr<Job> job = _job.lock ();
+       assert (job);
 
-/** Tell the writer that frame `f' should be a repeat of the frame before it */
-void
-Writer::repeat (int f, Eyes e)
-{
-       boost::mutex::scoped_lock lock (_mutex);
+       job->sub (_("Computing image digest"));
+       _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
 
-       QueueItem qi;
-       qi.type = QueueItem::REPEAT;
-       qi.frame = f;
-       if (_film->three_d() && e == EYES_BOTH) {
-               qi.eyes = EYES_LEFT;
-               _queue.push_back (qi);
-               qi.eyes = EYES_RIGHT;
-               _queue.push_back (qi);
-       } else {
-               qi.eyes = e;
-               _queue.push_back (qi);
+       if (_sound_mxf) {
+               job->sub (_("Computing audio digest"));
+               _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
        }
 
-       _condition.notify_all ();
+       dcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
+       meta.set_issue_date_now ();
+       dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, _film->is_signed() ? make_signer () : shared_ptr<const dcp::Signer> ());
+
+       _film->log()->log (
+               String::compose (N_("Wrote %1 FULL, %2 FAKE, %3 pushed to disk"), _full_written, _fake_written, _pushed_to_disk)
+               );
 }
 
 bool
 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
 {
        /* Read the frame info as written */
-       ifstream ifi (_film->info_path (f, eyes).c_str());
-       libdcp::FrameInfo info (ifi);
+       FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
+       if (!ifi) {
+               _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
+               return false;
+       }
+       
+       dcp::FrameInfo info (ifi);
+       fclose (ifi);
        if (info.size == 0) {
                _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
                return false;
        }
        
        /* Read the data from the MXF and hash it */
-       fseek (mxf, info.offset, SEEK_SET);
+       dcpomatic_fseek (mxf, info.offset, SEEK_SET);
        EncodedData data (info.size);
        size_t const read = fread (data.data(), 1, data.size(), mxf);
        if (read != static_cast<size_t> (data.size ())) {
@@ -468,14 +497,26 @@ Writer::check_existing_picture_mxf ()
        boost::filesystem::path p;
        p /= _film->internal_video_mxf_dir ();
        p /= _film->internal_video_mxf_filename ();
-       FILE* mxf = fopen (p.string().c_str(), "rb");
+       FILE* mxf = fopen_boost (p, "rb");
        if (!mxf) {
                _film->log()->log (String::compose ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno));
                return;
        }
 
+       int N = 0;
+       for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
+               ++N;
+       }
+
        while (1) {
 
+               shared_ptr<Job> job = _job.lock ();
+               assert (job);
+
+               if (N > 0) {
+                       job->set_progress (float (_first_nonexistant_frame) / N);
+               }
+
                if (_film->three_d ()) {
                        if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
                                break;