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"
36 #include "lib/ratio.h"
38 #include "lib/job_manager.h"
39 #include "lib/image.h"
40 #include "lib/exceptions.h"
41 #include "lib/examine_content_job.h"
42 #include "lib/filter.h"
43 #include "lib/player.h"
44 #include "lib/player_video.h"
45 #include "lib/video_content.h"
46 #include "lib/video_decoder.h"
47 #include "lib/timer.h"
48 #include "lib/butler.h"
50 #include "lib/config.h"
51 #include "lib/compose.hpp"
52 #include "lib/dcpomatic_log.h"
53 #include "lib/text_content.h"
55 #include <libavutil/pixfmt.h>
57 #include <dcp/exceptions.h>
58 #include <wx/tglbtn.h>
65 using std::dynamic_pointer_cast;
66 using std::make_shared;
68 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 _video_view->update ();
171 _player = make_shared<Player>(_film, _optimise_for_j2k ? Image::Alignment::COMPACT : Image::Alignment::PADDED);
172 _player->set_fast ();
173 if (_dcp_decode_reduction) {
174 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
176 } catch (bad_alloc &) {
177 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
182 _player->set_always_burn_open_subtitles ();
183 _player->set_play_referenced ();
185 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
186 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
187 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
189 film_change (ChangeType::DONE, Film::Property::VIDEO_FRAME_RATE);
190 film_change (ChangeType::DONE, Film::Property::THREE_D);
191 film_length_change ();
193 /* Keep about 1 second's worth of history samples */
194 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
196 _closed_captions_dialog->update_tracks (_film);
206 FilmViewer::recreate_butler ()
216 #if wxCHECK_VERSION(3, 1, 0)
217 auto const j2k_gl_optimised = dynamic_pointer_cast<GLVideoView>(_video_view) && _optimise_for_j2k;
219 auto const j2k_gl_optimised = false;
222 _butler = std::make_shared<Butler>(
225 Config::instance()->audio_mapping(_audio_channels),
227 bind(&PlayerVideo::force, AV_PIX_FMT_RGB24),
229 j2k_gl_optimised ? Image::Alignment::COMPACT : Image::Alignment::PADDED,
234 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
235 _butler->disable_audio ();
238 _closed_captions_dialog->set_butler (_butler);
245 FilmViewer::set_outline_content (bool o)
247 _outline_content = o;
248 _video_view->update ();
253 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
255 _outline_subtitles = rect;
256 _video_view->update ();
261 FilmViewer::set_eyes (Eyes e)
263 _video_view->set_eyes (e);
269 FilmViewer::video_view_sized ()
272 if (!quick_refresh()) {
279 FilmViewer::calculate_sizes ()
281 if (!_film || !_player) {
285 auto const container = _film->container ();
287 auto const scale = dpi_scale_factor (_video_view->get());
288 int const video_view_width = std::round(_video_view->get()->GetSize().x * scale);
289 int const video_view_height = std::round(_video_view->get()->GetSize().y * scale);
291 auto const view_ratio = float(video_view_width) / video_view_height;
292 auto const film_ratio = container ? container->ratio () : 1.78;
295 if (view_ratio < film_ratio) {
296 /* panel is less widscreen than the film; clamp width */
297 out_size.width = video_view_width;
298 out_size.height = lrintf (out_size.width / film_ratio);
300 /* panel is more widescreen than the film; clamp height */
301 out_size.height = video_view_height;
302 out_size.width = lrintf (out_size.height * film_ratio);
305 /* Catch silly values */
306 out_size.width = max (64, out_size.width);
307 out_size.height = max (64, out_size.height);
309 _player->set_video_container_size (out_size);
314 FilmViewer::suspend ()
317 if (_audio.isStreamRunning()) {
318 _audio.abortStream();
324 FilmViewer::start_audio_stream_if_open ()
326 if (_audio.isStreamOpen()) {
327 _audio.setStreamTime (_video_view->position().seconds());
329 _audio.startStream ();
330 } catch (RtAudioError& e) {
334 _("There was a problem starting audio playback. Please try another audio output device in Preferences."), std_to_wx(e.what())
342 FilmViewer::resume ()
344 DCPOMATIC_ASSERT (_suspended > 0);
346 if (_playing && !_suspended) {
347 start_audio_stream_if_open ();
348 _video_view->start ();
360 auto v = PlaybackPermitted ();
362 /* Computer says no */
366 /* We are about to set up the audio stream from the position of the video view.
367 If there is `lazy' seek in progress we need to wait for it to go through so that
368 _video_view->position() gives us a sensible answer.
374 /* Take the video view's idea of position as our `playhead' and start the
375 audio stream (which is the timing reference) there.
377 start_audio_stream_if_open ();
380 /* Calling start() below may directly result in Stopped being emitted, and if that
381 * happens we want it to come after the Started signal, so do that first.
384 _video_view->start ();
391 if (_audio.isStreamRunning()) {
392 /* stop stream and discard any remaining queued samples */
393 _audio.abortStream ();
401 _video_view->stop ();
404 _video_view->rethrow ();
410 FilmViewer::player_change (ChangeType type, int property, bool frequent)
412 if (type != ChangeType::DONE || frequent) {
416 if (_coalesce_player_changes) {
417 _pending_player_changes.push_back (property);
421 player_change ({property});
426 FilmViewer::player_change (vector<int> properties)
430 bool try_quick_refresh = false;
431 bool update_ccap_tracks = false;
433 for (auto i: properties) {
435 i == VideoContentProperty::CROP ||
436 i == VideoContentProperty::CUSTOM_RATIO ||
437 i == VideoContentProperty::CUSTOM_SIZE ||
438 i == VideoContentProperty::FADE_IN ||
439 i == VideoContentProperty::FADE_OUT ||
440 i == VideoContentProperty::COLOUR_CONVERSION ||
441 i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
442 i == PlayerProperty::FILM_CONTAINER
444 try_quick_refresh = true;
447 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
448 update_ccap_tracks = true;
452 if (!try_quick_refresh || !quick_refresh()) {
456 if (update_ccap_tracks) {
457 _closed_captions_dialog->update_tracks (_film);
463 FilmViewer::film_change (ChangeType type, Film::Property p)
465 if (type != ChangeType::DONE) {
469 if (p == Film::Property::AUDIO_CHANNELS) {
471 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
472 _video_view->set_video_frame_rate (_film->video_frame_rate());
473 } else if (p == Film::Property::THREE_D) {
474 _video_view->set_three_d (_film->three_d());
475 } else if (p == Film::Property::CONTENT) {
476 _closed_captions_dialog->update_tracks (_film);
482 FilmViewer::film_length_change ()
484 _video_view->set_length (_film->length());
488 /** Re-get the current frame slowly by seeking */
490 FilmViewer::slow_refresh ()
492 seek (_video_view->position(), true);
496 /** Try to re-get the current frame quickly by resetting the metadata
497 * in the PlayerVideo that we used last time.
498 * @return true if this was possible, false if not.
501 FilmViewer::quick_refresh ()
503 if (!_video_view || !_film || !_player) {
506 return _video_view->reset_metadata (_film, _player->video_container_size());
511 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
513 auto dt = _player->content_time_to_dcp (content, t);
515 seek (*dt, accurate);
521 FilmViewer::set_coalesce_player_changes (bool c)
523 _coalesce_player_changes = c;
526 player_change (_pending_player_changes);
527 _pending_player_changes.clear ();
533 FilmViewer::seek (DCPTime t, bool accurate)
543 if (t >= _film->length()) {
544 t = _film->length() - one_video_frame();
549 _closed_captions_dialog->clear ();
550 _butler->seek (t, accurate);
553 /* We're not playing, so let the GUI thread get on and
554 come back later to get the next frame after the seek.
556 request_idle_display_next_frame ();
558 /* We're going to start playing again straight away
559 so wait for the seek to finish.
561 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
569 FilmViewer::config_changed (Config::Property p)
571 if (p == Config::AUDIO_MAPPING) {
576 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
580 if (_audio.isStreamOpen ()) {
581 _audio.closeStream ();
584 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
586 if (Config::instance()->sound_output()) {
587 while (st < _audio.getDeviceCount()) {
589 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
592 } catch (RtAudioError&) {
593 /* Something went wrong with that device so we don't want to use it anyway */
597 if (st == _audio.getDeviceCount()) {
598 st = _audio.getDefaultOutputDevice();
601 st = _audio.getDefaultOutputDevice();
605 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
606 RtAudio::StreamParameters sp;
608 sp.nChannels = _audio_channels;
610 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
611 } catch (RtAudioError& e) {
615 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
628 FilmViewer::uncorrected_time () const
630 if (_audio.isStreamRunning()) {
631 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
634 return _video_view->position();
639 FilmViewer::audio_time () const
641 if (!_audio.isStreamRunning()) {
645 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
646 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
651 FilmViewer::time () const
653 return audio_time().get_value_or(_video_view->position());
658 FilmViewer::audio_callback (void* out_p, unsigned int frames)
661 auto t = _butler->get_audio (Butler::Behaviour::NON_BLOCKING, reinterpret_cast<float*> (out_p), frames);
662 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
663 /* There was an underrun or this audio is on time; carry on */
666 /* The audio we just got was (very) late; drop it and get some more. */
669 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
671 _latency_history.push_back (_audio.getStreamLatency ());
672 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
673 _latency_history.pop_front ();
682 FilmViewer::average_latency () const
684 boost::mutex::scoped_lock lm (_latency_history_mutex);
685 if (_latency_history.empty()) {
690 for (auto i: _latency_history) {
694 return total / _latency_history.size();
699 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
701 _dcp_decode_reduction = reduction;
703 _player->set_dcp_decode_reduction (reduction);
709 FilmViewer::dcp_decode_reduction () const
711 return _dcp_decode_reduction;
715 optional<ContentTime>
716 FilmViewer::position_in_content (shared_ptr<const Content> content) const
718 return _player->dcp_to_content_time (content, position());
723 FilmViewer::one_video_frame () const
725 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
729 /** Open a dialog box showing our film's closed captions */
731 FilmViewer::show_closed_captions ()
733 _closed_captions_dialog->Show();
738 FilmViewer::seek_by (DCPTime by, bool accurate)
740 seek (_video_view->position() + by, accurate);
745 FilmViewer::set_pad_black (bool p)
751 /** Called when a player has finished the current film.
752 * May be called from a non-UI thread.
755 FilmViewer::finished ()
757 emit (boost::bind(&FilmViewer::ui_finished, this));
761 /** Called by finished() in the UI thread */
763 FilmViewer::ui_finished ()
771 FilmViewer::dropped () const
773 return _video_view->dropped ();
778 FilmViewer::errored () const
780 return _video_view->errored ();
785 FilmViewer::gets () const
787 return _video_view->gets ();
792 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
794 emit (boost::bind(boost::ref(ImageChanged), pv));
799 FilmViewer::set_optimise_for_j2k (bool o)
801 _optimise_for_j2k = o;
802 _video_view->set_optimise_for_j2k (o);
807 FilmViewer::set_crop_guess (Rect<float> crop)
809 if (crop != _crop_guess) {
811 _video_view->update ();
817 FilmViewer::unset_crop_guess ()
820 _video_view->update ();