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"
32 #include "lib/ratio.h"
34 #include "lib/job_manager.h"
35 #include "lib/image.h"
36 #include "lib/exceptions.h"
37 #include "lib/examine_content_job.h"
38 #include "lib/filter.h"
39 #include "lib/player.h"
40 #include "lib/player_video.h"
41 #include "lib/video_content.h"
42 #include "lib/video_decoder.h"
43 #include "lib/timer.h"
44 #include "lib/butler.h"
46 #include "lib/config.h"
47 #include "lib/compose.hpp"
48 #include "lib/dcpomatic_log.h"
50 #include <libavutil/pixfmt.h>
52 #include <dcp/exceptions.h>
53 #include <wx/tglbtn.h>
66 using boost::shared_ptr;
67 using boost::dynamic_pointer_cast;
68 using boost::weak_ptr;
69 using boost::optional;
71 using namespace dcpomatic;
75 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
77 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
80 FilmViewer::FilmViewer (wxWindow* p)
81 /* XXX: make this configurable */
82 : _video_view (new GLVideoView(p))
83 , _coalesce_player_changes (false)
84 , _audio (DCPOMATIC_RTAUDIO_API)
86 , _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 , _in_watermark (false)
96 , _background_image (false)
98 , _state_timer ("viewer")
101 /* XXX: maybe this should be proxied through the VideoView */
102 _video_view->get()->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::video_view_sized, this));
103 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
105 set_film (shared_ptr<Film> ());
107 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
108 config_changed (Config::SOUND_OUTPUT);
111 FilmViewer::~FilmViewer ()
117 FilmViewer::set_film (shared_ptr<Film> film)
124 _video_position = DCPTime ();
125 _player_video.first.reset ();
126 _player_video.second = DCPTime ();
129 _closed_captions_dialog->clear ();
140 _player.reset (new Player (_film, _film->playlist ()));
141 _player->set_fast ();
142 if (_dcp_decode_reduction) {
143 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
145 } catch (bad_alloc &) {
146 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
151 _player->set_always_burn_open_subtitles ();
152 _player->set_play_referenced ();
154 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
155 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
157 /* Keep about 1 second's worth of history samples */
158 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
167 FilmViewer::recreate_butler ()
169 bool const was_running = stop ();
176 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
178 if (_audio_channels != 2 || _film->audio_channels() < 3) {
179 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
183 /* Special case: stereo output, at least 3 channel input.
184 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
185 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
187 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
188 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
189 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
190 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
191 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
192 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
193 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
194 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
197 _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
198 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
199 _butler->disable_audio ();
202 _closed_captions_dialog->set_film_and_butler (_film, _butler);
210 FilmViewer::refresh_panel ()
215 _state_timer.set ("refresh-panel");
218 _state_timer.unset ();
225 DCPOMATIC_ASSERT (_butler);
230 _player_video = _butler->get_video (&e);
231 if (!_player_video.first && e == Butler::AGAIN) {
232 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
236 _player_video.first &&
238 _eyes != _player_video.first->eyes() &&
239 _player_video.first->eyes() != EYES_BOTH
244 display_player_video ();
248 FilmViewer::display_player_video ()
250 if (!_player_video.first) {
256 if (_playing && (time() - _player_video.second) > one_video_frame()) {
257 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
258 part if this frame is J2K).
260 _video_position = _player_video.second;
265 /* In an ideal world, what we would do here is:
267 * 1. convert to XYZ exactly as we do in the DCP creation path.
268 * 2. convert back to RGB for the preview display, compensating
269 * for the monitor etc. etc.
271 * but this is inefficient if the source is RGB. Since we don't
272 * (currently) care too much about the precise accuracy of the preview's
273 * colour mapping (and we care more about its speed) we try to short-
274 * circuit this "ideal" situation in some cases.
276 * The content's specified colour conversion indicates the colourspace
277 * which the content is in (according to the user).
279 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
280 * image and convert it (from whatever the user has said it is) to RGB.
283 _state_timer.set ("get image");
285 /* XXX: do we need to store _frame? */
286 _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
287 _video_view->set_image (_frame);
289 _state_timer.set ("ImageChanged");
290 ImageChanged (_player_video.first);
291 _state_timer.unset ();
293 _video_position = _player_video.second;
294 _inter_position = _player_video.first->inter_position ();
295 _inter_size = _player_video.first->inter_size ();
299 _closed_captions_dialog->update (time());
305 if (!_film || !_playing) {
311 DCPTime const next = _video_position + one_video_frame();
313 if (next >= _film->length()) {
319 LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
320 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
328 #ifdef DCPOMATIC_VARIANT_SWAROOP
330 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
332 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
334 wxImage image (std_to_wx(bg->string()));
335 wxBitmap bitmap (image);
336 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
343 FilmViewer::maybe_draw_background_image (wxPaintDC &)
350 FilmViewer::set_outline_content (bool o)
352 _outline_content = o;
357 FilmViewer::set_eyes (Eyes e)
364 FilmViewer::video_view_sized ()
367 if (!quick_refresh()) {
374 FilmViewer::calculate_sizes ()
376 if (!_film || !_player) {
380 Ratio const * container = _film->container ();
382 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
383 float const film_ratio = container ? container->ratio () : 1.78;
385 if (view_ratio < film_ratio) {
386 /* panel is less widscreen than the film; clamp width */
387 _out_size.width = _video_view->get()->GetSize().x;
388 _out_size.height = lrintf (_out_size.width / film_ratio);
390 /* panel is more widescreen than the film; clamp height */
391 _out_size.height = _video_view->get()->GetSize().y;
392 _out_size.width = lrintf (_out_size.height * film_ratio);
395 /* Catch silly values */
396 _out_size.width = max (64, _out_size.width);
397 _out_size.height = max (64, _out_size.height);
399 /* Make OpenGL happy; XXX: only do this in GLVideoView? Is the round-to-4 constraint a thing? */
400 _out_size.width &= ~3;
401 _out_size.height &= ~3;
403 _player->set_video_container_size (_out_size);
413 optional<bool> v = PlaybackPermitted ();
415 /* Computer says no */
419 if (_audio.isStreamOpen()) {
420 _audio.setStreamTime (_video_position.seconds());
421 _audio.startStream ();
427 Started (position());
433 if (_audio.isStreamRunning()) {
434 /* stop stream and discard any remaining queued samples */
435 _audio.abortStream ();
443 Stopped (position());
448 FilmViewer::player_change (ChangeType type, int property, bool frequent)
450 if (type != CHANGE_TYPE_DONE || frequent) {
454 if (_coalesce_player_changes) {
455 _pending_player_changes.push_back (property);
460 bool refreshed = false;
462 property == VideoContentProperty::CROP ||
463 property == VideoContentProperty::SCALE ||
464 property == VideoContentProperty::FADE_IN ||
465 property == VideoContentProperty::FADE_OUT ||
466 property == VideoContentProperty::COLOUR_CONVERSION ||
467 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
468 property == PlayerProperty::FILM_CONTAINER
470 refreshed = quick_refresh ();
480 FilmViewer::film_change (ChangeType type, Film::Property p)
482 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
487 /** Re-get the current frame slowly by seeking */
489 FilmViewer::slow_refresh ()
491 seek (_video_position, true);
494 /** Try to re-get the current frame quickly by resetting the metadata
495 * in the PlayerVideo that we used last time.
496 * @return true if this was possible, false if not.
499 FilmViewer::quick_refresh ()
501 if (!_player_video.first) {
505 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
509 display_player_video ();
514 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
516 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
518 seek (*dt, accurate);
523 FilmViewer::set_coalesce_player_changes (bool c)
525 _coalesce_player_changes = c;
528 BOOST_FOREACH (int i, _pending_player_changes) {
529 player_change (CHANGE_TYPE_DONE, i, false);
531 _pending_player_changes.clear ();
536 FilmViewer::seek (DCPTime t, bool accurate)
542 if (t < DCPTime ()) {
546 if (t >= _film->length ()) {
547 t = _film->length ();
550 bool const was_running = stop ();
552 _closed_captions_dialog->clear ();
553 _butler->seek (t, accurate);
564 FilmViewer::config_changed (Config::Property p)
566 #ifdef DCPOMATIC_VARIANT_SWAROOP
567 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
573 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
577 if (_audio.isStreamOpen ()) {
578 _audio.closeStream ();
581 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
583 if (Config::instance()->sound_output()) {
584 while (st < _audio.getDeviceCount()) {
585 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
590 if (st == _audio.getDeviceCount()) {
591 st = _audio.getDefaultOutputDevice();
594 st = _audio.getDefaultOutputDevice();
597 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
599 RtAudio::StreamParameters sp;
601 sp.nChannels = _audio_channels;
604 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
605 #ifdef DCPOMATIC_USE_RTERROR
606 } catch (RtError& e) {
608 } catch (RtAudioError& e) {
612 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
624 FilmViewer::uncorrected_time () const
626 if (_audio.isStreamRunning ()) {
627 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
630 return _video_position;
634 FilmViewer::time () const
636 if (_audio.isStreamRunning ()) {
637 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
638 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
641 return _video_position;
645 FilmViewer::audio_callback (void* out_p, unsigned int frames)
648 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
649 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
650 /* There was an underrun or this audio is on time; carry on */
653 /* The audio we just got was (very) late; drop it and get some more. */
656 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
658 _latency_history.push_back (_audio.getStreamLatency ());
659 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
660 _latency_history.pop_front ();
668 FilmViewer::average_latency () const
670 boost::mutex::scoped_lock lm (_latency_history_mutex);
671 if (_latency_history.empty()) {
676 BOOST_FOREACH (Frame i, _latency_history) {
680 return total / _latency_history.size();
684 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
686 _dcp_decode_reduction = reduction;
688 _player->set_dcp_decode_reduction (reduction);
693 FilmViewer::dcp_decode_reduction () const
695 return _dcp_decode_reduction;
699 FilmViewer::one_video_frame () const
701 return DCPTime::from_frames (1, _film->video_frame_rate());
704 /** Open a dialog box showing our film's closed captions */
706 FilmViewer::show_closed_captions ()
708 _closed_captions_dialog->Show();
712 FilmViewer::seek_by (DCPTime by, bool accurate)
714 seek (_video_position + by, accurate);
718 FilmViewer::set_pad_black (bool p)