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/shared_ptr.hpp>
  29 #include <boost/signals2.hpp>
  30 #include <boost/thread.hpp>
  31 #include <boost/noncopyable.hpp>
  32
  33 class FilmViewer;
  34 class PlayerVideo;
  35 class wxWindow;
  36
  37 namespace dcpomatic {
  38         class Image;
  39 }
  40
  41 class VideoView : public ExceptionStore, public boost::noncopyable
  42 {
  43 public:
  44         VideoView (FilmViewer* viewer);
  45         virtual ~VideoView () {}
  46
  47         /** @return the thing displaying the image */
  48         virtual wxWindow* get () const = 0;
  49         /** Re-make and display the image from the current _player_video */
  50         virtual void update () = 0;
  51         /** Called when playback starts */
  52         virtual void start ();
  53         /** Called when playback stops */
  54         virtual void stop () {}
  55         /** Get the next frame and display it; used after seek */
  56         virtual bool display_next_frame (bool) = 0;
  57
  58         void clear ();
  59         bool refresh_metadata (boost::shared_ptr<const Film> film, dcp::Size video_container_size, dcp::Size film_frame_size);
  60
  61         /** Emitted from the GUI thread when our display changes in size */
  62         boost::signals2::signal<void()> Sized;
  63
  64
  65         /* Accessors for FilmViewer */
  66
  67         int dropped () const {
  68                 boost::mutex::scoped_lock lm (_mutex);
  69                 return _dropped;
  70         }
  71
  72         int errored () const {
  73                 boost::mutex::scoped_lock lm (_mutex);
  74                 return _errored;
  75         }
  76
  77         int gets () const {
  78                 boost::mutex::scoped_lock lm (_mutex);
  79                 return _gets;
  80         }
  81
  82         StateTimer const & state_timer () const {
  83                 return _state_timer;
  84         }
  85
  86         dcpomatic::DCPTime position () const {
  87                 boost::mutex::scoped_lock lm (_mutex);
  88                 return _player_video.second;
  89         }
  90
  91
  92         /* Setters for FilmViewer so it can tell us our state and
  93          * we can then use (thread) safely.
  94          */
  95
  96         void set_video_frame_rate (int r) {
  97                 boost::mutex::scoped_lock lm (_mutex);
  98                 _video_frame_rate = r;
  99         }
 100
 101         void set_length (dcpomatic::DCPTime len) {
 102                 boost::mutex::scoped_lock lm (_mutex);
 103                 _length = len;
 104         }
 105
 106         void set_eyes (Eyes eyes) {
 107                 boost::mutex::scoped_lock lm (_mutex);
 108                 _eyes = eyes;
 109         }
 110
 111         void set_three_d (bool t) {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 _three_d = t;
 114         }
 115
 116 protected:
 117         bool get_next_frame (bool non_blocking);
 118         boost::optional<int> time_until_next_frame () const;
 119         dcpomatic::DCPTime one_video_frame () const;
 120
 121         int video_frame_rate () const {
 122                 boost::mutex::scoped_lock lm (_mutex);
 123                 return _video_frame_rate;
 124         }
 125
 126         dcpomatic::DCPTime length () const {
 127                 boost::mutex::scoped_lock lm (_mutex);
 128                 return _length;
 129         }
 130
 131         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
 132                 boost::mutex::scoped_lock lm (_mutex);
 133                 return _player_video;
 134         }
 135
 136         void add_dropped () {
 137                 boost::mutex::scoped_lock lm (_mutex);
 138                 ++_dropped;
 139         }
 140
 141         void add_get () {
 142                 boost::mutex::scoped_lock lm (_mutex);
 143                 ++_gets;
 144         }
 145
 146         FilmViewer* _viewer;
 147
 148 #ifdef DCPOMATIC_VARIANT_SWAROOP
 149         bool _in_watermark;
 150         int _watermark_x;
 151         int _watermark_y;
 152 #endif
 153
 154         StateTimer _state_timer;
 155
 156 private:
 157         /** Mutex protecting all the state in this class */
 158         mutable boost::mutex _mutex;
 159
 160         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
 161         int _video_frame_rate;
 162         /** length of the film we are playing, or 0 if there is none */
 163         dcpomatic::DCPTime _length;
 164         Eyes _eyes;
 165         bool _three_d;
 166
 167         int _dropped;
 168         int _errored;
 169         int _gets;
 170 };
 171
 172 #endif