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)
87 , _latency_history_count (0)
89 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
90 , _outline_content (false)
93 #ifdef DCPOMATIC_VARIANT_SWAROOP
94 , _in_watermark (false)
95 , _background_image (false)
97 , _state_timer ("viewer")
100 switch (Config::instance()->video_view_type()) {
101 case Config::VIDEO_VIEW_OPENGL:
102 _video_view = new GLVideoView (p);
104 case Config::VIDEO_VIEW_SIMPLE:
105 _video_view = new SimpleVideoView (this, p);
109 _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
110 _timer.Bind (wxEVT_TIMER, boost::bind(&FilmViewer::timer, 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 ()
124 FilmViewer::set_film (shared_ptr<Film> film)
131 _video_position = DCPTime ();
132 _player_video.first.reset ();
133 _player_video.second = DCPTime ();
135 _video_view->set_image (shared_ptr<Image>());
136 _closed_captions_dialog->clear ();
146 _player.reset (new Player (_film, _film->playlist ()));
147 _player->set_fast ();
148 if (_dcp_decode_reduction) {
149 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
151 } catch (bad_alloc &) {
152 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
157 _player->set_always_burn_open_subtitles ();
158 _player->set_play_referenced ();
160 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
161 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
163 /* Keep about 1 second's worth of history samples */
164 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
173 FilmViewer::recreate_butler ()
175 bool const was_running = stop ();
182 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
184 if (_audio_channels != 2 || _film->audio_channels() < 3) {
185 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
189 /* Special case: stereo output, at least 3 channel input.
190 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
191 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
193 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
194 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
195 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
196 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
197 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
198 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
199 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
200 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
203 _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
204 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
205 _butler->disable_audio ();
208 _closed_captions_dialog->set_film_and_butler (_film, _butler);
216 FilmViewer::refresh_view ()
218 _state_timer.set ("refresh-view");
219 _video_view->get()->Refresh ();
220 _video_view->get()->Update ();
221 _state_timer.unset ();
227 DCPOMATIC_ASSERT (_butler);
232 _player_video = _butler->get_video (&e);
233 if (!_player_video.first && e == Butler::AGAIN) {
234 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
238 _player_video.first &&
240 _eyes != _player_video.first->eyes() &&
241 _player_video.first->eyes() != EYES_BOTH
246 display_player_video ();
250 FilmViewer::display_player_video ()
252 if (!_player_video.first) {
253 _video_view->set_image (shared_ptr<Image>());
258 if (_playing && (time() - _player_video.second) > one_video_frame()) {
259 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
260 part if this frame is J2K).
262 _video_position = _player_video.second;
267 /* In an ideal world, what we would do here is:
269 * 1. convert to XYZ exactly as we do in the DCP creation path.
270 * 2. convert back to RGB for the preview display, compensating
271 * for the monitor etc. etc.
273 * but this is inefficient if the source is RGB. Since we don't
274 * (currently) care too much about the precise accuracy of the preview's
275 * colour mapping (and we care more about its speed) we try to short-
276 * circuit this "ideal" situation in some cases.
278 * The content's specified colour conversion indicates the colourspace
279 * which the content is in (according to the user).
281 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
282 * image and convert it (from whatever the user has said it is) to RGB.
285 _state_timer.set ("get image");
287 _video_view->set_image (
288 _player_video.first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true)
291 _state_timer.set ("ImageChanged");
292 ImageChanged (_player_video.first);
293 _state_timer.unset ();
295 _video_position = _player_video.second;
296 _inter_position = _player_video.first->inter_position ();
297 _inter_size = _player_video.first->inter_size ();
301 _closed_captions_dialog->update (time());
307 if (!_film || !_playing) {
313 DCPTime const next = _video_position + one_video_frame();
315 if (next >= _film->length()) {
321 LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
322 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
330 #ifdef DCPOMATIC_VARIANT_SWAROOP
332 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
334 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
336 wxImage image (std_to_wx(bg->string()));
337 wxBitmap bitmap (image);
338 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
345 FilmViewer::maybe_draw_background_image (wxPaintDC &)
352 FilmViewer::set_outline_content (bool o)
354 _outline_content = o;
359 FilmViewer::set_eyes (Eyes e)
366 FilmViewer::video_view_sized ()
369 if (!quick_refresh()) {
376 FilmViewer::calculate_sizes ()
378 if (!_film || !_player) {
382 Ratio const * container = _film->container ();
384 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
385 float const film_ratio = container ? container->ratio () : 1.78;
387 if (view_ratio < film_ratio) {
388 /* panel is less widscreen than the film; clamp width */
389 _out_size.width = _video_view->get()->GetSize().x;
390 _out_size.height = lrintf (_out_size.width / film_ratio);
392 /* panel is more widescreen than the film; clamp height */
393 _out_size.height = _video_view->get()->GetSize().y;
394 _out_size.width = lrintf (_out_size.height * film_ratio);
397 /* Catch silly values */
398 _out_size.width = max (64, _out_size.width);
399 _out_size.height = max (64, _out_size.height);
401 /* Make OpenGL happy; XXX: only do this in GLVideoView? Is the round-to-4 constraint a thing? */
402 _out_size.width &= ~3;
403 _out_size.height &= ~3;
405 _player->set_video_container_size (_out_size);
415 optional<bool> v = PlaybackPermitted ();
417 /* Computer says no */
421 if (_audio.isStreamOpen()) {
422 _audio.setStreamTime (_video_position.seconds());
423 _audio.startStream ();
429 Started (position());
435 if (_audio.isStreamRunning()) {
436 /* stop stream and discard any remaining queued samples */
437 _audio.abortStream ();
445 Stopped (position());
450 FilmViewer::player_change (ChangeType type, int property, bool frequent)
452 if (type != CHANGE_TYPE_DONE || frequent) {
456 if (_coalesce_player_changes) {
457 _pending_player_changes.push_back (property);
462 bool refreshed = false;
464 property == VideoContentProperty::CROP ||
465 property == VideoContentProperty::SCALE ||
466 property == VideoContentProperty::FADE_IN ||
467 property == VideoContentProperty::FADE_OUT ||
468 property == VideoContentProperty::COLOUR_CONVERSION ||
469 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
470 property == PlayerProperty::FILM_CONTAINER
472 refreshed = quick_refresh ();
482 FilmViewer::film_change (ChangeType type, Film::Property p)
484 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
489 /** Re-get the current frame slowly by seeking */
491 FilmViewer::slow_refresh ()
493 seek (_video_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 (!_player_video.first) {
507 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
511 display_player_video ();
516 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
518 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
520 seek (*dt, accurate);
525 FilmViewer::set_coalesce_player_changes (bool c)
527 _coalesce_player_changes = c;
530 BOOST_FOREACH (int i, _pending_player_changes) {
531 player_change (CHANGE_TYPE_DONE, i, false);
533 _pending_player_changes.clear ();
538 FilmViewer::seek (DCPTime t, bool accurate)
544 if (t < DCPTime ()) {
548 if (t >= _film->length ()) {
549 t = _film->length ();
552 bool const was_running = stop ();
554 _closed_captions_dialog->clear ();
555 _butler->seek (t, accurate);
566 FilmViewer::config_changed (Config::Property p)
568 #ifdef DCPOMATIC_VARIANT_SWAROOP
569 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
575 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
579 if (_audio.isStreamOpen ()) {
580 _audio.closeStream ();
583 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
585 if (Config::instance()->sound_output()) {
586 while (st < _audio.getDeviceCount()) {
587 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
592 if (st == _audio.getDeviceCount()) {
593 st = _audio.getDefaultOutputDevice();
596 st = _audio.getDefaultOutputDevice();
599 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
601 RtAudio::StreamParameters sp;
603 sp.nChannels = _audio_channels;
606 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
607 #ifdef DCPOMATIC_USE_RTERROR
608 } catch (RtError& e) {
610 } catch (RtAudioError& e) {
614 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
626 FilmViewer::uncorrected_time () const
628 if (_audio.isStreamRunning ()) {
629 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
632 return _video_position;
636 FilmViewer::time () const
638 if (_audio.isStreamRunning ()) {
639 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
640 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
643 return _video_position;
647 FilmViewer::audio_callback (void* out_p, unsigned int frames)
650 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
651 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
652 /* There was an underrun or this audio is on time; carry on */
655 /* The audio we just got was (very) late; drop it and get some more. */
658 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
660 _latency_history.push_back (_audio.getStreamLatency ());
661 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
662 _latency_history.pop_front ();
670 FilmViewer::average_latency () const
672 boost::mutex::scoped_lock lm (_latency_history_mutex);
673 if (_latency_history.empty()) {
678 BOOST_FOREACH (Frame i, _latency_history) {
682 return total / _latency_history.size();
686 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
688 _dcp_decode_reduction = reduction;
690 _player->set_dcp_decode_reduction (reduction);
695 FilmViewer::dcp_decode_reduction () const
697 return _dcp_decode_reduction;
701 FilmViewer::one_video_frame () const
703 return DCPTime::from_frames (1, _film->video_frame_rate());
706 /** Open a dialog box showing our film's closed captions */
708 FilmViewer::show_closed_captions ()
710 _closed_captions_dialog->Show();
714 FilmViewer::seek_by (DCPTime by, bool accurate)
716 seek (_video_position + by, accurate);
720 FilmViewer::set_pad_black (bool p)