Tidy up logging a bit. Make it configurable from the GUI.
[dcpomatic.git] / src / lib / writer.cc
index 8d9b5855ebbd9a9a809225e2ccf0a53ce4a071d2..b058c2801160d301142e00509159aa7a243b57a1 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 "i18n.h"
 
+#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::GENERAL);
+#define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
+#define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::WARNING);
+
+/* OS X strikes again */
+#undef set_key
+
 using std::make_pair;
 using std::pair;
 using std::string;
 using std::list;
 using std::cout;
+using std::stringstream;
 using boost::shared_ptr;
 using boost::weak_ptr;
 
-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, weak_ptr<Job> j)
        : _film (f)
@@ -85,7 +93,8 @@ Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
        }
 
        _picture_asset->set_edit_rate (_film->video_frame_rate ());
-       _picture_asset->set_size (fit_ratio_within (_film->container()->ratio(), _film->full_frame ()));
+       _picture_asset->set_size (_film->frame_size ());
+       _picture_asset->set_interop (_film->interop ());
 
        if (_film->encrypted ()) {
                _picture_asset->set_key (_film->key ());
@@ -93,30 +102,42 @@ Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
        
        _picture_asset_writer = _picture_asset->start_write (_first_nonexistant_frame > 0);
 
-       /* Write the sound asset into the film directory so that we leave the creation
-          of the DCP directory until the last minute.
-       */
-       _sound_asset.reset (new libdcp::SoundAsset (_film->directory (), _film->audio_mxf_filename ()));
-       _sound_asset->set_edit_rate (_film->video_frame_rate ());
-       _sound_asset->set_channels (_film->audio_channels ());
-       _sound_asset->set_sampling_rate (_film->audio_frame_rate ());
+       if (_film->audio_channels ()) {
+               _sound_asset.reset (new libdcp::SoundAsset (_film->directory (), _film->audio_mxf_filename ()));
+               _sound_asset->set_edit_rate (_film->video_frame_rate ());
+               _sound_asset->set_channels (_film->audio_channels ());
+               _sound_asset->set_sampling_rate (_film->audio_frame_rate ());
+               _sound_asset->set_interop (_film->interop ());
 
-       if (_film->encrypted ()) {
-               _sound_asset->set_key (_film->key ());
+               if (_film->encrypted ()) {
+                       _sound_asset->set_key (_film->key ());
+               }
+               
+               /* 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 ();
        }
-       
-       _sound_asset_writer = _sound_asset->start_write ();
 
        _thread = new boost::thread (boost::bind (&Writer::thread, this));
 
        job->sub (_("Encoding image data"));
 }
 
+Writer::~Writer ()
+{
+       terminate_thread (false);
+}
+
 void
 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;
@@ -136,7 +157,7 @@ Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
                ++_queued_full_in_memory;
        }
        
-       _condition.notify_all ();
+       _empty_condition.notify_all ();
 }
 
 void
@@ -144,6 +165,10 @@ Writer::fake_write (int frame, Eyes eyes)
 {
        boost::mutex::scoped_lock lock (_mutex);
 
+       while (_queued_full_in_memory > _maximum_frames_in_memory) {
+               _full_condition.wait (lock);
+       }
+       
        FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
        libdcp::FrameInfo info (ifi);
        fclose (ifi);
@@ -162,14 +187,16 @@ 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_asset) {
+               _sound_asset_writer->write (audio->data(), audio->frames());
+       }
 }
 
 /** This must be called from Writer::thread() with an appropriate lock held */
@@ -216,9 +243,9 @@ try
                                break;
                        }
 
-                       TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
-                       _condition.wait (lock);
-                       TIMING (N_("writer wakes with a queue of %1"), _queue.size());
+                       LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
+                       _empty_condition.wait (lock);
+                       LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
                }
 
                if (_finish && _queue.empty()) {
@@ -237,7 +264,7 @@ try
                        switch (qi.type) {
                        case QueueItem::FULL:
                        {
-                               _film->log()->log (String::compose (N_("Writer FULL-writes %1 to MXF"), qi.frame));
+                               LOG_GENERAL (N_("Writer FULL-writes %1 to MXF"), qi.frame);
                                if (!qi.encoded) {
                                        qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
                                }
@@ -249,14 +276,14 @@ try
                                break;
                        }
                        case QueueItem::FAKE:
-                               _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
+                               LOG_GENERAL (N_("Writer FAKE-writes %1 to MXF"), qi.frame);
                                _picture_asset_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));
+                               LOG_GENERAL (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()
@@ -291,7 +318,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;
@@ -304,11 +332,10 @@ try
                        
                        lock.unlock ();
 
-                       _film->log()->log (
-                               String::compose (
-                                       "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
-                                       _last_written_frame + 1,
-                                       _last_written_eyes, qi.frame)
+                       LOG_GENERAL (
+                               "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
+                               _last_written_frame + 1,
+                               _last_written_eyes, qi.frame
                                );
                        
                        qi.encoded->write (_film, qi.frame, qi.eyes);
@@ -316,6 +343,8 @@ try
                        qi.encoded.reset ();
                        --_queued_full_in_memory;
                }
+
+               _full_condition.notify_all ();
        }
 }
 catch (...)
@@ -324,25 +353,40 @@ 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 ();
-       rethrow ();
+       _thread->join ();
+       if (can_throw) {
+               rethrow ();
+       }
        
        delete _thread;
        _thread = 0;
+}      
+
+void
+Writer::finish ()
+{
+       if (!_thread) {
+               return;
+       }
+       
+       terminate_thread (true);
 
        _picture_asset_writer->finalize ();
-       _sound_asset_writer->finalize ();
+       if (_sound_asset_writer) {
+               _sound_asset_writer->finalize ();
+       }
        
        int const frames = _last_written_frame + 1;
 
@@ -362,7 +406,7 @@ Writer::finish ()
        if (ec) {
                /* hard link failed; copy instead */
                boost::filesystem::copy_file (video_from, video_to);
-               _film->log()->log ("Hard-link failed; fell back to copying");
+               LOG_WARNING_NC ("Hard-link failed; fell back to copying");
        }
 
        /* And update the asset */
@@ -372,19 +416,21 @@ Writer::finish ()
 
        /* Move the audio MXF into the DCP */
 
-       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 ())
-                       );
+       if (_sound_asset) {
+               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 ())
+                               );
+               }
+               
+               _sound_asset->set_directory (_film->dir (_film->dcp_name ()));
+               _sound_asset->set_duration (frames);
        }
-
-       _sound_asset->set_directory (_film->dir (_film->dcp_name ()));
-       _sound_asset->set_duration (frames);
        
        libdcp::DCP dcp (_film->dir (_film->dcp_name()));
 
@@ -413,14 +459,18 @@ Writer::finish ()
        job->sub (_("Computing image digest"));
        _picture_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
 
-       job->sub (_("Computing audio digest"));
-       _sound_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
+       if (_sound_asset) {
+               job->sub (_("Computing audio digest"));
+               _sound_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
+       }
 
        libdcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
        meta.set_issue_date_now ();
        dcp.write_xml (_film->interop (), meta, _film->is_signed() ? make_signer () : shared_ptr<const libdcp::Signer> ());
 
-       _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));
+       LOG_GENERAL (
+               N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT; %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
+               );
 }
 
 /** Tell the writer that frame `f' should be a repeat of the frame before it */
@@ -429,6 +479,10 @@ Writer::repeat (int f, Eyes e)
 {
        boost::mutex::scoped_lock lock (_mutex);
 
+       while (_queued_full_in_memory > _maximum_frames_in_memory) {
+               _full_condition.wait (lock);
+       }
+       
        QueueItem qi;
        qi.type = QueueItem::REPEAT;
        qi.frame = f;
@@ -442,7 +496,7 @@ Writer::repeat (int f, Eyes e)
                _queue.push_back (qi);
        }
 
-       _condition.notify_all ();
+       _empty_condition.notify_all ();
 }
 
 bool
@@ -451,14 +505,14 @@ Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
        /* Read the frame info as written */
        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));
+               LOG_GENERAL ("Existing frame %1 has no info file", f);
                return false;
        }
        
        libdcp::FrameInfo info (ifi);
        fclose (ifi);
        if (info.size == 0) {
-               _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
+               LOG_GENERAL ("Existing frame %1 has no info file", f);
                return false;
        }
        
@@ -467,13 +521,13 @@ Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
        EncodedData data (info.size);
        size_t const read = fread (data.data(), 1, data.size(), mxf);
        if (read != static_cast<size_t> (data.size ())) {
-               _film->log()->log (String::compose ("Existing frame %1 is incomplete", f));
+               LOG_GENERAL ("Existing frame %1 is incomplete", f);
                return false;
        }
        
        string const existing_hash = md5_digest (data.data(), data.size());
        if (existing_hash != info.hash) {
-               _film->log()->log (String::compose ("Existing frame %1 failed hash check", f));
+               LOG_GENERAL ("Existing frame %1 failed hash check", f);
                return false;
        }
 
@@ -489,7 +543,7 @@ Writer::check_existing_picture_mxf ()
        p /= _film->internal_video_mxf_filename ();
        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));
+               LOG_GENERAL ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno);
                return;
        }
 
@@ -503,7 +557,9 @@ Writer::check_existing_picture_mxf ()
                shared_ptr<Job> job = _job.lock ();
                assert (job);
 
-               job->set_progress (float (_first_nonexistant_frame) / N);
+               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)) {
@@ -518,7 +574,7 @@ Writer::check_existing_picture_mxf ()
                        }
                }
 
-               _film->log()->log (String::compose ("Have existing frame %1", _first_nonexistant_frame));
+               LOG_GENERAL ("Have existing frame %1", _first_nonexistant_frame);
                ++_first_nonexistant_frame;
        }