/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
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
*/
-#include <list>
+/** @file src/lib/writer.h
+ * @brief Writer class.
+ */
+
+#include "exceptions.h"
+#include "types.h"
+#include "player_subtitles.h"
+#include "data.h"
#include <boost/shared_ptr.hpp>
+#include <boost/weak_ptr.hpp>
#include <boost/thread.hpp>
#include <boost/thread/condition.hpp>
-#include "exceptions.h"
-#include "types.h"
+#include <list>
class Film;
-class EncodedData;
+class Data;
class AudioBuffers;
class Job;
+class Font;
-namespace libdcp {
+namespace dcp {
class MonoPictureAsset;
class MonoPictureAssetWriter;
class StereoPictureAsset;
class PictureAssetWriter;
class SoundAsset;
class SoundAssetWriter;
+ class SubtitleAsset;
}
struct QueueItem
state but we use the data that is already on disk.
*/
FAKE,
- /** this is a repeat of the last frame to be written */
- REPEAT
} type;
/** encoded data for FULL */
- boost::shared_ptr<const EncodedData> encoded;
+ boost::optional<Data> encoded;
/** size of data for FAKE */
int size;
/** frame index */
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 assets on disk.
+ *
+ * This class creates sound and picture assets, then takes Data
+ * or AudioBuffers objects (containing image or sound data respectively)
+ * and writes them to the assets.
+ *
+ * ::write() for Data 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<const Film>, boost::shared_ptr<Job>);
+ Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
+ ~Writer ();
bool can_fake_write (int) const;
- void write (boost::shared_ptr<const EncodedData>, int, Eyes);
+ void write (Data, int, Eyes);
void fake_write (int, Eyes);
void write (boost::shared_ptr<const AudioBuffers>);
+ void write (PlayerSubtitles subs);
+ void write (std::list<boost::shared_ptr<Font> > fonts);
void repeat (int f, Eyes);
void finish ();
+ void set_encoder_threads (int threads);
+
private:
void thread ();
- void check_existing_picture_mxf ();
- bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
- bool have_sequenced_image_at_queue_head () const;
+ void terminate_thread (bool);
+ void check_existing_picture_asset ();
+ bool check_existing_picture_asset_frame (FILE *, int, Eyes);
+ bool have_sequenced_image_at_queue_head ();
/** our Film */
boost::shared_ptr<const Film> _film;
- boost::shared_ptr<Job> _job;
+ boost::weak_ptr<Job> _job;
/** the first frame index that does not already exist in our MXF */
int _first_nonexistant_frame;
int _queued_full_in_memory;
/** mutex for thread state */
mutable boost::mutex _mutex;
- /** condition to manage thread wakeups */
- boost::condition _condition;
- /** the data of the last written frame, or 0 if there isn't one */
- boost::shared_ptr<const EncodedData> _last_written[EYES_COUNT];
+ /** 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, if there is one */
+ boost::optional<Data> _last_written[EYES_COUNT];
/** the index of the last written frame */
int _last_written_frame;
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;
-
+ * ordering
+ */
+ int _maximum_frames_in_memory;
+
/** number of FULL written frames */
int _full_written;
/** number of FAKE written frames */
int _fake_written;
- /** number of REPEAT written frames */
- int _repeat_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<libdcp::PictureAsset> _picture_asset;
- boost::shared_ptr<libdcp::PictureAssetWriter> _picture_asset_writer;
- boost::shared_ptr<libdcp::SoundAsset> _sound_asset;
- boost::shared_ptr<libdcp::SoundAssetWriter> _sound_asset_writer;
+ boost::shared_ptr<dcp::PictureAsset> _picture_asset;
+ boost::shared_ptr<dcp::PictureAssetWriter> _picture_asset_writer;
+ boost::shared_ptr<dcp::SoundAsset> _sound_asset;
+ boost::shared_ptr<dcp::SoundAssetWriter> _sound_asset_writer;
+ boost::shared_ptr<dcp::SubtitleAsset> _subtitle_asset;
+
+ std::list<boost::shared_ptr<Font> > _fonts;
};