2 Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file src/film_viewer.cc
22 * @brief A wx widget to view a preview of a Film.
25 #include "film_viewer.h"
26 #include "playhead_to_timecode_dialog.h"
27 #include "playhead_to_frame_dialog.h"
29 #include "closed_captions_dialog.h"
30 #include "gl_video_view.h"
31 #include "simple_video_view.h"
33 #include "lib/ratio.h"
35 #include "lib/job_manager.h"
36 #include "lib/image.h"
37 #include "lib/exceptions.h"
38 #include "lib/examine_content_job.h"
39 #include "lib/filter.h"
40 #include "lib/player.h"
41 #include "lib/player_video.h"
42 #include "lib/video_content.h"
43 #include "lib/video_decoder.h"
44 #include "lib/timer.h"
45 #include "lib/butler.h"
47 #include "lib/config.h"
48 #include "lib/compose.hpp"
49 #include "lib/dcpomatic_log.h"
51 #include <libavutil/pixfmt.h>
53 #include <dcp/exceptions.h>
54 #include <wx/tglbtn.h>
67 using boost::shared_ptr;
68 using boost::dynamic_pointer_cast;
69 using boost::weak_ptr;
70 using boost::optional;
72 using namespace dcpomatic;
76 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
78 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
81 FilmViewer::FilmViewer (wxWindow* p)
82 : _coalesce_player_changes (false)
83 , _audio (DCPOMATIC_RTAUDIO_API)
85 , _audio_block_size (1024)
88 , _latency_history_count (0)
90 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
91 , _outline_content (false)
94 #ifdef DCPOMATIC_VARIANT_SWAROOP
95 , _background_image (false)
97 , _state_timer ("viewer")
101 switch (Config::instance()->video_view_type()) {
102 case Config::VIDEO_VIEW_OPENGL:
103 _video_view = new GLVideoView (this, p);
105 case Config::VIDEO_VIEW_SIMPLE:
106 _video_view = new SimpleVideoView (this, p);
110 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
111 _timer.Bind (wxEVT_TIMER, boost::bind(&FilmViewer::timer, this));
113 set_film (shared_ptr<Film> ());
115 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
116 config_changed (Config::SOUND_OUTPUT);
119 FilmViewer::~FilmViewer ()
124 /** Ask for ::get() to be called next time we are idle */
126 FilmViewer::request_idle_get ()
133 DCPOMATIC_ASSERT (signal_manager);
134 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
138 FilmViewer::idle_handler ()
147 /* get() could not complete quickly so we'll try again later */
148 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
153 FilmViewer::set_film (shared_ptr<Film> film)
160 _video_position = DCPTime ();
161 _player_video.first.reset ();
162 _player_video.second = DCPTime ();
164 _video_view->set_image (shared_ptr<Image>());
165 _closed_captions_dialog->clear ();
175 _player.reset (new Player (_film, _film->playlist ()));
176 _player->set_fast ();
177 if (_dcp_decode_reduction) {
178 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
180 } catch (bad_alloc &) {
181 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
186 _player->set_always_burn_open_subtitles ();
187 _player->set_play_referenced ();
189 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
190 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
192 /* Keep about 1 second's worth of history samples */
193 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
202 FilmViewer::recreate_butler ()
212 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
214 if (_audio_channels != 2 || _film->audio_channels() < 3) {
215 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
219 /* Special case: stereo output, at least 3 channel input.
220 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
221 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
223 if (_film->audio_channels() > 0) {
224 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
226 if (_film->audio_channels() > 1) {
227 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
229 if (_film->audio_channels() > 2) {
230 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
231 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
233 if (_film->audio_channels() > 3) {
234 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
235 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
237 if (_film->audio_channels() > 4) {
238 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
240 if (_film->audio_channels() > 5) {
241 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
245 _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
246 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
247 _butler->disable_audio ();
250 _closed_captions_dialog->set_film_and_butler (_film, _butler);
256 FilmViewer::refresh_view ()
258 _state_timer.set ("update-view");
259 _video_view->update ();
260 _state_timer.unset ();
263 /** Try to get a frame from the butler and display it.
264 * @param lazy true to return false quickly if no video is available quickly (i.e. we are waiting for the butler).
265 * false to ask the butler to block until it has video (unless it is suspended).
266 * @return true on success, false if we did nothing because it would have taken too long.
269 FilmViewer::get (bool lazy)
271 DCPOMATIC_ASSERT (_butler);
276 _player_video = _butler->get_video (!lazy, &e);
277 if (!_player_video.first && e == Butler::AGAIN) {
279 /* No video available; return saying we failed */
282 /* Player was suspended; come back later */
283 signal_manager->when_idle (boost::bind(&FilmViewer::get, this, false));
288 _player_video.first &&
290 _eyes != _player_video.first->eyes() &&
291 _player_video.first->eyes() != EYES_BOTH
296 } catch (DecodeError& e) {
297 error_dialog (_video_view->get(), e.what());
300 display_player_video ();
307 FilmViewer::display_player_video ()
309 if (!_player_video.first) {
310 _video_view->set_image (shared_ptr<Image>());
315 if (_playing && !_suspended && (time() - _player_video.second) > one_video_frame()) {
316 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
317 part if this frame is J2K).
319 _video_position = _player_video.second;
324 /* In an ideal world, what we would do here is:
326 * 1. convert to XYZ exactly as we do in the DCP creation path.
327 * 2. convert back to RGB for the preview display, compensating
328 * for the monitor etc. etc.
330 * but this is inefficient if the source is RGB. Since we don't
331 * (currently) care too much about the precise accuracy of the preview's
332 * colour mapping (and we care more about its speed) we try to short-
333 * circuit this "ideal" situation in some cases.
335 * The content's specified colour conversion indicates the colourspace
336 * which the content is in (according to the user).
338 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
339 * image and convert it (from whatever the user has said it is) to RGB.
342 _state_timer.set ("get image");
344 _video_view->set_image (
345 _player_video.first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true)
348 _state_timer.set ("ImageChanged");
349 ImageChanged (_player_video.first);
350 _state_timer.unset ();
352 _video_position = _player_video.second;
353 _inter_position = _player_video.first->inter_position ();
354 _inter_size = _player_video.first->inter_size ();
358 _closed_captions_dialog->update (time());
364 if (!_film || !_playing || _suspended) {
369 DCPTime const next = _video_position + one_video_frame();
371 if (next >= _film->length()) {
377 LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
378 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
386 FilmViewer::set_outline_content (bool o)
388 _outline_content = o;
393 FilmViewer::set_eyes (Eyes e)
400 FilmViewer::video_view_sized ()
403 if (!quick_refresh()) {
410 FilmViewer::calculate_sizes ()
412 if (!_film || !_player) {
416 Ratio const * container = _film->container ();
418 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
419 float const film_ratio = container ? container->ratio () : 1.78;
421 if (view_ratio < film_ratio) {
422 /* panel is less widscreen than the film; clamp width */
423 _out_size.width = _video_view->get()->GetSize().x;
424 _out_size.height = lrintf (_out_size.width / film_ratio);
426 /* panel is more widescreen than the film; clamp height */
427 _out_size.height = _video_view->get()->GetSize().y;
428 _out_size.width = lrintf (_out_size.height * film_ratio);
431 /* Catch silly values */
432 _out_size.width = max (64, _out_size.width);
433 _out_size.height = max (64, _out_size.height);
435 _player->set_video_container_size (_out_size);
439 FilmViewer::suspend ()
442 if (_audio.isStreamRunning()) {
443 _audio.abortStream();
448 FilmViewer::resume ()
451 if (_playing && !_suspended) {
452 if (_audio.isStreamOpen()) {
453 _audio.setStreamTime (_video_position.seconds());
454 _audio.startStream ();
467 optional<bool> v = PlaybackPermitted ();
469 /* Computer says no */
473 if (_audio.isStreamOpen()) {
474 _audio.setStreamTime (_video_position.seconds());
475 _audio.startStream ();
481 Started (position());
487 if (_audio.isStreamRunning()) {
488 /* stop stream and discard any remaining queued samples */
489 _audio.abortStream ();
497 Stopped (position());
502 FilmViewer::player_change (ChangeType type, int property, bool frequent)
504 if (type != CHANGE_TYPE_DONE || frequent) {
508 if (_coalesce_player_changes) {
509 _pending_player_changes.push_back (property);
514 bool refreshed = false;
516 property == VideoContentProperty::CROP ||
517 property == VideoContentProperty::SCALE ||
518 property == VideoContentProperty::FADE_IN ||
519 property == VideoContentProperty::FADE_OUT ||
520 property == VideoContentProperty::COLOUR_CONVERSION ||
521 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
522 property == PlayerProperty::FILM_CONTAINER
524 refreshed = quick_refresh ();
534 FilmViewer::film_change (ChangeType type, Film::Property p)
536 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
541 /** Re-get the current frame slowly by seeking */
543 FilmViewer::slow_refresh ()
545 seek (_video_position, true);
548 /** Try to re-get the current frame quickly by resetting the metadata
549 * in the PlayerVideo that we used last time.
550 * @return true if this was possible, false if not.
553 FilmViewer::quick_refresh ()
555 if (!_player_video.first) {
559 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
563 display_player_video ();
568 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
570 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
572 seek (*dt, accurate);
577 FilmViewer::set_coalesce_player_changes (bool c)
579 _coalesce_player_changes = c;
582 BOOST_FOREACH (int i, _pending_player_changes) {
583 player_change (CHANGE_TYPE_DONE, i, false);
585 _pending_player_changes.clear ();
590 FilmViewer::seek (DCPTime t, bool accurate)
596 if (t < DCPTime ()) {
600 if (t >= _film->length ()) {
601 t = _film->length ();
606 _closed_captions_dialog->clear ();
607 _butler->seek (t, accurate);
612 /* Make sure we get a frame so that _video_position is set up before we resume */
613 while (!get(true)) {}
620 FilmViewer::config_changed (Config::Property p)
622 #ifdef DCPOMATIC_VARIANT_SWAROOP
623 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
629 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
633 if (_audio.isStreamOpen ()) {
634 _audio.closeStream ();
637 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
639 if (Config::instance()->sound_output()) {
640 while (st < _audio.getDeviceCount()) {
641 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
646 if (st == _audio.getDeviceCount()) {
647 st = _audio.getDefaultOutputDevice();
650 st = _audio.getDefaultOutputDevice();
653 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
655 RtAudio::StreamParameters sp;
657 sp.nChannels = _audio_channels;
660 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
661 #ifdef DCPOMATIC_USE_RTERROR
662 } catch (RtError& e) {
664 } catch (RtAudioError& e) {
668 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
680 FilmViewer::uncorrected_time () const
682 if (_audio.isStreamRunning ()) {
683 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
686 return _video_position;
690 FilmViewer::time () const
692 if (_audio.isStreamRunning ()) {
693 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
694 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
697 return _video_position;
701 FilmViewer::audio_callback (void* out_p, unsigned int frames)
704 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
705 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
706 /* There was an underrun or this audio is on time; carry on */
709 /* The audio we just got was (very) late; drop it and get some more. */
712 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
714 _latency_history.push_back (_audio.getStreamLatency ());
715 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
716 _latency_history.pop_front ();
724 FilmViewer::average_latency () const
726 boost::mutex::scoped_lock lm (_latency_history_mutex);
727 if (_latency_history.empty()) {
732 BOOST_FOREACH (Frame i, _latency_history) {
736 return total / _latency_history.size();
740 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
742 _dcp_decode_reduction = reduction;
744 _player->set_dcp_decode_reduction (reduction);
749 FilmViewer::dcp_decode_reduction () const
751 return _dcp_decode_reduction;
755 FilmViewer::one_video_frame () const
757 return DCPTime::from_frames (1, _film->video_frame_rate());
760 /** Open a dialog box showing our film's closed captions */
762 FilmViewer::show_closed_captions ()
764 _closed_captions_dialog->Show();
768 FilmViewer::seek_by (DCPTime by, bool accurate)
770 seek (_video_position + by, accurate);
774 FilmViewer::set_pad_black (bool p)