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         virtual void set_image (boost::shared_ptr<const Image> image) = 0;
  45         virtual wxWindow* get () const = 0;
  46         /** Redraw the view after something has changed like content outlining,
  47          *  the film being removed, etc.
  48          */
  49         virtual void update () = 0;
  50
  51         virtual void start ();
  52         /* XXX_b: make pure */
  53         virtual void stop () {}
  54
  55         void clear ();
  56
  57         boost::signals2::signal<void()> Sized;
  58
  59         virtual bool display_next_frame (bool) = 0;
  60
  61         /* XXX_b: to remove */
  62         virtual void display_player_video () {}
  63
  64         int dropped () const {
  65                 boost::mutex::scoped_lock lm (_mutex);
  66                 return _dropped;
  67         }
  68
  69         int gets () const {
  70                 boost::mutex::scoped_lock lm (_mutex);
  71                 return _gets;
  72         }
  73
  74         StateTimer const & state_timer () const {
  75                 return _state_timer;
  76         }
  77
  78         dcpomatic::DCPTime position () const {
  79                 boost::mutex::scoped_lock lm (_mutex);
  80                 return _player_video.second;
  81         }
  82
  83         void set_video_frame_rate (int r) {
  84                 boost::mutex::scoped_lock lm (_mutex);
  85                 _video_frame_rate = r;
  86         }
  87
  88         void set_length (dcpomatic::DCPTime len) {
  89                 boost::mutex::scoped_lock lm (_mutex);
  90                 _length = len;
  91         }
  92
  93         void set_eyes (Eyes eyes) {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 _eyes = eyes;
  96         }
  97
  98         void set_three_d (bool t) {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 _three_d = t;
 101         }
 102
 103 protected:
 104         /* XXX_b: to remove */
 105         friend class FilmViewer;
 106
 107         bool get_next_frame (bool non_blocking);
 108         int time_until_next_frame () const;
 109         dcpomatic::DCPTime one_video_frame () const;
 110
 111         int video_frame_rate () const {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 return _video_frame_rate;
 114         }
 115
 116         dcpomatic::DCPTime length () const {
 117                 boost::mutex::scoped_lock lm (_mutex);
 118                 return _length;
 119         }
 120
 121         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
 122                 boost::mutex::scoped_lock lm (_mutex);
 123                 return _player_video;
 124         }
 125
 126         void add_dropped () {
 127                 boost::mutex::scoped_lock lm (_mutex);
 128                 ++_dropped;
 129         }
 130
 131         void add_get () {
 132                 boost::mutex::scoped_lock lm (_mutex);
 133                 ++_gets;
 134         }
 135
 136         FilmViewer* _viewer;
 137
 138 #ifdef DCPOMATIC_VARIANT_SWAROOP
 139         bool _in_watermark;
 140         int _watermark_x;
 141         int _watermark_y;
 142 #endif
 143
 144         StateTimer _state_timer;
 145
 146 private:
 147         /** Mutex protecting all the state in VideoView */
 148         mutable boost::mutex _mutex;
 149
 150         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
 151         int _video_frame_rate;
 152         /** length of the film we are playing, or 0 if there is none */
 153         dcpomatic::DCPTime _length;
 154         Eyes _eyes;
 155         bool _three_d;
 156
 157         int _dropped;
 158         int _gets;
 159 };
 160
 161 #endif