Note that newer libsub version is required.
[dcpomatic.git] / src / lib / player.h
index 76721837931fecc910ec45d3bc2afd33c1342a61..48f6f97ca2b6a542cb9d5b39afcde5a657527058 100644 (file)
 #include "atmos_metadata.h"
 #include "audio_merger.h"
 #include "audio_stream.h"
-#include "content.h"
 #include "content_atmos.h"
 #include "content_audio.h"
 #include "content_text.h"
 #include "content_video.h"
+#include "dcp_text_track.h"
 #include "empty.h"
-#include "film.h"
-#include "piece.h"
+#include "enum_indexed_vector.h"
+#include "film_property.h"
+#include "image.h"
 #include "player_text.h"
 #include "position_image.h"
 #include "shuffler.h"
@@ -46,16 +47,13 @@ namespace dcp {
        class ReelAsset;
 }
 
-namespace dcpomatic {
-       class FontData;
-}
-
 class AtmosContent;
+class AudioBuffers;
+class Content;
+class Film;
 class PlayerVideo;
 class Playlist;
-class AudioBuffers;
 class ReferencedReelAsset;
-class Shuffler;
 
 
 class PlayerProperty
@@ -67,28 +65,37 @@ public:
        static int const FILM_VIDEO_FRAME_RATE;
        static int const DCP_DECODE_REDUCTION;
        static int const PLAYBACK_LENGTH;
+       static int const IGNORE_VIDEO;
+       static int const IGNORE_AUDIO;
+       static int const IGNORE_TEXT;
+       static int const ALWAYS_BURN_OPEN_SUBTITLES;
+       static int const PLAY_REFERENCED;
 };
 
 
 /** @class Player
  *  @brief A class which can play a Playlist.
  */
-class Player : public std::enable_shared_from_this<Player>
+class Player
 {
 public:
-       Player (std::shared_ptr<const Film>, bool aligned_subtitles);
+       Player (std::shared_ptr<const Film>, Image::Alignment subtitle_alignment);
        Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
 
-       Player (Player const& Player) = delete;
-       Player& operator= (Player const& Player) = delete;
+       Player (Player const&) = delete;
+       Player& operator= (Player const&) = delete;
+
+       Player(Player&& other);
+       Player& operator=(Player&& other);
 
        bool pass ();
        void seek (dcpomatic::DCPTime time, bool accurate);
+       Frame frames_done() const;
+       float progress() const;
+
+       std::vector<std::shared_ptr<dcpomatic::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;
        }
 
@@ -100,9 +107,17 @@ public:
        void set_fast ();
        void set_play_referenced ();
        void set_dcp_decode_reduction (boost::optional<int> reduction);
+       void set_disable_audio_processor();
+
+       boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
+       boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
 
-       boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<Content> content, dcpomatic::ContentTime t);
+       void signal_change(ChangeType type, int property);
 
+       /** First parameter is PENDING, DONE or CANCELLED.
+        *  Second parameter is the property.
+        *  Third parameter is true if these signals are currently likely to be frequent.
+        */
        boost::signals2::signal<void (ChangeType, int, bool)> Change;
 
        /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
@@ -130,10 +145,9 @@ private:
        friend struct overlap_video_test1;
 
        void construct ();
+       void connect();
        void setup_pieces ();
-       void setup_pieces_unlocked ();
-       void flush ();
-       void film_change (ChangeType, Film::Property);
+       void film_change(ChangeType, FilmProperty);
        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;
@@ -143,6 +157,7 @@ private:
        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;
+       std::pair<std::shared_ptr<Piece>, boost::optional<dcpomatic::DCPTime>> earliest_piece_and_time() const;
 
        void video (std::weak_ptr<Piece>, ContentVideo);
        void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
@@ -162,79 +177,82 @@ private:
        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
+       /** Mutex to protect the most of the 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;
 
-       std::shared_ptr<const Film> _film;
+       std::weak_ptr<const Film> _film;
        /** Playlist, or 0 if we are using the one from the _film */
        std::shared_ptr<const Playlist> _playlist;
 
        /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
        boost::atomic<int> _suspended;
-       std::list<std::shared_ptr<Piece> > _pieces;
+       std::vector<std::shared_ptr<Piece>> _pieces;
 
        /** 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::atomic<dcp::Size> _video_container_size;
+
+       mutable boost::mutex _black_image_mutex;
        std::shared_ptr<Image> _black_image;
 
        /** true if the player should ignore all video; i.e. never produce any */
-       bool _ignore_video = false;
-       bool _ignore_audio = false;
+       boost::atomic<bool> _ignore_video;
+       boost::atomic<bool> _ignore_audio;
        /** true if the player should ignore all text; i.e. never produce any */
-       bool _ignore_text = false;
-       bool _always_burn_open_subtitles = false;
+       boost::atomic<bool> _ignore_text;
+       boost::atomic<bool> _always_burn_open_subtitles;
        /** true if we should try to be fast rather than high quality */
-       bool _fast = false;
+       boost::atomic<bool> _fast;
        /** true if we should keep going in the face of `survivable' errors */
-       bool _tolerant = false;
+       bool _tolerant;
        /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
-       bool _play_referenced = false;
+       boost::atomic<bool> _play_referenced;
 
-       /** 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;
+       /** Time of the next video that we will emit, or the time of the last accurate seek */
+       boost::optional<dcpomatic::DCPTime> _next_video_time;
+       /** Eyes of the next video that we will emit */
+       boost::optional<Eyes> _next_video_eyes;
+       /** Time of the next audio that we will emit, or the time of the last accurate seek */
+       boost::optional<dcpomatic::DCPTime> _next_audio_time;
 
-       boost::optional<int> _dcp_decode_reduction;
+       boost::atomic<boost::optional<int>> _dcp_decode_reduction;
 
        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;
        std::unique_ptr<Shuffler> _shuffler;
-       std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> > _delay;
+       std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
 
        class StreamState
        {
        public:
                StreamState () {}
 
-               StreamState (std::shared_ptr<Piece> p, dcpomatic::DCPTime l)
+               explicit StreamState(std::shared_ptr<Piece> p)
                        : piece(p)
-                       , last_push_end(l)
                {}
 
                std::shared_ptr<Piece> piece;
-               dcpomatic::DCPTime last_push_end;
+               boost::optional<dcpomatic::DCPTime> last_push_end;
        };
        std::map<AudioStreamPtr, StreamState> _stream_states;
 
        Empty _black;
        Empty _silent;
 
-       ActiveText _active_texts[static_cast<int>(TextType::COUNT)];
+       EnumIndexedVector<ActiveText, TextType> _active_texts;
        std::shared_ptr<AudioProcessor> _audio_processor;
+       bool _disable_audio_processor = false;
 
-       dcpomatic::DCPTime _playback_length;
+       boost::atomic<dcpomatic::DCPTime> _playback_length;
 
-       /** aligned flag for subtitle images that we create */
-       bool _aligned_subtitles = true;
+       /** Alignment for subtitle images that we create */
+       Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
 
        boost::signals2::scoped_connection _film_changed_connection;
        boost::signals2::scoped_connection _playlist_change_connection;