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