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 <boost/shared_ptr.hpp>
  27 #include <boost/signals2.hpp>
  28 #include <boost/thread.hpp>
  29
  30 class Image;
  31 class wxWindow;
  32 class FilmViewer;
  33 class PlayerVideo;
  34
  35 class VideoView
  36 {
  37 public:
  38         VideoView (FilmViewer* viewer);
  39         virtual ~VideoView () {}
  40
  41         virtual void set_image (boost::shared_ptr<const Image> image) = 0;
  42         virtual wxWindow* get () const = 0;
  43         /** Redraw the view after something has changed like content outlining,
  44          *  the film being removed, etc.
  45          */
  46         virtual void update () = 0;
  47
  48         virtual void start ();
  49         /* XXX_b: make pure */
  50         virtual void stop () {}
  51
  52         void clear ();
  53
  54         boost::signals2::signal<void()> Sized;
  55
  56         virtual bool display_next_frame (bool) = 0;
  57
  58         /* XXX_b: to remove */
  59         virtual void display_player_video () {}
  60
  61         int dropped () const {
  62                 boost::mutex::scoped_lock lm (_mutex);
  63                 return _dropped;
  64         }
  65
  66         StateTimer const & state_timer () const {
  67                 return _state_timer;
  68         }
  69
  70         dcpomatic::DCPTime position () const {
  71                 boost::mutex::scoped_lock lm (_mutex);
  72                 return _player_video.second;
  73         }
  74
  75         void set_video_frame_rate (int r) {
  76                 boost::mutex::scoped_lock lm (_mutex);
  77                 _video_frame_rate = r;
  78         }
  79
  80         void set_length (dcpomatic::DCPTime len) {
  81                 boost::mutex::scoped_lock lm (_mutex);
  82                 _length = len;
  83         }
  84
  85 protected:
  86         /* XXX_b: to remove */
  87         friend class FilmViewer;
  88
  89         bool get_next_frame (bool non_blocking);
  90         int time_until_next_frame () const;
  91         dcpomatic::DCPTime one_video_frame () const;
  92
  93         int video_frame_rate () const {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 return _video_frame_rate;
  96         }
  97
  98         dcpomatic::DCPTime length () const {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 return _length;
 101         }
 102
 103         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
 104                 boost::mutex::scoped_lock lm (_mutex);
 105                 return _player_video;
 106         }
 107
 108         void add_dropped () {
 109                 boost::mutex::scoped_lock lm (_mutex);
 110                 ++_dropped;
 111         }
 112
 113         FilmViewer* _viewer;
 114
 115 #ifdef DCPOMATIC_VARIANT_SWAROOP
 116         bool _in_watermark;
 117         int _watermark_x;
 118         int _watermark_y;
 119 #endif
 120
 121         StateTimer _state_timer;
 122
 123 private:
 124         /** Mutex protecting all the state in VideoView */
 125         mutable boost::mutex _mutex;
 126
 127         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
 128         int _video_frame_rate;
 129         /** length of the film we are playing, or 0 if there is none */
 130         dcpomatic::DCPTime _length;
 131
 132         int _dropped;
 133 };
 134
 135 #endif