src/wx/video_view.h

   1 /*
   2     Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_VIDEO_VIEW_H
  22 #define DCPOMATIC_VIDEO_VIEW_H
  23
  24 #include "lib/dcpomatic_time.h"
  25 #include "lib/timer.h"
  26 #include "lib/types.h"
  27 #include "lib/exception_store.h"
  28 #include <boost/signals2.hpp>
  29 #include <boost/thread.hpp>
  30 #include <boost/noncopyable.hpp>
  31
  32 class Image;
  33 class wxWindow;
  34 class FilmViewer;
  35 class Player;
  36 class PlayerVideo;
  37
  38 class VideoView : public ExceptionStore, public boost::noncopyable
  39 {
  40 public:
  41         VideoView (FilmViewer* viewer);
  42         virtual ~VideoView () {}
  43
  44         /** @return the thing displaying the image */
  45         virtual wxWindow* get () const = 0;
  46         /** Re-make and display the image from the current _player_video */
  47         virtual void update () = 0;
  48         /** Called when playback starts */
  49         virtual void start ();
  50         /** Called when playback stops */
  51         virtual void stop () {}
  52
  53         enum NextFrameResult {
  54                 FAIL,
  55                 AGAIN,
  56                 SUCCESS
  57         };
  58
  59         /** Get the next frame and display it; used after seek */
  60         virtual NextFrameResult display_next_frame (bool) = 0;
  61
  62         void clear ();
  63         bool reset_metadata (std::shared_ptr<const Film> film, dcp::Size player_video_container_size);
  64
  65         /** Emitted from the GUI thread when our display changes in size */
  66         boost::signals2::signal<void()> Sized;
  67
  68
  69         /* Accessors for FilmViewer */
  70
  71         int dropped () const {
  72                 boost::mutex::scoped_lock lm (_mutex);
  73                 return _dropped;
  74         }
  75
  76         int errored () const {
  77                 boost::mutex::scoped_lock lm (_mutex);
  78                 return _errored;
  79         }
  80
  81         int gets () const {
  82                 boost::mutex::scoped_lock lm (_mutex);
  83                 return _gets;
  84         }
  85
  86         StateTimer const & state_timer () const {
  87                 return _state_timer;
  88         }
  89
  90         dcpomatic::DCPTime position () const {
  91                 boost::mutex::scoped_lock lm (_mutex);
  92                 return _player_video.second;
  93         }
  94
  95
  96         /* Setters for FilmViewer so it can tell us our state and
  97          * we can then use (thread) safely.
  98          */
  99
 100         void set_video_frame_rate (int r) {
 101                 boost::mutex::scoped_lock lm (_mutex);
 102                 _video_frame_rate = r;
 103         }
 104
 105         void set_length (dcpomatic::DCPTime len) {
 106                 boost::mutex::scoped_lock lm (_mutex);
 107                 _length = len;
 108         }
 109
 110         void set_eyes (Eyes eyes) {
 111                 boost::mutex::scoped_lock lm (_mutex);
 112                 _eyes = eyes;
 113         }
 114
 115         void set_three_d (bool t) {
 116                 boost::mutex::scoped_lock lm (_mutex);
 117                 _three_d = t;
 118         }
 119
 120 protected:
 121         NextFrameResult get_next_frame (bool non_blocking);
 122         boost::optional<int> time_until_next_frame () const;
 123         dcpomatic::DCPTime one_video_frame () const;
 124
 125         int video_frame_rate () const {
 126                 boost::mutex::scoped_lock lm (_mutex);
 127                 return _video_frame_rate;
 128         }
 129
 130         dcpomatic::DCPTime length () const {
 131                 boost::mutex::scoped_lock lm (_mutex);
 132                 return _length;
 133         }
 134
 135         std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
 136                 boost::mutex::scoped_lock lm (_mutex);
 137                 return _player_video;
 138         }
 139
 140         void add_dropped () {
 141                 boost::mutex::scoped_lock lm (_mutex);
 142                 ++_dropped;
 143         }
 144
 145         void add_get () {
 146                 boost::mutex::scoped_lock lm (_mutex);
 147                 ++_gets;
 148         }
 149
 150         FilmViewer* _viewer;
 151
 152         StateTimer _state_timer;
 153
 154 private:
 155         /** Mutex protecting all the state in this class */
 156         mutable boost::mutex _mutex;
 157
 158         std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
 159         int _video_frame_rate;
 160         /** length of the film we are playing, or 0 if there is none */
 161         dcpomatic::DCPTime _length;
 162         Eyes _eyes;
 163         bool _three_d;
 164
 165         int _dropped;
 166         int _errored;
 167         int _gets;
 168 };
 169
 170 #endif