/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
-#include <list>
-#include <boost/shared_ptr.hpp>
+
+/** @file src/lib/writer.h
+ * @brief Writer class.
+ */
+
+
+#include "atmos_metadata.h"
+#include "types.h"
+#include "player_text.h"
+#include "exception_store.h"
+#include "dcp_text_track.h"
+#include "weak_film.h"
+#include <dcp/atmos_frame.h>
#include <boost/thread.hpp>
#include <boost/thread/condition.hpp>
+#include <list>
-class Film;
-class EncodedData;
-namespace libdcp {
- class MonoPictureAsset;
- class MonoPictureAssetWriter;
+namespace dcp {
+ class Data;
}
-class Writer
+namespace dcpomatic {
+ class FontData;
+}
+
+class Film;
+class AudioBuffers;
+class Job;
+class ReferencedReelAsset;
+class ReelWriter;
+
+
+struct QueueItem
{
public:
- Writer (boost::shared_ptr<const Film>);
-
- void write (boost::shared_ptr<EncodedData>, int);
- void repeat (int f);
- void finish ();
+ QueueItem () {}
-private:
+ enum class 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,
+ REPEAT,
+ } type;
+
+ /** encoded data for FULL */
+ std::shared_ptr<const dcp::Data> encoded;
+ /** size of data for FAKE */
+ int size = 0;
+ /** reel index */
+ size_t reel = 0;
+ /** frame index within the reel */
+ int frame = 0;
+ /** eyes for FULL, FAKE and REPEAT */
+ Eyes eyes = Eyes::BOTH;
+};
+
+
+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 (picture) 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 WeakConstFilm
+{
+public:
+ Writer (std::weak_ptr<const Film>, std::weak_ptr<Job>, bool text_only = false);
+ ~Writer ();
+
+ Writer (Writer const &) = delete;
+ Writer& operator= (Writer const &) = delete;
+
+ void start ();
+
+ bool can_fake_write (Frame) const;
+ void write (std::shared_ptr<const dcp::Data>, Frame, Eyes);
+ void fake_write (Frame, Eyes);
+ bool can_repeat (Frame) const;
+ void repeat (Frame, Eyes);
+ void write (std::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
+ void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
+ void write (std::vector<dcpomatic::FontData> fonts);
+ void write (ReferencedReelAsset asset);
+ void write (std::shared_ptr<const dcp::AtmosFrame> atmos, dcpomatic::DCPTime time, AtmosMetadata metadata);
+ void finish (boost::filesystem::path output_dcp);
+
+ void set_encoder_threads (int threads);
+
+private:
void thread ();
+ void terminate_thread (bool);
+ bool have_sequenced_image_at_queue_head ();
+ size_t video_reel (int frame) const;
+ void set_digest_progress (Job* job, float progress);
+ void write_cover_sheet (boost::filesystem::path output_dcp);
+ void calculate_referenced_digests (std::function<void (float)> set_progress);
+ void write_hanging_text (ReelWriter& reel);
+ void calculate_digests ();
+
+ std::weak_ptr<Job> _job;
+ std::vector<ReelWriter> _reels;
+ std::vector<ReelWriter>::iterator _audio_reel;
+ std::vector<ReelWriter>::iterator _subtitle_reel;
+ std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
+ std::vector<ReelWriter>::iterator _atmos_reel;
+
+ /** our thread */
+ boost::thread _thread;
+ /** true if our thread should finish */
+ bool _finish = false;
+ /** queue of things to write to disk */
+ std::list<QueueItem> _queue;
+ /** number of FULL frames whose JPEG200 data is currently held in RAM */
+ int _queued_full_in_memory = 0;
+ /** mutex for thread state */
+ mutable boost::mutex _state_mutex;
+ /** 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;
+ /** maximum number of frames to hold in memory, for when we are managing
+ * ordering
+ */
+ int _maximum_frames_in_memory;
+ unsigned int _maximum_queue_size;
+
+ class LastWritten
+ {
+ public:
+ LastWritten()
+ : _frame(-1)
+ , _eyes(Eyes::RIGHT)
+ {}
+
+ /** @return true if qi is the next item after this one */
+ bool next (QueueItem qi) const;
+ void update (QueueItem qi);
+
+ int frame () const {
+ return _frame;
+ }
+
+ private:
+ int _frame;
+ Eyes _eyes;
+ };
+
+ /** The last frame written to each reel */
+ std::vector<LastWritten> _last_written;
+
+ /** number of FULL written frames */
+ int _full_written = 0;
+ /** number of FAKE written frames */
+ int _fake_written = 0;
+ int _repeat_written = 0;
+ /** number of frames pushed to disk and then recovered
+ due to the limit of frames to be held in memory.
+ */
+ int _pushed_to_disk = 0;
+
+ bool _text_only;
+
+ boost::mutex _digest_progresses_mutex;
+ std::map<boost::thread::id, float> _digest_progresses;
+
+ std::list<ReferencedReelAsset> _reel_assets;
+
+ std::vector<dcpomatic::FontData> _fonts;
- boost::shared_ptr<const Film> _film;
+ /** true if any reel has any subtitles */
+ bool _have_subtitles = false;
+ /** all closed caption tracks that we have on any reel */
+ std::set<DCPTextTrack> _have_closed_captions;
- boost::thread* _thread;
- bool _finish;
- std::list<std::pair<boost::shared_ptr<EncodedData>, int> > _queue;
- mutable boost::mutex _mutex;
- boost::condition _condition;
- boost::shared_ptr<EncodedData> _last_written;
- std::list<int> _pending;
- int _last_written_frame;
- static const unsigned int _maximum_frames_in_memory;
+ struct HangingText {
+ PlayerText text;
+ TextType type;
+ boost::optional<DCPTextTrack> track;
+ dcpomatic::DCPTimePeriod period;
+ };
- boost::shared_ptr<libdcp::MonoPictureAsset> _picture_asset;
- boost::shared_ptr<libdcp::MonoPictureAssetWriter> _picture_asset_writer;
+ std::vector<HangingText> _hanging_texts;
};
projects / dcpomatic.git / blobdiff