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 /* XXX: make this configurable */
83 // : _video_view (new GLVideoView(p))
84 : _video_view (new SimpleVideoView(this, p))
85 , _coalesce_player_changes (false)
86 , _audio (DCPOMATIC_RTAUDIO_API)
88 , _audio_block_size (1024)
90 , _latency_history_count (0)
92 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
93 , _outline_content (false)
96 #ifdef DCPOMATIC_VARIANT_SWAROOP
97 , _in_watermark (false)
98 , _background_image (false)
100 , _state_timer ("viewer")
103 /* XXX: maybe this should be proxied through the VideoView */
104 _video_view->get()->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::video_view_sized, this));
105 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
107 set_film (shared_ptr<Film> ());
109 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
110 config_changed (Config::SOUND_OUTPUT);
113 FilmViewer::~FilmViewer ()
119 FilmViewer::set_film (shared_ptr<Film> film)
126 _video_position = DCPTime ();
127 _player_video.first.reset ();
128 _player_video.second = DCPTime ();
131 _closed_captions_dialog->clear ();
142 _player.reset (new Player (_film, _film->playlist ()));
143 _player->set_fast ();
144 if (_dcp_decode_reduction) {
145 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
147 } catch (bad_alloc &) {
148 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
153 _player->set_always_burn_open_subtitles ();
154 _player->set_play_referenced ();
156 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
157 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
159 /* Keep about 1 second's worth of history samples */
160 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
169 FilmViewer::recreate_butler ()
171 bool const was_running = stop ();
178 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
180 if (_audio_channels != 2 || _film->audio_channels() < 3) {
181 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
185 /* Special case: stereo output, at least 3 channel input.
186 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
187 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
189 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
190 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
191 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
192 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
193 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
194 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
195 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
196 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
199 _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
200 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
201 _butler->disable_audio ();
204 _closed_captions_dialog->set_film_and_butler (_film, _butler);
212 FilmViewer::refresh_view ()
214 _state_timer.set ("refresh-view");
215 _video_view->get()->Refresh ();
216 _video_view->get()->Update ();
217 _state_timer.unset ();
223 DCPOMATIC_ASSERT (_butler);
228 _player_video = _butler->get_video (&e);
229 if (!_player_video.first && e == Butler::AGAIN) {
230 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
234 _player_video.first &&
236 _eyes != _player_video.first->eyes() &&
237 _player_video.first->eyes() != EYES_BOTH
242 display_player_video ();
246 FilmViewer::display_player_video ()
248 if (!_player_video.first) {
254 if (_playing && (time() - _player_video.second) > one_video_frame()) {
255 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
256 part if this frame is J2K).
258 _video_position = _player_video.second;
263 /* In an ideal world, what we would do here is:
265 * 1. convert to XYZ exactly as we do in the DCP creation path.
266 * 2. convert back to RGB for the preview display, compensating
267 * for the monitor etc. etc.
269 * but this is inefficient if the source is RGB. Since we don't
270 * (currently) care too much about the precise accuracy of the preview's
271 * colour mapping (and we care more about its speed) we try to short-
272 * circuit this "ideal" situation in some cases.
274 * The content's specified colour conversion indicates the colourspace
275 * which the content is in (according to the user).
277 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
278 * image and convert it (from whatever the user has said it is) to RGB.
281 _state_timer.set ("get image");
283 /* XXX: do we need to store _frame? */
284 _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
285 _video_view->set_image (_frame);
287 _state_timer.set ("ImageChanged");
288 ImageChanged (_player_video.first);
289 _state_timer.unset ();
291 _video_position = _player_video.second;
292 _inter_position = _player_video.first->inter_position ();
293 _inter_size = _player_video.first->inter_size ();
297 _closed_captions_dialog->update (time());
303 if (!_film || !_playing) {
309 DCPTime const next = _video_position + one_video_frame();
311 if (next >= _film->length()) {
317 LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
318 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
326 #ifdef DCPOMATIC_VARIANT_SWAROOP
328 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
330 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
332 wxImage image (std_to_wx(bg->string()));
333 wxBitmap bitmap (image);
334 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
341 FilmViewer::maybe_draw_background_image (wxPaintDC &)
348 FilmViewer::set_outline_content (bool o)
350 _outline_content = o;
355 FilmViewer::set_eyes (Eyes e)
362 FilmViewer::video_view_sized ()
365 if (!quick_refresh()) {
372 FilmViewer::calculate_sizes ()
374 if (!_film || !_player) {
378 Ratio const * container = _film->container ();
380 float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
381 float const film_ratio = container ? container->ratio () : 1.78;
383 if (view_ratio < film_ratio) {
384 /* panel is less widscreen than the film; clamp width */
385 _out_size.width = _video_view->get()->GetSize().x;
386 _out_size.height = lrintf (_out_size.width / film_ratio);
388 /* panel is more widescreen than the film; clamp height */
389 _out_size.height = _video_view->get()->GetSize().y;
390 _out_size.width = lrintf (_out_size.height * film_ratio);
393 /* Catch silly values */
394 _out_size.width = max (64, _out_size.width);
395 _out_size.height = max (64, _out_size.height);
397 /* Make OpenGL happy; XXX: only do this in GLVideoView? Is the round-to-4 constraint a thing? */
398 _out_size.width &= ~3;
399 _out_size.height &= ~3;
401 _player->set_video_container_size (_out_size);
411 optional<bool> v = PlaybackPermitted ();
413 /* Computer says no */
417 if (_audio.isStreamOpen()) {
418 _audio.setStreamTime (_video_position.seconds());
419 _audio.startStream ();
425 Started (position());
431 if (_audio.isStreamRunning()) {
432 /* stop stream and discard any remaining queued samples */
433 _audio.abortStream ();
441 Stopped (position());
446 FilmViewer::player_change (ChangeType type, int property, bool frequent)
448 if (type != CHANGE_TYPE_DONE || frequent) {
452 if (_coalesce_player_changes) {
453 _pending_player_changes.push_back (property);
458 bool refreshed = false;
460 property == VideoContentProperty::CROP ||
461 property == VideoContentProperty::SCALE ||
462 property == VideoContentProperty::FADE_IN ||
463 property == VideoContentProperty::FADE_OUT ||
464 property == VideoContentProperty::COLOUR_CONVERSION ||
465 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
466 property == PlayerProperty::FILM_CONTAINER
468 refreshed = quick_refresh ();
478 FilmViewer::film_change (ChangeType type, Film::Property p)
480 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
485 /** Re-get the current frame slowly by seeking */
487 FilmViewer::slow_refresh ()
489 seek (_video_position, true);
492 /** Try to re-get the current frame quickly by resetting the metadata
493 * in the PlayerVideo that we used last time.
494 * @return true if this was possible, false if not.
497 FilmViewer::quick_refresh ()
499 if (!_player_video.first) {
503 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
507 display_player_video ();
512 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
514 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
516 seek (*dt, accurate);
521 FilmViewer::set_coalesce_player_changes (bool c)
523 _coalesce_player_changes = c;
526 BOOST_FOREACH (int i, _pending_player_changes) {
527 player_change (CHANGE_TYPE_DONE, i, false);
529 _pending_player_changes.clear ();
534 FilmViewer::seek (DCPTime t, bool accurate)
540 if (t < DCPTime ()) {
544 if (t >= _film->length ()) {
545 t = _film->length ();
548 bool const was_running = stop ();
550 _closed_captions_dialog->clear ();
551 _butler->seek (t, accurate);
562 FilmViewer::config_changed (Config::Property p)
564 #ifdef DCPOMATIC_VARIANT_SWAROOP
565 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
571 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
575 if (_audio.isStreamOpen ()) {
576 _audio.closeStream ();
579 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
581 if (Config::instance()->sound_output()) {
582 while (st < _audio.getDeviceCount()) {
583 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
588 if (st == _audio.getDeviceCount()) {
589 st = _audio.getDefaultOutputDevice();
592 st = _audio.getDefaultOutputDevice();
595 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
597 RtAudio::StreamParameters sp;
599 sp.nChannels = _audio_channels;
602 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
603 #ifdef DCPOMATIC_USE_RTERROR
604 } catch (RtError& e) {
606 } catch (RtAudioError& e) {
610 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
622 FilmViewer::uncorrected_time () const
624 if (_audio.isStreamRunning ()) {
625 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
628 return _video_position;
632 FilmViewer::time () const
634 if (_audio.isStreamRunning ()) {
635 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
636 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
639 return _video_position;
643 FilmViewer::audio_callback (void* out_p, unsigned int frames)
646 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
647 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
648 /* There was an underrun or this audio is on time; carry on */
651 /* The audio we just got was (very) late; drop it and get some more. */
654 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
656 _latency_history.push_back (_audio.getStreamLatency ());
657 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
658 _latency_history.pop_front ();
666 FilmViewer::average_latency () const
668 boost::mutex::scoped_lock lm (_latency_history_mutex);
669 if (_latency_history.empty()) {
674 BOOST_FOREACH (Frame i, _latency_history) {
678 return total / _latency_history.size();
682 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
684 _dcp_decode_reduction = reduction;
686 _player->set_dcp_decode_reduction (reduction);
691 FilmViewer::dcp_decode_reduction () const
693 return _dcp_decode_reduction;
697 FilmViewer::one_video_frame () const
699 return DCPTime::from_frames (1, _film->video_frame_rate());
702 /** Open a dialog box showing our film's closed captions */
704 FilmViewer::show_closed_captions ()
706 _closed_captions_dialog->Show();
710 FilmViewer::seek_by (DCPTime by, bool accurate)
712 seek (_video_position + by, accurate);
716 FilmViewer::set_pad_black (bool p)