A variety of changes to improve (but not entirely fix) behaviour
[dcpomatic.git] / src / wx / film_viewer.cc
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.cc
22  *  @brief A wx widget to view a preview of a Film.
23  */
24
25 #include "film_viewer.h"
26 #include "playhead_to_timecode_dialog.h"
27 #include "playhead_to_frame_dialog.h"
28 #include "wx_util.h"
29 #include "closed_captions_dialog.h"
30 #include "lib/film.h"
31 #include "lib/ratio.h"
32 #include "lib/util.h"
33 #include "lib/job_manager.h"
34 #include "lib/image.h"
35 #include "lib/exceptions.h"
36 #include "lib/examine_content_job.h"
37 #include "lib/filter.h"
38 #include "lib/player.h"
39 #include "lib/player_video.h"
40 #include "lib/video_content.h"
41 #include "lib/video_decoder.h"
42 #include "lib/timer.h"
43 #include "lib/butler.h"
44 #include "lib/log.h"
45 #include "lib/config.h"
46 extern "C" {
47 #include <libavutil/pixfmt.h>
48 }
49 #include <dcp/exceptions.h>
50 #include <wx/tglbtn.h>
51 #include <iostream>
52 #include <iomanip>
53
54 using std::string;
55 using std::pair;
56 using std::min;
57 using std::max;
58 using std::cout;
59 using std::list;
60 using std::bad_alloc;
61 using std::make_pair;
62 using std::exception;
63 using boost::shared_ptr;
64 using boost::dynamic_pointer_cast;
65 using boost::weak_ptr;
66 using boost::optional;
67 using dcp::Size;
68
69 static
70 int
71 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
72 {
73         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
74 }
75
76 FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected)
77         : wxPanel (p)
78         , _panel (new wxPanel (this))
79         , _outline_content (0)
80         , _eye (0)
81         , _jump_to_selected (0)
82         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
83         , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
84         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
85         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
86         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
87         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
88         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
89         , _coalesce_player_changes (false)
90         , _slider_being_moved (false)
91         , _was_running_before_slider (false)
92         , _audio (DCPOMATIC_RTAUDIO_API)
93         , _audio_channels (0)
94         , _audio_block_size (1024)
95         , _playing (false)
96         , _latency_history_count (0)
97         , _dropped (0)
98         , _closed_captions_dialog (new ClosedCaptionsDialog(GetParent()))
99 {
100 #ifndef __WXOSX__
101         _panel->SetDoubleBuffered (true);
102 #endif
103
104         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
105
106         _v_sizer = new wxBoxSizer (wxVERTICAL);
107         SetSizer (_v_sizer);
108
109         _v_sizer->Add (_panel, 1, wxEXPAND);
110
111         wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
112         if (outline_content) {
113                 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
114                 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
115         }
116
117         _eye = new wxChoice (this, wxID_ANY);
118         _eye->Append (_("Left"));
119         _eye->Append (_("Right"));
120         _eye->SetSelection (0);
121         view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
122
123         if (jump_to_selected) {
124                 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
125                 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
126         }
127
128         _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
129
130         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
131
132         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
133         time_sizer->Add (_frame_number, 0, wxEXPAND);
134         time_sizer->Add (_timecode, 0, wxEXPAND);
135
136         h_sizer->Add (_rewind_button, 0, wxALL, 2);
137         h_sizer->Add (_back_button, 0, wxALL, 2);
138         h_sizer->Add (time_sizer, 0, wxEXPAND);
139         h_sizer->Add (_forward_button, 0, wxALL, 2);
140         h_sizer->Add (_play_button, 0, wxEXPAND);
141         h_sizer->Add (_slider, 1, wxEXPAND);
142
143         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
144
145         _frame_number->SetMinSize (wxSize (84, -1));
146         _rewind_button->SetMinSize (wxSize (32, -1));
147         _back_button->SetMinSize (wxSize (32, -1));
148         _forward_button->SetMinSize (wxSize (32, -1));
149
150         _panel->Bind            (wxEVT_PAINT,               boost::bind (&FilmViewer::paint_panel,     this));
151         _panel->Bind            (wxEVT_SIZE,                boost::bind (&FilmViewer::panel_sized,     this, _1));
152         if (_outline_content) {
153                 _outline_content->Bind  (wxEVT_CHECKBOX,    boost::bind (&FilmViewer::refresh_panel,   this));
154         }
155         _eye->Bind              (wxEVT_CHOICE,              boost::bind (&FilmViewer::slow_refresh,    this));
156         _slider->Bind           (wxEVT_SCROLL_THUMBTRACK,   boost::bind (&FilmViewer::slider_moved,    this, false));
157         _slider->Bind           (wxEVT_SCROLL_PAGEUP,       boost::bind (&FilmViewer::slider_moved,    this, true));
158         _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,     boost::bind (&FilmViewer::slider_moved,    this, true));
159         _slider->Bind           (wxEVT_SCROLL_THUMBRELEASE, boost::bind (&FilmViewer::slider_released, this));
160         _play_button->Bind      (wxEVT_TOGGLEBUTTON,        boost::bind (&FilmViewer::play_clicked,    this));
161         _timer.Bind             (wxEVT_TIMER,               boost::bind (&FilmViewer::timer,           this));
162         _rewind_button->Bind    (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::rewind_clicked,  this, _1));
163         _back_button->Bind      (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::back_clicked,    this, _1));
164         _forward_button->Bind   (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::forward_clicked, this, _1));
165         _frame_number->Bind     (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::frame_number_clicked, this));
166         _timecode->Bind         (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::timecode_clicked, this));
167         if (_jump_to_selected) {
168                 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
169                 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
170         }
171
172         set_film (shared_ptr<Film> ());
173
174         JobManager::instance()->ActiveJobsChanged.connect (
175                 bind (&FilmViewer::active_jobs_changed, this, _2)
176                 );
177
178         setup_sensitivity ();
179
180         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
181         config_changed (Config::SOUND_OUTPUT);
182 }
183
184 FilmViewer::~FilmViewer ()
185 {
186         stop ();
187 }
188
189 void
190 FilmViewer::set_film (shared_ptr<Film> film)
191 {
192         if (_film == film) {
193                 return;
194         }
195
196         _film = film;
197
198         _frame.reset ();
199         _closed_captions_dialog->clear ();
200
201         update_position_slider ();
202         update_position_label ();
203
204         if (!_film) {
205                 _player.reset ();
206                 _closed_captions_dialog->set_player (_player);
207                 recreate_butler ();
208                 _frame.reset ();
209                 refresh_panel ();
210                 return;
211         }
212
213         try {
214                 _player.reset (new Player (_film, _film->playlist ()));
215                 _player->set_fast ();
216                 if (_dcp_decode_reduction) {
217                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
218                 }
219         } catch (bad_alloc) {
220                 error_dialog (this, _("There is not enough free memory to do that."));
221                 _film.reset ();
222                 return;
223         }
224
225         _closed_captions_dialog->set_player (_player);
226
227         _player->set_always_burn_open_subtitles ();
228         _player->set_play_referenced ();
229
230         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
231         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1, _2));
232
233         /* Keep about 1 second's worth of history samples */
234         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
235
236         recreate_butler ();
237
238         calculate_sizes ();
239         slow_refresh ();
240
241         setup_sensitivity ();
242 }
243
244 void
245 FilmViewer::recreate_butler ()
246 {
247         bool const was_running = stop ();
248         _butler.reset ();
249
250         if (!_film) {
251                 return;
252         }
253
254         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
255
256         if (_audio_channels != 2 || _film->audio_channels() < 3) {
257                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
258                         map.set (i, i, 1);
259                 }
260         } else {
261                 /* Special case: stereo output, at least 3 channel input.
262                    Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
263                                Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
264                 */
265                 map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
266                 map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
267                 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
268                 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
269                 map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
270                 map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
271                 map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
272                 map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
273         }
274
275         _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
276         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
277                 _butler->disable_audio ();
278         }
279
280         if (was_running) {
281                 start ();
282         }
283 }
284
285 void
286 FilmViewer::refresh_panel ()
287 {
288         _panel->Refresh ();
289         _panel->Update ();
290 }
291
292 void
293 FilmViewer::get ()
294 {
295         DCPOMATIC_ASSERT (_butler);
296
297         do {
298                 _player_video = _butler->get_video ();
299         } while (
300                 _film->three_d() &&
301                 ((_eye->GetSelection() == 0 && _player_video.first->eyes() == EYES_RIGHT) || (_eye->GetSelection() == 1 && _player_video.first->eyes() == EYES_LEFT))
302                 );
303
304         _butler->rethrow ();
305
306         display_player_video ();
307 }
308
309 void
310 FilmViewer::display_player_video ()
311 {
312         if (!_player_video.first) {
313                 _frame.reset ();
314                 refresh_panel ();
315                 return;
316         }
317
318         if (_playing && (time() - _player_video.second) > one_video_frame()) {
319                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
320                    part if this frame is J2K).
321                 */
322                 _video_position = _player_video.second;
323                 ++_dropped;
324                 return;
325         }
326
327         /* In an ideal world, what we would do here is:
328          *
329          * 1. convert to XYZ exactly as we do in the DCP creation path.
330          * 2. convert back to RGB for the preview display, compensating
331          *    for the monitor etc. etc.
332          *
333          * but this is inefficient if the source is RGB.  Since we don't
334          * (currently) care too much about the precise accuracy of the preview's
335          * colour mapping (and we care more about its speed) we try to short-
336          * circuit this "ideal" situation in some cases.
337          *
338          * The content's specified colour conversion indicates the colourspace
339          * which the content is in (according to the user).
340          *
341          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
342          * image and convert it (from whatever the user has said it is) to RGB.
343          */
344
345         _frame = _player_video.first->image (
346                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
347                 bind (&PlayerVideo::always_rgb, _1),
348                 false, true
349                 );
350
351         ImageChanged (_player_video.first);
352
353         _video_position = _player_video.second;
354         _inter_position = _player_video.first->inter_position ();
355         _inter_size = _player_video.first->inter_size ();
356
357         refresh_panel ();
358
359         _closed_captions_dialog->update (time());
360 }
361
362 void
363 FilmViewer::timer ()
364 {
365         if (!_film || !_playing) {
366                 return;
367         }
368
369         get ();
370         update_position_label ();
371         update_position_slider ();
372         DCPTime const next = _video_position + one_video_frame();
373
374         if (next >= _film->length()) {
375                 stop ();
376         }
377
378         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
379
380         if (_butler) {
381                 _butler->rethrow ();
382         }
383 }
384
385 void
386 FilmViewer::paint_panel ()
387 {
388         wxPaintDC dc (_panel);
389
390         if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
391                 dc.Clear ();
392                 return;
393         }
394
395         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
396         wxBitmap frame_bitmap (frame);
397         dc.DrawBitmap (frame_bitmap, 0, 0);
398
399         if (_out_size.width < _panel_size.width) {
400                 wxPen p (GetBackgroundColour ());
401                 wxBrush b (GetBackgroundColour ());
402                 dc.SetPen (p);
403                 dc.SetBrush (b);
404                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
405         }
406
407         if (_out_size.height < _panel_size.height) {
408                 wxPen p (GetBackgroundColour ());
409                 wxBrush b (GetBackgroundColour ());
410                 dc.SetPen (p);
411                 dc.SetBrush (b);
412                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
413         }
414
415         if (_outline_content && _outline_content->GetValue ()) {
416                 wxPen p (wxColour (255, 0, 0), 2);
417                 dc.SetPen (p);
418                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
419                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
420         }
421 }
422
423 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
424 void
425 FilmViewer::slider_moved (bool page)
426 {
427         if (!_film) {
428                 return;
429         }
430
431         if (!page && !_slider_being_moved) {
432                 /* This is the first event of a drag; stop playback for the duration of the drag */
433                 _was_running_before_slider = stop ();
434                 _slider_being_moved = true;
435         }
436
437         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
438         t = t.round (_film->video_frame_rate());
439         /* Ensure that we hit the end of the film at the end of the slider */
440         if (t >= _film->length ()) {
441                 t = _film->length() - one_video_frame();
442         }
443         seek (t, false);
444         update_position_label ();
445 }
446
447 void
448 FilmViewer::slider_released ()
449 {
450         if (_was_running_before_slider) {
451                 /* Restart after a drag */
452                 start ();
453         }
454         _slider_being_moved = false;
455 }
456
457 void
458 FilmViewer::panel_sized (wxSizeEvent& ev)
459 {
460         _panel_size.width = ev.GetSize().GetWidth();
461         _panel_size.height = ev.GetSize().GetHeight();
462
463         calculate_sizes ();
464         if (!quick_refresh()) {
465                 slow_refresh ();
466         }
467         update_position_label ();
468         update_position_slider ();
469 }
470
471 void
472 FilmViewer::calculate_sizes ()
473 {
474         if (!_film || !_player) {
475                 return;
476         }
477
478         Ratio const * container = _film->container ();
479
480         float const panel_ratio = _panel_size.ratio ();
481         float const film_ratio = container ? container->ratio () : 1.78;
482
483         if (panel_ratio < film_ratio) {
484                 /* panel is less widscreen than the film; clamp width */
485                 _out_size.width = _panel_size.width;
486                 _out_size.height = lrintf (_out_size.width / film_ratio);
487         } else {
488                 /* panel is more widescreen than the film; clamp height */
489                 _out_size.height = _panel_size.height;
490                 _out_size.width = lrintf (_out_size.height * film_ratio);
491         }
492
493         /* Catch silly values */
494         _out_size.width = max (64, _out_size.width);
495         _out_size.height = max (64, _out_size.height);
496
497         _player->set_video_container_size (_out_size);
498 }
499
500 void
501 FilmViewer::play_clicked ()
502 {
503         check_play_state ();
504 }
505
506 void
507 FilmViewer::check_play_state ()
508 {
509         if (!_film || _film->video_frame_rate() == 0) {
510                 return;
511         }
512
513         if (_play_button->GetValue()) {
514                 start ();
515         } else {
516                 stop ();
517         }
518 }
519
520 void
521 FilmViewer::start ()
522 {
523         if (!_film) {
524                 return;
525         }
526
527         if (_audio.isStreamOpen()) {
528                 _audio.setStreamTime (_video_position.seconds());
529                 _audio.startStream ();
530         }
531
532         _playing = true;
533         _dropped = 0;
534         timer ();
535         _play_button->SetValue (true);
536 }
537
538 bool
539 FilmViewer::stop ()
540 {
541         if (_audio.isStreamRunning()) {
542                 /* stop stream and discard any remaining queued samples */
543                 _audio.abortStream ();
544         }
545
546         if (!_playing) {
547                 return false;
548         }
549
550         _playing = false;
551         _play_button->SetValue (false);
552         return true;
553 }
554
555 void
556 FilmViewer::update_position_slider ()
557 {
558         if (!_film) {
559                 _slider->SetValue (0);
560                 return;
561         }
562
563         DCPTime const len = _film->length ();
564
565         if (len.get ()) {
566                 int const new_slider_position = 4096 * _video_position.get() / len.get();
567                 if (new_slider_position != _slider->GetValue()) {
568                         _slider->SetValue (new_slider_position);
569                 }
570         }
571 }
572
573 void
574 FilmViewer::update_position_label ()
575 {
576         if (!_film) {
577                 _frame_number->SetLabel ("0");
578                 _timecode->SetLabel ("0:0:0.0");
579                 return;
580         }
581
582         double const fps = _film->video_frame_rate ();
583         /* Count frame number from 1 ... not sure if this is the best idea */
584         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
585         _timecode->SetLabel (time_to_timecode (_video_position, fps));
586 }
587
588 void
589 FilmViewer::active_jobs_changed (optional<string> j)
590 {
591         /* examine content is the only job which stops the viewer working */
592         bool const a = !j || *j != "examine_content";
593         _slider->Enable (a);
594         _play_button->Enable (a);
595 }
596
597 DCPTime
598 FilmViewer::nudge_amount (wxKeyboardState& ev)
599 {
600         DCPTime amount = one_video_frame ();
601
602         if (ev.ShiftDown() && !ev.ControlDown()) {
603                 amount = DCPTime::from_seconds (1);
604         } else if (!ev.ShiftDown() && ev.ControlDown()) {
605                 amount = DCPTime::from_seconds (10);
606         } else if (ev.ShiftDown() && ev.ControlDown()) {
607                 amount = DCPTime::from_seconds (60);
608         }
609
610         return amount;
611 }
612
613 void
614 FilmViewer::go_to (DCPTime t)
615 {
616         if (t < DCPTime ()) {
617                 t = DCPTime ();
618         }
619
620         if (t >= _film->length ()) {
621                 t = _film->length ();
622         }
623
624         seek (t, true);
625         update_position_label ();
626         update_position_slider ();
627 }
628
629 void
630 FilmViewer::rewind_clicked (wxMouseEvent& ev)
631 {
632         go_to(DCPTime());
633         ev.Skip();
634 }
635
636 void
637 FilmViewer::back_frame ()
638 {
639         if (!_film) {
640                 return;
641         }
642
643         go_to (_video_position - one_video_frame());
644 }
645
646 void
647 FilmViewer::forward_frame ()
648 {
649         if (!_film) {
650                 return;
651         }
652
653         go_to (_video_position + one_video_frame());
654 }
655
656 void
657 FilmViewer::back_clicked (wxKeyboardState& ev)
658 {
659         go_to (_video_position - nudge_amount (ev));
660 }
661
662 void
663 FilmViewer::forward_clicked (wxKeyboardState& ev)
664 {
665         go_to (_video_position + nudge_amount (ev));
666 }
667
668 void
669 FilmViewer::player_changed (int property, bool frequent)
670 {
671         if (frequent) {
672                 return;
673         }
674
675         if (_coalesce_player_changes) {
676                 _pending_player_changes.push_back (property);
677                 return;
678         }
679
680         calculate_sizes ();
681         bool refreshed = false;
682         if (
683                 property == VideoContentProperty::CROP ||
684                 property == VideoContentProperty::SCALE ||
685                 property == VideoContentProperty::FADE_IN ||
686                 property == VideoContentProperty::FADE_OUT ||
687                 property == VideoContentProperty::COLOUR_CONVERSION ||
688                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
689                 property == PlayerProperty::FILM_CONTAINER
690                 ) {
691                 refreshed = quick_refresh ();
692         }
693
694         if (!refreshed) {
695                 slow_refresh ();
696         }
697         update_position_label ();
698         update_position_slider ();
699 }
700
701 void
702 FilmViewer::setup_sensitivity ()
703 {
704         bool const c = _film && !_film->content().empty ();
705
706         _slider->Enable (c);
707         _rewind_button->Enable (c);
708         _back_button->Enable (c);
709         _forward_button->Enable (c);
710         _play_button->Enable (c);
711         if (_outline_content) {
712                 _outline_content->Enable (c);
713         }
714         _frame_number->Enable (c);
715         _timecode->Enable (c);
716         if (_jump_to_selected) {
717                 _jump_to_selected->Enable (c);
718         }
719
720         _eye->Enable (c && _film->three_d ());
721 }
722
723 void
724 FilmViewer::film_changed (Film::Property p)
725 {
726         if (p == Film::CONTENT || p == Film::THREE_D) {
727                 setup_sensitivity ();
728         } else if (p == Film::AUDIO_CHANNELS) {
729                 recreate_butler ();
730         }
731 }
732
733 /** Re-get the current frame slowly by seeking */
734 void
735 FilmViewer::slow_refresh ()
736 {
737         seek (_video_position, true);
738 }
739
740 /** Try to re-get the current frame quickly by resetting the metadata
741  *  in the PlayerVideo that we used last time.
742  *  @return true if this was possible, false if not.
743  */
744 bool
745 FilmViewer::quick_refresh ()
746 {
747         if (!_player_video.first) {
748                 return false;
749         }
750
751         if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
752                 return false;
753         }
754
755         display_player_video ();
756         return true;
757 }
758
759 void
760 FilmViewer::set_position (DCPTime p)
761 {
762         _video_position = p;
763         seek (p, true);
764         update_position_label ();
765         update_position_slider ();
766 }
767
768 void
769 FilmViewer::set_position (shared_ptr<Content> content, ContentTime t)
770 {
771         set_position (_player->content_time_to_dcp (content, t));
772 }
773
774 void
775 FilmViewer::set_coalesce_player_changes (bool c)
776 {
777         _coalesce_player_changes = c;
778
779         if (!c) {
780                 BOOST_FOREACH (int i, _pending_player_changes) {
781                         player_changed (i, false);
782                 }
783                 _pending_player_changes.clear ();
784         }
785 }
786
787 void
788 FilmViewer::timecode_clicked ()
789 {
790         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
791         if (dialog->ShowModal() == wxID_OK) {
792                 go_to (dialog->get ());
793         }
794         dialog->Destroy ();
795 }
796
797 void
798 FilmViewer::frame_number_clicked ()
799 {
800         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
801         if (dialog->ShowModal() == wxID_OK) {
802                 go_to (dialog->get ());
803         }
804         dialog->Destroy ();
805 }
806
807 void
808 FilmViewer::jump_to_selected_clicked ()
809 {
810         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
811 }
812
813 void
814 FilmViewer::seek (DCPTime t, bool accurate)
815 {
816         if (!_butler) {
817                 return;
818         }
819
820         bool const was_running = stop ();
821
822         _closed_captions_dialog->clear ();
823         _butler->seek (t, accurate);
824         get ();
825
826         if (was_running) {
827                 start ();
828         }
829 }
830
831 void
832 FilmViewer::config_changed (Config::Property p)
833 {
834         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
835                 return;
836         }
837
838         if (_audio.isStreamOpen ()) {
839                 _audio.closeStream ();
840         }
841
842         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
843                 unsigned int st = 0;
844                 if (Config::instance()->sound_output()) {
845                         while (st < _audio.getDeviceCount()) {
846                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
847                                         break;
848                                 }
849                                 ++st;
850                         }
851                         if (st == _audio.getDeviceCount()) {
852                                 st = _audio.getDefaultOutputDevice();
853                         }
854                 } else {
855                         st = _audio.getDefaultOutputDevice();
856                 }
857
858                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
859
860                 RtAudio::StreamParameters sp;
861                 sp.deviceId = st;
862                 sp.nChannels = _audio_channels;
863                 sp.firstChannel = 0;
864                 try {
865                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
866 #ifdef DCPOMATIC_USE_RTERROR
867                 } catch (RtError& e) {
868 #else
869                 } catch (RtAudioError& e) {
870 #endif
871                         error_dialog (
872                                 this,
873                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
874                                 );
875                 }
876                 recreate_butler ();
877
878         } else {
879                 _audio_channels = 0;
880                 recreate_butler ();
881         }
882 }
883
884 DCPTime
885 FilmViewer::time () const
886 {
887         if (_audio.isStreamRunning ()) {
888                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
889                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
890         }
891
892         return _video_position;
893 }
894
895 int
896 FilmViewer::audio_callback (void* out_p, unsigned int frames)
897 {
898         _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
899
900         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
901         if (lm) {
902                 _latency_history.push_back (_audio.getStreamLatency ());
903                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
904                         _latency_history.pop_front ();
905                 }
906         }
907
908         return 0;
909 }
910
911 Frame
912 FilmViewer::average_latency () const
913 {
914         boost::mutex::scoped_lock lm (_latency_history_mutex);
915         if (_latency_history.empty()) {
916                 return 0;
917         }
918
919         Frame total = 0;
920         BOOST_FOREACH (Frame i, _latency_history) {
921                 total += i;
922         }
923
924         return total / _latency_history.size();
925 }
926
927 void
928 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
929 {
930         _dcp_decode_reduction = reduction;
931         if (_player) {
932                 _player->set_dcp_decode_reduction (reduction);
933         }
934 }
935
936 optional<int>
937 FilmViewer::dcp_decode_reduction () const
938 {
939         return _dcp_decode_reduction;
940 }
941
942 DCPTime
943 FilmViewer::one_video_frame () const
944 {
945         return DCPTime::from_frames (1, _film->video_frame_rate());
946 }
947
948 void
949 FilmViewer::show_closed_captions ()
950 {
951         _closed_captions_dialog->Show();
952 }