2 Copyright (C) 2012-2018 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"
31 #include "lib/ratio.h"
33 #include "lib/job_manager.h"
34 #include "lib/image.h"
35 #include "lib/exceptions.h"
36 #include "lib/examine_content_job.h"
37 #include "lib/filter.h"
38 #include "lib/player.h"
39 #include "lib/player_video.h"
40 #include "lib/video_content.h"
41 #include "lib/video_decoder.h"
42 #include "lib/timer.h"
43 #include "lib/butler.h"
45 #include "lib/config.h"
47 #include <libavutil/pixfmt.h>
49 #include <dcp/exceptions.h>
50 #include <wx/tglbtn.h>
63 using boost::shared_ptr;
64 using boost::dynamic_pointer_cast;
65 using boost::weak_ptr;
66 using boost::optional;
71 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
73 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
76 FilmViewer::FilmViewer (wxWindow* p)
77 : _panel (new wxPanel (p))
78 , _coalesce_player_changes (false)
79 , _audio (DCPOMATIC_RTAUDIO_API)
81 , _audio_block_size (1024)
83 , _latency_history_count (0)
85 , _closed_captions_dialog (new ClosedCaptionsDialog(p))
86 , _outline_content (false)
90 _panel->SetDoubleBuffered (true);
93 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
94 _panel->SetBackgroundColour (*wxBLACK);
96 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
97 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
98 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
100 set_film (shared_ptr<Film> ());
102 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
103 config_changed (Config::SOUND_OUTPUT);
106 FilmViewer::~FilmViewer ()
112 FilmViewer::set_film (shared_ptr<Film> film)
123 _closed_captions_dialog->clear ();
134 _player.reset (new Player (_film, _film->playlist ()));
135 _player->set_fast ();
136 if (_dcp_decode_reduction) {
137 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
139 } catch (bad_alloc) {
140 error_dialog (_panel, _("There is not enough free memory to do that."));
145 _player->set_always_burn_open_subtitles ();
146 _player->set_play_referenced ();
148 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
149 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
151 /* Keep about 1 second's worth of history samples */
152 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
161 FilmViewer::recreate_butler ()
163 bool const was_running = stop ();
170 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
172 if (_audio_channels != 2 || _film->audio_channels() < 3) {
173 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
177 /* Special case: stereo output, at least 3 channel input.
178 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
179 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
181 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
182 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
183 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
184 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
185 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
186 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
187 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
188 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
191 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
192 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
193 _butler->disable_audio ();
196 _closed_captions_dialog->set_butler (_butler);
204 FilmViewer::refresh_panel ()
213 DCPOMATIC_ASSERT (_butler);
217 _player_video = _butler->get_video (&e);
218 if (!_player_video.first && e == Butler::AGAIN) {
219 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
223 _player_video.first &&
225 (_eyes != _player_video.first->eyes())
230 display_player_video ();
234 FilmViewer::display_player_video ()
236 if (!_player_video.first) {
242 if (_playing && (time() - _player_video.second) > one_video_frame()) {
243 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
244 part if this frame is J2K).
246 _video_position = _player_video.second;
251 /* In an ideal world, what we would do here is:
253 * 1. convert to XYZ exactly as we do in the DCP creation path.
254 * 2. convert back to RGB for the preview display, compensating
255 * for the monitor etc. etc.
257 * but this is inefficient if the source is RGB. Since we don't
258 * (currently) care too much about the precise accuracy of the preview's
259 * colour mapping (and we care more about its speed) we try to short-
260 * circuit this "ideal" situation in some cases.
262 * The content's specified colour conversion indicates the colourspace
263 * which the content is in (according to the user).
265 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
266 * image and convert it (from whatever the user has said it is) to RGB.
269 _frame = _player_video.first->image (
270 bind (&Log::dcp_log, _film->log().get(), _1, _2),
271 bind (&PlayerVideo::always_rgb, _1),
275 ImageChanged (_player_video.first);
277 _video_position = _player_video.second;
278 _inter_position = _player_video.first->inter_position ();
279 _inter_size = _player_video.first->inter_size ();
283 _closed_captions_dialog->update (time());
289 if (!_film || !_playing) {
295 DCPTime const next = _video_position + one_video_frame();
297 if (next >= _film->length()) {
301 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
309 FilmViewer::paint_panel ()
311 wxPaintDC dc (_panel);
313 if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
318 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
319 wxBitmap frame_bitmap (frame);
320 dc.DrawBitmap (frame_bitmap, 0, 0);
322 if (_out_size.width < _panel_size.width) {
323 wxPen p (_panel->GetParent()->GetBackgroundColour());
324 wxBrush b (_panel->GetParent()->GetBackgroundColour());
327 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
330 if (_out_size.height < _panel_size.height) {
331 wxPen p (_panel->GetParent()->GetBackgroundColour());
332 wxBrush b (_panel->GetParent()->GetBackgroundColour());
335 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
338 if (_outline_content) {
339 wxPen p (wxColour (255, 0, 0), 2);
341 dc.SetBrush (*wxTRANSPARENT_BRUSH);
342 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
347 FilmViewer::set_outline_content (bool o)
349 _outline_content = o;
354 FilmViewer::set_eyes (Eyes e)
361 FilmViewer::panel_sized (wxSizeEvent& ev)
363 _panel_size.width = ev.GetSize().GetWidth();
364 _panel_size.height = ev.GetSize().GetHeight();
367 if (!quick_refresh()) {
374 FilmViewer::calculate_sizes ()
376 if (!_film || !_player) {
380 Ratio const * container = _film->container ();
382 float const panel_ratio = _panel_size.ratio ();
383 float const film_ratio = container ? container->ratio () : 1.78;
385 if (panel_ratio < film_ratio) {
386 /* panel is less widscreen than the film; clamp width */
387 _out_size.width = _panel_size.width;
388 _out_size.height = lrintf (_out_size.width / film_ratio);
390 /* panel is more widescreen than the film; clamp height */
391 _out_size.height = _panel_size.height;
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 _player->set_video_container_size (_out_size);
409 if (_audio.isStreamOpen()) {
410 _audio.setStreamTime (_video_position.seconds());
411 _audio.startStream ();
423 if (_audio.isStreamRunning()) {
424 /* stop stream and discard any remaining queued samples */
425 _audio.abortStream ();
438 FilmViewer::player_change (ChangeType type, int property, bool frequent)
440 if (type != CHANGE_TYPE_DONE || frequent) {
444 if (_coalesce_player_changes) {
445 _pending_player_changes.push_back (property);
450 bool refreshed = false;
452 property == VideoContentProperty::CROP ||
453 property == VideoContentProperty::SCALE ||
454 property == VideoContentProperty::FADE_IN ||
455 property == VideoContentProperty::FADE_OUT ||
456 property == VideoContentProperty::COLOUR_CONVERSION ||
457 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
458 property == PlayerProperty::FILM_CONTAINER
460 refreshed = quick_refresh ();
470 FilmViewer::film_change (ChangeType type, Film::Property p)
472 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
477 /** Re-get the current frame slowly by seeking */
479 FilmViewer::slow_refresh ()
481 seek (_video_position, true);
484 /** Try to re-get the current frame quickly by resetting the metadata
485 * in the PlayerVideo that we used last time.
486 * @return true if this was possible, false if not.
489 FilmViewer::quick_refresh ()
491 if (!_player_video.first) {
495 if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
499 display_player_video ();
504 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
506 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
508 seek (*dt, accurate);
513 FilmViewer::set_coalesce_player_changes (bool c)
515 _coalesce_player_changes = c;
518 BOOST_FOREACH (int i, _pending_player_changes) {
519 player_change (CHANGE_TYPE_DONE, i, false);
521 _pending_player_changes.clear ();
526 FilmViewer::seek (DCPTime t, bool accurate)
532 if (t < DCPTime ()) {
536 if (t >= _film->length ()) {
537 t = _film->length ();
540 bool const was_running = stop ();
542 _closed_captions_dialog->clear ();
543 _butler->seek (t, accurate);
554 FilmViewer::config_changed (Config::Property p)
556 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
560 if (_audio.isStreamOpen ()) {
561 _audio.closeStream ();
564 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
566 if (Config::instance()->sound_output()) {
567 while (st < _audio.getDeviceCount()) {
568 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
573 if (st == _audio.getDeviceCount()) {
574 st = _audio.getDefaultOutputDevice();
577 st = _audio.getDefaultOutputDevice();
580 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
582 RtAudio::StreamParameters sp;
584 sp.nChannels = _audio_channels;
587 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
588 #ifdef DCPOMATIC_USE_RTERROR
589 } catch (RtError& e) {
591 } catch (RtAudioError& e) {
595 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
607 FilmViewer::uncorrected_time () const
609 if (_audio.isStreamRunning ()) {
610 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
613 return _video_position;
617 FilmViewer::time () const
619 if (_audio.isStreamRunning ()) {
620 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
621 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
624 return _video_position;
628 FilmViewer::audio_callback (void* out_p, unsigned int frames)
631 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
632 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
633 /* There was an underrun or this audio is on time; carry on */
636 /* The audio we just got was (very) late; drop it and get some more. */
639 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
641 _latency_history.push_back (_audio.getStreamLatency ());
642 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
643 _latency_history.pop_front ();
651 FilmViewer::average_latency () const
653 boost::mutex::scoped_lock lm (_latency_history_mutex);
654 if (_latency_history.empty()) {
659 BOOST_FOREACH (Frame i, _latency_history) {
663 return total / _latency_history.size();
667 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
669 _dcp_decode_reduction = reduction;
671 _player->set_dcp_decode_reduction (reduction);
676 FilmViewer::dcp_decode_reduction () const
678 return _dcp_decode_reduction;
682 FilmViewer::one_video_frame () const
684 return DCPTime::from_frames (1, _film->video_frame_rate());
687 /** Open a dialog box showing our film's closed captions */
689 FilmViewer::show_closed_captions ()
691 _closed_captions_dialog->Show();
695 FilmViewer::seek_by (DCPTime by, bool accurate)
697 seek (_video_position + by, accurate);