Add some code to help with profiling the player.
[dcpomatic.git] / src / wx / film_viewer.cc
1 /*
2     Copyright (C) 2012-2018 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 #include "lib/compose.hpp"
47 extern "C" {
48 #include <libavutil/pixfmt.h>
49 }
50 #include <dcp/exceptions.h>
51 #include <wx/tglbtn.h>
52 #include <iostream>
53 #include <iomanip>
54
55 using std::string;
56 using std::pair;
57 using std::min;
58 using std::max;
59 using std::cout;
60 using std::list;
61 using std::bad_alloc;
62 using std::make_pair;
63 using std::exception;
64 using boost::shared_ptr;
65 using boost::dynamic_pointer_cast;
66 using boost::weak_ptr;
67 using boost::optional;
68 using dcp::Size;
69
70 static
71 int
72 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
73 {
74         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
75 }
76
77 FilmViewer::FilmViewer (wxWindow* p)
78         : _panel (new wxPanel (p))
79         , _coalesce_player_changes (false)
80         , _audio (DCPOMATIC_RTAUDIO_API)
81         , _audio_channels (0)
82         , _audio_block_size (1024)
83         , _playing (false)
84         , _latency_history_count (0)
85         , _dropped (0)
86         , _closed_captions_dialog (new ClosedCaptionsDialog(p))
87         , _outline_content (false)
88         , _eyes (EYES_LEFT)
89 #ifdef DCPOMATIC_VARIANT_SWAROOP
90         , _in_watermark (false)
91 #endif
92 {
93 #ifndef __WXOSX__
94         _panel->SetDoubleBuffered (true);
95 #endif
96
97         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
98         _panel->SetBackgroundColour (*wxBLACK);
99
100         _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
101         _panel->Bind (wxEVT_SIZE,  boost::bind (&FilmViewer::panel_sized, this, _1));
102         _timer.Bind  (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
103
104         set_film (shared_ptr<Film> ());
105
106         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
107         config_changed (Config::SOUND_OUTPUT);
108 }
109
110 FilmViewer::~FilmViewer ()
111 {
112         stop ();
113 }
114
115 void
116 FilmViewer::set_film (shared_ptr<Film> film)
117 {
118         if (_film == film) {
119                 return;
120         }
121
122         _film = film;
123
124         FilmChanged ();
125
126         _frame.reset ();
127         _closed_captions_dialog->clear ();
128
129         if (!_film) {
130                 _player.reset ();
131                 recreate_butler ();
132                 _frame.reset ();
133                 refresh_panel ();
134                 return;
135         }
136
137         try {
138                 _player.reset (new Player (_film, _film->playlist ()));
139                 _player->set_fast ();
140                 if (_dcp_decode_reduction) {
141                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
142                 }
143         } catch (bad_alloc) {
144                 error_dialog (_panel, _("There is not enough free memory to do that."));
145                 _film.reset ();
146                 return;
147         }
148
149         _player->set_always_burn_open_subtitles ();
150         _player->set_play_referenced ();
151
152         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
153         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
154
155         /* Keep about 1 second's worth of history samples */
156         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
157
158         recreate_butler ();
159
160         calculate_sizes ();
161         slow_refresh ();
162 }
163
164 void
165 FilmViewer::recreate_butler ()
166 {
167         bool const was_running = stop ();
168         _butler.reset ();
169
170         if (!_film) {
171                 return;
172         }
173
174         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
175
176         if (_audio_channels != 2 || _film->audio_channels() < 3) {
177                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
178                         map.set (i, i, 1);
179                 }
180         } else {
181                 /* Special case: stereo output, at least 3 channel input.
182                    Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
183                                Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
184                 */
185                 map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
186                 map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
187                 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
188                 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
189                 map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
190                 map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
191                 map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
192                 map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
193         }
194
195         _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
196         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
197                 _butler->disable_audio ();
198         }
199
200         _closed_captions_dialog->set_butler (_butler);
201
202         if (was_running) {
203                 start ();
204         }
205 }
206
207 void
208 FilmViewer::refresh_panel ()
209 {
210         _panel->Refresh ();
211         _panel->Update ();
212 }
213
214 void
215 FilmViewer::get ()
216 {
217         DCPOMATIC_ASSERT (_butler);
218
219         do {
220                 Butler::Error e;
221                 _player_video = _butler->get_video (&e);
222                 if (!_player_video.first && e == Butler::AGAIN) {
223                         signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
224                         return;
225                 }
226         } while (
227                 _player_video.first &&
228                 _film->three_d() &&
229                 (_eyes != _player_video.first->eyes())
230                 );
231
232         _butler->rethrow ();
233
234         display_player_video ();
235 }
236
237 void
238 FilmViewer::display_player_video ()
239 {
240         if (!_player_video.first) {
241                 _frame.reset ();
242                 refresh_panel ();
243                 return;
244         }
245
246         if (_playing && (time() - _player_video.second) > one_video_frame()) {
247                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
248                    part if this frame is J2K).
249                 */
250                 _video_position = _player_video.second;
251                 ++_dropped;
252                 return;
253         }
254
255         /* In an ideal world, what we would do here is:
256          *
257          * 1. convert to XYZ exactly as we do in the DCP creation path.
258          * 2. convert back to RGB for the preview display, compensating
259          *    for the monitor etc. etc.
260          *
261          * but this is inefficient if the source is RGB.  Since we don't
262          * (currently) care too much about the precise accuracy of the preview's
263          * colour mapping (and we care more about its speed) we try to short-
264          * circuit this "ideal" situation in some cases.
265          *
266          * The content's specified colour conversion indicates the colourspace
267          * which the content is in (according to the user).
268          *
269          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
270          * image and convert it (from whatever the user has said it is) to RGB.
271          */
272
273         _frame = _player_video.first->image (
274                 optional<dcp::NoteHandler>(bind(&Log::dcp_log, _film->log().get(), _1, _2)),
275                 bind (&PlayerVideo::always_rgb, _1),
276                 false, true
277                 );
278
279         ImageChanged (_player_video.first);
280
281         _video_position = _player_video.second;
282         _inter_position = _player_video.first->inter_position ();
283         _inter_size = _player_video.first->inter_size ();
284
285         refresh_panel ();
286
287         _closed_captions_dialog->update (time());
288 }
289
290 void
291 FilmViewer::timer ()
292 {
293         if (!_film || !_playing) {
294                 return;
295         }
296
297         get ();
298         PositionChanged ();
299         DCPTime const next = _video_position + one_video_frame();
300
301         if (next >= _film->length()) {
302                 stop ();
303         }
304
305         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
306
307         if (_butler) {
308                 _butler->rethrow ();
309         }
310 }
311
312 void
313 FilmViewer::paint_panel ()
314 {
315         wxPaintDC dc (_panel);
316
317         if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
318                 dc.Clear ();
319 #ifdef DCPOMATIC_VARIANT_SWAROOP
320                 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
321                 if (bg) {
322                         wxImage image (std_to_wx(bg->string()));
323                         wxBitmap bitmap (image);
324                         dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
325                 }
326 #endif
327                 return;
328         }
329
330         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
331         wxBitmap frame_bitmap (frame);
332         dc.DrawBitmap (frame_bitmap, 0, max(0, (_panel_size.height - _out_size.height) / 2));
333
334 #ifdef DCPOMATIC_VARIANT_SWAROOP
335         DCPTime const period = DCPTime::from_seconds(Config::instance()->player_watermark_period() * 60);
336         int64_t n = _video_position.get() / period.get();
337         DCPTime from(n * period.get());
338         DCPTime to = from + DCPTime::from_seconds(Config::instance()->player_watermark_duration() / 1000.0);
339         if (from <= _video_position && _video_position <= to) {
340                 if (!_in_watermark) {
341                         _in_watermark = true;
342                         _watermark_x = rand() % _panel_size.width;
343                         _watermark_y = rand() % _panel_size.height;
344                 }
345                 dc.SetTextForeground(*wxWHITE);
346                 string wm = Config::instance()->player_watermark_theatre();
347                 boost::posix_time::ptime t = boost::posix_time::second_clock::local_time();
348                 wm += "\n" + boost::posix_time::to_iso_extended_string(t);
349                 dc.DrawText(std_to_wx(wm), _watermark_x, _watermark_y);
350         } else {
351                 _in_watermark = false;
352         }
353 #endif
354
355         if (_out_size.width < _panel_size.width) {
356                 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
357                 wxPen p (wxColour (240, 240, 240));
358                 wxBrush b (wxColour (240, 240, 240));
359                 dc.SetPen (p);
360                 dc.SetBrush (b);
361                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
362         }
363
364         if (_out_size.height < _panel_size.height) {
365                 wxPen p (wxColour (240, 240, 240));
366                 wxBrush b (wxColour (240, 240, 240));
367                 dc.SetPen (p);
368                 dc.SetBrush (b);
369                 int const gap = (_panel_size.height - _out_size.height) / 2;
370                 dc.DrawRectangle (0, 0, _panel_size.width, gap);
371                 dc.DrawRectangle (0, gap + _out_size.height + 1, _panel_size.width, gap);
372         }
373
374         if (_outline_content) {
375                 wxPen p (wxColour (255, 0, 0), 2);
376                 dc.SetPen (p);
377                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
378                 dc.DrawRectangle (_inter_position.x, _inter_position.y + (_panel_size.height - _out_size.height) / 2, _inter_size.width, _inter_size.height);
379         }
380 }
381
382 void
383 FilmViewer::set_outline_content (bool o)
384 {
385         _outline_content = o;
386         refresh_panel ();
387 }
388
389 void
390 FilmViewer::set_eyes (Eyes e)
391 {
392         _eyes = e;
393         slow_refresh ();
394 }
395
396 void
397 FilmViewer::panel_sized (wxSizeEvent& ev)
398 {
399         _panel_size.width = ev.GetSize().GetWidth();
400         _panel_size.height = ev.GetSize().GetHeight();
401
402         calculate_sizes ();
403         if (!quick_refresh()) {
404                 slow_refresh ();
405         }
406         PositionChanged ();
407 }
408
409 void
410 FilmViewer::calculate_sizes ()
411 {
412         if (!_film || !_player) {
413                 return;
414         }
415
416         Ratio const * container = _film->container ();
417
418         float const panel_ratio = _panel_size.ratio ();
419         float const film_ratio = container ? container->ratio () : 1.78;
420
421         if (panel_ratio < film_ratio) {
422                 /* panel is less widscreen than the film; clamp width */
423                 _out_size.width = _panel_size.width;
424                 _out_size.height = lrintf (_out_size.width / film_ratio);
425         } else {
426                 /* panel is more widescreen than the film; clamp height */
427                 _out_size.height = _panel_size.height;
428                 _out_size.width = lrintf (_out_size.height * film_ratio);
429         }
430
431         /* Catch silly values */
432         _out_size.width = max (64, _out_size.width);
433         _out_size.height = max (64, _out_size.height);
434
435         _player->set_video_container_size (_out_size);
436 }
437
438 void
439 FilmViewer::start ()
440 {
441         if (!_film) {
442                 return;
443         }
444
445         optional<bool> v = PlaybackPermitted ();
446         if (v && !*v) {
447                 /* Computer says no */
448                 return;
449         }
450
451         if (_audio.isStreamOpen()) {
452                 _audio.setStreamTime (_video_position.seconds());
453                 _audio.startStream ();
454         }
455
456         _playing = true;
457         _dropped = 0;
458         timer ();
459         Started (position());
460 }
461
462 bool
463 FilmViewer::stop ()
464 {
465         if (_audio.isStreamRunning()) {
466                 /* stop stream and discard any remaining queued samples */
467                 _audio.abortStream ();
468         }
469
470         if (!_playing) {
471                 return false;
472         }
473
474         _playing = false;
475         Stopped (position());
476         return true;
477 }
478
479 void
480 FilmViewer::player_change (ChangeType type, int property, bool frequent)
481 {
482         if (type != CHANGE_TYPE_DONE || frequent) {
483                 return;
484         }
485
486         if (_coalesce_player_changes) {
487                 _pending_player_changes.push_back (property);
488                 return;
489         }
490
491         calculate_sizes ();
492         bool refreshed = false;
493         if (
494                 property == VideoContentProperty::CROP ||
495                 property == VideoContentProperty::SCALE ||
496                 property == VideoContentProperty::FADE_IN ||
497                 property == VideoContentProperty::FADE_OUT ||
498                 property == VideoContentProperty::COLOUR_CONVERSION ||
499                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
500                 property == PlayerProperty::FILM_CONTAINER
501                 ) {
502                 refreshed = quick_refresh ();
503         }
504
505         if (!refreshed) {
506                 slow_refresh ();
507         }
508         PositionChanged ();
509 }
510
511 void
512 FilmViewer::film_change (ChangeType type, Film::Property p)
513 {
514         if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
515                 recreate_butler ();
516         }
517 }
518
519 /** Re-get the current frame slowly by seeking */
520 void
521 FilmViewer::slow_refresh ()
522 {
523         seek (_video_position, true);
524 }
525
526 /** Try to re-get the current frame quickly by resetting the metadata
527  *  in the PlayerVideo that we used last time.
528  *  @return true if this was possible, false if not.
529  */
530 bool
531 FilmViewer::quick_refresh ()
532 {
533         if (!_player_video.first) {
534                 return false;
535         }
536
537         if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
538                 return false;
539         }
540
541         display_player_video ();
542         return true;
543 }
544
545 void
546 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
547 {
548         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
549         if (dt) {
550                 seek (*dt, accurate);
551         }
552 }
553
554 void
555 FilmViewer::set_coalesce_player_changes (bool c)
556 {
557         _coalesce_player_changes = c;
558
559         if (!c) {
560                 BOOST_FOREACH (int i, _pending_player_changes) {
561                         player_change (CHANGE_TYPE_DONE, i, false);
562                 }
563                 _pending_player_changes.clear ();
564         }
565 }
566
567 void
568 FilmViewer::seek (DCPTime t, bool accurate)
569 {
570         if (!_butler) {
571                 return;
572         }
573
574         if (t < DCPTime ()) {
575                 t = DCPTime ();
576         }
577
578         if (t >= _film->length ()) {
579                 t = _film->length ();
580         }
581
582         bool const was_running = stop ();
583
584         _closed_captions_dialog->clear ();
585         _butler->seek (t, accurate);
586         get ();
587
588         if (was_running) {
589                 start ();
590         }
591
592         PositionChanged ();
593         Seeked (position());
594 }
595
596 void
597 FilmViewer::config_changed (Config::Property p)
598 {
599 #ifdef DCPOMATIC_VARIANT_SWAROOP
600         if (p == Config::PLAYER_BACKGROUND_IMAGE) {
601                 refresh_panel ();
602                 return;
603         }
604 #endif
605
606         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
607                 return;
608         }
609
610         if (_audio.isStreamOpen ()) {
611                 _audio.closeStream ();
612         }
613
614         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
615                 unsigned int st = 0;
616                 if (Config::instance()->sound_output()) {
617                         while (st < _audio.getDeviceCount()) {
618                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
619                                         break;
620                                 }
621                                 ++st;
622                         }
623                         if (st == _audio.getDeviceCount()) {
624                                 st = _audio.getDefaultOutputDevice();
625                         }
626                 } else {
627                         st = _audio.getDefaultOutputDevice();
628                 }
629
630                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
631
632                 RtAudio::StreamParameters sp;
633                 sp.deviceId = st;
634                 sp.nChannels = _audio_channels;
635                 sp.firstChannel = 0;
636                 try {
637                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
638 #ifdef DCPOMATIC_USE_RTERROR
639                 } catch (RtError& e) {
640 #else
641                 } catch (RtAudioError& e) {
642 #endif
643                         error_dialog (
644                                 _panel,
645                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
646                                 );
647                 }
648                 recreate_butler ();
649
650         } else {
651                 _audio_channels = 0;
652                 recreate_butler ();
653         }
654 }
655
656 DCPTime
657 FilmViewer::uncorrected_time () const
658 {
659         if (_audio.isStreamRunning ()) {
660                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
661         }
662
663         return _video_position;
664 }
665
666 DCPTime
667 FilmViewer::time () const
668 {
669         if (_audio.isStreamRunning ()) {
670                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
671                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
672         }
673
674         return _video_position;
675 }
676
677 int
678 FilmViewer::audio_callback (void* out_p, unsigned int frames)
679 {
680         while (true) {
681                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
682                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
683                         /* There was an underrun or this audio is on time; carry on */
684                         break;
685                 }
686                 /* The audio we just got was (very) late; drop it and get some more. */
687         }
688
689         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
690         if (lm) {
691                 _latency_history.push_back (_audio.getStreamLatency ());
692                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
693                         _latency_history.pop_front ();
694                 }
695         }
696
697         return 0;
698 }
699
700 Frame
701 FilmViewer::average_latency () const
702 {
703         boost::mutex::scoped_lock lm (_latency_history_mutex);
704         if (_latency_history.empty()) {
705                 return 0;
706         }
707
708         Frame total = 0;
709         BOOST_FOREACH (Frame i, _latency_history) {
710                 total += i;
711         }
712
713         return total / _latency_history.size();
714 }
715
716 void
717 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
718 {
719         _dcp_decode_reduction = reduction;
720         if (_player) {
721                 _player->set_dcp_decode_reduction (reduction);
722         }
723 }
724
725 optional<int>
726 FilmViewer::dcp_decode_reduction () const
727 {
728         return _dcp_decode_reduction;
729 }
730
731 DCPTime
732 FilmViewer::one_video_frame () const
733 {
734         return DCPTime::from_frames (1, _film->video_frame_rate());
735 }
736
737 /** Open a dialog box showing our film's closed captions */
738 void
739 FilmViewer::show_closed_captions ()
740 {
741         _closed_captions_dialog->Show();
742 }
743
744 void
745 FilmViewer::seek_by (DCPTime by, bool accurate)
746 {
747         seek (_video_position + by, accurate);
748 }