src/lib/writer.h

   1 /*
   2     Copyright (C) 2012-2014 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 /** @file  src/lib/writer.h
  21  *  @brief Writer class.
  22  */
  23
  24 #include "exceptions.h"
  25 #include "types.h"
  26 #include "player_subtitles.h"
  27 #include <dcp/subtitle_content.h>
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/weak_ptr.hpp>
  30 #include <boost/thread.hpp>
  31 #include <boost/thread/condition.hpp>
  32 #include <list>
  33
  34 class Film;
  35 class EncodedData;
  36 class AudioBuffers;
  37 class Job;
  38
  39 namespace dcp {
  40         class MonoPictureMXF;
  41         class MonoPictureMXFWriter;
  42         class StereoPictureMXF;
  43         class StereoPictureMXFWriter;
  44         class PictureMXF;
  45         class PictureMXFWriter;
  46         class SoundMXF;
  47         class SoundMXFWriter;
  48 }
  49
  50 struct QueueItem
  51 {
  52 public:
  53         enum Type {
  54                 /** a normal frame with some JPEG200 data */
  55                 FULL,
  56                 /** a frame whose data already exists in the MXF,
  57                     and we fake-write it; i.e. we update the writer's
  58                     state but we use the data that is already on disk.
  59                 */
  60                 FAKE,
  61         } type;
  62
  63         /** encoded data for FULL */
  64         boost::shared_ptr<const EncodedData> encoded;
  65         /** size of data for FAKE */
  66         int size;
  67         /** frame index */
  68         int frame;
  69         Eyes eyes;
  70 };
  71
  72 bool operator< (QueueItem const & a, QueueItem const & b);
  73 bool operator== (QueueItem const & a, QueueItem const & b);
  74
  75 /** @class Writer
  76  *  @brief Class to manage writing JPEG2000 and audio data to MXFs on disk.
  77  *
  78  *  This class creates sound and picture MXFs, then takes EncodedData
  79  *  or AudioBuffers objects (containing image or sound data respectively)
  80  *  and writes them to the MXFs.
  81  *
  82  *  ::write() for EncodedData can be called out of order, and the Writer
  83  *  will sort it out.  write() for AudioBuffers must be called in order.
  84  */
  85
  86 class Writer : public ExceptionStore, public boost::noncopyable
  87 {
  88 public:
  89         Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
  90         ~Writer ();
  91
  92         bool can_fake_write (int) const;
  93
  94         void write (boost::shared_ptr<const EncodedData>, int, Eyes);
  95         void fake_write (int, Eyes);
  96         void write (boost::shared_ptr<const AudioBuffers>);
  97         void write (PlayerSubtitles subs);
  98         void repeat (int f, Eyes);
  99         void finish ();
 100
 101 private:
 102
 103         void thread ();
 104         void terminate_thread (bool);
 105         void check_existing_picture_mxf ();
 106         bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
 107         bool have_sequenced_image_at_queue_head ();
 108
 109         /** our Film */
 110         boost::shared_ptr<const Film> _film;
 111         boost::weak_ptr<Job> _job;
 112         /** the first frame index that does not already exist in our MXF */
 113         int _first_nonexistant_frame;
 114
 115         /** our thread, or 0 */
 116         boost::thread* _thread;
 117         /** true if our thread should finish */
 118         bool _finish;
 119         /** queue of things to write to disk */
 120         std::list<QueueItem> _queue;
 121         /** number of FULL frames whose JPEG200 data is currently held in RAM */
 122         int _queued_full_in_memory;
 123         /** mutex for thread state */
 124         mutable boost::mutex _mutex;
 125         /** condition to manage thread wakeups when we have nothing to do  */
 126         boost::condition _empty_condition;
 127         /** condition to manage thread wakeups when we have too much to do */
 128         boost::condition _full_condition;
 129         /** the data of the last written frame, or 0 if there isn't one */
 130         boost::shared_ptr<const EncodedData> _last_written[EYES_COUNT];
 131         /** the index of the last written frame */
 132         int _last_written_frame;
 133         Eyes _last_written_eyes;
 134         /** maximum number of frames to hold in memory, for when we are managing
 135             ordering
 136         */
 137         static const int _maximum_frames_in_memory;
 138
 139         /** number of FULL written frames */
 140         int _full_written;
 141         /** number of FAKE written frames */
 142         int _fake_written;
 143         /** number of frames pushed to disk and then recovered
 144             due to the limit of frames to be held in memory.
 145         */
 146         int _pushed_to_disk;
 147
 148         boost::shared_ptr<dcp::PictureMXF> _picture_mxf;
 149         boost::shared_ptr<dcp::PictureMXFWriter> _picture_mxf_writer;
 150         boost::shared_ptr<dcp::SoundMXF> _sound_mxf;
 151         boost::shared_ptr<dcp::SoundMXFWriter> _sound_mxf_writer;
 152         boost::shared_ptr<dcp::SubtitleContent> _subtitle_content;
 153 };