Tweak class declaration.
[dcpomatic.git] / src / wx / film_viewer.h
1 /*
2     Copyright (C) 2012-2017 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 /** @file  src/film_viewer.h
22  *  @brief A wx widget to view `thumbnails' of a Film.
23  */
24
25 #include <wx/wx.h>
26 #include "lib/film.h"
27
28 class wxToggleButton;
29 class FFmpegPlayer;
30 class Image;
31 class RGBPlusAlphaImage;
32 class PlayerVideo;
33 class Player;
34
35 /** @class FilmViewer
36  *  @brief A wx widget to view a preview of a Film.
37  */
38 class FilmViewer : public wxPanel
39 {
40 public:
41         FilmViewer (wxWindow *);
42
43         void set_film (boost::shared_ptr<Film>);
44
45         /** @return our `playhead' position; this may not lie exactly on a frame boundary */
46         DCPTime position () const {
47                 return _position;
48         }
49
50         void set_position (DCPTime p);
51         void set_coalesce_player_changes (bool c);
52
53         void refresh ();
54
55         boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
56
57 private:
58         void paint_panel ();
59         void panel_sized (wxSizeEvent &);
60         void slider_moved ();
61         void play_clicked ();
62         void timer ();
63         void calculate_sizes ();
64         void check_play_state ();
65         void active_jobs_changed (boost::optional<std::string>);
66         void back_clicked (wxMouseEvent &);
67         void forward_clicked (wxMouseEvent &);
68         void player_changed (bool);
69         void update_position_label ();
70         void update_position_slider ();
71         void video (boost::shared_ptr<PlayerVideo>, DCPTime time);
72         void get ();
73         void seek (DCPTime t, bool accurate);
74         void refresh_panel ();
75         void setup_sensitivity ();
76         void film_changed (Film::Property);
77         DCPTime nudge_amount (wxMouseEvent &);
78         void timecode_clicked ();
79         void frame_number_clicked ();
80         void go_to (DCPTime t);
81         void jump_to_selected_clicked ();
82
83         boost::shared_ptr<Film> _film;
84         boost::shared_ptr<Player> _player;
85
86         wxSizer* _v_sizer;
87         wxPanel* _panel;
88         wxCheckBox* _outline_content;
89         wxRadioButton* _left_eye;
90         wxRadioButton* _right_eye;
91         wxCheckBox* _jump_to_selected;
92         wxSlider* _slider;
93         wxButton* _back_button;
94         wxButton* _forward_button;
95         wxStaticText* _frame_number;
96         wxStaticText* _timecode;
97         wxToggleButton* _play_button;
98         wxTimer _timer;
99         bool _coalesce_player_changes;
100         bool _pending_player_change;
101
102         boost::shared_ptr<const Image> _frame;
103         DCPTime _position;
104         Position<int> _inter_position;
105         dcp::Size _inter_size;
106
107         /** Size of our output (including padding if we have any) */
108         dcp::Size _out_size;
109         /** Size of the panel that we have available */
110         dcp::Size _panel_size;
111         /** true if the last call to Player::seek() was specified to be accurate;
112          *  this is used so that when re-fetching the current frame we
113          *  can get the same one that we got last time.
114          */
115         bool _last_seek_accurate;
116 };