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