*/
-#include <libdcp/picture_asset.h>
-#include <libdcp/sound_asset.h>
-#include <libdcp/reel.h>
+#include <fstream>
+#include <cerrno>
+#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 "format.h"
+#include "ratio.h"
#include "log.h"
#include "dcp_video_frame.h"
+#include "dcp_content_type.h"
+#include "player.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::list;
+using std::cout;
+using std::stringstream;
using boost::shared_ptr;
+using boost::weak_ptr;
+using boost::dynamic_pointer_cast;
-unsigned 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<Film> f)
+Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
: _film (f)
+ , _job (j)
+ , _first_nonexistant_frame (0)
, _thread (0)
, _finish (false)
+ , _queued_full_in_memory (0)
, _last_written_frame (-1)
+ , _last_written_eyes (EYES_RIGHT)
+ , _full_written (0)
+ , _fake_written (0)
+ , _repeat_written (0)
+ , _pushed_to_disk (0)
{
- _picture_asset.reset (
- new libdcp::MonoPictureAsset (
- _film->dir (_film->dcp_name()),
- _film->video_mxf_path(),
- DCPFrameRate (_film->frames_per_second()).frames_per_second,
- _film->format()->dcp_size()
- )
- );
+ /* 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 (_film->three_d ()) {
+ _picture_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
+ } else {
+ _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
+ }
+
+ _picture_mxf->set_size (_film->frame_size ());
+
+ if (_film->encrypted ()) {
+ _picture_mxf->set_key (_film->key ());
+ }
- _picture_asset_writer = _picture_asset->start_write ();
-
- if (_film->audio_channels() > 0) {
- _sound_asset.reset (
- new libdcp::SoundAsset (
- _film->dir (_film->dcp_name()),
- "audio.mxf",
- DCPFrameRate (_film->frames_per_second()).frames_per_second,
- _film->audio_channels(),
- dcp_audio_sample_rate (_film->audio_stream()->sample_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
+ );
+
+ _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
- _sound_asset_writer = _sound_asset->start_write ();
+ if (_film->encrypted ()) {
+ _sound_mxf->set_key (_film->key ());
}
+ /* 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->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;
+ qi.frame = frame;
+
+ if (_film->three_d() && eyes == EYES_BOTH) {
+ /* 2D material in a 3D DCP; fake the 3D */
+ qi.eyes = EYES_LEFT;
+ _queue.push_back (qi);
+ ++_queued_full_in_memory;
+ qi.eyes = EYES_RIGHT;
+ _queue.push_back (qi);
+ ++_queued_full_in_memory;
+ } else {
+ qi.eyes = eyes;
+ _queue.push_back (qi);
+ ++_queued_full_in_memory;
+ }
+
+ _empty_condition.notify_all ();
}
void
-Writer::write (shared_ptr<const EncodedData> encoded, int frame)
+Writer::fake_write (int frame, Eyes eyes)
{
boost::mutex::scoped_lock lock (_mutex);
- _queue.push_back (make_pair (encoded, frame));
- _condition.notify_all ();
+
+ 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;
+ qi.size = info.size;
+ qi.frame = frame;
+ if (_film->three_d() && eyes == EYES_BOTH) {
+ qi.eyes = EYES_LEFT;
+ _queue.push_back (qi);
+ qi.eyes = EYES_RIGHT;
+ _queue.push_back (qi);
+ } else {
+ qi.eyes = eyes;
+ _queue.push_back (qi);
+ }
+
+ _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());
+ _sound_mxf_writer->write (audio->data(), audio->frames());
}
-struct QueueSorter
+/** This must be called from Writer::thread() with an appropriate lock held */
+bool
+Writer::have_sequenced_image_at_queue_head ()
{
- bool operator() (pair<shared_ptr<const EncodedData>, int> const & a, pair<shared_ptr<const EncodedData>, int> const & b) {
- return a.second < b.second;
+ 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) {
+ /* 2D */
+ return _queue.front().frame == (_last_written_frame + 1);
+ }
+
+ /* 3D */
+
+ if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
+ return true;
+ }
+
+ if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
+ return true;
+ }
+
+ return false;
+}
void
Writer::thread ()
+try
{
while (1)
{
boost::mutex::scoped_lock lock (_mutex);
while (1) {
- if (_finish ||
- _queue.size() > _maximum_frames_in_memory ||
- (!_queue.empty() && _queue.front().second == (_last_written_frame + 1))) {
-
- break;
- }
-
- TIMING ("writer sleeps with a queue of %1; %2 pending", _queue.size(), _pending.size());
- _condition.wait (lock);
- TIMING ("writer wakes with a queue of %1", _queue.size());
-
- _queue.sort (QueueSorter ());
+
+ 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());
+ _empty_condition.wait (lock);
+ TIMING (N_("writer wakes with a queue of %1"), _queue.size());
}
- if (_finish && _queue.empty() && _pending.empty()) {
+ if (_finish && _queue.empty()) {
return;
}
- /* Write any frames that we can write; i.e. those that are in sequence */
- while (!_queue.empty() && _queue.front().second == (_last_written_frame + 1)) {
- pair<boost::shared_ptr<const EncodedData>, int> encoded = _queue.front ();
+ /* 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 ();
+ if (qi.type == QueueItem::FULL && qi.encoded) {
+ --_queued_full_in_memory;
+ }
lock.unlock ();
- _film->log()->log (String::compose ("Writer writes %1 to MXF", encoded.second));
- if (encoded.first) {
- _picture_asset_writer->write (encoded.first->data(), encoded.first->size());
- encoded.first->write_hash (_film, encoded.second);
- _last_written = encoded.first;
- } else {
- _picture_asset_writer->write (_last_written->data(), _last_written->size());
- _last_written->write_hash (_film, encoded.second);
+ switch (qi.type) {
+ case QueueItem::FULL:
+ {
+ _film->log()->log (String::compose (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)));
+ }
+
+ 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;
+ break;
+ }
+ case QueueItem::FAKE:
+ _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
+ _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));
+ dcp::FrameInfo fin = _picture_mxf_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;
+ _last_written_frame = qi.frame;
+ _last_written_eyes = qi.eyes;
+
+ 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 + _repeat_written) / total);
+ }
}
- while (_queue.size() > _maximum_frames_in_memory) {
+ while (_queued_full_in_memory > _maximum_frames_in_memory) {
/* Too many frames in memory which can't yet be written to the stream.
- Put some to disk.
+ Write some FULL frames to disk.
*/
- pair<boost::shared_ptr<const EncodedData>, int> encoded = _queue.back ();
- _queue.pop_back ();
- if (!encoded.first) {
- /* This is a `repeat-last' frame, so no need to write it to disk */
- continue;
+ /* 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;
}
- lock.unlock ();
- _film->log()->log (String::compose ("Writer full (awaiting %1); pushes %2 to disk", _last_written_frame + 1, encoded.second));
- encoded.first->write (_film, encoded.second);
- lock.lock ();
-
- _pending.push_back (encoded.second);
- }
-
- while (_queue.size() < _maximum_frames_in_memory && !_pending.empty()) {
- /* We have some space in memory. Fetch some frames back off disk. */
-
- _pending.sort ();
- int const fetch = _pending.front ();
+ assert (i != _queue.rend());
+ QueueItem qi = *i;
+ ++_pushed_to_disk;
+
lock.unlock ();
- _film->log()->log (String::compose ("Writer pulls %1 back from disk", fetch));
- shared_ptr<const EncodedData> encoded;
- if (boost::filesystem::exists (_film->j2c_path (fetch, false))) {
- /* It's an actual frame (not a repeat-last); load it in */
- encoded.reset (new EncodedData (_film->j2c_path (fetch, false)));
- }
- lock.lock ();
- _queue.push_back (make_pair (encoded, fetch));
- _pending.remove (fetch);
+ _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)
+ );
+
+ qi.encoded->write (_film, qi.frame, qi.eyes);
+ lock.lock ();
+ qi.encoded.reset ();
+ --_queued_full_in_memory;
}
- }
+ _full_condition.notify_all ();
+ }
+}
+catch (...)
+{
+ store_current ();
}
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 ();
+ _thread->join ();
+ if (can_throw) {
+ rethrow ();
+ }
+
delete _thread;
_thread = 0;
+}
- _picture_asset_writer->finalize ();
-
- if (_sound_asset_writer) {
- _sound_asset_writer->finalize ();
+void
+Writer::finish ()
+{
+ if (!_thread) {
+ return;
}
+
+ terminate_thread (true);
- int const frames = _last_written_frame + 1;
- int const duration = frames - _film->trim_start() - _film->trim_end();
+ _picture_mxf_writer->finalize ();
+ _sound_mxf_writer->finalize ();
- _film->set_dcp_intrinsic_duration (frames);
+ /* Hard-link the video MXF into the DCP */
+ boost::filesystem::path video_from;
+ video_from /= _film->internal_video_mxf_dir();
+ video_from /= _film->internal_video_mxf_filename();
- _picture_asset->set_entry_point (_film->trim_start ());
- _picture_asset->set_duration (duration);
-
- if (_sound_asset) {
- _sound_asset->set_entry_point (_film->trim_start ());
- _sound_asset->set_duration (duration);
+ 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 (video_from, video_to, ec);
+ 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");
}
+
+ /* 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 ();
- libdcp::DCP dcp (_film->dir (_film->dcp_name()));
- DCPFrameRate dfr (_film->frames_per_second ());
+ 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 ())
+ );
+ }
- shared_ptr<libdcp::CPL> cpl (
- new libdcp::CPL (_film->dir (_film->dcp_name()), _film->dcp_name(), _film->dcp_content_type()->libdcp_kind (), frames, dfr.frames_per_second)
+ dcp::DCP dcp (_film->dir (_film->dcp_name()));
+
+ shared_ptr<dcp::CPL> cpl (
+ new dcp::CPL (
+ _film->dcp_name(),
+ _film->dcp_content_type()->libdcp_kind ()
+ )
);
- dcp.add_cpl (cpl);
+ dcp.add (cpl);
+
+ shared_ptr<dcp::Reel> reel (new dcp::Reel ());
+
+ 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)));
+ }
+
+ 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)));
+ }
+
+ reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
+
+ cpl->add (reel);
+
+ shared_ptr<Job> job = _job.lock ();
+ assert (job);
+
+ job->sub (_("Computing image digest"));
+ _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
- cpl->add_reel (shared_ptr<libdcp::Reel> (new libdcp::Reel (
- _picture_asset,
- _sound_asset,
- shared_ptr<libdcp::SubtitleAsset> ()
- )
- ));
+ job->sub (_("Computing audio digest"));
+ _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
- dcp.write_xml ();
+ 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 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 */
void
-Writer::repeat (int f)
+Writer::repeat (int f, Eyes e)
{
boost::mutex::scoped_lock lock (_mutex);
- _queue.push_back (make_pair (shared_ptr<const EncodedData> (), f));
+
+ while (_queued_full_in_memory > _maximum_frames_in_memory) {
+ _full_condition.wait (lock);
+ }
+
+ 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);
+ }
+
+ _empty_condition.notify_all ();
+}
+
+bool
+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));
+ 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 */
+ 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 ())) {
+ _film->log()->log (String::compose ("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));
+ return false;
+ }
+
+ return true;
+}
+
+void
+Writer::check_existing_picture_mxf ()
+{
+ /* Try to open the existing MXF */
+ boost::filesystem::path p;
+ p /= _film->internal_video_mxf_dir ();
+ 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));
+ 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;
+ }
+ if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
+ break;
+ }
+ } else {
+ if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
+ break;
+ }
+ }
+
+ _film->log()->log (String::compose ("Have existing frame %1", _first_nonexistant_frame));
+ ++_first_nonexistant_frame;
+ }
+
+ fclose (mxf);
+}
+
+/** @param frame Frame index.
+ * @return true if we can fake-write this frame.
+ */
+bool
+Writer::can_fake_write (int frame) const
+{
+ /* We have to do a proper write of the first frame so that we can set up the JPEG2000
+ parameters in the MXF writer.
+ */
+ return (frame != 0 && frame < _first_nonexistant_frame);
+}
+
+bool
+operator< (QueueItem const & a, QueueItem const & b)
+{
+ if (a.frame != b.frame) {
+ return a.frame < b.frame;
+ }
+
+ return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
+}
+
+bool
+operator== (QueueItem const & a, QueueItem const & b)
+{
+ return a.frame == b.frame && a.eyes == b.eyes;
}