src/lib/writer.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <fstream>
  21 #include <libdcp/picture_asset.h>
  22 #include <libdcp/sound_asset.h>
  23 #include <libdcp/picture_frame.h>
  24 #include <libdcp/reel.h>
  25 #include "writer.h"
  26 #include "compose.hpp"
  27 #include "film.h"
  28 #include "format.h"
  29 #include "log.h"
  30 #include "dcp_video_frame.h"
  31
  32 using std::make_pair;
  33 using std::pair;
  34 using std::string;
  35 using std::ifstream;
  36 using std::list;
  37 using std::cout;
  38 using boost::shared_ptr;
  39
  40 int const Writer::_maximum_frames_in_memory = 8;
  41
  42 Writer::Writer (shared_ptr<Film> f)
  43         : _film (f)
  44         , _first_nonexistant_frame (0)
  45         , _thread (0)
  46         , _finish (false)
  47         , _queued_full_in_memory (0)
  48         , _last_written_frame (-1)
  49         , _full_written (0)
  50         , _fake_written (0)
  51         , _repeat_written (0)
  52         , _pushed_to_disk (0)
  53 {
  54         /* Remove any old DCP */
  55         boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
  56
  57         check_existing_picture_mxf ();
  58
  59         /* Create our picture asset in a subdirectory, named according to those
  60            film's parameters which affect the video output.  We will hard-link
  61            it into the DCP later.
  62         */
  63
  64         _picture_asset.reset (
  65                 new libdcp::MonoPictureAsset (
  66                         _film->video_mxf_dir (),
  67                         _film->video_mxf_filename (),
  68                         DCPFrameRate (_film->frames_per_second()).frames_per_second,
  69                         _film->format()->dcp_size()
  70                         )
  71                 );
  72
  73         _picture_asset_writer = _picture_asset->start_write (_first_nonexistant_frame > 0);
  74
  75         if (_film->audio_channels() > 0) {
  76                 _sound_asset.reset (
  77                         new libdcp::SoundAsset (
  78                                 _film->dir (_film->dcp_name()),
  79                                 "audio.mxf",
  80                                 DCPFrameRate (_film->frames_per_second()).frames_per_second,
  81                                 _film->audio_channels(),
  82                                 dcp_audio_sample_rate (_film->audio_stream()->sample_rate())
  83                                 )
  84                         );
  85
  86                 _sound_asset_writer = _sound_asset->start_write ();
  87         }
  88
  89         _thread = new boost::thread (boost::bind (&Writer::thread, this));
  90 }
  91
  92 void
  93 Writer::write (shared_ptr<const EncodedData> encoded, int frame)
  94 {
  95         boost::mutex::scoped_lock lock (_mutex);
  96
  97         QueueItem qi;
  98         qi.type = QueueItem::FULL;
  99         qi.encoded = encoded;
 100         qi.frame = frame;
 101         _queue.push_back (qi);
 102         ++_queued_full_in_memory;
 103
 104         _condition.notify_all ();
 105 }
 106
 107 void
 108 Writer::fake_write (int frame)
 109 {
 110         boost::mutex::scoped_lock lock (_mutex);
 111
 112         ifstream ifi (_film->info_path (frame).c_str());
 113         libdcp::FrameInfo info (ifi);
 114
 115         QueueItem qi;
 116         qi.type = QueueItem::FAKE;
 117         qi.size = info.size;
 118         qi.frame = frame;
 119         _queue.push_back (qi);
 120
 121         _condition.notify_all ();
 122 }
 123
 124 /** This method is not thread safe */
 125 void
 126 Writer::write (shared_ptr<const AudioBuffers> audio)
 127 {
 128         _sound_asset_writer->write (audio->data(), audio->frames());
 129 }
 130
 131 void
 132 Writer::thread ()
 133 {
 134         while (1)
 135         {
 136                 boost::mutex::scoped_lock lock (_mutex);
 137
 138                 while (1) {
 139
 140                         _queue.sort ();
 141
 142                         if (_finish ||
 143                             _queued_full_in_memory > _maximum_frames_in_memory ||
 144                             (!_queue.empty() && _queue.front().frame == (_last_written_frame + 1))) {
 145
 146                                 break;
 147                         }
 148
 149                         TIMING ("writer sleeps with a queue of %1", _queue.size());
 150                         _condition.wait (lock);
 151                         TIMING ("writer wakes with a queue of %1", _queue.size());
 152                 }
 153
 154                 if (_finish && _queue.empty()) {
 155                         return;
 156                 }
 157
 158                 /* Write any frames that we can write; i.e. those that are in sequence */
 159                 while (!_queue.empty() && _queue.front().frame == (_last_written_frame + 1)) {
 160                         QueueItem qi = _queue.front ();
 161                         _queue.pop_front ();
 162                         if (qi.type == QueueItem::FULL && qi.encoded) {
 163                                 --_queued_full_in_memory;
 164                         }
 165
 166                         switch (qi.type) {
 167                         case QueueItem::FULL:
 168                                 ++_full_written;
 169                                 break;
 170                         case QueueItem::FAKE:
 171                                 ++_fake_written;
 172                                 break;
 173                         case QueueItem::REPEAT:
 174                                 ++_repeat_written;
 175                                 break;
 176                         }
 177
 178                         lock.unlock ();
 179                         switch (qi.type) {
 180                         case QueueItem::FULL:
 181                         {
 182                                 _film->log()->log (String::compose ("Writer FULL-writes %1 to MXF", qi.frame));
 183                                 if (!qi.encoded) {
 184                                         qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, false)));
 185                                 }
 186                                 libdcp::FrameInfo const fin = _picture_asset_writer->write (qi.encoded->data(), qi.encoded->size());
 187                                 qi.encoded->write_info (_film, qi.frame, fin);
 188                                 _last_written = qi.encoded;
 189                                 break;
 190                         }
 191                         case QueueItem::FAKE:
 192                                 _film->log()->log (String::compose ("Writer FAKE-writes %1 to MXF", qi.frame));
 193                                 _picture_asset_writer->fake_write (qi.size);
 194                                 _last_written.reset ();
 195                                 break;
 196                         case QueueItem::REPEAT:
 197                         {
 198                                 _film->log()->log (String::compose ("Writer REPEAT-writes %1 to MXF", qi.frame));
 199                                 libdcp::FrameInfo const fin = _picture_asset_writer->write (_last_written->data(), _last_written->size());
 200                                 _last_written->write_info (_film, qi.frame, fin);
 201                                 break;
 202                         }
 203                         }
 204                         lock.lock ();
 205
 206                         ++_last_written_frame;
 207                 }
 208
 209                 while (_queued_full_in_memory > _maximum_frames_in_memory) {
 210                         /* Too many frames in memory which can't yet be written to the stream.
 211                            Write some FULL frames to disk.
 212                         */
 213
 214                         /* Find one */
 215                         list<QueueItem>::reverse_iterator i = _queue.rbegin ();
 216                         while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
 217                                 ++i;
 218                         }
 219
 220                         assert (i != _queue.rend());
 221                         QueueItem qi = *i;
 222
 223                         ++_pushed_to_disk;
 224
 225                         lock.unlock ();
 226                         _film->log()->log (String::compose ("Writer full (awaiting %1); pushes %2 to disk", _last_written_frame + 1, qi.frame));
 227                         qi.encoded->write (_film, qi.frame);
 228                         lock.lock ();
 229                         qi.encoded.reset ();
 230                         --_queued_full_in_memory;
 231                 }
 232         }
 233
 234 }
 235
 236 void
 237 Writer::finish ()
 238 {
 239         if (!_thread) {
 240                 return;
 241         }
 242
 243         boost::mutex::scoped_lock lock (_mutex);
 244         _finish = true;
 245         _condition.notify_all ();
 246         lock.unlock ();
 247
 248         _thread->join ();
 249         delete _thread;
 250         _thread = 0;
 251
 252         _picture_asset_writer->finalize ();
 253
 254         if (_sound_asset_writer) {
 255                 _sound_asset_writer->finalize ();
 256         }
 257
 258         int const frames = _last_written_frame + 1;
 259         int const duration = frames - _film->trim_start() - _film->trim_end();
 260
 261         _film->set_dcp_intrinsic_duration (frames);
 262
 263         _picture_asset->set_entry_point (_film->trim_start ());
 264         _picture_asset->set_duration (duration);
 265
 266         /* Hard-link the video MXF into the DCP */
 267
 268         boost::filesystem::path from;
 269         from /= _film->video_mxf_dir();
 270         from /= _film->video_mxf_filename();
 271
 272         boost::filesystem::path to;
 273         to /= _film->dir (_film->dcp_name());
 274         to /= "video.mxf";
 275
 276         boost::filesystem::create_hard_link (from, to);
 277
 278         /* And update the asset */
 279
 280         _picture_asset->set_directory (_film->dir (_film->dcp_name ()));
 281         _picture_asset->set_file_name ("video.mxf");
 282
 283         if (_sound_asset) {
 284                 _sound_asset->set_entry_point (_film->trim_start ());
 285                 _sound_asset->set_duration (duration);
 286         }
 287
 288         libdcp::DCP dcp (_film->dir (_film->dcp_name()));
 289         DCPFrameRate dfr (_film->frames_per_second ());
 290
 291         shared_ptr<libdcp::CPL> cpl (
 292                 new libdcp::CPL (_film->dir (_film->dcp_name()), _film->dcp_name(), _film->dcp_content_type()->libdcp_kind (), frames, dfr.frames_per_second)
 293                 );
 294
 295         dcp.add_cpl (cpl);
 296
 297         cpl->add_reel (shared_ptr<libdcp::Reel> (new libdcp::Reel (
 298                                                          _picture_asset,
 299                                                          _sound_asset,
 300                                                          shared_ptr<libdcp::SubtitleAsset> ()
 301                                                          )
 302                                ));
 303
 304         dcp.write_xml ();
 305
 306         _film->log()->log (String::compose ("Wrote %1 FULL, %2 FAKE, %3 REPEAT; %4 pushed to disk", _full_written, _fake_written, _repeat_written, _pushed_to_disk));
 307 }
 308
 309 /** Tell the writer that frame `f' should be a repeat of the frame before it */
 310 void
 311 Writer::repeat (int f)
 312 {
 313         boost::mutex::scoped_lock lock (_mutex);
 314
 315         QueueItem qi;
 316         qi.type = QueueItem::REPEAT;
 317         qi.frame = f;
 318
 319         _queue.push_back (qi);
 320
 321         _condition.notify_all ();
 322 }
 323
 324
 325 void
 326 Writer::check_existing_picture_mxf ()
 327 {
 328         /* Try to open the existing MXF */
 329         boost::filesystem::path p;
 330         p /= _film->video_mxf_dir ();
 331         p /= _film->video_mxf_filename ();
 332         FILE* mxf = fopen (p.string().c_str(), "rb");
 333         if (!mxf) {
 334                 return;
 335         }
 336
 337         while (1) {
 338
 339                 /* Read the frame info as written */
 340                 ifstream ifi (_film->info_path (_first_nonexistant_frame).c_str());
 341                 libdcp::FrameInfo info (ifi);
 342
 343                 /* Read the data from the MXF and hash it */
 344                 fseek (mxf, info.offset, SEEK_SET);
 345                 EncodedData data (info.size);
 346                 fread (data.data(), 1, data.size(), mxf);
 347                 string const existing_hash = md5_digest (data.data(), data.size());
 348
 349                 if (existing_hash != info.hash) {
 350                         _film->log()->log (String::compose ("Existing frame %1 failed hash check", _first_nonexistant_frame));
 351                         break;
 352                 }
 353
 354                 _film->log()->log (String::compose ("Have existing frame %1", _first_nonexistant_frame));
 355                 ++_first_nonexistant_frame;
 356         }
 357
 358         fclose (mxf);
 359 }
 360
 361 /** @return true if the fake write succeeded, otherwise false */
 362 bool
 363 Writer::can_fake_write (int frame) const
 364 {
 365         return (frame != 0 && frame < _first_nonexistant_frame);
 366 }
 367
 368
 369 bool
 370 operator< (QueueItem const & a, QueueItem const & b)
 371 {
 372         return a.frame < b.frame;
 373 }
 374
 375 bool
 376 operator== (QueueItem const & a, QueueItem const & b)
 377 {
 378         return a.frame == b.frame;
 379 }