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 std::shared_ptr;
69 using std::dynamic_pointer_cast;
72 using boost::optional;
73 #if BOOST_VERSION >= 106100
74 using namespace boost::placeholders;
77 using namespace dcpomatic;
81 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
83 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
86 FilmViewer::FilmViewer (wxWindow* p)
87 : _coalesce_player_changes (false)
88 , _audio (DCPOMATIC_RTAUDIO_API)
90 , _audio_block_size (1024)
93 , _latency_history_count (0)
94 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
95 , _outline_content (false)
99 switch (Config::instance()->video_view_type()) {
100 case Config::VIDEO_VIEW_OPENGL:
101 _video_view = new GLVideoView (this, p);
103 case Config::VIDEO_VIEW_SIMPLE:
104 _video_view = new SimpleVideoView (this, p);
108 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
110 set_film (shared_ptr<Film> ());
112 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
113 config_changed (Config::SOUND_OUTPUT);
116 FilmViewer::~FilmViewer ()
121 /** Ask for ::get() 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));
135 FilmViewer::idle_handler ()
141 if (_video_view->display_next_frame(true) == VideoView::AGAIN) {
142 /* get() could not complete quickly so we'll try again later */
143 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
150 FilmViewer::set_film (shared_ptr<Film> film)
158 _video_view->clear ();
159 _closed_captions_dialog->clear ();
164 _video_view->update ();
169 _player.reset (new Player(_film));
170 _player->set_fast ();
171 if (_dcp_decode_reduction) {
172 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
174 } catch (bad_alloc &) {
175 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
180 _player->set_always_burn_open_subtitles ();
181 _player->set_play_referenced ();
183 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
184 _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
185 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
187 film_change (ChangeType::DONE, Film::Property::VIDEO_FRAME_RATE);
188 film_change (ChangeType::DONE, Film::Property::THREE_D);
189 film_length_change ();
191 /* Keep about 1 second's worth of history samples */
192 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
194 _closed_captions_dialog->update_tracks (_film);
203 FilmViewer::recreate_butler ()
217 Config::instance()->audio_mapping(_audio_channels),
219 bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
226 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
227 _butler->disable_audio ();
230 _closed_captions_dialog->set_butler (_butler);
236 FilmViewer::set_outline_content (bool o)
238 _outline_content = o;
239 _video_view->update ();
244 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double> > rect)
246 _outline_subtitles = rect;
247 _video_view->update ();
252 FilmViewer::set_eyes (Eyes e)
254 _video_view->set_eyes (e);
259 FilmViewer::video_view_sized ()
262 if (!quick_refresh()) {
268 FilmViewer::calculate_sizes ()
270 if (!_film || !_player) {
274 Ratio const * container = _film->container ();
276 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
277 float const film_ratio = container ? container->ratio () : 1.78;
279 if (view_ratio < film_ratio) {
280 /* panel is less widscreen than the film; clamp width */
281 _out_size.width = _video_view->get()->GetSize().x;
282 _out_size.height = lrintf (_out_size.width / film_ratio);
284 /* panel is more widescreen than the film; clamp height */
285 _out_size.height = _video_view->get()->GetSize().y;
286 _out_size.width = lrintf (_out_size.height * film_ratio);
289 /* Catch silly values */
290 _out_size.width = max (64, _out_size.width);
291 _out_size.height = max (64, _out_size.height);
293 _player->set_video_container_size (_out_size);
297 FilmViewer::suspend ()
300 if (_audio.isStreamRunning()) {
301 _audio.abortStream();
306 FilmViewer::resume ()
308 DCPOMATIC_ASSERT (_suspended > 0);
310 if (_playing && !_suspended) {
311 if (_audio.isStreamOpen()) {
312 _audio.setStreamTime (_video_view->position().seconds());
313 _audio.startStream ();
315 _video_view->start ();
326 optional<bool> v = PlaybackPermitted ();
328 /* Computer says no */
332 /* We are about to set up the audio stream from the position of the video view.
333 If there is `lazy' seek in progress we need to wait for it to go through so that
334 _video_view->position() gives us a sensible answer.
340 /* Take the video view's idea of position as our `playhead' and start the
341 audio stream (which is the timing reference) there.
343 if (_audio.isStreamOpen()) {
344 _audio.setStreamTime (_video_view->position().seconds());
345 _audio.startStream ();
349 /* Calling start() below may directly result in Stopped being emitted, and if that
350 * happens we want it to come after the Started signal, so do that first.
352 Started (position());
353 _video_view->start ();
359 if (_audio.isStreamRunning()) {
360 /* stop stream and discard any remaining queued samples */
361 _audio.abortStream ();
369 _video_view->stop ();
370 Stopped (position());
372 _video_view->rethrow ();
377 FilmViewer::player_change (ChangeType type, int property, bool frequent)
379 if (type != ChangeType::DONE || frequent) {
383 if (_coalesce_player_changes) {
384 _pending_player_changes.push_back (property);
388 player_change ({property});
392 FilmViewer::player_change (vector<int> properties)
396 bool try_quick_refresh = false;
397 bool update_ccap_tracks = false;
399 for (auto i: properties) {
401 i == VideoContentProperty::CROP ||
402 i == VideoContentProperty::SCALE ||
403 i == VideoContentProperty::FADE_IN ||
404 i == VideoContentProperty::FADE_OUT ||
405 i == VideoContentProperty::COLOUR_CONVERSION ||
406 i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
407 i == PlayerProperty::FILM_CONTAINER
409 try_quick_refresh = true;
412 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
413 update_ccap_tracks = true;
417 if (!try_quick_refresh || !quick_refresh()) {
421 if (update_ccap_tracks) {
422 _closed_captions_dialog->update_tracks (_film);
427 FilmViewer::film_change (ChangeType type, Film::Property p)
429 if (type != ChangeType::DONE) {
433 if (p == Film::Property::AUDIO_CHANNELS) {
435 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
436 _video_view->set_video_frame_rate (_film->video_frame_rate());
437 } else if (p == Film::Property::THREE_D) {
438 _video_view->set_three_d (_film->three_d());
439 } else if (p == Film::Property::CONTENT) {
440 _closed_captions_dialog->update_tracks (_film);
445 FilmViewer::film_length_change ()
447 _video_view->set_length (_film->length());
450 /** Re-get the current frame slowly by seeking */
452 FilmViewer::slow_refresh ()
454 seek (_video_view->position(), true);
457 /** Try to re-get the current frame quickly by resetting the metadata
458 * in the PlayerVideo that we used last time.
459 * @return true if this was possible, false if not.
462 FilmViewer::quick_refresh ()
464 if (!_video_view || !_film || !_player) {
467 return _video_view->reset_metadata (_film, _player->video_container_size());
471 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
473 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
475 seek (*dt, accurate);
480 FilmViewer::set_coalesce_player_changes (bool c)
482 _coalesce_player_changes = c;
485 player_change (_pending_player_changes);
486 _pending_player_changes.clear ();
491 FilmViewer::seek (DCPTime t, bool accurate)
497 if (t < DCPTime ()) {
501 if (t >= _film->length ()) {
502 t = _film->length() - one_video_frame();
507 _closed_captions_dialog->clear ();
508 _butler->seek (t, accurate);
511 /* We're not playing, so let the GUI thread get on and
512 come back later to get the next frame after the seek.
514 request_idle_display_next_frame ();
516 /* We're going to start playing again straight away
517 so wait for the seek to finish.
519 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
526 FilmViewer::config_changed (Config::Property p)
528 if (p == Config::AUDIO_MAPPING) {
533 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
537 if (_audio.isStreamOpen ()) {
538 _audio.closeStream ();
541 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
543 if (Config::instance()->sound_output()) {
544 while (st < _audio.getDeviceCount()) {
546 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
549 } catch (RtAudioError&) {
550 /* Something went wrong with that device so we don't want to use it anyway */
554 if (st == _audio.getDeviceCount()) {
555 st = _audio.getDefaultOutputDevice();
558 st = _audio.getDefaultOutputDevice();
562 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
563 RtAudio::StreamParameters sp;
565 sp.nChannels = _audio_channels;
567 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
568 } catch (RtAudioError& e) {
572 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
584 FilmViewer::uncorrected_time () const
586 if (_audio.isStreamRunning ()) {
587 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
590 return _video_view->position();
594 FilmViewer::audio_time () const
596 if (!_audio.isStreamRunning()) {
597 return optional<DCPTime>();
600 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
601 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
605 FilmViewer::time () const
607 return audio_time().get_value_or(_video_view->position());
611 FilmViewer::audio_callback (void* out_p, unsigned int frames)
614 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
615 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
616 /* There was an underrun or this audio is on time; carry on */
619 /* The audio we just got was (very) late; drop it and get some more. */
622 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
624 _latency_history.push_back (_audio.getStreamLatency ());
625 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
626 _latency_history.pop_front ();
634 FilmViewer::average_latency () const
636 boost::mutex::scoped_lock lm (_latency_history_mutex);
637 if (_latency_history.empty()) {
642 for (auto i: _latency_history) {
646 return total / _latency_history.size();
650 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
652 _dcp_decode_reduction = reduction;
654 _player->set_dcp_decode_reduction (reduction);
659 FilmViewer::dcp_decode_reduction () const
661 return _dcp_decode_reduction;
665 FilmViewer::one_video_frame () const
667 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
670 /** Open a dialog box showing our film's closed captions */
672 FilmViewer::show_closed_captions ()
674 _closed_captions_dialog->Show();
678 FilmViewer::seek_by (DCPTime by, bool accurate)
680 seek (_video_view->position() + by, accurate);
684 FilmViewer::set_pad_black (bool p)
689 /** Called when a player has finished the current film.
690 * May be called from a non-UI thread.
693 FilmViewer::finished ()
695 emit (boost::bind(&FilmViewer::ui_finished, this));
698 /** Called by finished() in the UI thread */
700 FilmViewer::ui_finished ()
707 FilmViewer::dropped () const
709 return _video_view->dropped ();
714 FilmViewer::errored () const
716 return _video_view->errored ();
721 FilmViewer::gets () const
723 return _video_view->gets ();
728 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
730 emit (boost::bind(boost::ref(ImageChanged), pv));