/*
- Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2020 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/>.
*/
+
/** @file src/lib/writer.h
* @brief Writer class.
*/
+
+#include "atmos_metadata.h"
#include "types.h"
-#include "player_subtitles.h"
-#include "data.h"
+#include "player_text.h"
#include "exception_store.h"
-#include <boost/shared_ptr.hpp>
-#include <boost/weak_ptr.hpp>
+#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>
+
+namespace dcp {
+ class Data;
+}
+
+namespace dcpomatic {
+ class FontData;
+}
+
class Film;
-class Data;
class AudioBuffers;
class Job;
-class Font;
class ReferencedReelAsset;
class ReelWriter;
+
struct QueueItem
{
public:
- QueueItem ()
- : size (0)
- {}
+ QueueItem () {}
- enum Type {
+ enum class Type {
/** a normal frame with some JPEG200 data */
FULL,
/** a frame whose data already exists in the MXF,
} type;
/** encoded data for FULL */
- boost::optional<Data> encoded;
+ std::shared_ptr<const dcp::Data> encoded;
/** size of data for FAKE */
- int size;
+ int size = 0;
/** reel index */
- size_t reel;
+ size_t reel = 0;
/** frame index within the reel */
- int frame;
+ int frame = 0;
/** eyes for FULL, FAKE and REPEAT */
- Eyes eyes;
+ 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.
*
* 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
+ * 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 boost::noncopyable
+class Writer : public ExceptionStore, public WeakConstFilm
{
public:
- Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
+ 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 (Data, Frame, Eyes);
+ 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 (boost::shared_ptr<const AudioBuffers>);
- void write (PlayerSubtitles subs);
- void write (std::list<boost::shared_ptr<Font> > fonts);
+ 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 finish ();
+ 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);
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 (boost::function<void (float)> set_progress);
- /** our Film */
- boost::shared_ptr<const Film> _film;
- boost::weak_ptr<Job> _job;
+ 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, or 0 */
- boost::thread* _thread;
+ /** our thread */
+ boost::thread _thread;
/** true if our thread should finish */
- bool _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;
+ 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 */
* 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;
+ int _full_written = 0;
/** number of FAKE written frames */
- int _fake_written;
- int _repeat_written;
+ 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;
+ 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::list<boost::shared_ptr<Font> > _fonts;
+ std::vector<dcpomatic::FontData> _fonts;
+
+ /** 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;
};
projects / dcpomatic.git / blobdiff