Reword again: Text -> Caption and Plain -> Text.
[dcpomatic.git] / src / lib / player.h
index 684de53f5b46d56290a64615e0eb488e9966fe77..16e9d57a5b38d92af5a0431b988a3c5413275d9a 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.
 
 #ifndef DCPOMATIC_PLAYER_H
 #define DCPOMATIC_PLAYER_H
 
-#include "player_subtitles.h"
+#include "player_caption.h"
+#include "active_captions.h"
+#include "content_text.h"
 #include "film.h"
 #include "content.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 "empty.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/enable_shared_from_this.hpp>
 #include <list>
@@ -44,7 +46,17 @@ 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;
+};
 
 /** @class Player
  *  @brief A class which can `play' a Playlist.
@@ -53,66 +65,79 @@ 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);
 
        std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
        std::list<ReferencedReelAsset> get_reel_assets ();
+       dcp::Size video_container_size () const {
+               return _video_container_size;
+       }
 
        void set_video_container_size (dcp::Size);
        void set_ignore_video ();
-       void set_ignore_audio ();
-       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);
+
+       DCPTime content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
 
        /** 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.
+        *  The first parameter is what changed.
+        *  The second parameter is true if these signals are currently likely to be frequent.
         */
-       boost::signals2::signal<void (bool)> Changed;
+       boost::signals2::signal<void (int, 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;
-       boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
+       /** Emitted when a caption is ready.  This signal may be emitted considerably
+        *  after the corresponding Video.
+        */
+       boost::signals2::signal<void (PlayerCaption, TextType, DCPTimePeriod)> Text;
 
 private:
        friend class PlayerWrapper;
        friend class Piece;
-       friend struct player_overlaps_test;
        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 ();
        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;
+       std::list<PositionImage> transform_bitmap_texts (std::list<BitmapText>) 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;
-       std::list<boost::shared_ptr<Piece> > overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid);
+       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 (boost::weak_ptr<Piece>, ContentImageSubtitle);
-       void text_subtitle (boost::weak_ptr<Piece>, ContentTextSubtitle);
-       boost::shared_ptr<Resampler> resampler (boost::shared_ptr<const AudioContent> content, AudioStreamPtr stream, bool create);
+       void bitmap_text_start (boost::weak_ptr<Piece>, ContentBitmapCaption);
+       void plain_text_start (boost::weak_ptr<Piece>, ContentTextCaption);
+       void subtitle_stop (boost::weak_ptr<Piece>, ContentTime, TextType);
        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) const;
+       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 do_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;
@@ -128,7 +153,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
        */
@@ -138,16 +163,23 @@ 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 the last seek time */
+       /** 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 the last seek 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<DCPTime> _last_audio_time;
 
+       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;
+       std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
 
-       class StreamState {
+       class StreamState
+       {
        public:
                StreamState () {}
 
@@ -161,14 +193,11 @@ private:
        };
        std::map<AudioStreamPtr, StreamState> _stream_states;
 
-       std::list<DCPTimePeriod> _no_video;
-       std::list<DCPTimePeriod> _no_audio;
-
-       std::list<std::pair<PlayerSubtitles, DCPTimePeriod> > _subtitles;
+       Empty _black;
+       Empty _silent;
 
+       ActiveCaptions _active_text[TEXT_COUNT];
        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;