2 Copyright (C) 2012-2021 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/>.
22 /** @file src/film_viewer.cc
23 * @brief A wx widget to view a preview of a Film.
27 #include "closed_captions_dialog.h"
28 #include "film_viewer.h"
29 #include "gl_video_view.h"
30 #include "nag_dialog.h"
31 #include "playhead_to_frame_dialog.h"
32 #include "playhead_to_timecode_dialog.h"
33 #include "sign_language_dialog.h"
34 #include "simple_video_view.h"
36 #include "lib/butler.h"
37 #include "lib/compose.hpp"
38 #include "lib/config.h"
39 #include "lib/dcpomatic_log.h"
40 #include "lib/examine_content_job.h"
41 #include "lib/exceptions.h"
43 #include "lib/filter.h"
44 #include "lib/image.h"
45 #include "lib/job_manager.h"
47 #include "lib/player.h"
48 #include "lib/player_video.h"
49 #include "lib/ratio.h"
50 #include "lib/text_content.h"
51 #include "lib/timer.h"
53 #include "lib/video_content.h"
54 #include "lib/video_decoder.h"
55 #include <dcp/exceptions.h>
56 #include <dcp/warnings.h>
58 #include <libavutil/pixfmt.h>
60 LIBDCP_DISABLE_WARNINGS
61 #include <wx/tglbtn.h>
62 LIBDCP_ENABLE_WARNINGS
67 using std::dynamic_pointer_cast;
68 using std::make_shared;
70 using std::shared_ptr;
73 using boost::optional;
74 #if BOOST_VERSION >= 106100
75 using namespace boost::placeholders;
78 using namespace dcpomatic;
83 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
85 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
89 FilmViewer::FilmViewer (wxWindow* p)
90 : _audio (DCPOMATIC_RTAUDIO_API)
91 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
92 , _sign_language_dialog(new SignLanguageDialog(p))
94 #if wxCHECK_VERSION(3, 1, 0)
95 switch (Config::instance()->video_view_type()) {
96 case Config::VIDEO_VIEW_OPENGL:
97 _video_view = std::make_shared<GLVideoView>(this, p);
99 case Config::VIDEO_VIEW_SIMPLE:
100 _video_view = std::make_shared<SimpleVideoView>(this, p);
104 _video_view = std::make_shared<SimpleVideoView>(this, p);
107 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
108 _video_view->TooManyDropped.connect (boost::bind(boost::ref(TooManyDropped)));
110 set_film (shared_ptr<Film>());
112 _config_changed_connection = Config::instance()->Changed.connect(bind(&FilmViewer::config_changed, this, _1));
113 config_changed (Config::SOUND_OUTPUT);
117 FilmViewer::~FilmViewer ()
123 /** Ask for ::idle_handler() to be called next time we are idle */
125 FilmViewer::request_idle_display_next_frame ()
132 DCPOMATIC_ASSERT (signal_manager);
133 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
138 FilmViewer::idle_handler ()
144 if (_video_view->display_next_frame(true) == VideoView::AGAIN) {
145 /* get() could not complete quickly so we'll try again later */
146 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
154 FilmViewer::set_film (shared_ptr<Film> film)
162 _video_view->clear ();
163 _closed_captions_dialog->clear ();
168 _player = boost::none;
170 _video_view->update ();
175 _player.emplace(_film, _optimise_for_j2k ? Image::Alignment::COMPACT : Image::Alignment::PADDED);
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."));
187 _player->set_always_burn_open_subtitles ();
188 _player->set_play_referenced ();
190 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
191 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
192 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
194 film_change (ChangeType::DONE, Film::Property::VIDEO_FRAME_RATE);
195 film_change (ChangeType::DONE, Film::Property::THREE_D);
196 film_length_change ();
198 /* Keep about 1 second's worth of history samples */
199 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
201 _closed_captions_dialog->update_tracks (_film);
211 FilmViewer::destroy_butler()
219 FilmViewer::destroy_and_maybe_create_butler()
233 FilmViewer::create_butler()
235 #if wxCHECK_VERSION(3, 1, 0)
236 auto const j2k_gl_optimised = dynamic_pointer_cast<GLVideoView>(_video_view) && _optimise_for_j2k;
238 auto const j2k_gl_optimised = false;
241 DCPOMATIC_ASSERT(_player);
243 _butler = std::make_shared<Butler>(
246 Config::instance()->audio_mapping(_audio_channels),
248 boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24),
250 j2k_gl_optimised ? Image::Alignment::COMPACT : Image::Alignment::PADDED,
253 (Config::instance()->sound() && _audio.isStreamOpen()) ? Butler::Audio::ENABLED : Butler::Audio::DISABLED
256 _closed_captions_dialog->set_butler (_butler);
263 FilmViewer::set_outline_content (bool o)
265 _outline_content = o;
266 _video_view->update ();
271 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
273 _outline_subtitles = rect;
274 _video_view->update ();
279 FilmViewer::set_eyes (Eyes e)
281 _video_view->set_eyes (e);
287 FilmViewer::video_view_sized ()
290 if (!quick_refresh()) {
297 FilmViewer::calculate_sizes ()
299 if (!_film || !_player) {
303 auto const container = _film->container ();
305 auto const scale = dpi_scale_factor (_video_view->get());
306 int const video_view_width = std::round(_video_view->get()->GetSize().x * scale);
307 int const video_view_height = std::round(_video_view->get()->GetSize().y * scale);
309 auto const view_ratio = float(video_view_width) / video_view_height;
310 auto const film_ratio = container ? container->ratio () : 1.78;
313 if (view_ratio < film_ratio) {
314 /* panel is less widscreen than the film; clamp width */
315 out_size.width = video_view_width;
316 out_size.height = lrintf (out_size.width / film_ratio);
318 /* panel is more widescreen than the film; clamp height */
319 out_size.height = video_view_height;
320 out_size.width = lrintf (out_size.height * film_ratio);
323 /* Catch silly values */
324 out_size.width = max (64, out_size.width);
325 out_size.height = max (64, out_size.height);
327 /* Make sure the video container sizes are always a multiple of 2 so that
328 * we don't get gaps with subsampled sources (e.g. YUV420)
330 if (out_size.width % 2) {
333 if (out_size.height % 2) {
337 _player->set_video_container_size (out_size);
342 FilmViewer::suspend ()
345 if (_audio.isStreamRunning()) {
346 _audio.abortStream();
352 FilmViewer::start_audio_stream_if_open ()
354 if (_audio.isStreamOpen()) {
355 _audio.setStreamTime (_video_view->position().seconds());
357 _audio.startStream ();
358 } catch (RtAudioError& e) {
362 _("There was a problem starting audio playback. Please try another audio output device in Preferences."), std_to_wx(e.what())
370 FilmViewer::resume ()
372 DCPOMATIC_ASSERT (_suspended > 0);
374 if (_playing && !_suspended) {
375 start_audio_stream_if_open ();
376 _video_view->start ();
388 auto v = PlaybackPermitted ();
390 /* Computer says no */
394 /* We are about to set up the audio stream from the position of the video view.
395 If there is `lazy' seek in progress we need to wait for it to go through so that
396 _video_view->position() gives us a sensible answer.
402 /* Take the video view's idea of position as our `playhead' and start the
403 audio stream (which is the timing reference) there.
405 start_audio_stream_if_open ();
408 /* Calling start() below may directly result in Stopped being emitted, and if that
409 * happens we want it to come after the Started signal, so do that first.
412 _video_view->start ();
419 if (_audio.isStreamRunning()) {
420 /* stop stream and discard any remaining queued samples */
421 _audio.abortStream ();
429 _video_view->stop ();
432 _video_view->rethrow ();
438 FilmViewer::player_change (ChangeType type, int property, bool frequent)
440 if (type != ChangeType::DONE || frequent) {
444 if (_coalesce_player_changes) {
445 _pending_player_changes.push_back (property);
449 player_change ({property});
454 FilmViewer::player_change (vector<int> properties)
458 bool try_quick_refresh = false;
459 bool update_ccap_tracks = false;
461 for (auto i: properties) {
463 i == VideoContentProperty::CROP ||
464 i == VideoContentProperty::CUSTOM_RATIO ||
465 i == VideoContentProperty::CUSTOM_SIZE ||
466 i == VideoContentProperty::FADE_IN ||
467 i == VideoContentProperty::FADE_OUT ||
468 i == VideoContentProperty::COLOUR_CONVERSION ||
469 i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
470 i == PlayerProperty::FILM_CONTAINER
472 try_quick_refresh = true;
475 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
476 update_ccap_tracks = true;
480 if (!try_quick_refresh || !quick_refresh()) {
484 if (update_ccap_tracks) {
485 _closed_captions_dialog->update_tracks (_film);
491 FilmViewer::film_change (ChangeType type, Film::Property p)
493 if (type != ChangeType::DONE) {
497 if (p == Film::Property::AUDIO_CHANNELS) {
498 destroy_and_maybe_create_butler();
499 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
500 _video_view->set_video_frame_rate (_film->video_frame_rate());
501 } else if (p == Film::Property::THREE_D) {
502 _video_view->set_three_d (_film->three_d());
503 } else if (p == Film::Property::CONTENT) {
504 _closed_captions_dialog->update_tracks (_film);
510 FilmViewer::film_length_change ()
512 _video_view->set_length (_film->length());
516 /** Re-get the current frame slowly by seeking */
518 FilmViewer::slow_refresh ()
520 seek (_video_view->position(), true);
524 /** Try to re-get the current frame quickly by resetting the metadata
525 * in the PlayerVideo that we used last time.
526 * @return true if this was possible, false if not.
529 FilmViewer::quick_refresh ()
531 if (!_video_view || !_film || !_player) {
534 return _video_view->reset_metadata (_film, _player->video_container_size());
539 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
541 DCPOMATIC_ASSERT(_player);
542 auto dt = _player->content_time_to_dcp (content, t);
544 seek (*dt, accurate);
550 FilmViewer::set_coalesce_player_changes (bool c)
552 _coalesce_player_changes = c;
555 player_change (_pending_player_changes);
556 _pending_player_changes.clear ();
562 FilmViewer::seek (DCPTime t, bool accurate)
572 if (t >= _film->length()) {
573 t = _film->length() - one_video_frame();
578 _closed_captions_dialog->clear ();
579 _butler->seek (t, accurate);
582 /* We're not playing, so let the GUI thread get on and
583 come back later to get the next frame after the seek.
585 request_idle_display_next_frame ();
587 /* We're going to start playing again straight away
588 so wait for the seek to finish.
590 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
598 FilmViewer::config_changed (Config::Property p)
600 if (p == Config::AUDIO_MAPPING) {
601 destroy_and_maybe_create_butler();
605 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
609 if (_audio.isStreamOpen ()) {
610 _audio.closeStream ();
613 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
615 if (Config::instance()->sound_output()) {
616 while (st < _audio.getDeviceCount()) {
618 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
621 } catch (RtAudioError&) {
622 /* Something went wrong with that device so we don't want to use it anyway */
626 if (st == _audio.getDeviceCount()) {
627 st = _audio.getDefaultOutputDevice();
630 st = _audio.getDefaultOutputDevice();
634 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
635 RtAudio::StreamParameters sp;
637 sp.nChannels = _audio_channels;
639 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
640 } catch (RtAudioError& e) {
644 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
647 destroy_and_maybe_create_butler();
651 destroy_and_maybe_create_butler();
657 FilmViewer::uncorrected_time () const
659 if (_audio.isStreamRunning()) {
660 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
663 return _video_view->position();
668 FilmViewer::audio_time () const
670 if (!_audio.isStreamRunning()) {
674 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
675 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
680 FilmViewer::time () const
682 return audio_time().get_value_or(_video_view->position());
687 FilmViewer::audio_callback (void* out_p, unsigned int frames)
690 auto t = _butler->get_audio (Butler::Behaviour::NON_BLOCKING, reinterpret_cast<float*> (out_p), frames);
691 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
692 /* There was an underrun or this audio is on time; carry on */
695 /* The audio we just got was (very) late; drop it and get some more. */
698 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
700 _latency_history.push_back (_audio.getStreamLatency ());
701 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
702 _latency_history.pop_front ();
711 FilmViewer::average_latency () const
713 boost::mutex::scoped_lock lm (_latency_history_mutex);
714 if (_latency_history.empty()) {
719 for (auto i: _latency_history) {
723 return total / _latency_history.size();
728 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
730 _dcp_decode_reduction = reduction;
732 _player->set_dcp_decode_reduction (reduction);
738 FilmViewer::dcp_decode_reduction () const
740 return _dcp_decode_reduction;
744 optional<ContentTime>
745 FilmViewer::position_in_content (shared_ptr<const Content> content) const
747 DCPOMATIC_ASSERT(_player);
748 return _player->dcp_to_content_time (content, position());
753 FilmViewer::one_video_frame () const
755 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
759 /** Open a dialog box showing our film's closed captions */
761 FilmViewer::show_closed_captions ()
763 _closed_captions_dialog->Show();
768 FilmViewer::show_sign_language()
770 _sign_language_dialog->Show();
775 FilmViewer::seek_by (DCPTime by, bool accurate)
777 seek (_video_view->position() + by, accurate);
782 FilmViewer::set_pad_black (bool p)
788 /** Called when a player has finished the current film.
789 * May be called from a non-UI thread.
792 FilmViewer::finished ()
794 emit (boost::bind(&FilmViewer::ui_finished, this));
798 /** Called by finished() in the UI thread */
800 FilmViewer::ui_finished ()
808 FilmViewer::dropped () const
810 return _video_view->dropped ();
815 FilmViewer::errored () const
817 return _video_view->errored ();
822 FilmViewer::gets () const
824 return _video_view->gets ();
829 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
831 emit (boost::bind(boost::ref(ImageChanged), pv));
836 FilmViewer::set_optimise_for_j2k (bool o)
838 _optimise_for_j2k = o;
839 _video_view->set_optimise_for_j2k (o);
844 FilmViewer::set_crop_guess (dcpomatic::Rect<float> crop)
846 if (crop != _crop_guess) {
848 _video_view->update ();
854 FilmViewer::unset_crop_guess ()
856 _crop_guess = boost::none;
857 _video_view->update ();