In general the player assumes that it won't receive out of order video.
[dcpomatic.git] / src / lib / player.h
index ffc578c711fffe50410231b07042695dcaa7f8a2..0b8540c15e046c783ac995acd814352a4a3d999b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -32,6 +32,7 @@
 #include "content_subtitle.h"
 #include "audio_stream.h"
 #include "audio_merger.h"
+#include "empty.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/enable_shared_from_this.hpp>
 #include <list>
@@ -45,7 +46,7 @@ class Playlist;
 class Font;
 class AudioBuffers;
 class ReferencedReelAsset;
-class Resampler;
+class Shuffler;
 
 /** @class Player
  *  @brief A class which can `play' a Playlist.
@@ -54,6 +55,7 @@ class Player : public boost::enable_shared_from_this<Player>, public boost::nonc
 {
 public:
        Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
+       ~Player ();
 
        bool pass ();
        void seek (DCPTime time, bool accurate);
@@ -63,10 +65,11 @@ public:
 
        void set_video_container_size (dcp::Size);
        void set_ignore_video ();
-       void set_enable_subtitles (bool enable);
+       void set_ignore_subtitle ();
        void set_always_burn_subtitles (bool burn);
        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
@@ -76,6 +79,7 @@ public:
         */
        boost::signals2::signal<void (bool)> Changed;
 
+       /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
        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
@@ -89,6 +93,7 @@ private:
        friend struct player_time_calculation_test1;
        friend struct player_time_calculation_test2;
        friend struct player_time_calculation_test3;
+       friend struct player_subframe_test;
 
        void setup_pieces ();
        void flush ();
@@ -102,22 +107,20 @@ private:
        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;
+       boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) 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_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
                ) const;
        boost::optional<PositionImage> subtitles_for_frame (DCPTime time) const;
        void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
+       void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 
        boost::shared_ptr<const Film> _film;
        boost::shared_ptr<const Playlist> _playlist;
@@ -133,7 +136,7 @@ private:
        /** 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;
+       bool _ignore_subtitle;
        /** true if the player should always burn subtitles into the video regardless
            of content settings
        */
@@ -143,16 +146,19 @@ private:
        /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
        bool _play_referenced;
 
-       /** Last PlayerVideo that was emitted */
-       boost::shared_ptr<PlayerVideo> _last_video;
-       /** Time just after the last video frame we emitted, or empty if we have just seeked */
+       /** Time just after the last video frame we emitted, or the time of the last accurate seek */
        boost::optional<DCPTime> _last_video_time;
-       /** Time just after the last audio frame we emitted, or empty if we have just seeked */
+       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<DCPTime> _last_audio_time;
-       boost::optional<DCPTime> _last_seek_time;
-       bool _last_seek_accurate;
+
+       boost::optional<int> _dcp_decode_reduction;
+
+       typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
+       LastVideoMap _last_video;
 
        AudioMerger _audio_merger;
+       Shuffler* _shuffler;
 
        class StreamState
        {
@@ -169,13 +175,11 @@ private:
        };
        std::map<AudioStreamPtr, StreamState> _stream_states;
 
-       std::list<DCPTimePeriod> _no_video;
-       std::list<DCPTimePeriod> _no_audio;
+       Empty _black;
+       Empty _silent;
 
        ActiveSubtitles _active_subtitles;
        boost::shared_ptr<AudioProcessor> _audio_processor;
-       typedef std::map<std::pair<boost::shared_ptr<const AudioContent>, AudioStreamPtr>, boost::shared_ptr<Resampler> > ResamplerMap;
-       ResamplerMap _resamplers;
 
        boost::signals2::scoped_connection _film_changed_connection;
        boost::signals2::scoped_connection _playlist_changed_connection;