Add some very basic timing of the player.

[dcpomatic.git] / src / wx / film_viewer.h

diff --git a/src/wx/film_viewer.h b/src/wx/film_viewer.h
index d080c79a5957dd08b8639f81ef6c34736d264db9..97da5f59185e8c1b030b0abb2e683c866e8c4ced 100644 (file)
--- a/src/wx/film_viewer.h
+++ b/src/wx/film_viewer.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -19,12 +19,13 @@
 */
 
 /** @file  src/film_viewer.h
- *  @brief A wx widget to view `thumbnails' of a Film.
+ *  @brief FilmViewer class.
  */
 
 #include "lib/film.h"
 #include "lib/config.h"
 #include "lib/player_text.h"
+#include "lib/timer.h"
 #include <RtAudio.h>
 #include <wx/wx.h>
 
@@ -38,7 +39,7 @@ class Butler;
 class ClosedCaptionsDialog;
 
 /** @class FilmViewer
- *  @brief A wx widget to view a preview of a Film.
+ *  @brief A wx widget to view a Film.
  */
 class FilmViewer
 {
@@ -46,75 +47,91 @@ public:
        FilmViewer (wxWindow *);
        ~FilmViewer ();
 
+       /** @return the panel showing the film's video */
        wxPanel* panel () const {
                return _panel;
        }
 
+       void show_closed_captions ();
+
        void set_film (boost::shared_ptr<Film>);
        boost::shared_ptr<Film> film () const {
                return _film;
        }
 
+       void seek (DCPTime t, bool accurate);
+       void seek (boost::shared_ptr<Content> content, ContentTime p, bool accurate);
+       void seek_by (DCPTime by, bool accurate);
        /** @return our `playhead' position; this may not lie exactly on a frame boundary */
        DCPTime position () const {
                return _video_position;
        }
+       DCPTime one_video_frame () const;
+
+       void start ();
+       bool stop ();
+       bool playing () const {
+               return _playing;
+       }
 
-       void set_position (DCPTime p);
-       void set_position (boost::shared_ptr<Content> content, ContentTime p);
        void set_coalesce_player_changes (bool c);
        void set_dcp_decode_reduction (boost::optional<int> reduction);
        boost::optional<int> dcp_decode_reduction () const;
+       void set_outline_content (bool o);
+       void set_eyes (Eyes e);
+       void set_pad_black (bool p);
 
        void slow_refresh ();
-       bool quick_refresh ();
 
        int dropped () const {
                return _dropped;
        }
 
-       void start ();
-       bool stop ();
-       bool playing () const {
-               return _playing;
-       }
+       int audio_callback (void* out, unsigned int frames);
 
-       void move (DCPTime by);
-       DCPTime one_video_frame () const;
-       void seek (DCPTime t, bool accurate);
-       DCPTime video_position () const {
-               return _video_position;
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       void set_background_image (bool b) {
+               _background_image = b;
+               refresh_panel ();
        }
-       void go_to (DCPTime t);
-       void set_outline_content (bool o);
-       void set_eyes (Eyes e);
+#endif
 
-       int audio_callback (void* out, unsigned int frames);
+       StateTimer const & state_timer () const {
+               return _state_timer;
+       }
 
-       void show_closed_captions ();
+       int gets () const {
+               return _gets;
+       }
 
        boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
        boost::signals2::signal<void ()> PositionChanged;
-       boost::signals2::signal<void ()> Started;
-       boost::signals2::signal<void ()> Stopped;
+       boost::signals2::signal<void (DCPTime)> Started;
+       boost::signals2::signal<void (DCPTime)> Stopped;
+       /** While playing back we reached the end of the film (emitted from GUI thread) */
+       boost::signals2::signal<void ()> Finished;
+
+       boost::signals2::signal<bool ()> PlaybackPermitted;
 
 private:
        void paint_panel ();
        void panel_sized (wxSizeEvent &);
        void timer ();
        void calculate_sizes ();
-       void check_play_state ();
        void player_change (ChangeType type, int, bool);
        void get ();
        void display_player_video ();
        void film_change (ChangeType, Film::Property);
-       void timecode_clicked ();
        void recreate_butler ();
        void config_changed (Config::Property);
+       bool maybe_draw_background_image (wxPaintDC& dc);
+
        DCPTime time () const;
        DCPTime uncorrected_time () const;
        Frame average_latency () const;
+
        void refresh_panel ();
+       bool quick_refresh ();
 
        boost::shared_ptr<Film> _film;
        boost::shared_ptr<Player> _player;
@@ -154,6 +171,20 @@ private:
 
        bool _outline_content;
        Eyes _eyes;
+       /** true to pad the viewer panel with black, false to use
+           the normal window background colour.
+       */
+       bool _pad_black;
+
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       bool _in_watermark;
+       int _watermark_x;
+       int _watermark_y;
+       bool _background_image;
+#endif
+
+       StateTimer _state_timer;
+       int _gets;
 
        boost::signals2::scoped_connection _config_changed_connection;
 };