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"
51 #include <libavutil/pixfmt.h>
53 #include <dcp/exceptions.h>
54 #include <wx/tglbtn.h>
67 using boost::shared_ptr;
68 using boost::dynamic_pointer_cast;
69 using boost::weak_ptr;
70 using boost::optional;
72 using namespace dcpomatic;
76 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
78 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
81 FilmViewer::FilmViewer (wxWindow* p)
82 : _coalesce_player_changes (false)
83 , _audio (DCPOMATIC_RTAUDIO_API)
85 , _audio_block_size (1024)
88 , _latency_history_count (0)
90 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
91 , _outline_content (false)
94 #ifdef DCPOMATIC_VARIANT_SWAROOP
95 , _background_image (false)
97 , _state_timer ("viewer")
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_get ()
132 DCPOMATIC_ASSERT (signal_manager);
133 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
137 FilmViewer::idle_handler ()
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)
159 _video_position = DCPTime ();
160 _player_video.first.reset ();
161 _player_video.second = DCPTime ();
163 _video_view->set_image (shared_ptr<Image>());
164 _closed_captions_dialog->clear ();
174 _player.reset (new Player (_film, _film->playlist ()));
175 _player->set_fast ();
176 if (_dcp_decode_reduction) {
177 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
179 } catch (bad_alloc &) {
180 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
185 _player->set_always_burn_open_subtitles ();
186 _player->set_play_referenced ();
188 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
189 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
191 /* Keep about 1 second's worth of history samples */
192 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
201 FilmViewer::recreate_butler ()
214 Config::instance()->audio_mapping(_audio_channels),
216 bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
222 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
223 _butler->disable_audio ();
226 _closed_captions_dialog->set_film_and_butler (_film, _butler);
232 FilmViewer::refresh_view ()
234 _state_timer.set ("update-view");
235 _video_view->update ();
236 _state_timer.unset ();
239 /** Try to get a frame from the butler and display it.
240 * @param lazy true to return false quickly if no video is available quickly (i.e. we are waiting for the butler).
241 * false to ask the butler to block until it has video (unless it is suspended).
242 * @return true on success, false if we did nothing because it would have taken too long.
245 FilmViewer::get (bool lazy)
247 DCPOMATIC_ASSERT (_butler);
252 _player_video = _butler->get_video (!lazy, &e);
253 if (!_player_video.first && e == Butler::AGAIN) {
255 /* No video available; return saying we failed */
258 /* Player was suspended; come back later */
259 signal_manager->when_idle (boost::bind(&FilmViewer::get, this, false));
264 _player_video.first &&
266 _eyes != _player_video.first->eyes() &&
267 _player_video.first->eyes() != EYES_BOTH
272 } catch (DecodeError& e) {
273 error_dialog (_video_view->get(), e.what());
276 display_player_video ();
283 FilmViewer::display_player_video ()
285 if (!_player_video.first) {
286 _video_view->set_image (shared_ptr<Image>());
291 if (_playing && !_suspended && (time() - _player_video.second) > one_video_frame()) {
292 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
293 part if this frame is J2K).
295 _video_position = _player_video.second;
300 /* In an ideal world, what we would do here is:
302 * 1. convert to XYZ exactly as we do in the DCP creation path.
303 * 2. convert back to RGB for the preview display, compensating
304 * for the monitor etc. etc.
306 * but this is inefficient if the source is RGB. Since we don't
307 * (currently) care too much about the precise accuracy of the preview's
308 * colour mapping (and we care more about its speed) we try to short-
309 * circuit this "ideal" situation in some cases.
311 * The content's specified colour conversion indicates the colourspace
312 * which the content is in (according to the user).
314 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
315 * image and convert it (from whatever the user has said it is) to RGB.
318 _state_timer.set ("get image");
320 _video_view->set_image (
321 _player_video.first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true)
324 _state_timer.set ("ImageChanged");
325 ImageChanged (_player_video.first);
326 _state_timer.unset ();
328 _video_position = _player_video.second;
329 _inter_position = _player_video.first->inter_position ();
330 _inter_size = _player_video.first->inter_size ();
334 _closed_captions_dialog->update (time());
338 FilmViewer::set_outline_content (bool o)
340 _outline_content = o;
345 FilmViewer::set_eyes (Eyes e)
352 FilmViewer::video_view_sized ()
355 if (!quick_refresh()) {
362 FilmViewer::calculate_sizes ()
364 if (!_film || !_player) {
368 Ratio const * container = _film->container ();
370 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
371 float const film_ratio = container ? container->ratio () : 1.78;
373 if (view_ratio < film_ratio) {
374 /* panel is less widscreen than the film; clamp width */
375 _out_size.width = _video_view->get()->GetSize().x;
376 _out_size.height = lrintf (_out_size.width / film_ratio);
378 /* panel is more widescreen than the film; clamp height */
379 _out_size.height = _video_view->get()->GetSize().y;
380 _out_size.width = lrintf (_out_size.height * film_ratio);
383 /* Catch silly values */
384 _out_size.width = max (64, _out_size.width);
385 _out_size.height = max (64, _out_size.height);
387 _player->set_video_container_size (_out_size);
391 FilmViewer::suspend ()
394 if (_audio.isStreamRunning()) {
395 _audio.abortStream();
400 FilmViewer::resume ()
403 if (_playing && !_suspended) {
404 if (_audio.isStreamOpen()) {
405 _audio.setStreamTime (_video_position.seconds());
406 _audio.startStream ();
419 optional<bool> v = PlaybackPermitted ();
421 /* Computer says no */
425 if (_audio.isStreamOpen()) {
426 _audio.setStreamTime (_video_position.seconds());
427 _audio.startStream ();
432 _video_view->timer ();
433 Started (position());
439 if (_audio.isStreamRunning()) {
440 /* stop stream and discard any remaining queued samples */
441 _audio.abortStream ();
449 Stopped (position());
454 FilmViewer::player_change (ChangeType type, int property, bool frequent)
456 if (type != CHANGE_TYPE_DONE || frequent) {
460 if (_coalesce_player_changes) {
461 _pending_player_changes.push_back (property);
466 bool refreshed = false;
468 property == VideoContentProperty::CROP ||
469 property == VideoContentProperty::SCALE ||
470 property == VideoContentProperty::FADE_IN ||
471 property == VideoContentProperty::FADE_OUT ||
472 property == VideoContentProperty::COLOUR_CONVERSION ||
473 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
474 property == PlayerProperty::FILM_CONTAINER
476 refreshed = quick_refresh ();
486 FilmViewer::film_change (ChangeType type, Film::Property p)
488 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
493 /** Re-get the current frame slowly by seeking */
495 FilmViewer::slow_refresh ()
497 seek (_video_position, true);
500 /** Try to re-get the current frame quickly by resetting the metadata
501 * in the PlayerVideo that we used last time.
502 * @return true if this was possible, false if not.
505 FilmViewer::quick_refresh ()
507 if (!_player_video.first) {
511 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
515 display_player_video ();
520 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
522 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
524 seek (*dt, accurate);
529 FilmViewer::set_coalesce_player_changes (bool c)
531 _coalesce_player_changes = c;
534 BOOST_FOREACH (int i, _pending_player_changes) {
535 player_change (CHANGE_TYPE_DONE, i, false);
537 _pending_player_changes.clear ();
542 FilmViewer::seek (DCPTime t, bool accurate)
548 if (t < DCPTime ()) {
552 if (t >= _film->length ()) {
553 t = _film->length ();
558 _closed_captions_dialog->clear ();
559 _butler->seek (t, accurate);
564 /* Make sure we get a frame so that _video_position is set up before we resume */
565 while (!get(true)) {}
572 FilmViewer::config_changed (Config::Property p)
574 #ifdef DCPOMATIC_VARIANT_SWAROOP
575 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
581 if (p == Config::AUDIO_MAPPING) {
586 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
590 if (_audio.isStreamOpen ()) {
591 _audio.closeStream ();
594 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
596 if (Config::instance()->sound_output()) {
597 while (st < _audio.getDeviceCount()) {
598 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
603 if (st == _audio.getDeviceCount()) {
604 st = _audio.getDefaultOutputDevice();
607 st = _audio.getDefaultOutputDevice();
610 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
612 RtAudio::StreamParameters sp;
614 sp.nChannels = _audio_channels;
617 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
618 #ifdef DCPOMATIC_USE_RTERROR
619 } catch (RtError& e) {
621 } catch (RtAudioError& e) {
625 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
637 FilmViewer::uncorrected_time () const
639 if (_audio.isStreamRunning ()) {
640 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
643 return _video_position;
647 FilmViewer::time () const
649 if (_audio.isStreamRunning ()) {
650 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
651 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
654 return _video_position;
658 FilmViewer::audio_callback (void* out_p, unsigned int frames)
661 optional<DCPTime> t = _butler->get_audio (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 ();
681 FilmViewer::average_latency () const
683 boost::mutex::scoped_lock lm (_latency_history_mutex);
684 if (_latency_history.empty()) {
689 BOOST_FOREACH (Frame i, _latency_history) {
693 return total / _latency_history.size();
697 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
699 _dcp_decode_reduction = reduction;
701 _player->set_dcp_decode_reduction (reduction);
706 FilmViewer::dcp_decode_reduction () const
708 return _dcp_decode_reduction;
712 FilmViewer::one_video_frame () const
714 return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
717 /** Open a dialog box showing our film's closed captions */
719 FilmViewer::show_closed_captions ()
721 _closed_captions_dialog->Show();
725 FilmViewer::seek_by (DCPTime by, bool accurate)
727 seek (_video_position + by, accurate);
731 FilmViewer::set_pad_black (bool p)