X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fwriter.h;h=66fe98ec734c914d3de27eeb4b4ccde15e6309b7;hb=1555c48eda3def5f7ece413a47f0c7ff94dd70dd;hp=8156308a6b9c86e9849703c28aef22c9ce9df584;hpb=479b67ec506289a4763b2dd4f07e72d1dd676483;p=dcpomatic.git diff --git a/src/lib/writer.h b/src/lib/writer.h index 8156308a6..66fe98ec7 100644 --- a/src/lib/writer.h +++ b/src/lib/writer.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,44 +17,136 @@ */ +/** @file src/lib/writer.h + * @brief Writer class. + */ + #include #include #include #include +#include +#include "exceptions.h" +#include "types.h" +#include "player_subtitles.h" class Film; class EncodedData; +class AudioBuffers; +class Job; -namespace libdcp { - class MonoPictureAsset; - class MonoPictureAssetWriter; +namespace dcp { + class MonoPictureMXF; + class MonoPictureMXFWriter; + class StereoPictureMXF; + class StereoPictureMXFWriter; + class PictureMXF; + class PictureMXFWriter; + class SoundMXF; + class SoundMXFWriter; } -class Writer +struct QueueItem +{ +public: + enum Type { + /** a normal frame with some JPEG200 data */ + FULL, + /** a frame whose data already exists in the MXF, + and we fake-write it; i.e. we update the writer's + state but we use the data that is already on disk. + */ + FAKE, + } type; + + /** encoded data for FULL */ + boost::shared_ptr encoded; + /** size of data for FAKE */ + int size; + /** frame index */ + int frame; + Eyes eyes; +}; + +bool operator< (QueueItem const & a, QueueItem const & b); +bool operator== (QueueItem const & a, QueueItem const & b); + +/** @class Writer + * @brief Class to manage writing JPEG2000 and audio data to MXFs on disk. + * + * This class creates sound and picture MXFs, then takes EncodedData + * or AudioBuffers objects (containing image or sound data respectively) + * and writes them to the MXFs. + * + * ::write() for EncodedData can be called out of order, and the Writer + * will sort it out. write() for AudioBuffers must be called in order. + */ + +class Writer : public ExceptionStore, public boost::noncopyable { public: - Writer (boost::shared_ptr); + Writer (boost::shared_ptr, boost::weak_ptr); + ~Writer (); + + bool can_fake_write (int) const; - void write (boost::shared_ptr, int); - void repeat (int f); + void write (boost::shared_ptr, int, Eyes); + void fake_write (int, Eyes); + void write (boost::shared_ptr); + void write (PlayerSubtitles); + void repeat (int f, Eyes); void finish (); private: void thread (); + void terminate_thread (bool); + void check_existing_picture_mxf (); + bool check_existing_picture_mxf_frame (FILE *, int, Eyes); + bool have_sequenced_image_at_queue_head (); + /** our Film */ boost::shared_ptr _film; + boost::weak_ptr _job; + /** the first frame index that does not already exist in our MXF */ + int _first_nonexistant_frame; + /** our thread, or 0 */ boost::thread* _thread; + /** true if our thread should finish */ bool _finish; - std::list, int> > _queue; + /** queue of things to write to disk */ + std::list _queue; + /** number of FULL frames whose JPEG200 data is currently held in RAM */ + int _queued_full_in_memory; + /** mutex for thread state */ mutable boost::mutex _mutex; - boost::condition _condition; - boost::shared_ptr _last_written; - std::list _pending; + /** condition to manage thread wakeups when we have nothing to do */ + boost::condition _empty_condition; + /** condition to manage thread wakeups when we have too much to do */ + boost::condition _full_condition; + /** the data of the last written frame, or 0 if there isn't one */ + boost::shared_ptr _last_written[EYES_COUNT]; + /** the index of the last written frame */ int _last_written_frame; - static const unsigned int _maximum_frames_in_memory; + Eyes _last_written_eyes; + /** maximum number of frames to hold in memory, for when we are managing + ordering + */ + static const int _maximum_frames_in_memory; - boost::shared_ptr _picture_asset; - boost::shared_ptr _picture_asset_writer; + /** number of FULL written frames */ + int _full_written; + /** number of FAKE written frames */ + int _fake_written; + /** number of frames pushed to disk and then recovered + due to the limit of frames to be held in memory. + */ + int _pushed_to_disk; + + boost::shared_ptr _picture_mxf; + boost::shared_ptr _picture_mxf_writer; + boost::shared_ptr _sound_mxf; + boost::shared_ptr _sound_mxf_writer; + boost::shared_ptr _subtitle_content; };