/*
- Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2020 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
#ifndef DCPOMATIC_PLAYER_H
#define DCPOMATIC_PLAYER_H
-#include "player_subtitles.h"
+#include "atmos_metadata.h"
+#include "player_text.h"
+#include "active_text.h"
+#include "content_text.h"
#include "film.h"
#include "content.h"
+#include "content_atmos.h"
#include "position_image.h"
#include "piece.h"
#include "content_video.h"
#include "content_audio.h"
-#include "content_subtitle.h"
#include "audio_stream.h"
#include "audio_merger.h"
-#include <boost/shared_ptr.hpp>
-#include <boost/enable_shared_from_this.hpp>
+#include "empty.h"
+#include <boost/atomic.hpp>
#include <list>
namespace dcp {
class ReelAsset;
}
+namespace dcpomatic {
+ class FontData;
+}
+
+class AtmosContent;
class PlayerVideo;
class Playlist;
-class Font;
class AudioBuffers;
class ReferencedReelAsset;
-class Resampler;
+class Shuffler;
+
+class PlayerProperty
+{
+public:
+ static int const VIDEO_CONTAINER_SIZE;
+ static int const PLAYLIST;
+ static int const FILM_CONTAINER;
+ static int const FILM_VIDEO_FRAME_RATE;
+ static int const DCP_DECODE_REDUCTION;
+ static int const PLAYBACK_LENGTH;
+};
/** @class Player
- * @brief A class which can `play' a Playlist.
+ * @brief A class which can play a Playlist.
*/
-class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
+class Player : public std::enable_shared_from_this<Player>, public boost::noncopyable
{
public:
- Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
+ Player (std::shared_ptr<const Film>);
+ Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
+ ~Player ();
bool pass ();
- void seek (DCPTime time, bool accurate);
+ void seek (dcpomatic::DCPTime time, bool accurate);
- std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
+ std::vector<dcpomatic::FontData> get_subtitle_fonts ();
std::list<ReferencedReelAsset> get_reel_assets ();
+ dcp::Size video_container_size () const {
+ boost::mutex::scoped_lock lm (_mutex);
+ return _video_container_size;
+ }
void set_video_container_size (dcp::Size);
void set_ignore_video ();
- void set_enable_subtitles (bool enable);
- void set_always_burn_subtitles (bool burn);
+ void set_ignore_audio ();
+ void set_ignore_text ();
+ void set_always_burn_open_subtitles ();
void set_fast ();
void set_play_referenced ();
+ void set_dcp_decode_reduction (boost::optional<int> reduction);
- /** Emitted when something has changed such that if we went back and emitted
- * the last frame again it would look different. This is not emitted after
- * a seek.
- *
- * The parameter is true if these signals are currently likely to be frequent.
- */
- boost::signals2::signal<void (bool)> Changed;
+ boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<Content> content, dcpomatic::ContentTime t);
+
+ boost::signals2::signal<void (ChangeType, int, bool)> Change;
- boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
- boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
- /** Emitted when a subtitle is ready. This signal may be emitted considerably
+ /** Emitted when a video frame is ready. These emissions happen in the correct order. */
+ boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
+ boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
+ /** Emitted when a text is ready. This signal may be emitted considerably
* after the corresponding Video.
*/
- boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
+ boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
+ boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
private:
friend class PlayerWrapper;
friend struct player_time_calculation_test1;
friend struct player_time_calculation_test2;
friend struct player_time_calculation_test3;
+ friend struct player_subframe_test;
+ friend struct empty_test1;
+ friend struct empty_test2;
+ friend struct check_reuse_old_data_test;
+ void construct ();
void setup_pieces ();
+ void setup_pieces_unlocked ();
void flush ();
- void film_changed (Film::Property);
- void playlist_changed ();
- void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
- std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
- Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
- DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
- Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
- DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
- ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
- DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
- boost::shared_ptr<PlayerVideo> black_player_video_frame () const;
- void video (boost::weak_ptr<Piece>, ContentVideo);
- void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
- void image_subtitle_start (boost::weak_ptr<Piece>, ContentImageSubtitle);
- void text_subtitle_start (boost::weak_ptr<Piece>, ContentTextSubtitle);
- void subtitle_stop (boost::weak_ptr<Piece>, ContentTime);
- boost::shared_ptr<Resampler> resampler (boost::shared_ptr<const AudioContent> content, AudioStreamPtr stream, bool create);
- DCPTime one_video_frame () const;
- void fill_video (DCPTimePeriod period);
- void fill_audio (DCPTimePeriod period);
- void audio_flush (boost::shared_ptr<Piece>, AudioStreamPtr stream);
- void audio_transform (boost::shared_ptr<AudioContent> content, AudioStreamPtr stream, ContentAudio content_audio, DCPTime time);
- std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
- boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
+ void film_change (ChangeType, Film::Property);
+ void playlist_change (ChangeType);
+ void playlist_content_change (ChangeType, int, bool);
+ Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
+ dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
+ Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
+ dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
+ dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
+ dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
+ std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
+
+ void video (std::weak_ptr<Piece>, ContentVideo);
+ void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
+ void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
+ void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
+ void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
+ void atmos (std::weak_ptr<Piece>, ContentAtmos);
+
+ dcpomatic::DCPTime one_video_frame () const;
+ void fill_audio (dcpomatic::DCPTimePeriod period);
+ std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
+ std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
) const;
+ boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
+ void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
+ void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
+ void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
+ std::shared_ptr<const Playlist> playlist () const;
+
+ /** Mutex to protect the whole Player state. When it's used for the preview we have
+ seek() and pass() called from the Butler thread and lots of other stuff called
+ from the GUI thread.
+ */
+ mutable boost::mutex _mutex;
- boost::shared_ptr<const Film> _film;
- boost::shared_ptr<const Playlist> _playlist;
+ std::shared_ptr<const Film> _film;
+ /** Playlist, or 0 if we are using the one from the _film */
+ std::shared_ptr<const Playlist> _playlist;
- /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
- bool _have_valid_pieces;
- std::list<boost::shared_ptr<Piece> > _pieces;
+ /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
+ boost::atomic<int> _suspended;
+ std::list<std::shared_ptr<Piece> > _pieces;
- /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
+ /** Size of the image we are rendering to; this may be the DCP frame size, or
+ * the size of preview in a window.
+ */
dcp::Size _video_container_size;
- boost::shared_ptr<Image> _black_image;
+ std::shared_ptr<Image> _black_image;
/** true if the player should ignore all video; i.e. never produce any */
- bool _ignore_video;
- /** true if the player should ignore all audio; i.e. never produce any */
- bool _ignore_audio;
- /** true if the player should always burn subtitles into the video regardless
- of content settings
- */
- bool _always_burn_subtitles;
+ bool _ignore_video = false;
+ bool _ignore_audio = false;
+ /** true if the player should ignore all text; i.e. never produce any */
+ bool _ignore_text = false;
+ bool _always_burn_open_subtitles = false;
/** true if we should try to be fast rather than high quality */
- bool _fast;
+ bool _fast = false;
+ /** true if we should keep going in the face of `survivable' errors */
+ bool _tolerant = false;
/** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
- bool _play_referenced;
+ bool _play_referenced = false;
+
+ /** Time just after the last video frame we emitted, or the time of the last accurate seek */
+ boost::optional<dcpomatic::DCPTime> _last_video_time;
+ boost::optional<Eyes> _last_video_eyes;
+ /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
+ boost::optional<dcpomatic::DCPTime> _last_audio_time;
+
+ boost::optional<int> _dcp_decode_reduction;
- /** Last PlayerVideo that was emitted */
- boost::shared_ptr<PlayerVideo> _last_video;
- /** Time just after the last video frame we emitted, or the last seek time */
- boost::optional<DCPTime> _last_video_time;
- /** Time just after the last audio frame we emitted, or the last seek time */
- boost::optional<DCPTime> _last_audio_time;
+ typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
+ LastVideoMap _last_video;
AudioMerger _audio_merger;
+ Shuffler* _shuffler = nullptr;
+ std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> > _delay;
class StreamState
{
public:
StreamState () {}
- StreamState (boost::shared_ptr<Piece> p, DCPTime l)
+ StreamState (std::shared_ptr<Piece> p, dcpomatic::DCPTime l)
: piece(p)
, last_push_end(l)
{}
- boost::shared_ptr<Piece> piece;
- DCPTime last_push_end;
+ std::shared_ptr<Piece> piece;
+ dcpomatic::DCPTime last_push_end;
};
std::map<AudioStreamPtr, StreamState> _stream_states;
- std::list<DCPTimePeriod> _no_video;
- std::list<DCPTimePeriod> _no_audio;
+ Empty _black;
+ Empty _silent;
- class ActiveSubtitles
- {
- public:
- ActiveSubtitles () {}
-
- ActiveSubtitles (PlayerSubtitles s, DCPTime f)
- : subs (s)
- , from (f)
- {}
-
- PlayerSubtitles subs;
- DCPTime from;
- boost::optional<DCPTime> to;
- };
- typedef std::map<boost::weak_ptr<Piece>, ActiveSubtitles> ActiveSubtitlesMap;
- ActiveSubtitlesMap _active_subtitles;
+ ActiveText _active_texts[static_cast<int>(TextType::COUNT)];
+ std::shared_ptr<AudioProcessor> _audio_processor;
- boost::shared_ptr<AudioProcessor> _audio_processor;
- typedef std::map<std::pair<boost::shared_ptr<const AudioContent>, AudioStreamPtr>, boost::shared_ptr<Resampler> > ResamplerMap;
- ResamplerMap _resamplers;
+ dcpomatic::DCPTime _playback_length;
boost::signals2::scoped_connection _film_changed_connection;
- boost::signals2::scoped_connection _playlist_changed_connection;
- boost::signals2::scoped_connection _playlist_content_changed_connection;
+ boost::signals2::scoped_connection _playlist_change_connection;
+ boost::signals2::scoped_connection _playlist_content_change_connection;
};
#endif