/*
- Copyright (C) 2012-2015 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/>.
*/
+
+#ifndef DCPOMATIC_WRITER_H
+#define DCPOMATIC_WRITER_H
+
+
/** @file src/lib/writer.h
* @brief Writer class.
*/
-#include "types.h"
-#include "player_subtitles.h"
-#include "data.h"
+
+#include "atmos_metadata.h"
+#include "dcp_text_track.h"
+#include "dcpomatic_time.h"
#include "exception_store.h"
-#include <dcp/picture_asset_writer.h>
-#include <boost/shared_ptr.hpp>
-#include <boost/weak_ptr.hpp>
+#include "font_id_map.h"
+#include "player_text.h"
+#include "weak_film.h"
+#include <dcp/atmos_frame.h>
#include <boost/thread.hpp>
#include <boost/thread/condition.hpp>
#include <list>
-class Film;
-class Data;
-class AudioBuffers;
-class Job;
-class Font;
namespace dcp {
- class MonoPictureAsset;
- class MonoPictureAssetWriter;
- class StereoPictureAsset;
- class StereoPictureAssetWriter;
- class PictureAsset;
- class PictureAssetWriter;
- class SoundAsset;
- class SoundAssetWriter;
- class SubtitleAsset;
+ class Data;
}
+class AudioBuffers;
+class Film;
+class Job;
+class ReelWriter;
+class ReferencedReelAsset;
+struct writer_disambiguate_font_ids1;
+struct writer_disambiguate_font_ids2;
+struct writer_disambiguate_font_ids3;
+
+
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;
- /** frame index */
- int frame;
- Eyes eyes;
+ 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.
*
* 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
+ * 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 (int) const;
+ bool can_fake_write (Frame) const;
- void write (Data, int, Eyes);
- void fake_write (int, Eyes);
- void repeat (int, Eyes);
- void write (boost::shared_ptr<const AudioBuffers>);
- void write (PlayerSubtitles subs);
- void write (std::list<boost::shared_ptr<Font> > fonts);
- void finish ();
+ 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<std::shared_ptr<dcpomatic::Font>> 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:
+ friend struct ::writer_disambiguate_font_ids1;
+ friend struct ::writer_disambiguate_font_ids2;
+ friend struct ::writer_disambiguate_font_ids3;
void thread ();
void terminate_thread (bool);
- void check_existing_picture_asset ();
bool have_sequenced_image_at_queue_head ();
- void write_frame_info (int frame, Eyes eyes, dcp::FrameInfo info) const;
- long frame_info_position (int frame, Eyes eyes) const;
- dcp::FrameInfo read_frame_info (FILE* file, int frame, Eyes eyes) const;
-
- /** our Film */
- boost::shared_ptr<const Film> _film;
- boost::weak_ptr<Job> _job;
- /** the first frame index that does not already exist in our MXF */
- int _first_nonexistant_frame;
-
- /** our thread, or 0 */
- boost::thread* _thread;
+ size_t video_reel (int frame) const;
+ void set_digest_progress(Job* job, int id, int64_t done, int64_t size);
+ void write_cover_sheet (boost::filesystem::path output_dcp);
+ void calculate_referenced_digests(std::function<void (int64_t, int64_t)> 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;
+ 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 */
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
*/
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::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;
+ boost::mutex _digest_progresses_mutex;
+ std::map<int, std::pair<int64_t, int64_t>> _digest_progresses;
- std::list<boost::shared_ptr<Font> > _fonts;
+ std::list<ReferencedReelAsset> _reel_assets;
- static int const _info_size;
+ FontIdMap _fonts;
+ /** If we are given many fonts, but we're making an Interop DCP, we'll choose a single
+ * one that we'll use everywher. This is that chosen font.
+ */
+ std::shared_ptr<dcpomatic::Font> _chosen_interop_font;
+
+ /** 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;
+
+ struct HangingText {
+ PlayerText text;
+ TextType type;
+ boost::optional<DCPTextTrack> track;
+ dcpomatic::DCPTimePeriod period;
+ };
+
+ std::vector<HangingText> _hanging_texts;
};
+
+
+#endif
+
projects / dcpomatic.git / blobdiff