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