Merge branch 'master' of ssh://git.carlh.net/home/carl/git/dcpomatic

[dcpomatic.git] / src / lib / player.h

diff --git a/src/lib/player.h b/src/lib/player.h
index abc06721a6c7f0f7818ca1537a15034fe695d905..a4fd80c161c565ccd4a47b210ca833b603c6132e 100644 (file)
--- a/src/lib/player.h
+++ b/src/lib/player.h
@@ -21,8 +21,8 @@
 #ifndef DCPOMATIC_PLAYER_H
 #define DCPOMATIC_PLAYER_H
 
-#include "player_subtitles.h"
-#include "active_subtitles.h"
+#include "player_text.h"
+#include "active_text.h"
 #include "content_text.h"
 #include "film.h"
 #include "content.h"
@@ -59,7 +59,7 @@ public:
 };
 
 /** @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
 {
@@ -73,19 +73,23 @@ public:
        std::list<boost::shared_ptr<Font> > 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_ignore_subtitle ();
-       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);
 
        DCPTime content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
 
+       std::list<PlayerText> closed_captions_for_frame (DCPTime time) const;
+
        /** 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.
@@ -98,10 +102,10 @@ public:
        /** 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
+       /** 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, DCPTimePeriod)> Text;
 
 private:
        friend class PlayerWrapper;
@@ -126,19 +130,25 @@ private:
        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 bitmap_text_start (boost::weak_ptr<Piece>, ContentBitmapText);
-       void plain_text_start (boost::weak_ptr<Piece>, ContentPlainText);
-       void subtitle_stop (boost::weak_ptr<Piece>, ContentTime);
+       void bitmap_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentBitmapText);
+       void plain_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentStringText);
+       void subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentTime, TextType);
        DCPTime one_video_frame () const;
        void fill_audio (DCPTimePeriod period);
        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;
+       boost::optional<PositionImage> open_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);
 
+       /** 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;
 
@@ -152,12 +162,10 @@ 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_subtitle;
-       /** true if the player should always burn subtitles into the video regardless
-           of content settings
-       */
-       bool _always_burn_subtitles;
+       bool _ignore_audio;
+       /** true if the player should ignore all text; i.e. never produce any */
+       bool _ignore_text;
+       bool _always_burn_open_subtitles;
        /** true if we should try to be fast rather than high quality */
        bool _fast;
        /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
@@ -196,7 +204,7 @@ private:
        Empty _black;
        Empty _silent;
 
-       ActiveSubtitles _active_subtitles;
+       ActiveText _active_texts[TEXT_COUNT];
        boost::shared_ptr<AudioProcessor> _audio_processor;
 
        boost::signals2::scoped_connection _film_changed_connection;