2 Copyright (C) 2012-2019 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/>.
21 /** @file src/film_viewer.cc
22 * @brief A wx widget to view a preview of a Film.
25 #include "film_viewer.h"
26 #include "playhead_to_timecode_dialog.h"
27 #include "playhead_to_frame_dialog.h"
29 #include "closed_captions_dialog.h"
30 #include "gl_video_view.h"
31 #include "simple_video_view.h"
33 #include "lib/ratio.h"
35 #include "lib/job_manager.h"
36 #include "lib/image.h"
37 #include "lib/exceptions.h"
38 #include "lib/examine_content_job.h"
39 #include "lib/filter.h"
40 #include "lib/player.h"
41 #include "lib/player_video.h"
42 #include "lib/video_content.h"
43 #include "lib/video_decoder.h"
44 #include "lib/timer.h"
45 #include "lib/butler.h"
47 #include "lib/config.h"
48 #include "lib/compose.hpp"
49 #include "lib/dcpomatic_log.h"
50 #include "lib/text_content.h"
52 #include <libavutil/pixfmt.h>
54 #include <dcp/exceptions.h>
55 #include <wx/tglbtn.h>
68 using boost::shared_ptr;
69 using boost::dynamic_pointer_cast;
70 using boost::weak_ptr;
71 using boost::optional;
72 #if BOOST_VERSION >= 106100
73 using namespace boost::placeholders;
76 using namespace dcpomatic;
80 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
82 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
85 FilmViewer::FilmViewer (wxWindow* p)
86 : _coalesce_player_changes (false)
87 , _audio (DCPOMATIC_RTAUDIO_API)
89 , _audio_block_size (1024)
92 , _latency_history_count (0)
93 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
94 , _outline_content (false)
96 #ifdef DCPOMATIC_VARIANT_SWAROOP
97 , _background_image (false)
101 switch (Config::instance()->video_view_type()) {
102 case Config::VIDEO_VIEW_OPENGL:
103 _video_view = new GLVideoView (this, p);
105 case Config::VIDEO_VIEW_SIMPLE:
106 _video_view = new SimpleVideoView (this, p);
110 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
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);
118 FilmViewer::~FilmViewer ()
123 /** Ask for ::get() 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));
137 FilmViewer::idle_handler ()
143 if (_video_view->display_next_frame(true)) {
146 /* get() could not complete quickly so we'll try again later */
147 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.reset (new Player(_film));
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->ContentChange.connect (boost::bind(&FilmViewer::content_change, this, _1, _3));
187 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
188 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
190 film_change (CHANGE_TYPE_DONE, Film::VIDEO_FRAME_RATE);
191 film_change (CHANGE_TYPE_DONE, Film::THREE_D);
192 film_length_change ();
194 /* Keep about 1 second's worth of history samples */
195 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
197 _closed_captions_dialog->update_tracks (_film);
206 FilmViewer::recreate_butler ()
219 Config::instance()->audio_mapping(_audio_channels),
221 bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
227 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
228 _butler->disable_audio ();
231 _closed_captions_dialog->set_butler (_butler);
237 FilmViewer::set_outline_content (bool o)
239 _outline_content = o;
240 _video_view->update ();
245 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double> > rect)
247 _outline_subtitles = rect;
248 _video_view->update ();
253 FilmViewer::set_eyes (Eyes e)
255 _video_view->set_eyes (e);
260 FilmViewer::video_view_sized ()
263 if (!quick_refresh()) {
269 FilmViewer::calculate_sizes ()
271 if (!_film || !_player) {
275 Ratio const * container = _film->container ();
277 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
278 float const film_ratio = container ? container->ratio () : 1.78;
280 if (view_ratio < film_ratio) {
281 /* panel is less widscreen than the film; clamp width */
282 _out_size.width = _video_view->get()->GetSize().x;
283 _out_size.height = lrintf (_out_size.width / film_ratio);
285 /* panel is more widescreen than the film; clamp height */
286 _out_size.height = _video_view->get()->GetSize().y;
287 _out_size.width = lrintf (_out_size.height * film_ratio);
290 /* Catch silly values */
291 _out_size.width = max (64, _out_size.width);
292 _out_size.height = max (64, _out_size.height);
294 _player->set_video_container_size (_out_size);
298 FilmViewer::suspend ()
301 if (_audio.isStreamRunning()) {
302 _audio.abortStream();
307 FilmViewer::resume ()
309 DCPOMATIC_ASSERT (_suspended > 0);
311 if (_playing && !_suspended) {
312 if (_audio.isStreamOpen()) {
313 _audio.setStreamTime (_video_view->position().seconds());
314 _audio.startStream ();
316 _video_view->start ();
327 optional<bool> v = PlaybackPermitted ();
329 /* Computer says no */
333 /* We are about to set up the audio stream from the position of the video view.
334 If there is `lazy' seek in progress we need to wait for it to go through so that
335 _video_view->position() gives us a sensible answer.
341 /* Take the video view's idea of position as our `playhead' and start the
342 audio stream (which is the timing reference) there.
344 if (_audio.isStreamOpen()) {
345 _audio.setStreamTime (_video_view->position().seconds());
346 _audio.startStream ();
350 _video_view->start ();
351 Started (position());
357 if (_audio.isStreamRunning()) {
358 /* stop stream and discard any remaining queued samples */
359 _audio.abortStream ();
367 _video_view->stop ();
368 Stopped (position());
370 _video_view->rethrow ();
375 FilmViewer::player_change (ChangeType type, int property, bool frequent)
377 if (type != CHANGE_TYPE_DONE || frequent) {
381 if (_coalesce_player_changes) {
382 _pending_player_changes.push_back (property);
387 bool refreshed = false;
389 property == VideoContentProperty::CROP ||
390 property == VideoContentProperty::SCALE ||
391 property == VideoContentProperty::FADE_IN ||
392 property == VideoContentProperty::FADE_OUT ||
393 property == VideoContentProperty::COLOUR_CONVERSION ||
394 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
395 property == PlayerProperty::FILM_CONTAINER
397 refreshed = quick_refresh ();
406 FilmViewer::film_change (ChangeType type, Film::Property p)
408 if (type != CHANGE_TYPE_DONE) {
412 if (p == Film::AUDIO_CHANNELS) {
414 } else if (p == Film::VIDEO_FRAME_RATE) {
415 _video_view->set_video_frame_rate (_film->video_frame_rate());
416 } else if (p == Film::THREE_D) {
417 _video_view->set_three_d (_film->three_d());
418 } else if (p == Film::CONTENT) {
419 _closed_captions_dialog->update_tracks (_film);
424 FilmViewer::film_length_change ()
426 _video_view->set_length (_film->length());
429 /** Re-get the current frame slowly by seeking */
431 FilmViewer::slow_refresh ()
433 seek (_video_view->position(), true);
436 /** Try to re-get the current frame quickly by resetting the metadata
437 * in the PlayerVideo that we used last time.
438 * @return true if this was possible, false if not.
441 FilmViewer::quick_refresh ()
443 if (!_video_view || !_film || !_player) {
446 return _video_view->refresh_metadata (_film, _player->video_container_size(), _film->frame_size());
450 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
452 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
454 seek (*dt, accurate);
459 FilmViewer::set_coalesce_player_changes (bool c)
461 _coalesce_player_changes = c;
464 BOOST_FOREACH (int i, _pending_player_changes) {
465 player_change (CHANGE_TYPE_DONE, i, false);
467 _pending_player_changes.clear ();
472 FilmViewer::seek (DCPTime t, bool accurate)
478 if (t < DCPTime ()) {
482 if (t >= _film->length ()) {
483 t = _film->length() - one_video_frame();
488 _closed_captions_dialog->clear ();
489 _butler->seek (t, accurate);
492 /* We're not playing, so let the GUI thread get on and
493 come back later to get the next frame after the seek.
495 request_idle_display_next_frame ();
497 /* We're going to start playing again straight away
498 so wait for the seek to finish.
500 while (!_video_view->display_next_frame(false)) {}
507 FilmViewer::config_changed (Config::Property p)
509 #ifdef DCPOMATIC_VARIANT_SWAROOP
510 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
511 _video_view->update ();
516 if (p == Config::AUDIO_MAPPING) {
521 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
525 if (_audio.isStreamOpen ()) {
526 _audio.closeStream ();
529 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
531 if (Config::instance()->sound_output()) {
532 while (st < _audio.getDeviceCount()) {
534 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
537 } catch (RtAudioError&) {
538 /* Something went wrong with that device so we don't want to use it anyway */
542 if (st == _audio.getDeviceCount()) {
543 st = _audio.getDefaultOutputDevice();
546 st = _audio.getDefaultOutputDevice();
550 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
551 RtAudio::StreamParameters sp;
553 sp.nChannels = _audio_channels;
555 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
556 #ifdef DCPOMATIC_USE_RTERROR
557 } catch (RtError& e) {
559 } catch (RtAudioError& e) {
564 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
576 FilmViewer::uncorrected_time () const
578 if (_audio.isStreamRunning ()) {
579 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
582 return _video_view->position();
586 FilmViewer::audio_time () const
588 if (!_audio.isStreamRunning()) {
589 return optional<DCPTime>();
592 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
593 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
597 FilmViewer::time () const
599 return audio_time().get_value_or(_video_view->position());
603 FilmViewer::audio_callback (void* out_p, unsigned int frames)
606 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
607 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
608 /* There was an underrun or this audio is on time; carry on */
611 /* The audio we just got was (very) late; drop it and get some more. */
614 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
616 _latency_history.push_back (_audio.getStreamLatency ());
617 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
618 _latency_history.pop_front ();
626 FilmViewer::average_latency () const
628 boost::mutex::scoped_lock lm (_latency_history_mutex);
629 if (_latency_history.empty()) {
634 BOOST_FOREACH (Frame i, _latency_history) {
638 return total / _latency_history.size();
642 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
644 _dcp_decode_reduction = reduction;
646 _player->set_dcp_decode_reduction (reduction);
651 FilmViewer::dcp_decode_reduction () const
653 return _dcp_decode_reduction;
657 FilmViewer::one_video_frame () const
659 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
662 /** Open a dialog box showing our film's closed captions */
664 FilmViewer::show_closed_captions ()
666 _closed_captions_dialog->Show();
670 FilmViewer::seek_by (DCPTime by, bool accurate)
672 seek (_video_view->position() + by, accurate);
676 FilmViewer::set_pad_black (bool p)
681 /** Called when a player has finished the current film.
682 * May be called from a non-UI thread.
685 FilmViewer::finished ()
687 emit (boost::bind(&FilmViewer::ui_finished, this));
690 /** Called by finished() in the UI thread */
692 FilmViewer::ui_finished ()
699 FilmViewer::dropped () const
701 return _video_view->dropped ();
706 FilmViewer::errored () const
708 return _video_view->errored ();
713 FilmViewer::gets () const
715 return _video_view->gets ();
720 FilmViewer::content_change (ChangeType type, int property)
722 if (type != CHANGE_TYPE_DONE) {
726 if (property == TextContentProperty::USE || property == TextContentProperty::TYPE || property == TextContentProperty::DCP_TRACK) {
727 _closed_captions_dialog->update_tracks (_film);