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 <libdcp/dcp.h>
  26 #include <libdcp/cpl.h>
  27 #include "writer.h"
  28 #include "compose.hpp"
  29 #include "film.h"
  30 #include "format.h"
  31 #include "log.h"
  32 #include "dcp_video_frame.h"
  33 #include "dcp_content_type.h"
  34 #include "player.h"
  35 #include "audio_mapping.h"
  36 #include "config.h"
  37 #include "job.h"
  38
  39 #include "i18n.h"
  40
  41 using std::make_pair;
  42 using std::pair;
  43 using std::string;
  44 using std::ifstream;
  45 using std::list;
  46 using std::cout;
  47 using boost::shared_ptr;
  48
  49 int const Writer::_maximum_frames_in_memory = 8;
  50
  51 Writer::Writer (shared_ptr<Film> f, shared_ptr<Job> j)
  52         : _film (f)
  53         , _job (j)
  54         , _first_nonexistant_frame (0)
  55         , _thread (0)
  56         , _finish (false)
  57         , _queued_full_in_memory (0)
  58         , _last_written_frame (-1)
  59         , _full_written (0)
  60         , _fake_written (0)
  61         , _repeat_written (0)
  62         , _pushed_to_disk (0)
  63 {
  64         /* Remove any old DCP */
  65         boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
  66
  67         check_existing_picture_mxf ();
  68
  69         /* Create our picture asset in a subdirectory, named according to those
  70            film's parameters which affect the video output.  We will hard-link
  71            it into the DCP later.
  72         */
  73
  74         _picture_asset.reset (
  75                 new libdcp::MonoPictureAsset (
  76                         _film->internal_video_mxf_dir (),
  77                         _film->internal_video_mxf_filename (),
  78                         _film->dcp_video_frame_rate (),
  79                         _film->format()->dcp_size ()
  80                         )
  81                 );
  82
  83         _picture_asset_writer = _picture_asset->start_write (_first_nonexistant_frame > 0);
  84
  85         _sound_asset.reset (
  86                 new libdcp::SoundAsset (
  87                         _film->dir (_film->dcp_name()),
  88                         _film->dcp_audio_mxf_filename (),
  89                         _film->dcp_video_frame_rate (),
  90                         MAX_AUDIO_CHANNELS,
  91                         _film->dcp_audio_frame_rate()
  92                         )
  93                 );
  94
  95         _sound_asset_writer = _sound_asset->start_write ();
  96
  97         _thread = new boost::thread (boost::bind (&Writer::thread, this));
  98 }
  99
 100 void
 101 Writer::write (shared_ptr<const EncodedData> encoded, int frame)
 102 {
 103         boost::mutex::scoped_lock lock (_mutex);
 104
 105         QueueItem qi;
 106         qi.type = QueueItem::FULL;
 107         qi.encoded = encoded;
 108         qi.frame = frame;
 109         _queue.push_back (qi);
 110         ++_queued_full_in_memory;
 111
 112         _condition.notify_all ();
 113 }
 114
 115 void
 116 Writer::fake_write (int frame)
 117 {
 118         boost::mutex::scoped_lock lock (_mutex);
 119
 120         ifstream ifi (_film->info_path (frame).c_str());
 121         libdcp::FrameInfo info (ifi);
 122
 123         QueueItem qi;
 124         qi.type = QueueItem::FAKE;
 125         qi.size = info.size;
 126         qi.frame = frame;
 127         _queue.push_back (qi);
 128
 129         _condition.notify_all ();
 130 }
 131
 132 /** This method is not thread safe */
 133 void
 134 Writer::write (shared_ptr<const AudioBuffers> audio)
 135 {
 136         _sound_asset_writer->write (audio->data(), audio->frames());
 137 }
 138
 139 void
 140 Writer::thread ()
 141 try
 142 {
 143         while (1)
 144         {
 145                 boost::mutex::scoped_lock lock (_mutex);
 146
 147                 while (1) {
 148
 149                         _queue.sort ();
 150
 151                         if (_finish ||
 152                             _queued_full_in_memory > _maximum_frames_in_memory ||
 153                             (!_queue.empty() && _queue.front().frame == (_last_written_frame + 1))) {
 154
 155                                 break;
 156                         }
 157
 158                         TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
 159                         _condition.wait (lock);
 160                         TIMING (N_("writer wakes with a queue of %1"), _queue.size());
 161                 }
 162
 163                 if (_finish && _queue.empty()) {
 164                         return;
 165                 }
 166
 167                 /* Write any frames that we can write; i.e. those that are in sequence */
 168                 while (!_queue.empty() && _queue.front().frame == (_last_written_frame + 1)) {
 169                         QueueItem qi = _queue.front ();
 170                         _queue.pop_front ();
 171                         if (qi.type == QueueItem::FULL && qi.encoded) {
 172                                 --_queued_full_in_memory;
 173                         }
 174
 175                         lock.unlock ();
 176                         switch (qi.type) {
 177                         case QueueItem::FULL:
 178                         {
 179                                 _film->log()->log (String::compose (N_("Writer FULL-writes %1 to MXF"), qi.frame));
 180                                 if (!qi.encoded) {
 181                                         qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, false)));
 182                                 }
 183                                 libdcp::FrameInfo const fin = _picture_asset_writer->write (qi.encoded->data(), qi.encoded->size());
 184                                 qi.encoded->write_info (_film, qi.frame, fin);
 185                                 _last_written = qi.encoded;
 186                                 ++_full_written;
 187                                 break;
 188                         }
 189                         case QueueItem::FAKE:
 190                                 _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
 191                                 _picture_asset_writer->fake_write (qi.size);
 192                                 _last_written.reset ();
 193                                 ++_fake_written;
 194                                 break;
 195                         case QueueItem::REPEAT:
 196                         {
 197                                 _film->log()->log (String::compose (N_("Writer REPEAT-writes %1 to MXF"), qi.frame));
 198                                 libdcp::FrameInfo const fin = _picture_asset_writer->write (_last_written->data(), _last_written->size());
 199                                 _last_written->write_info (_film, qi.frame, fin);
 200                                 ++_repeat_written;
 201                                 break;
 202                         }
 203                         }
 204                         lock.lock ();
 205
 206                         if (_film->length ()) {
 207                                 _job->set_progress (float(_full_written + _fake_written + _repeat_written) / _film->time_to_video_frames (_film->length()));
 208                         }
 209
 210                         ++_last_written_frame;
 211                 }
 212
 213                 while (_queued_full_in_memory > _maximum_frames_in_memory) {
 214                         /* Too many frames in memory which can't yet be written to the stream.
 215                            Write some FULL frames to disk.
 216                         */
 217
 218                         /* Find one */
 219                         list<QueueItem>::reverse_iterator i = _queue.rbegin ();
 220                         while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
 221                                 ++i;
 222                         }
 223
 224                         assert (i != _queue.rend());
 225                         QueueItem qi = *i;
 226
 227                         ++_pushed_to_disk;
 228
 229                         lock.unlock ();
 230                         _film->log()->log (String::compose (N_("Writer full (awaiting %1); pushes %2 to disk"), _last_written_frame + 1, qi.frame));
 231                         qi.encoded->write (_film, qi.frame);
 232                         lock.lock ();
 233                         qi.encoded.reset ();
 234                         --_queued_full_in_memory;
 235                 }
 236         }
 237 }
 238 catch (...)
 239 {
 240         store_current ();
 241 }
 242
 243 void
 244 Writer::finish ()
 245 {
 246         if (!_thread) {
 247                 return;
 248         }
 249
 250         boost::mutex::scoped_lock lock (_mutex);
 251         _finish = true;
 252         _condition.notify_all ();
 253         lock.unlock ();
 254
 255         _thread->join ();
 256         if (thrown ()) {
 257                 rethrow ();
 258         }
 259
 260         delete _thread;
 261         _thread = 0;
 262
 263         _picture_asset_writer->finalize ();
 264         _sound_asset_writer->finalize ();
 265
 266         int const frames = _last_written_frame + 1;
 267         int duration = 0;
 268         if (_film->trim_type() == Film::CPL) {
 269                 duration = frames - _film->trim_start() - _film->trim_end();
 270                 _picture_asset->set_entry_point (_film->trim_start ());
 271         } else {
 272                 duration = frames;
 273         }
 274
 275         _picture_asset->set_duration (duration);
 276
 277         /* Hard-link the video MXF into the DCP */
 278
 279         boost::filesystem::path from;
 280         from /= _film->internal_video_mxf_dir();
 281         from /= _film->internal_video_mxf_filename();
 282
 283         boost::filesystem::path to;
 284         to /= _film->dir (_film->dcp_name());
 285         to /= _film->dcp_video_mxf_filename ();
 286
 287         boost::system::error_code ec;
 288         boost::filesystem::create_hard_link (from, to, ec);
 289         if (ec) {
 290                 /* hard link failed; copy instead */
 291                 boost::filesystem::copy_file (from, to);
 292                 _film->log()->log ("Hard-link failed; fell back to copying");
 293         }
 294
 295         /* And update the asset */
 296
 297         _picture_asset->set_directory (_film->dir (_film->dcp_name ()));
 298         _picture_asset->set_file_name (_film->dcp_video_mxf_filename ());
 299
 300         if (_film->trim_type() == Film::CPL) {
 301                 _sound_asset->set_entry_point (_film->trim_start ());
 302         }
 303         _sound_asset->set_duration (duration);
 304
 305         libdcp::DCP dcp (_film->dir (_film->dcp_name()));
 306
 307         shared_ptr<libdcp::CPL> cpl (
 308                 new libdcp::CPL (
 309                         _film->dir (_film->dcp_name()),
 310                         _film->dcp_name(),
 311                         _film->dcp_content_type()->libdcp_kind (),
 312                         frames,
 313                         _film->dcp_video_frame_rate ()
 314                         )
 315                 );
 316
 317         dcp.add_cpl (cpl);
 318
 319         cpl->add_reel (shared_ptr<libdcp::Reel> (new libdcp::Reel (
 320                                                          _picture_asset,
 321                                                          _sound_asset,
 322                                                          shared_ptr<libdcp::SubtitleAsset> ()
 323                                                          )
 324                                ));
 325
 326         libdcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
 327         meta.set_issue_date_now ();
 328         dcp.write_xml (meta);
 329
 330         _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));
 331 }
 332
 333 /** Tell the writer that frame `f' should be a repeat of the frame before it */
 334 void
 335 Writer::repeat (int f)
 336 {
 337         boost::mutex::scoped_lock lock (_mutex);
 338
 339         QueueItem qi;
 340         qi.type = QueueItem::REPEAT;
 341         qi.frame = f;
 342
 343         _queue.push_back (qi);
 344
 345         _condition.notify_all ();
 346 }
 347
 348
 349 void
 350 Writer::check_existing_picture_mxf ()
 351 {
 352         /* Try to open the existing MXF */
 353         boost::filesystem::path p;
 354         p /= _film->internal_video_mxf_dir ();
 355         p /= _film->internal_video_mxf_filename ();
 356         FILE* mxf = fopen (p.string().c_str(), N_("rb"));
 357         if (!mxf) {
 358                 return;
 359         }
 360
 361         while (1) {
 362
 363                 /* Read the frame info as written */
 364                 ifstream ifi (_film->info_path (_first_nonexistant_frame).c_str());
 365                 libdcp::FrameInfo info (ifi);
 366
 367                 /* Read the data from the MXF and hash it */
 368                 fseek (mxf, info.offset, SEEK_SET);
 369                 EncodedData data (info.size);
 370                 fread (data.data(), 1, data.size(), mxf);
 371                 string const existing_hash = md5_digest (data.data(), data.size());
 372
 373                 if (existing_hash != info.hash) {
 374                         _film->log()->log (String::compose (N_("Existing frame %1 failed hash check"), _first_nonexistant_frame));
 375                         break;
 376                 }
 377
 378                 _film->log()->log (String::compose (N_("Have existing frame %1"), _first_nonexistant_frame));
 379                 ++_first_nonexistant_frame;
 380         }
 381
 382         fclose (mxf);
 383 }
 384
 385 /** @param frame Frame index.
 386  *  @return true if we can fake-write this frame.
 387  */
 388 bool
 389 Writer::can_fake_write (int frame) const
 390 {
 391         /* We have to do a proper write of the first frame so that we can set up the JPEG2000
 392            parameters in the MXF writer.
 393         */
 394         return (frame != 0 && frame < _first_nonexistant_frame);
 395 }
 396
 397 bool
 398 operator< (QueueItem const & a, QueueItem const & b)
 399 {
 400         return a.frame < b.frame;
 401 }
 402
 403 bool
 404 operator== (QueueItem const & a, QueueItem const & b)
 405 {
 406         return a.frame == b.frame;
 407 }