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[VideoType::MAIN] = std::make_shared<GLVideoView>(this, VideoType::MAIN, p);
98 _video_view[VideoType::SIGN_LANGUAGE] = std::make_shared<GLVideoView>(this, VideoType::SIGN_LANGUAGE, _sign_language_dialog);
100 case Config::VIDEO_VIEW_SIMPLE:
101 _video_view[VideoType::MAIN] = std::make_shared<SimpleVideoView>(this, VideoType::MAIN, p);
102 _video_view[VideoType::SIGN_LANGUAGE] = std::make_shared<SimpleVideoView>(this, VideoType::SIGN_LANGUAGE, _sign_language_dialog);
106 _video_view = std::make_shared<SimpleVideoView>(this, p);
109 _video_view[VideoType::MAIN]->Sized.connect(boost::bind(&FilmViewer::video_view_sized, this, VideoType::MAIN));
110 _video_view[VideoType::SIGN_LANGUAGE]->Sized.connect(boost::bind(&FilmViewer::video_view_sized, this, VideoType::SIGN_LANGUAGE));
111 _video_view[VideoType::MAIN]->TooManyDropped.connect(boost::bind(boost::ref(TooManyDropped)));
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);
120 FilmViewer::~FilmViewer ()
126 /** Ask for ::idle_handler() to be called next time we are idle */
128 FilmViewer::request_idle_display_next_frame ()
135 DCPOMATIC_ASSERT (signal_manager);
136 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
141 FilmViewer::idle_handler ()
147 if (_video_view[VideoType::MAIN]->display_next_frame(true) == VideoView::AGAIN) {
148 /* get() could not complete quickly so we'll try again later */
149 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
157 FilmViewer::set_film (shared_ptr<Film> film)
165 _video_view[VideoType::MAIN]->clear();
166 _video_view[VideoType::SIGN_LANGUAGE]->clear();
167 _closed_captions_dialog->clear ();
172 _player = boost::none;
174 _video_view[VideoType::MAIN]->update();
175 _video_view[VideoType::SIGN_LANGUAGE]->update();
180 _player.emplace(_film, _optimise_for_j2k ? Image::Alignment::COMPACT : Image::Alignment::PADDED);
181 _player->set_fast ();
182 if (_dcp_decode_reduction) {
183 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
185 } catch (bad_alloc &) {
186 error_dialog(_video_view[VideoType::MAIN]->get(), _("There is not enough free memory to do that."));
192 _player->set_always_burn_open_subtitles ();
193 _player->set_play_referenced ();
195 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
196 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
197 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
199 film_change (ChangeType::DONE, Film::Property::VIDEO_FRAME_RATE);
200 film_change (ChangeType::DONE, Film::Property::THREE_D);
201 film_length_change ();
203 /* Keep about 1 second's worth of history samples */
204 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
206 _closed_captions_dialog->update_tracks (_film);
216 FilmViewer::destroy_butler()
224 FilmViewer::destroy_and_maybe_create_butler()
238 FilmViewer::create_butler()
240 #if wxCHECK_VERSION(3, 1, 0)
241 auto const j2k_gl_optimised = dynamic_pointer_cast<GLVideoView>(_video_view[VideoType::MAIN]) && _optimise_for_j2k;
243 auto const j2k_gl_optimised = false;
246 DCPOMATIC_ASSERT(_player);
248 _butler = std::make_shared<Butler>(
251 Config::instance()->audio_mapping(_audio_channels),
253 boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24),
255 j2k_gl_optimised ? Image::Alignment::COMPACT : Image::Alignment::PADDED,
258 (Config::instance()->sound() && _audio.isStreamOpen()) ? Butler::Audio::ENABLED : Butler::Audio::DISABLED
261 _closed_captions_dialog->set_butler (_butler);
268 FilmViewer::set_outline_content (bool o)
270 _outline_content = o;
271 _video_view[VideoType::MAIN]->update();
276 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
278 _outline_subtitles = rect;
279 _video_view[VideoType::MAIN]->update();
284 FilmViewer::set_eyes (Eyes e)
286 _video_view[VideoType::MAIN]->set_eyes(e);
292 FilmViewer::video_view_sized(VideoType)
295 if (!quick_refresh()) {
302 FilmViewer::calculate_sizes ()
304 if (!_film || !_player) {
308 auto set_sizes = [this](VideoType type, float ratio) {
309 auto const scale = dpi_scale_factor(_video_view[type]->get());
310 int const video_view_width = std::round(_video_view[type]->get()->GetSize().x * scale);
311 int const video_view_height = std::round(_video_view[type]->get()->GetSize().y * scale);
313 auto const view_ratio = float(video_view_width) / video_view_height;
316 if (view_ratio < ratio) {
317 /* panel is less widescreen than the film; clamp width */
318 out_size.width = video_view_width;
319 out_size.height = lrintf(out_size.width / ratio);
321 /* panel is more widescreen than the film; clamp height */
322 out_size.height = video_view_height;
323 out_size.width = lrintf(out_size.height * ratio);
326 /* Catch silly values */
327 out_size.width = max (64, out_size.width);
328 out_size.height = max (64, out_size.height);
330 /* Make sure the video container sizes are always a multiple of 2 so that
331 * we don't get gaps with subsampled sources (e.g. YUV420)
333 if (out_size.width % 2) {
336 if (out_size.height % 2) {
340 _player->set_video_container_size(type, out_size);
343 set_sizes(VideoType::MAIN, _film->container() ? _film->container()->ratio() : 1.78);
344 set_sizes(VideoType::SIGN_LANGUAGE, 480.0 / 640.0);
349 FilmViewer::suspend ()
352 if (_audio.isStreamRunning()) {
353 _audio.abortStream();
359 FilmViewer::start_audio_stream_if_open ()
361 if (_audio.isStreamOpen()) {
362 _audio.setStreamTime(_video_view[VideoType::MAIN]->position().seconds());
364 _audio.startStream ();
365 } catch (RtAudioError& e) {
368 _video_view[VideoType::MAIN]->get(),
369 _("There was a problem starting audio playback. Please try another audio output device in Preferences."), std_to_wx(e.what())
377 FilmViewer::resume ()
379 DCPOMATIC_ASSERT (_suspended > 0);
381 if (_playing && !_suspended) {
382 start_audio_stream_if_open ();
383 _video_view[VideoType::MAIN]->start();
384 _video_view[VideoType::SIGN_LANGUAGE]->start();
396 auto v = PlaybackPermitted ();
398 /* Computer says no */
402 /* We are about to set up the audio stream from the position of the video view.
403 If there is `lazy' seek in progress we need to wait for it to go through so that
404 _video_view->position() gives us a sensible answer.
410 /* Take the video view's idea of position as our `playhead' and start the
411 audio stream (which is the timing reference) there.
413 start_audio_stream_if_open ();
416 /* Calling start() below may directly result in Stopped being emitted, and if that
417 * happens we want it to come after the Started signal, so do that first.
420 _video_view[VideoType::MAIN]->start();
421 _video_view[VideoType::SIGN_LANGUAGE]->start();
428 if (_audio.isStreamRunning()) {
429 /* stop stream and discard any remaining queued samples */
430 _audio.abortStream ();
438 _video_view[VideoType::MAIN]->stop();
439 _video_view[VideoType::SIGN_LANGUAGE]->stop();
442 _video_view[VideoType::MAIN]->rethrow();
443 _video_view[VideoType::SIGN_LANGUAGE]->rethrow();
449 FilmViewer::player_change (ChangeType type, int property, bool frequent)
451 if (type != ChangeType::DONE || frequent) {
455 if (_coalesce_player_changes) {
456 _pending_player_changes.push_back (property);
460 player_change ({property});
465 FilmViewer::player_change (vector<int> properties)
469 bool try_quick_refresh = false;
470 bool update_ccap_tracks = false;
472 for (auto i: properties) {
474 i == VideoContentProperty::CROP ||
475 i == VideoContentProperty::CUSTOM_RATIO ||
476 i == VideoContentProperty::CUSTOM_SIZE ||
477 i == VideoContentProperty::FADE_IN ||
478 i == VideoContentProperty::FADE_OUT ||
479 i == VideoContentProperty::COLOUR_CONVERSION ||
480 i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
481 i == PlayerProperty::FILM_CONTAINER
483 try_quick_refresh = true;
486 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
487 update_ccap_tracks = true;
491 if (!try_quick_refresh || !quick_refresh()) {
495 if (update_ccap_tracks) {
496 _closed_captions_dialog->update_tracks (_film);
502 FilmViewer::film_change (ChangeType type, Film::Property p)
504 if (type != ChangeType::DONE) {
508 if (p == Film::Property::AUDIO_CHANNELS) {
509 destroy_and_maybe_create_butler();
510 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
511 _video_view[VideoType::MAIN]->set_video_frame_rate(_film->video_frame_rate());
512 _video_view[VideoType::SIGN_LANGUAGE]->set_video_frame_rate(_film->video_frame_rate());
513 } else if (p == Film::Property::THREE_D) {
514 _video_view[VideoType::MAIN]->set_three_d(_film->three_d());
515 } else if (p == Film::Property::CONTENT) {
516 _closed_captions_dialog->update_tracks (_film);
522 FilmViewer::film_length_change ()
524 _video_view[VideoType::MAIN]->set_length(_film->length());
525 _video_view[VideoType::SIGN_LANGUAGE]->set_length(_film->length());
529 /** Re-get the current frame slowly by seeking */
531 FilmViewer::slow_refresh ()
533 seek(_video_view[VideoType::MAIN]->position(), true);
537 /** Try to re-get the current frame quickly by resetting the metadata
538 * in the PlayerVideo that we used last time.
539 * @return true if this was possible, false if not.
542 FilmViewer::quick_refresh ()
544 if (!_video_view[VideoType::MAIN] || !_film || !_player) {
547 return _video_view[VideoType::MAIN]->reset_metadata(_film, _player->video_container_size(VideoType::MAIN));
552 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
554 DCPOMATIC_ASSERT(_player);
555 auto dt = _player->content_time_to_dcp (content, t);
557 seek (*dt, accurate);
563 FilmViewer::set_coalesce_player_changes (bool c)
565 _coalesce_player_changes = c;
568 player_change (_pending_player_changes);
569 _pending_player_changes.clear ();
575 FilmViewer::seek (DCPTime t, bool accurate)
585 if (t >= _film->length()) {
586 t = _film->length() - one_video_frame();
591 _closed_captions_dialog->clear ();
592 _butler->seek (t, accurate);
595 /* We're not playing, so let the GUI thread get on and
596 come back later to get the next frame after the seek.
598 request_idle_display_next_frame ();
600 /* We're going to start playing again straight away
601 so wait for the seek to finish.
603 while (_video_view[VideoType::MAIN]->display_next_frame(false) == VideoView::AGAIN) {}
611 FilmViewer::config_changed (Config::Property p)
613 if (p == Config::AUDIO_MAPPING) {
614 destroy_and_maybe_create_butler();
618 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
622 if (_audio.isStreamOpen ()) {
623 _audio.closeStream ();
626 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
628 if (Config::instance()->sound_output()) {
629 while (st < _audio.getDeviceCount()) {
631 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
634 } catch (RtAudioError&) {
635 /* Something went wrong with that device so we don't want to use it anyway */
639 if (st == _audio.getDeviceCount()) {
640 st = _audio.getDefaultOutputDevice();
643 st = _audio.getDefaultOutputDevice();
647 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
648 RtAudio::StreamParameters sp;
650 sp.nChannels = _audio_channels;
652 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
653 } catch (RtAudioError& e) {
656 _video_view[VideoType::MAIN]->get(),
657 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
660 destroy_and_maybe_create_butler();
664 destroy_and_maybe_create_butler();
670 FilmViewer::uncorrected_time () const
672 if (_audio.isStreamRunning()) {
673 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
676 return _video_view[VideoType::MAIN]->position();
681 FilmViewer::audio_time () const
683 if (!_audio.isStreamRunning()) {
687 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
688 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
693 FilmViewer::time () const
695 return audio_time().get_value_or(_video_view[VideoType::MAIN]->position());
700 FilmViewer::audio_callback (void* out_p, unsigned int frames)
703 auto t = _butler->get_audio (Butler::Behaviour::NON_BLOCKING, reinterpret_cast<float*> (out_p), frames);
704 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
705 /* There was an underrun or this audio is on time; carry on */
708 /* The audio we just got was (very) late; drop it and get some more. */
711 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
713 _latency_history.push_back (_audio.getStreamLatency ());
714 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
715 _latency_history.pop_front ();
724 FilmViewer::average_latency () const
726 boost::mutex::scoped_lock lm (_latency_history_mutex);
727 if (_latency_history.empty()) {
732 for (auto i: _latency_history) {
736 return total / _latency_history.size();
741 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
743 _dcp_decode_reduction = reduction;
745 _player->set_dcp_decode_reduction (reduction);
751 FilmViewer::dcp_decode_reduction () const
753 return _dcp_decode_reduction;
757 optional<ContentTime>
758 FilmViewer::position_in_content (shared_ptr<const Content> content) const
760 DCPOMATIC_ASSERT(_player);
761 return _player->dcp_to_content_time (content, position());
766 FilmViewer::one_video_frame () const
768 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
772 /** Open a dialog box showing our film's closed captions */
774 FilmViewer::show_closed_captions ()
776 _closed_captions_dialog->Show();
781 FilmViewer::show_sign_language()
783 _sign_language_dialog->Show();
788 FilmViewer::seek_by (DCPTime by, bool accurate)
790 seek(_video_view[VideoType::MAIN]->position() + by, accurate);
795 FilmViewer::set_pad_black (bool p)
801 /** Called when a player has finished the current film.
802 * May be called from a non-UI thread.
805 FilmViewer::finished ()
807 emit (boost::bind(&FilmViewer::ui_finished, this));
811 /** Called by finished() in the UI thread */
813 FilmViewer::ui_finished ()
821 FilmViewer::dropped () const
823 return _video_view[VideoType::MAIN]->dropped();
828 FilmViewer::errored () const
830 return _video_view[VideoType::MAIN]->errored();
835 FilmViewer::gets () const
837 return _video_view[VideoType::MAIN]->gets();
842 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
844 emit (boost::bind(boost::ref(ImageChanged), pv));
849 FilmViewer::set_optimise_for_j2k (bool o)
851 _optimise_for_j2k = o;
852 _video_view[VideoType::MAIN]->set_optimise_for_j2k(o);
857 FilmViewer::set_crop_guess (dcpomatic::Rect<float> crop)
859 if (crop != _crop_guess) {
861 _video_view[VideoType::MAIN]->update();
867 FilmViewer::unset_crop_guess ()
869 _crop_guess = boost::none;
870 _video_view[VideoType::MAIN]->update();
874 optional<dcpomatic::Rect<float>>
875 FilmViewer::crop_guess(VideoType type) const
877 if (type != VideoType::MAIN) {
885 optional<dcpomatic::Rect<double>>
886 FilmViewer::outline_subtitles(VideoType type) const
888 if (type != VideoType::MAIN) {
892 return _outline_subtitles;