src/lib/writer.h

   1 /*
   2     Copyright (C) 2012-2015 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 "data.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 Data;
  36 class AudioBuffers;
  37 class Job;
  38 class Font;
  39
  40 namespace dcp {
  41         class MonoPictureAsset;
  42         class MonoPictureAssetWriter;
  43         class StereoPictureAsset;
  44         class StereoPictureAssetWriter;
  45         class PictureAsset;
  46         class PictureAssetWriter;
  47         class SoundAsset;
  48         class SoundAssetWriter;
  49         class SubtitleAsset;
  50 }
  51
  52 struct QueueItem
  53 {
  54 public:
  55         enum Type {
  56                 /** a normal frame with some JPEG200 data */
  57                 FULL,
  58                 /** a frame whose data already exists in the MXF,
  59                     and we fake-write it; i.e. we update the writer's
  60                     state but we use the data that is already on disk.
  61                 */
  62                 FAKE,
  63         } type;
  64
  65         /** encoded data for FULL */
  66         boost::optional<Data> encoded;
  67         /** size of data for FAKE */
  68         int size;
  69         /** frame index */
  70         int frame;
  71         Eyes eyes;
  72 };
  73
  74 bool operator< (QueueItem const & a, QueueItem const & b);
  75 bool operator== (QueueItem const & a, QueueItem const & b);
  76
  77 /** @class Writer
  78  *  @brief Class to manage writing JPEG2000 and audio data to assets on disk.
  79  *
  80  *  This class creates sound and picture assets, then takes Data
  81  *  or AudioBuffers objects (containing image or sound data respectively)
  82  *  and writes them to the assets.
  83  *
  84  *  ::write() for Data can be called out of order, and the Writer
  85  *  will sort it out.  write() for AudioBuffers must be called in order.
  86  */
  87
  88 class Writer : public ExceptionStore, public boost::noncopyable
  89 {
  90 public:
  91         Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
  92         ~Writer ();
  93
  94         bool can_fake_write (int) const;
  95
  96         void write (Data, int, Eyes);
  97         void fake_write (int, Eyes);
  98         void write (boost::shared_ptr<const AudioBuffers>);
  99         void write (PlayerSubtitles subs);
 100         void write (std::list<boost::shared_ptr<Font> > fonts);
 101         void finish ();
 102
 103         void set_encoder_threads (int threads);
 104
 105 private:
 106
 107         void thread ();
 108         void terminate_thread (bool);
 109         void check_existing_picture_asset ();
 110         bool check_existing_picture_asset_frame (FILE *, int, Eyes);
 111         bool have_sequenced_image_at_queue_head ();
 112
 113         /** our Film */
 114         boost::shared_ptr<const Film> _film;
 115         boost::weak_ptr<Job> _job;
 116         /** the first frame index that does not already exist in our MXF */
 117         int _first_nonexistant_frame;
 118
 119         /** our thread, or 0 */
 120         boost::thread* _thread;
 121         /** true if our thread should finish */
 122         bool _finish;
 123         /** queue of things to write to disk */
 124         std::list<QueueItem> _queue;
 125         /** number of FULL frames whose JPEG200 data is currently held in RAM */
 126         int _queued_full_in_memory;
 127         /** mutex for thread state */
 128         mutable boost::mutex _mutex;
 129         /** condition to manage thread wakeups when we have nothing to do  */
 130         boost::condition _empty_condition;
 131         /** condition to manage thread wakeups when we have too much to do */
 132         boost::condition _full_condition;
 133         /** the data of the last written frame, if there is one */
 134         boost::optional<Data> _last_written[EYES_COUNT];
 135         /** the index of the last written frame */
 136         int _last_written_frame;
 137         Eyes _last_written_eyes;
 138         /** maximum number of frames to hold in memory, for when we are managing
 139          *  ordering
 140          */
 141         int _maximum_frames_in_memory;
 142
 143         /** number of FULL written frames */
 144         int _full_written;
 145         /** number of FAKE written frames */
 146         int _fake_written;
 147         /** number of frames pushed to disk and then recovered
 148             due to the limit of frames to be held in memory.
 149         */
 150         int _pushed_to_disk;
 151
 152         boost::shared_ptr<dcp::PictureAsset> _picture_asset;
 153         boost::shared_ptr<dcp::PictureAssetWriter> _picture_asset_writer;
 154         boost::shared_ptr<dcp::SoundAsset> _sound_asset;
 155         boost::shared_ptr<dcp::SoundAssetWriter> _sound_asset_writer;
 156         boost::shared_ptr<dcp::SubtitleAsset> _subtitle_asset;
 157
 158         std::list<boost::shared_ptr<Font> > _fonts;
 159 };