A little thread safety.
[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                 : _viewer (viewer)
39 #ifdef DCPOMATIC_VARIANT_SWAROOP
40                 , _in_watermark (false)
41 #endif
42         {}
43
44         virtual ~VideoView () {}
45
46         virtual void set_image (boost::shared_ptr<const Image> image) = 0;
47         virtual wxWindow* get () const = 0;
48         virtual void update () = 0;
49
50         /* XXX_b: make pure */
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         dcpomatic::DCPTime position () const {
65                 boost::mutex::scoped_lock lm (_mutex);
66                 return _player_video.second;
67         }
68
69         void set_film (boost::shared_ptr<const Film> film) {
70                 boost::mutex::scoped_lock lm (_mutex);
71                 _film = film;
72         }
73
74 protected:
75         /* XXX_b: to remove */
76         friend class FilmViewer;
77
78         bool get_next_frame (bool non_blocking);
79         int time_until_next_frame () const;
80         dcpomatic::DCPTime one_video_frame () const;
81
82         boost::shared_ptr<const Film> film () const {
83                 boost::mutex::scoped_lock lm (_mutex);
84                 return _film;
85         }
86
87         FilmViewer* _viewer;
88         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
89
90         /** Mutex protecting all the state in VideoView */
91         mutable boost::mutex _mutex;
92
93 #ifdef DCPOMATIC_VARIANT_SWAROOP
94         bool _in_watermark;
95         int _watermark_x;
96         int _watermark_y;
97 #endif
98
99 private:
100         boost::shared_ptr<const Film> _film;
101 };
102
103 #endif