Fix display when all content is removed. Fix sensitivity of jump-to-selected checkbox.
[dcpomatic.git] / src / wx / film_viewer.cc
1 /*
2     Copyright (C) 2012-2016 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 "lib/film.h"
30 #include "lib/ratio.h"
31 #include "lib/util.h"
32 #include "lib/job_manager.h"
33 #include "lib/image.h"
34 #include "lib/exceptions.h"
35 #include "lib/examine_content_job.h"
36 #include "lib/filter.h"
37 #include "lib/player.h"
38 #include "lib/player_video.h"
39 #include "lib/video_content.h"
40 #include "lib/video_decoder.h"
41 #include "lib/timer.h"
42 #include "lib/butler.h"
43 #include "lib/log.h"
44 #include "lib/config.h"
45 extern "C" {
46 #include <libavutil/pixfmt.h>
47 }
48 #include <dcp/exceptions.h>
49 #include <wx/tglbtn.h>
50 #include <iostream>
51 #include <iomanip>
52
53 using std::string;
54 using std::pair;
55 using std::min;
56 using std::max;
57 using std::cout;
58 using std::list;
59 using std::bad_alloc;
60 using std::make_pair;
61 using std::exception;
62 using boost::shared_ptr;
63 using boost::dynamic_pointer_cast;
64 using boost::weak_ptr;
65 using boost::optional;
66 using dcp::Size;
67
68 static
69 int
70 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
71 {
72         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
73 }
74
75 FilmViewer::FilmViewer (wxWindow* p)
76         : wxPanel (p)
77         , _panel (new wxPanel (this))
78         , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
79         , _left_eye (new wxRadioButton (this, wxID_ANY, _("Left eye"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP))
80         , _right_eye (new wxRadioButton (this, wxID_ANY, _("Right eye")))
81         , _jump_to_selected (new wxCheckBox (this, wxID_ANY, _("Jump to selected content")))
82         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
83         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
84         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
85         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
86         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
87         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
88         , _coalesce_player_changes (false)
89         , _pending_player_change (false)
90         , _last_seek_accurate (true)
91         , _audio (DCPOMATIC_RTAUDIO_API)
92         , _audio_channels (0)
93         , _audio_block_size (1024)
94         , _playing (false)
95 {
96 #ifndef __WXOSX__
97         _panel->SetDoubleBuffered (true);
98 #endif
99
100         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
101
102         _v_sizer = new wxBoxSizer (wxVERTICAL);
103         SetSizer (_v_sizer);
104
105         _v_sizer->Add (_panel, 1, wxEXPAND);
106
107         wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
108         view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
109         view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
110         view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
111         view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
112         _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
113
114         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
115
116         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
117         time_sizer->Add (_frame_number, 0, wxEXPAND);
118         time_sizer->Add (_timecode, 0, wxEXPAND);
119
120         h_sizer->Add (_back_button, 0, wxALL, 2);
121         h_sizer->Add (time_sizer, 0, wxEXPAND);
122         h_sizer->Add (_forward_button, 0, wxALL, 2);
123         h_sizer->Add (_play_button, 0, wxEXPAND);
124         h_sizer->Add (_slider, 1, wxEXPAND);
125
126         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
127
128         _frame_number->SetMinSize (wxSize (84, -1));
129         _back_button->SetMinSize (wxSize (32, -1));
130         _forward_button->SetMinSize (wxSize (32, -1));
131
132         _panel->Bind            (wxEVT_PAINT,             boost::bind (&FilmViewer::paint_panel,     this));
133         _panel->Bind            (wxEVT_SIZE,              boost::bind (&FilmViewer::panel_sized,     this, _1));
134         _outline_content->Bind  (wxEVT_CHECKBOX,          boost::bind (&FilmViewer::refresh_panel,   this));
135         _left_eye->Bind         (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
136         _right_eye->Bind        (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
137         _slider->Bind           (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved,    this));
138         _slider->Bind           (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this));
139         _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this));
140         _play_button->Bind      (wxEVT_TOGGLEBUTTON,      boost::bind (&FilmViewer::play_clicked,    this));
141         _timer.Bind             (wxEVT_TIMER,             boost::bind (&FilmViewer::timer,           this));
142         _back_button->Bind      (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::back_clicked,    this, _1));
143         _forward_button->Bind   (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::forward_clicked, this, _1));
144         _frame_number->Bind     (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::frame_number_clicked, this));
145         _timecode->Bind         (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::timecode_clicked, this));
146         _jump_to_selected->Bind (wxEVT_CHECKBOX,          boost::bind (&FilmViewer::jump_to_selected_clicked, this));
147
148         _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
149
150         set_film (shared_ptr<Film> ());
151
152         JobManager::instance()->ActiveJobsChanged.connect (
153                 bind (&FilmViewer::active_jobs_changed, this, _2)
154                 );
155
156         setup_sensitivity ();
157
158         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
159         config_changed (Config::SOUND_OUTPUT);
160 }
161
162 FilmViewer::~FilmViewer ()
163 {
164         stop ();
165 }
166
167 void
168 FilmViewer::set_film (shared_ptr<Film> film)
169 {
170         if (_film == film) {
171                 return;
172         }
173
174         _film = film;
175
176         _frame.reset ();
177
178         update_position_slider ();
179         update_position_label ();
180
181         if (!_film) {
182                 return;
183         }
184
185         try {
186                 _player.reset (new Player (_film, _film->playlist ()));
187                 _player->set_fast ();
188         } catch (bad_alloc) {
189                 error_dialog (this, _("There is not enough free memory to do that."));
190                 _film.reset ();
191                 return;
192         }
193
194         /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
195            in the preview.
196         */
197         _player->set_always_burn_subtitles (true);
198         _player->set_play_referenced ();
199
200         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
201         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
202
203         recreate_butler ();
204
205         calculate_sizes ();
206         refresh ();
207
208         setup_sensitivity ();
209 }
210
211 void
212 FilmViewer::recreate_butler ()
213 {
214         bool const was_running = stop ();
215         _butler.reset ();
216
217         if (!_film) {
218                 return;
219         }
220
221         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
222
223         if (_audio_channels != 2 || _film->audio_channels() < 3) {
224                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
225                         map.set (i, i, 1);
226                 }
227         } else {
228                 /* Special case: stereo output, at least 3 channel input, map L+R to L/R and
229                    C to both, all 3dB down.
230                 */
231                 map.set (0, 0, 1 / sqrt(2)); // L -> L
232                 map.set (1, 1, 1 / sqrt(2)); // R -> R
233                 map.set (2, 0, 1 / sqrt(2)); // C -> L
234                 map.set (2, 1, 1 / sqrt(2)); // C -> R
235         }
236
237         _butler.reset (new Butler (_film, _player, map, _audio_channels));
238
239         if (was_running) {
240                 start ();
241         }
242 }
243
244 void
245 FilmViewer::refresh_panel ()
246 {
247         _panel->Refresh ();
248         _panel->Update ();
249 }
250
251 void
252 FilmViewer::get ()
253 {
254         pair<shared_ptr<PlayerVideo>, DCPTime> video;
255         do {
256                 video = _butler->get_video ();
257         } while (
258                 _film->three_d() &&
259                 ((_left_eye->GetValue() && video.first->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && video.first->eyes() == EYES_LEFT))
260                 );
261
262         if (!video.first) {
263                 _frame.reset ();
264                 refresh_panel ();
265                 return;
266         }
267
268         /* In an ideal world, what we would do here is:
269          *
270          * 1. convert to XYZ exactly as we do in the DCP creation path.
271          * 2. convert back to RGB for the preview display, compensating
272          *    for the monitor etc. etc.
273          *
274          * but this is inefficient if the source is RGB.  Since we don't
275          * (currently) care too much about the precise accuracy of the preview's
276          * colour mapping (and we care more about its speed) we try to short-
277          * circuit this "ideal" situation in some cases.
278          *
279          * The content's specified colour conversion indicates the colourspace
280          * which the content is in (according to the user).
281          *
282          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
283          * image and convert it (from whatever the user has said it is) to RGB.
284          */
285
286         _frame = video.first->image (
287                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
288                 bind (&PlayerVideo::always_rgb, _1),
289                 false, true
290                 );
291
292         ImageChanged (video.first);
293
294         _video_position = video.second;
295         _inter_position = video.first->inter_position ();
296         _inter_size = video.first->inter_size ();
297
298         refresh_panel ();
299 }
300
301 void
302 FilmViewer::timer ()
303 {
304         if (!_film) {
305                 return;
306         }
307
308         if (_audio.isStreamRunning ()) {
309                 DCPTime const now = time().ceil (_film->video_frame_rate ());
310                 get ();
311                 update_position_label ();
312                 update_position_slider ();
313                 DCPTime const next = now + DCPTime::from_frames (1, _film->video_frame_rate ());
314                 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 0.0), wxTIMER_ONE_SHOT);
315         }
316
317         if (_butler) {
318                 _butler->rethrow ();
319         }
320 }
321
322 void
323 FilmViewer::paint_panel ()
324 {
325         wxPaintDC dc (_panel);
326
327         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
328                 dc.Clear ();
329                 return;
330         }
331
332         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
333         wxBitmap frame_bitmap (frame);
334         dc.DrawBitmap (frame_bitmap, 0, 0);
335
336         if (_out_size.width < _panel_size.width) {
337                 wxPen p (GetBackgroundColour ());
338                 wxBrush b (GetBackgroundColour ());
339                 dc.SetPen (p);
340                 dc.SetBrush (b);
341                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
342         }
343
344         if (_out_size.height < _panel_size.height) {
345                 wxPen p (GetBackgroundColour ());
346                 wxBrush b (GetBackgroundColour ());
347                 dc.SetPen (p);
348                 dc.SetBrush (b);
349                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
350         }
351
352         if (_outline_content->GetValue ()) {
353                 wxPen p (wxColour (255, 0, 0), 2);
354                 dc.SetPen (p);
355                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
356                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
357         }
358 }
359
360 void
361 FilmViewer::slider_moved ()
362 {
363         if (!_film) {
364                 return;
365         }
366
367         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
368         /* Ensure that we hit the end of the film at the end of the slider */
369         if (t >= _film->length ()) {
370                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
371         }
372         seek (t, false);
373         update_position_label ();
374 }
375
376 void
377 FilmViewer::panel_sized (wxSizeEvent& ev)
378 {
379         _panel_size.width = ev.GetSize().GetWidth();
380         _panel_size.height = ev.GetSize().GetHeight();
381
382         calculate_sizes ();
383         refresh ();
384         update_position_label ();
385         update_position_slider ();
386 }
387
388 void
389 FilmViewer::calculate_sizes ()
390 {
391         if (!_film) {
392                 return;
393         }
394
395         Ratio const * container = _film->container ();
396
397         float const panel_ratio = _panel_size.ratio ();
398         float const film_ratio = container ? container->ratio () : 1.78;
399
400         if (panel_ratio < film_ratio) {
401                 /* panel is less widscreen than the film; clamp width */
402                 _out_size.width = _panel_size.width;
403                 _out_size.height = lrintf (_out_size.width / film_ratio);
404         } else {
405                 /* panel is more widescreen than the film; clamp height */
406                 _out_size.height = _panel_size.height;
407                 _out_size.width = lrintf (_out_size.height * film_ratio);
408         }
409
410         /* Catch silly values */
411         _out_size.width = max (64, _out_size.width);
412         _out_size.height = max (64, _out_size.height);
413
414         _player->set_video_container_size (_out_size);
415 }
416
417 void
418 FilmViewer::play_clicked ()
419 {
420         check_play_state ();
421 }
422
423 void
424 FilmViewer::check_play_state ()
425 {
426         if (!_film || _film->video_frame_rate() == 0) {
427                 return;
428         }
429
430         if (_play_button->GetValue()) {
431                 start ();
432         } else {
433                 stop ();
434         }
435 }
436
437 void
438 FilmViewer::start ()
439 {
440         if (_audio.isStreamOpen()) {
441                 _audio.setStreamTime (_video_position.seconds());
442                 _audio.startStream ();
443         }
444
445         _playing = true;
446         _timer.Start (0, wxTIMER_ONE_SHOT);
447 }
448
449 bool
450 FilmViewer::stop ()
451 {
452         if (_audio.isStreamRunning()) {
453                 /* stop stream and discard any remainig queued samples */
454                 _audio.abortStream ();
455         }
456
457         if (!_playing) {
458                 return false;
459         }
460
461         _playing = false;
462         return true;
463 }
464
465 void
466 FilmViewer::update_position_slider ()
467 {
468         if (!_film) {
469                 _slider->SetValue (0);
470                 return;
471         }
472
473         DCPTime const len = _film->length ();
474
475         if (len.get ()) {
476                 int const new_slider_position = 4096 * _video_position.get() / len.get();
477                 if (new_slider_position != _slider->GetValue()) {
478                         _slider->SetValue (new_slider_position);
479                 }
480         }
481 }
482
483 void
484 FilmViewer::update_position_label ()
485 {
486         if (!_film) {
487                 _frame_number->SetLabel ("0");
488                 _timecode->SetLabel ("0:0:0.0");
489                 return;
490         }
491
492         double const fps = _film->video_frame_rate ();
493         /* Count frame number from 1 ... not sure if this is the best idea */
494         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
495         _timecode->SetLabel (time_to_timecode (_video_position, fps));
496 }
497
498 void
499 FilmViewer::active_jobs_changed (optional<string> j)
500 {
501         /* examine content is the only job which stops the viewer working */
502         bool const a = !j || *j != "examine_content";
503         _slider->Enable (a);
504         _play_button->Enable (a);
505 }
506
507 DCPTime
508 FilmViewer::nudge_amount (wxMouseEvent& ev)
509 {
510         DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
511
512         if (ev.ShiftDown() && !ev.ControlDown()) {
513                 amount = DCPTime::from_seconds (1);
514         } else if (!ev.ShiftDown() && ev.ControlDown()) {
515                 amount = DCPTime::from_seconds (10);
516         } else if (ev.ShiftDown() && ev.ControlDown()) {
517                 amount = DCPTime::from_seconds (60);
518         }
519
520         return amount;
521 }
522
523 void
524 FilmViewer::go_to (DCPTime t)
525 {
526         if (t < DCPTime ()) {
527                 t = DCPTime ();
528         }
529
530         if (t >= _film->length ()) {
531                 t = _film->length ();
532         }
533
534         seek (t, true);
535         update_position_label ();
536         update_position_slider ();
537 }
538
539 void
540 FilmViewer::back_clicked (wxMouseEvent& ev)
541 {
542         go_to (_video_position - nudge_amount (ev));
543         ev.Skip ();
544 }
545
546 void
547 FilmViewer::forward_clicked (wxMouseEvent& ev)
548 {
549         go_to (_video_position + nudge_amount (ev));
550         ev.Skip ();
551 }
552
553 void
554 FilmViewer::player_changed (bool frequent)
555 {
556         if (frequent) {
557                 return;
558         }
559
560         if (_coalesce_player_changes) {
561                 _pending_player_change = true;
562                 return;
563         }
564
565         calculate_sizes ();
566         refresh ();
567         update_position_label ();
568         update_position_slider ();
569 }
570
571 void
572 FilmViewer::setup_sensitivity ()
573 {
574         bool const c = _film && !_film->content().empty ();
575
576         _slider->Enable (c);
577         _back_button->Enable (c);
578         _forward_button->Enable (c);
579         _play_button->Enable (c);
580         _outline_content->Enable (c);
581         _frame_number->Enable (c);
582         _timecode->Enable (c);
583         _jump_to_selected->Enable (c);
584
585         _left_eye->Enable (c && _film->three_d ());
586         _right_eye->Enable (c && _film->three_d ());
587 }
588
589 void
590 FilmViewer::film_changed (Film::Property p)
591 {
592         if (p == Film::CONTENT || p == Film::THREE_D) {
593                 setup_sensitivity ();
594         }
595 }
596
597 /** Re-get the current frame */
598 void
599 FilmViewer::refresh ()
600 {
601         seek (_video_position, _last_seek_accurate);
602 }
603
604 void
605 FilmViewer::set_position (DCPTime p)
606 {
607         _video_position = p;
608         seek (p, true);
609         update_position_label ();
610         update_position_slider ();
611 }
612
613 void
614 FilmViewer::set_coalesce_player_changes (bool c)
615 {
616         _coalesce_player_changes = c;
617
618         if (c) {
619                 _pending_player_change = false;
620         } else {
621                 if (_pending_player_change) {
622                         player_changed (false);
623                 }
624         }
625 }
626
627 void
628 FilmViewer::timecode_clicked ()
629 {
630         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
631         if (dialog->ShowModal() == wxID_OK) {
632                 go_to (dialog->get ());
633         }
634         dialog->Destroy ();
635 }
636
637 void
638 FilmViewer::frame_number_clicked ()
639 {
640         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
641         if (dialog->ShowModal() == wxID_OK) {
642                 go_to (dialog->get ());
643         }
644         dialog->Destroy ();
645 }
646
647 void
648 FilmViewer::jump_to_selected_clicked ()
649 {
650         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
651 }
652
653 void
654 FilmViewer::seek (DCPTime t, bool accurate)
655 {
656         if (!_butler) {
657                 return;
658         }
659
660         _butler->seek (t, accurate);
661         _last_seek_accurate = accurate;
662         get ();
663 }
664
665 void
666 FilmViewer::config_changed (Config::Property p)
667 {
668         if (p != Config::SOUND_OUTPUT) {
669                 return;
670         }
671
672         if (_audio.isStreamOpen ()) {
673                 _audio.closeStream ();
674         }
675
676         unsigned int st = 0;
677         if (Config::instance()->sound_output()) {
678                 while (st < _audio.getDeviceCount()) {
679                         if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
680                                 break;
681                         }
682                         ++st;
683                 }
684                 if (st == _audio.getDeviceCount()) {
685                         st = _audio.getDefaultOutputDevice();
686                 }
687         } else {
688                 st = _audio.getDefaultOutputDevice();
689         }
690
691         _audio_channels = _audio.getDeviceInfo(st).outputChannels;
692         recreate_butler ();
693
694         RtAudio::StreamParameters sp;
695         sp.deviceId = st;
696         sp.nChannels = _audio_channels;
697         sp.firstChannel = 0;
698         try {
699                 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
700 #ifdef DCPOMATIC_USE_RTERROR
701         } catch (RtError& e) {
702 #else
703         } catch (RtAudioError& e) {
704 #endif
705                 error_dialog (this, wxString::Format (_("Could not set up audio output (%s).  There will be no audio during the preview."), e.what()));
706         }
707 }
708
709 DCPTime
710 FilmViewer::time () const
711 {
712         if (_audio.isStreamRunning ()) {
713                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ());
714         }
715
716         return _video_position;
717 }
718
719 int
720 FilmViewer::audio_callback (void* out_p, unsigned int frames)
721 {
722         _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
723         return 0;
724 }