Try to improve refetching of last frame and seek backwards.
[dcpomatic.git] / src / wx / film_viewer.cc
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file  src/film_viewer.cc
21  *  @brief A wx widget to view a preview of a Film.
22  */
23
24 #include <iostream>
25 #include <iomanip>
26 #include <wx/tglbtn.h>
27 #include "lib/film.h"
28 #include "lib/ratio.h"
29 #include "lib/util.h"
30 #include "lib/job_manager.h"
31 #include "lib/image.h"
32 #include "lib/scaler.h"
33 #include "lib/exceptions.h"
34 #include "lib/examine_content_job.h"
35 #include "lib/filter.h"
36 #include "lib/player.h"
37 #include "lib/video_content.h"
38 #include "lib/ffmpeg_content.h"
39 #include "lib/imagemagick_content.h"
40 #include "film_viewer.h"
41 #include "wx_util.h"
42 #include "video_decoder.h"
43
44 using std::string;
45 using std::pair;
46 using std::min;
47 using std::max;
48 using std::cout;
49 using std::list;
50 using boost::shared_ptr;
51 using boost::dynamic_pointer_cast;
52 using boost::weak_ptr;
53 using libdcp::Size;
54
55 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
56         : wxPanel (p)
57         , _panel (new wxPanel (this))
58         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
59         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
60         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
61         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
62         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
63         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
64         , _got_frame (false)
65 {
66 #ifndef __WXOSX__
67         _panel->SetDoubleBuffered (true);
68 #endif
69         
70         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
71         
72         _v_sizer = new wxBoxSizer (wxVERTICAL);
73         SetSizer (_v_sizer);
74
75         _v_sizer->Add (_panel, 1, wxEXPAND);
76
77         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
78
79         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
80         time_sizer->Add (_frame_number, 0, wxEXPAND);
81         time_sizer->Add (_timecode, 0, wxEXPAND);
82
83         h_sizer->Add (_back_button, 0, wxALL, 2);
84         h_sizer->Add (time_sizer, 0, wxEXPAND);
85         h_sizer->Add (_forward_button, 0, wxALL, 2);
86         h_sizer->Add (_play_button, 0, wxEXPAND);
87         h_sizer->Add (_slider, 1, wxEXPAND);
88
89         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
90
91         _frame_number->SetMinSize (wxSize (84, -1));
92         _back_button->SetMinSize (wxSize (32, -1));
93         _forward_button->SetMinSize (wxSize (32, -1));
94
95         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
96         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
97         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
98         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
99         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
100         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
101         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
102         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
103         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
104
105         set_film (f);
106
107         JobManager::instance()->ActiveJobsChanged.connect (
108                 bind (&FilmViewer::active_jobs_changed, this, _1)
109                 );
110 }
111
112 void
113 FilmViewer::set_film (shared_ptr<Film> f)
114 {
115         if (_film == f) {
116                 return;
117         }
118
119         _film = f;
120
121         _frame.reset ();
122
123         if (!_film) {
124                 return;
125         }
126
127         _player = f->player ();
128         _player->disable_audio ();
129         _player->Video.connect (boost::bind (&FilmViewer::process_video, this, _1, _2, _3));
130         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this));
131
132         calculate_sizes ();
133         fetch_current_frame_again ();
134 }
135
136 void
137 FilmViewer::fetch_current_frame_again ()
138 {
139         if (!_player) {
140                 return;
141         }
142
143         Time const t = _film->video_frames_to_time (1);
144
145         /* This 2.5 is, in theory: 1 to get back to the same frame, 1 more
146            because we are about to call fetch_next_frame(), and 0.5 for luck.
147         */
148            
149         _player->seek (_player->video_position() - t * 2.5, true);
150         fetch_next_frame ();
151 }
152
153 void
154 FilmViewer::timer (wxTimerEvent &)
155 {
156         if (!_player) {
157                 return;
158         }
159         
160         fetch_next_frame ();
161
162         if (_film->length()) {
163                 int const new_slider_position = 4096 * _player->video_position() / _film->length();
164                 if (new_slider_position != _slider->GetValue()) {
165                         _slider->SetValue (new_slider_position);
166                 }
167         }
168 }
169
170
171 void
172 FilmViewer::paint_panel (wxPaintEvent &)
173 {
174         wxPaintDC dc (_panel);
175
176         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
177                 dc.Clear ();
178                 return;
179         }
180
181         shared_ptr<Image> packed_frame (new Image (_frame, false));
182
183         wxImage frame (_out_size.width, _out_size.height, packed_frame->data()[0], true);
184         wxBitmap frame_bitmap (frame);
185         dc.DrawBitmap (frame_bitmap, 0, 0);
186
187         if (_out_size.width < _panel_size.width) {
188                 wxPen p (GetBackgroundColour ());
189                 wxBrush b (GetBackgroundColour ());
190                 dc.SetPen (p);
191                 dc.SetBrush (b);
192                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
193         }
194
195         if (_out_size.height < _panel_size.height) {
196                 wxPen p (GetBackgroundColour ());
197                 wxBrush b (GetBackgroundColour ());
198                 dc.SetPen (p);
199                 dc.SetBrush (b);
200                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
201         }               
202 }
203
204
205 void
206 FilmViewer::slider_moved (wxScrollEvent &)
207 {
208         if (_film && _player) {
209                 _player->seek (_slider->GetValue() * _film->length() / 4096, false);
210                 fetch_next_frame ();
211         }
212 }
213
214 void
215 FilmViewer::panel_sized (wxSizeEvent& ev)
216 {
217         _panel_size.width = ev.GetSize().GetWidth();
218         _panel_size.height = ev.GetSize().GetHeight();
219         calculate_sizes ();
220         fetch_current_frame_again ();
221 }
222
223 void
224 FilmViewer::calculate_sizes ()
225 {
226         if (!_film || !_player) {
227                 return;
228         }
229
230         Ratio const * container = _film->container ();
231         
232         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
233         float const film_ratio = container ? container->ratio () : 1.78;
234                         
235         if (panel_ratio < film_ratio) {
236                 /* panel is less widscreen than the film; clamp width */
237                 _out_size.width = _panel_size.width;
238                 _out_size.height = _out_size.width / film_ratio;
239         } else {
240                 /* panel is more widescreen than the film; clamp height */
241                 _out_size.height = _panel_size.height;
242                 _out_size.width = _out_size.height * film_ratio;
243         }
244
245         /* Catch silly values */
246         _out_size.width = max (64, _out_size.width);
247         _out_size.height = max (64, _out_size.height);
248
249         _player->set_video_container_size (_out_size);
250 }
251
252 void
253 FilmViewer::play_clicked (wxCommandEvent &)
254 {
255         check_play_state ();
256 }
257
258 void
259 FilmViewer::check_play_state ()
260 {
261         if (!_film || _film->dcp_video_frame_rate() == 0) {
262                 return;
263         }
264         
265         if (_play_button->GetValue()) {
266                 _timer.Start (1000 / _film->dcp_video_frame_rate());
267         } else {
268                 _timer.Stop ();
269         }
270 }
271
272 void
273 FilmViewer::process_video (shared_ptr<const Image> image, bool, Time t)
274 {
275         _frame = image;
276
277         _got_frame = true;
278
279         double const fps = _film->dcp_video_frame_rate ();
280         /* Count frame number from 1 ... not sure if this is the best idea */
281         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ)) + 1));
282         
283         double w = static_cast<double>(t) / TIME_HZ;
284         int const h = (w / 3600);
285         w -= h * 3600;
286         int const m = (w / 60);
287         w -= m * 60;
288         int const s = floor (w);
289         w -= s;
290         int const f = rint (w * fps);
291         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
292 }
293
294 /** Ask the player to emit its next frame, then update our display */
295 void
296 FilmViewer::fetch_next_frame ()
297 {
298         /* Clear our frame in case we don't get a new one */
299         _frame.reset ();
300
301         if (!_player) {
302                 return;
303         }
304
305         try {
306                 _got_frame = false;
307                 while (!_got_frame && !_player->pass ()) {}
308         } catch (DecodeError& e) {
309                 _play_button->SetValue (false);
310                 check_play_state ();
311                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
312         }
313
314         _panel->Refresh ();
315         _panel->Update ();
316 }
317
318 void
319 FilmViewer::active_jobs_changed (bool a)
320 {
321         if (a) {
322                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
323                 list<shared_ptr<Job> >::iterator i = jobs.begin ();             
324                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
325                         ++i;
326                 }
327                 
328                 if (i == jobs.end() || (*i)->finished()) {
329                         /* no examine content job running, so we're ok to use the viewer */
330                         a = false;
331                 }
332         }
333                         
334         _slider->Enable (!a);
335         _play_button->Enable (!a);
336 }
337
338 void
339 FilmViewer::back_clicked (wxCommandEvent &)
340 {
341         if (!_player) {
342                 return;
343         }
344
345         Time const t = _film->video_frames_to_time (1);
346         
347         _player->seek (_player->video_position() - t * 2.5, true);
348         fetch_next_frame ();
349 }
350
351 void
352 FilmViewer::forward_clicked (wxCommandEvent &)
353 {
354         if (!_player) {
355                 return;
356         }
357
358         fetch_next_frame ();
359 }
360
361 void
362 FilmViewer::player_changed ()
363 {
364         calculate_sizes ();
365         fetch_current_frame_again ();
366 }