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 #if (RTAUDIO_VERSION_MAJOR >= 6)
90 : _audio(DCPOMATIC_RTAUDIO_API, boost::bind(&FilmViewer::rtaudio_error_callback, this, _2))
92 : _audio (DCPOMATIC_RTAUDIO_API)
94 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
96 #if wxCHECK_VERSION(3, 1, 0)
97 switch (Config::instance()->video_view_type()) {
98 case Config::VIDEO_VIEW_OPENGL:
99 _video_view = std::make_shared<GLVideoView>(this, p);
101 case Config::VIDEO_VIEW_SIMPLE:
102 _video_view = std::make_shared<SimpleVideoView>(this, p);
106 _video_view = std::make_shared<SimpleVideoView>(this, p);
109 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
110 _video_view->TooManyDropped.connect (boost::bind(boost::ref(TooManyDropped)));
112 set_film (shared_ptr<Film>());
114 _config_changed_connection = Config::instance()->Changed.connect(bind(&FilmViewer::config_changed, this, _1));
115 config_changed (Config::SOUND_OUTPUT);
119 FilmViewer::~FilmViewer ()
125 /** Ask for ::idle_handler() to be called next time we are idle */
127 FilmViewer::request_idle_display_next_frame ()
134 DCPOMATIC_ASSERT (signal_manager);
135 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
140 FilmViewer::idle_handler ()
146 if (_video_view->display_next_frame(true) == VideoView::AGAIN) {
147 /* get() could not complete quickly so we'll try again later */
148 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
156 FilmViewer::set_film (shared_ptr<Film> film)
164 _video_view->clear ();
165 _closed_captions_dialog->clear ();
170 _player = boost::none;
172 _video_view->update ();
177 _player.emplace(_film, _optimise_for_j2k ? Image::Alignment::COMPACT : Image::Alignment::PADDED);
178 _player->set_fast ();
179 if (_dcp_decode_reduction) {
180 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
182 } catch (bad_alloc &) {
183 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
189 _player->set_always_burn_open_subtitles ();
190 _player->set_play_referenced ();
192 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
193 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
194 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
196 film_change(ChangeType::DONE, FilmProperty::VIDEO_FRAME_RATE);
197 film_change(ChangeType::DONE, FilmProperty::THREE_D);
198 film_length_change ();
200 /* Keep about 1 second's worth of history samples */
201 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
203 _closed_captions_dialog->update_tracks (_film);
213 FilmViewer::destroy_butler()
221 FilmViewer::destroy_and_maybe_create_butler()
235 FilmViewer::create_butler()
237 #if wxCHECK_VERSION(3, 1, 0)
238 auto const j2k_gl_optimised = dynamic_pointer_cast<GLVideoView>(_video_view) && _optimise_for_j2k;
240 auto const j2k_gl_optimised = false;
243 DCPOMATIC_ASSERT(_player);
245 _butler = std::make_shared<Butler>(
248 Config::instance()->audio_mapping(_audio_channels),
250 boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24),
252 j2k_gl_optimised ? Image::Alignment::COMPACT : Image::Alignment::PADDED,
255 (Config::instance()->sound() && _audio.isStreamOpen()) ? Butler::Audio::ENABLED : Butler::Audio::DISABLED
258 _closed_captions_dialog->set_butler (_butler);
265 FilmViewer::set_outline_content (bool o)
267 _outline_content = o;
268 _video_view->update ();
273 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
275 _outline_subtitles = rect;
276 _video_view->update ();
281 FilmViewer::set_eyes (Eyes e)
283 _video_view->set_eyes (e);
289 FilmViewer::video_view_sized ()
292 if (!quick_refresh()) {
299 FilmViewer::calculate_sizes ()
301 if (!_film || !_player) {
305 auto const container = _film->container ();
307 auto const scale = dpi_scale_factor (_video_view->get());
308 int const video_view_width = std::round(_video_view->get()->GetSize().x * scale);
309 int const video_view_height = std::round(_video_view->get()->GetSize().y * scale);
311 auto const view_ratio = float(video_view_width) / video_view_height;
312 auto const film_ratio = container ? container->ratio () : 1.78;
315 if (view_ratio < film_ratio) {
316 /* panel is less widscreen than the film; clamp width */
317 out_size.width = video_view_width;
318 out_size.height = lrintf (out_size.width / film_ratio);
320 /* panel is more widescreen than the film; clamp height */
321 out_size.height = video_view_height;
322 out_size.width = lrintf (out_size.height * film_ratio);
325 /* Catch silly values */
326 out_size.width = max (64, out_size.width);
327 out_size.height = max (64, out_size.height);
329 /* Make sure the video container sizes are always a multiple of 2 so that
330 * we don't get gaps with subsampled sources (e.g. YUV420)
332 if (out_size.width % 2) {
335 if (out_size.height % 2) {
339 _player->set_video_container_size (out_size);
344 FilmViewer::suspend ()
347 if (_audio.isStreamRunning()) {
348 _audio.abortStream();
354 FilmViewer::start_audio_stream_if_open ()
356 if (_audio.isStreamOpen()) {
357 _audio.setStreamTime (_video_view->position().seconds());
358 #if (RTAUDIO_VERSION_MAJOR >= 6)
359 if (_audio.startStream() != RTAUDIO_NO_ERROR) {
363 _("There was a problem starting audio playback. Please try another audio output device in Preferences."), std_to_wx(last_rtaudio_error())
368 _audio.startStream ();
369 } catch (RtAudioError& e) {
373 _("There was a problem starting audio playback. Please try another audio output device in Preferences."), std_to_wx(e.what())
382 FilmViewer::resume ()
384 DCPOMATIC_ASSERT (_suspended > 0);
386 if (_playing && !_suspended) {
387 start_audio_stream_if_open ();
388 _video_view->start ();
400 auto v = PlaybackPermitted ();
402 /* Computer says no */
406 /* We are about to set up the audio stream from the position of the video view.
407 If there is `lazy' seek in progress we need to wait for it to go through so that
408 _video_view->position() gives us a sensible answer.
414 /* Take the video view's idea of position as our `playhead' and start the
415 audio stream (which is the timing reference) there.
417 start_audio_stream_if_open ();
420 /* Calling start() below may directly result in Stopped being emitted, and if that
421 * happens we want it to come after the Started signal, so do that first.
424 _video_view->start ();
431 if (_audio.isStreamRunning()) {
432 /* stop stream and discard any remaining queued samples */
433 _audio.abortStream ();
441 _video_view->stop ();
444 _video_view->rethrow ();
450 FilmViewer::player_change (ChangeType type, int property, bool frequent)
452 if (type != ChangeType::DONE || frequent) {
456 if (_coalesce_player_changes) {
457 _pending_player_changes.push_back (property);
461 player_change ({property});
466 FilmViewer::player_change (vector<int> properties)
470 bool try_quick_refresh = false;
471 bool update_ccap_tracks = false;
473 for (auto i: properties) {
475 i == VideoContentProperty::CROP ||
476 i == VideoContentProperty::CUSTOM_RATIO ||
477 i == VideoContentProperty::CUSTOM_SIZE ||
478 i == VideoContentProperty::FADE_IN ||
479 i == VideoContentProperty::FADE_OUT ||
480 i == VideoContentProperty::COLOUR_CONVERSION ||
481 i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
482 i == PlayerProperty::FILM_CONTAINER
484 try_quick_refresh = true;
487 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
488 update_ccap_tracks = true;
492 if (!try_quick_refresh || !quick_refresh()) {
496 if (update_ccap_tracks) {
497 _closed_captions_dialog->update_tracks (_film);
503 FilmViewer::film_change(ChangeType type, FilmProperty p)
505 if (type != ChangeType::DONE) {
509 if (p == FilmProperty::AUDIO_CHANNELS) {
510 destroy_and_maybe_create_butler();
511 } else if (p == FilmProperty::VIDEO_FRAME_RATE) {
512 _video_view->set_video_frame_rate (_film->video_frame_rate());
513 } else if (p == FilmProperty::THREE_D) {
514 _video_view->set_three_d (_film->three_d());
515 } else if (p == FilmProperty::CONTENT) {
516 _closed_captions_dialog->update_tracks (_film);
522 FilmViewer::film_length_change ()
524 _video_view->set_length (_film->length());
528 /** Re-get the current frame slowly by seeking */
530 FilmViewer::slow_refresh ()
532 seek (_video_view->position(), true);
536 /** Try to re-get the current frame quickly by resetting the metadata
537 * in the PlayerVideo that we used last time.
538 * @return true if this was possible, false if not.
541 FilmViewer::quick_refresh ()
543 if (!_video_view || !_film || !_player) {
546 return _video_view->reset_metadata (_film, _player->video_container_size());
551 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
553 DCPOMATIC_ASSERT(_player);
554 auto dt = _player->content_time_to_dcp (content, t);
556 seek (*dt, accurate);
562 FilmViewer::set_coalesce_player_changes (bool c)
564 _coalesce_player_changes = c;
567 player_change (_pending_player_changes);
568 _pending_player_changes.clear ();
574 FilmViewer::seek (DCPTime t, bool accurate)
584 if (t >= _film->length()) {
585 t = _film->length() - one_video_frame();
590 _closed_captions_dialog->clear ();
591 _butler->seek (t, accurate);
594 /* We're not playing, so let the GUI thread get on and
595 come back later to get the next frame after the seek.
597 request_idle_display_next_frame ();
599 /* We're going to start playing again straight away
600 so wait for the seek to finish.
602 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
610 FilmViewer::config_changed (Config::Property p)
612 if (p == Config::AUDIO_MAPPING) {
613 destroy_and_maybe_create_butler();
617 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
621 if (_audio.isStreamOpen ()) {
622 _audio.closeStream ();
625 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
626 optional<unsigned int> chosen_device_id;
627 #if (RTAUDIO_VERSION_MAJOR >= 6)
628 if (Config::instance()->sound_output()) {
629 for (auto device_id: _audio.getDeviceIds()) {
630 if (_audio.getDeviceInfo(device_id).name == Config::instance()->sound_output().get()) {
631 chosen_device_id = device_id;
637 if (!chosen_device_id) {
638 chosen_device_id = _audio.getDefaultOutputDevice();
640 _audio_channels = _audio.getDeviceInfo(*chosen_device_id).outputChannels;
641 RtAudio::StreamParameters sp;
642 sp.deviceId = *chosen_device_id;
643 sp.nChannels = _audio_channels;
645 if (_audio.openStream(&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this) != RTAUDIO_NO_ERROR) {
649 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(last_rtaudio_error())
654 if (Config::instance()->sound_output()) {
655 while (st < _audio.getDeviceCount()) {
657 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
660 } catch (RtAudioError&) {
661 /* Something went wrong with that device so we don't want to use it anyway */
665 if (st == _audio.getDeviceCount()) {
667 st = _audio.getDefaultOutputDevice();
668 } catch (RtAudioError&) {
669 /* Something went wrong with that device so we don't want to use it anyway */
674 st = _audio.getDefaultOutputDevice();
675 } catch (RtAudioError&) {
676 /* Something went wrong with that device so we don't want to use it anyway */
681 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
682 RtAudio::StreamParameters sp;
684 sp.nChannels = _audio_channels;
686 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
687 } catch (RtAudioError& e) {
691 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
695 destroy_and_maybe_create_butler();
699 destroy_and_maybe_create_butler();
705 FilmViewer::uncorrected_time () const
707 if (_audio.isStreamRunning()) {
708 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
711 return _video_view->position();
716 FilmViewer::audio_time () const
718 if (!_audio.isStreamRunning()) {
722 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
723 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
728 FilmViewer::time () const
730 return audio_time().get_value_or(_video_view->position());
735 FilmViewer::audio_callback (void* out_p, unsigned int frames)
738 auto t = _butler->get_audio (Butler::Behaviour::NON_BLOCKING, reinterpret_cast<float*> (out_p), frames);
739 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
740 /* There was an underrun or this audio is on time; carry on */
743 /* The audio we just got was (very) late; drop it and get some more. */
746 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
748 _latency_history.push_back (_audio.getStreamLatency ());
749 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
750 _latency_history.pop_front ();
759 FilmViewer::average_latency () const
761 boost::mutex::scoped_lock lm (_latency_history_mutex);
762 if (_latency_history.empty()) {
767 for (auto i: _latency_history) {
771 return total / _latency_history.size();
776 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
778 _dcp_decode_reduction = reduction;
780 _player->set_dcp_decode_reduction (reduction);
786 FilmViewer::dcp_decode_reduction () const
788 return _dcp_decode_reduction;
792 optional<ContentTime>
793 FilmViewer::position_in_content (shared_ptr<const Content> content) const
795 DCPOMATIC_ASSERT(_player);
796 return _player->dcp_to_content_time (content, position());
801 FilmViewer::one_video_frame () const
803 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
807 /** Open a dialog box showing our film's closed captions */
809 FilmViewer::show_closed_captions ()
811 _closed_captions_dialog->Show();
816 FilmViewer::seek_by (DCPTime by, bool accurate)
818 seek (_video_view->position() + by, accurate);
823 FilmViewer::set_pad_black (bool p)
829 /** Called when a player has finished the current film.
830 * May be called from a non-UI thread.
833 FilmViewer::finished ()
835 emit (boost::bind(&FilmViewer::ui_finished, this));
839 /** Called by finished() in the UI thread */
841 FilmViewer::ui_finished ()
849 FilmViewer::dropped () const
851 return _video_view->dropped ();
856 FilmViewer::errored () const
858 return _video_view->errored ();
863 FilmViewer::gets () const
865 return _video_view->gets ();
870 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
872 emit (boost::bind(boost::ref(ImageChanged), pv));
877 FilmViewer::set_optimise_for_j2k (bool o)
879 _optimise_for_j2k = o;
880 _video_view->set_optimise_for_j2k (o);
885 FilmViewer::set_crop_guess (dcpomatic::Rect<float> crop)
887 if (crop != _crop_guess) {
889 _video_view->update ();
895 FilmViewer::unset_crop_guess ()
897 _crop_guess = boost::none;
898 _video_view->update ();
902 #if (RTAUDIO_VERSION_MAJOR >= 6)
904 FilmViewer::rtaudio_error_callback(string const& error)
906 boost::mutex::scoped_lock lm(_last_rtaudio_error_mutex);
907 _last_rtaudio_error = error;
912 FilmViewer::last_rtaudio_error() const
914 boost::mutex::scoped_lock lm(_last_rtaudio_error_mutex);
915 return _last_rtaudio_error;