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