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 "simple_video_view.h"
35 #include "lib/butler.h"
36 #include "lib/compose.hpp"
37 #include "lib/config.h"
38 #include "lib/dcpomatic_log.h"
39 #include "lib/examine_content_job.h"
40 #include "lib/exceptions.h"
42 #include "lib/filter.h"
43 #include "lib/image.h"
44 #include "lib/job_manager.h"
46 #include "lib/player.h"
47 #include "lib/player_video.h"
48 #include "lib/ratio.h"
49 #include "lib/text_content.h"
50 #include "lib/timer.h"
52 #include "lib/video_content.h"
53 #include "lib/video_decoder.h"
54 #include <dcp/exceptions.h>
55 #include <dcp/warnings.h>
57 #include <libavutil/pixfmt.h>
59 LIBDCP_DISABLE_WARNINGS
60 #include <wx/tglbtn.h>
61 LIBDCP_ENABLE_WARNINGS
66 using std::dynamic_pointer_cast;
67 using std::make_shared;
69 using std::shared_ptr;
72 using boost::optional;
73 #if BOOST_VERSION >= 106100
74 using namespace boost::placeholders;
77 using namespace dcpomatic;
82 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
84 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
88 FilmViewer::FilmViewer (wxWindow* p)
89 : _audio (DCPOMATIC_RTAUDIO_API)
90 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
92 #if wxCHECK_VERSION(3, 1, 0)
93 switch (Config::instance()->video_view_type()) {
94 case Config::VIDEO_VIEW_OPENGL:
95 _video_view = std::make_shared<GLVideoView>(this, p);
97 case Config::VIDEO_VIEW_SIMPLE:
98 _video_view = std::make_shared<SimpleVideoView>(this, p);
102 _video_view = std::make_shared<SimpleVideoView>(this, p);
105 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
106 _video_view->TooManyDropped.connect (boost::bind(boost::ref(TooManyDropped)));
108 set_film (shared_ptr<Film>());
110 _config_changed_connection = Config::instance()->Changed.connect(bind(&FilmViewer::config_changed, this, _1));
111 config_changed (Config::SOUND_OUTPUT);
115 FilmViewer::~FilmViewer ()
121 /** Ask for ::idle_handler() to be called next time we are idle */
123 FilmViewer::request_idle_display_next_frame ()
130 DCPOMATIC_ASSERT (signal_manager);
131 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
136 FilmViewer::idle_handler ()
142 if (_video_view->display_next_frame(true) == VideoView::AGAIN) {
143 /* get() could not complete quickly so we'll try again later */
144 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
152 FilmViewer::set_film (shared_ptr<Film> film)
160 _video_view->clear ();
161 _closed_captions_dialog->clear ();
166 _player = boost::none;
168 _video_view->update ();
173 _player.emplace(_film, _optimise_for_j2k ? Image::Alignment::COMPACT : Image::Alignment::PADDED);
174 _player->set_fast ();
175 if (_dcp_decode_reduction) {
176 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
178 } catch (bad_alloc &) {
179 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
185 _player->set_always_burn_open_subtitles ();
186 _player->set_play_referenced ();
188 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
189 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
190 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
192 film_change (ChangeType::DONE, Film::Property::VIDEO_FRAME_RATE);
193 film_change (ChangeType::DONE, Film::Property::THREE_D);
194 film_length_change ();
196 /* Keep about 1 second's worth of history samples */
197 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
199 _closed_captions_dialog->update_tracks (_film);
209 FilmViewer::destroy_butler()
217 FilmViewer::destroy_and_maybe_create_butler()
231 FilmViewer::create_butler()
233 #if wxCHECK_VERSION(3, 1, 0)
234 auto const j2k_gl_optimised = dynamic_pointer_cast<GLVideoView>(_video_view) && _optimise_for_j2k;
236 auto const j2k_gl_optimised = false;
239 DCPOMATIC_ASSERT(_player);
241 _butler = std::make_shared<Butler>(
244 Config::instance()->audio_mapping(_audio_channels),
246 boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24),
248 j2k_gl_optimised ? Image::Alignment::COMPACT : Image::Alignment::PADDED,
251 (Config::instance()->sound() && _audio.isStreamOpen()) ? Butler::Audio::ENABLED : Butler::Audio::DISABLED
254 _closed_captions_dialog->set_butler (_butler);
261 FilmViewer::set_outline_content (bool o)
263 _outline_content = o;
264 _video_view->update ();
269 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
271 _outline_subtitles = rect;
272 _video_view->update ();
277 FilmViewer::set_eyes (Eyes e)
279 _video_view->set_eyes (e);
285 FilmViewer::video_view_sized ()
288 if (!quick_refresh()) {
295 FilmViewer::calculate_sizes ()
297 if (!_film || !_player) {
301 auto const container = _film->container ();
303 auto const scale = dpi_scale_factor (_video_view->get());
304 int const video_view_width = std::round(_video_view->get()->GetSize().x * scale);
305 int const video_view_height = std::round(_video_view->get()->GetSize().y * scale);
307 auto const view_ratio = float(video_view_width) / video_view_height;
308 auto const film_ratio = container ? container->ratio () : 1.78;
311 if (view_ratio < film_ratio) {
312 /* panel is less widscreen than the film; clamp width */
313 out_size.width = video_view_width;
314 out_size.height = lrintf (out_size.width / film_ratio);
316 /* panel is more widescreen than the film; clamp height */
317 out_size.height = video_view_height;
318 out_size.width = lrintf (out_size.height * film_ratio);
321 /* Catch silly values */
322 out_size.width = max (64, out_size.width);
323 out_size.height = max (64, out_size.height);
325 /* Make sure the video container sizes are always a multiple of 2 so that
326 * we don't get gaps with subsampled sources (e.g. YUV420)
328 if (out_size.width % 2) {
331 if (out_size.height % 2) {
335 _player->set_video_container_size (out_size);
340 FilmViewer::suspend ()
343 if (_audio.isStreamRunning()) {
344 _audio.abortStream();
350 FilmViewer::start_audio_stream_if_open ()
352 if (_audio.isStreamOpen()) {
353 _audio.setStreamTime (_video_view->position().seconds());
355 _audio.startStream ();
356 } catch (RtAudioError& e) {
360 _("There was a problem starting audio playback. Please try another audio output device in Preferences."), std_to_wx(e.what())
368 FilmViewer::resume ()
370 DCPOMATIC_ASSERT (_suspended > 0);
372 if (_playing && !_suspended) {
373 start_audio_stream_if_open ();
374 _video_view->start ();
386 auto v = PlaybackPermitted ();
388 /* Computer says no */
392 /* We are about to set up the audio stream from the position of the video view.
393 If there is `lazy' seek in progress we need to wait for it to go through so that
394 _video_view->position() gives us a sensible answer.
400 /* Take the video view's idea of position as our `playhead' and start the
401 audio stream (which is the timing reference) there.
403 start_audio_stream_if_open ();
406 /* Calling start() below may directly result in Stopped being emitted, and if that
407 * happens we want it to come after the Started signal, so do that first.
410 _video_view->start ();
417 if (_audio.isStreamRunning()) {
418 /* stop stream and discard any remaining queued samples */
419 _audio.abortStream ();
427 _video_view->stop ();
430 _video_view->rethrow ();
436 FilmViewer::player_change (ChangeType type, int property, bool frequent)
438 if (type != ChangeType::DONE || frequent) {
442 if (_coalesce_player_changes) {
443 _pending_player_changes.push_back (property);
447 player_change ({property});
452 FilmViewer::player_change (vector<int> properties)
456 bool try_quick_refresh = false;
457 bool update_ccap_tracks = false;
459 for (auto i: properties) {
461 i == VideoContentProperty::CROP ||
462 i == VideoContentProperty::CUSTOM_RATIO ||
463 i == VideoContentProperty::CUSTOM_SIZE ||
464 i == VideoContentProperty::FADE_IN ||
465 i == VideoContentProperty::FADE_OUT ||
466 i == VideoContentProperty::COLOUR_CONVERSION ||
467 i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
468 i == PlayerProperty::FILM_CONTAINER
470 try_quick_refresh = true;
473 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
474 update_ccap_tracks = true;
478 if (!try_quick_refresh || !quick_refresh()) {
482 if (update_ccap_tracks) {
483 _closed_captions_dialog->update_tracks (_film);
489 FilmViewer::film_change (ChangeType type, Film::Property p)
491 if (type != ChangeType::DONE) {
495 if (p == Film::Property::AUDIO_CHANNELS) {
496 destroy_and_maybe_create_butler();
497 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
498 _video_view->set_video_frame_rate (_film->video_frame_rate());
499 } else if (p == Film::Property::THREE_D) {
500 _video_view->set_three_d (_film->three_d());
501 } else if (p == Film::Property::CONTENT) {
502 _closed_captions_dialog->update_tracks (_film);
508 FilmViewer::film_length_change ()
510 _video_view->set_length (_film->length());
514 /** Re-get the current frame slowly by seeking */
516 FilmViewer::slow_refresh ()
518 seek (_video_view->position(), true);
522 /** Try to re-get the current frame quickly by resetting the metadata
523 * in the PlayerVideo that we used last time.
524 * @return true if this was possible, false if not.
527 FilmViewer::quick_refresh ()
529 if (!_video_view || !_film || !_player) {
532 return _video_view->reset_metadata (_film, _player->video_container_size());
537 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
539 DCPOMATIC_ASSERT(_player);
540 auto dt = _player->content_time_to_dcp (content, t);
542 seek (*dt, accurate);
548 FilmViewer::set_coalesce_player_changes (bool c)
550 _coalesce_player_changes = c;
553 player_change (_pending_player_changes);
554 _pending_player_changes.clear ();
560 FilmViewer::seek (DCPTime t, bool accurate)
570 if (t >= _film->length()) {
571 t = _film->length() - one_video_frame();
576 _closed_captions_dialog->clear ();
577 _butler->seek (t, accurate);
580 /* We're not playing, so let the GUI thread get on and
581 come back later to get the next frame after the seek.
583 request_idle_display_next_frame ();
585 /* We're going to start playing again straight away
586 so wait for the seek to finish.
588 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
596 FilmViewer::config_changed (Config::Property p)
598 if (p == Config::AUDIO_MAPPING) {
599 destroy_and_maybe_create_butler();
603 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
607 if (_audio.isStreamOpen ()) {
608 _audio.closeStream ();
611 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
613 if (Config::instance()->sound_output()) {
614 while (st < _audio.getDeviceCount()) {
616 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
619 } catch (RtAudioError&) {
620 /* Something went wrong with that device so we don't want to use it anyway */
624 if (st == _audio.getDeviceCount()) {
625 st = _audio.getDefaultOutputDevice();
628 st = _audio.getDefaultOutputDevice();
632 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
633 RtAudio::StreamParameters sp;
635 sp.nChannels = _audio_channels;
637 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
638 } catch (RtAudioError& e) {
642 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
645 destroy_and_maybe_create_butler();
649 destroy_and_maybe_create_butler();
655 FilmViewer::uncorrected_time () const
657 if (_audio.isStreamRunning()) {
658 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
661 return _video_view->position();
666 FilmViewer::audio_time () const
668 if (!_audio.isStreamRunning()) {
672 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
673 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
678 FilmViewer::time () const
680 return audio_time().get_value_or(_video_view->position());
685 FilmViewer::audio_callback (void* out_p, unsigned int frames)
688 auto t = _butler->get_audio (Butler::Behaviour::NON_BLOCKING, reinterpret_cast<float*> (out_p), frames);
689 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
690 /* There was an underrun or this audio is on time; carry on */
693 /* The audio we just got was (very) late; drop it and get some more. */
696 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
698 _latency_history.push_back (_audio.getStreamLatency ());
699 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
700 _latency_history.pop_front ();
709 FilmViewer::average_latency () const
711 boost::mutex::scoped_lock lm (_latency_history_mutex);
712 if (_latency_history.empty()) {
717 for (auto i: _latency_history) {
721 return total / _latency_history.size();
726 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
728 _dcp_decode_reduction = reduction;
730 _player->set_dcp_decode_reduction (reduction);
736 FilmViewer::dcp_decode_reduction () const
738 return _dcp_decode_reduction;
742 optional<ContentTime>
743 FilmViewer::position_in_content (shared_ptr<const Content> content) const
745 DCPOMATIC_ASSERT(_player);
746 return _player->dcp_to_content_time (content, position());
751 FilmViewer::one_video_frame () const
753 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
757 /** Open a dialog box showing our film's closed captions */
759 FilmViewer::show_closed_captions ()
761 _closed_captions_dialog->Show();
766 FilmViewer::seek_by (DCPTime by, bool accurate)
768 seek (_video_view->position() + by, accurate);
773 FilmViewer::set_pad_black (bool p)
779 /** Called when a player has finished the current film.
780 * May be called from a non-UI thread.
783 FilmViewer::finished ()
785 emit (boost::bind(&FilmViewer::ui_finished, this));
789 /** Called by finished() in the UI thread */
791 FilmViewer::ui_finished ()
799 FilmViewer::dropped () const
801 return _video_view->dropped ();
806 FilmViewer::errored () const
808 return _video_view->errored ();
813 FilmViewer::gets () const
815 return _video_view->gets ();
820 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
822 emit (boost::bind(boost::ref(ImageChanged), pv));
827 FilmViewer::set_optimise_for_j2k (bool o)
829 _optimise_for_j2k = o;
830 _video_view->set_optimise_for_j2k (o);
835 FilmViewer::set_crop_guess (dcpomatic::Rect<float> crop)
837 if (crop != _crop_guess) {
839 _video_view->update ();
845 FilmViewer::unset_crop_guess ()
847 _crop_guess = boost::none;
848 _video_view->update ();