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, bool outline_content, bool jump_to_selected)
77 : _panel (new wxPanel (p))
78 , _outline_content (0)
80 , _jump_to_selected (0)
81 , _coalesce_player_changes (false)
82 , _slider_being_moved (false)
83 , _was_running_before_slider (false)
84 , _audio (DCPOMATIC_RTAUDIO_API)
86 , _audio_block_size (1024)
88 , _latency_history_count (0)
90 , _closed_captions_dialog (new ClosedCaptionsDialog(GetParent()))
93 _panel->SetDoubleBuffered (true);
96 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
98 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
99 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
100 if (_outline_content) {
101 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::refresh_panel, this));
103 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
105 set_film (shared_ptr<Film> ());
107 JobManager::instance()->ActiveJobsChanged.connect (
108 bind (&FilmViewer::active_jobs_changed, this, _2)
111 setup_sensitivity ();
113 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
114 config_changed (Config::SOUND_OUTPUT);
117 FilmViewer::~FilmViewer ()
123 FilmViewer::set_film (shared_ptr<Film> film)
132 _closed_captions_dialog->clear ();
143 _player.reset (new Player (_film, _film->playlist ()));
144 _player->set_fast ();
145 if (_dcp_decode_reduction) {
146 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
148 } catch (bad_alloc) {
149 error_dialog (this, _("There is not enough free memory to do that."));
154 _player->set_always_burn_open_subtitles ();
155 _player->set_play_referenced ();
157 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
158 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
160 /* Keep about 1 second's worth of history samples */
161 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
168 setup_sensitivity ();
172 FilmViewer::recreate_butler ()
174 bool const was_running = stop ();
181 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
183 if (_audio_channels != 2 || _film->audio_channels() < 3) {
184 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
188 /* Special case: stereo output, at least 3 channel input.
189 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
190 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
192 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
193 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
194 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
195 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
196 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
197 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
198 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
199 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
202 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
203 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
204 _butler->disable_audio ();
207 _closed_captions_dialog->set_butler (_butler);
215 FilmViewer::refresh_panel ()
224 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 ((_eye->GetSelection() == 0 && _player_video.first->eyes() == EYES_RIGHT) || (_eye->GetSelection() == 1 && _player_video.first->eyes() == EYES_LEFT))
241 display_player_video ();
245 FilmViewer::display_player_video ()
247 if (!_player_video.first) {
253 if (_playing && (time() - _player_video.second) > one_video_frame()) {
254 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
255 part if this frame is J2K).
257 _video_position = _player_video.second;
262 /* In an ideal world, what we would do here is:
264 * 1. convert to XYZ exactly as we do in the DCP creation path.
265 * 2. convert back to RGB for the preview display, compensating
266 * for the monitor etc. etc.
268 * but this is inefficient if the source is RGB. Since we don't
269 * (currently) care too much about the precise accuracy of the preview's
270 * colour mapping (and we care more about its speed) we try to short-
271 * circuit this "ideal" situation in some cases.
273 * The content's specified colour conversion indicates the colourspace
274 * which the content is in (according to the user).
276 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
277 * image and convert it (from whatever the user has said it is) to RGB.
280 _frame = _player_video.first->image (
281 bind (&Log::dcp_log, _film->log().get(), _1, _2),
282 bind (&PlayerVideo::always_rgb, _1),
286 ImageChanged (_player_video.first);
288 _video_position = _player_video.second;
289 _inter_position = _player_video.first->inter_position ();
290 _inter_size = _player_video.first->inter_size ();
294 _closed_captions_dialog->update (time());
300 if (!_film || !_playing) {
305 update_position_label ();
306 update_position_slider ();
307 DCPTime const next = _video_position + one_video_frame();
309 if (next >= _film->length()) {
313 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
321 FilmViewer::paint_panel ()
323 wxPaintDC dc (_panel);
325 if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
330 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
331 wxBitmap frame_bitmap (frame);
332 dc.DrawBitmap (frame_bitmap, 0, 0);
334 if (_out_size.width < _panel_size.width) {
335 wxPen p (GetBackgroundColour ());
336 wxBrush b (GetBackgroundColour ());
339 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
342 if (_out_size.height < _panel_size.height) {
343 wxPen p (GetBackgroundColour ());
344 wxBrush b (GetBackgroundColour ());
347 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
350 if (_outline_content && _outline_content->GetValue ()) {
351 wxPen p (wxColour (255, 0, 0), 2);
353 dc.SetBrush (*wxTRANSPARENT_BRUSH);
354 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
359 FilmViewer::panel_sized (wxSizeEvent& ev)
361 _panel_size.width = ev.GetSize().GetWidth();
362 _panel_size.height = ev.GetSize().GetHeight();
365 if (!quick_refresh()) {
368 update_position_label ();
369 update_position_slider ();
373 FilmViewer::calculate_sizes ()
375 if (!_film || !_player) {
379 Ratio const * container = _film->container ();
381 float const panel_ratio = _panel_size.ratio ();
382 float const film_ratio = container ? container->ratio () : 1.78;
384 if (panel_ratio < film_ratio) {
385 /* panel is less widscreen than the film; clamp width */
386 _out_size.width = _panel_size.width;
387 _out_size.height = lrintf (_out_size.width / film_ratio);
389 /* panel is more widescreen than the film; clamp height */
390 _out_size.height = _panel_size.height;
391 _out_size.width = lrintf (_out_size.height * film_ratio);
394 /* Catch silly values */
395 _out_size.width = max (64, _out_size.width);
396 _out_size.height = max (64, _out_size.height);
398 _player->set_video_container_size (_out_size);
408 if (_audio.isStreamOpen()) {
409 _audio.setStreamTime (_video_position.seconds());
410 _audio.startStream ();
416 _play_button->SetValue (true);
422 if (_audio.isStreamRunning()) {
423 /* stop stream and discard any remaining queued samples */
424 _audio.abortStream ();
432 _play_button->SetValue (false);
437 FilmViewer::go_to (DCPTime t)
439 if (t < DCPTime ()) {
443 if (t >= _film->length ()) {
444 t = _film->length ();
448 update_position_label ();
449 update_position_slider ();
453 FilmViewer::player_change (ChangeType type, int property, bool frequent)
455 if (type != CHANGE_TYPE_DONE || frequent) {
459 if (_coalesce_player_changes) {
460 _pending_player_changes.push_back (property);
465 bool refreshed = false;
467 property == VideoContentProperty::CROP ||
468 property == VideoContentProperty::SCALE ||
469 property == VideoContentProperty::FADE_IN ||
470 property == VideoContentProperty::FADE_OUT ||
471 property == VideoContentProperty::COLOUR_CONVERSION ||
472 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
473 property == PlayerProperty::FILM_CONTAINER
475 refreshed = quick_refresh ();
481 update_position_label ();
482 update_position_slider ();
486 FilmViewer::film_change (ChangeType type, Film::Property p)
488 if (type != CHANGE_TYPE_DONE) {
492 if (p == Film::CONTENT || p == Film::THREE_D) {
493 setup_sensitivity ();
494 } else if (p == Film::AUDIO_CHANNELS) {
499 /** Re-get the current frame slowly by seeking */
501 FilmViewer::slow_refresh ()
503 seek (_video_position, true);
506 /** Try to re-get the current frame quickly by resetting the metadata
507 * in the PlayerVideo that we used last time.
508 * @return true if this was possible, false if not.
511 FilmViewer::quick_refresh ()
513 if (!_player_video.first) {
517 if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
521 display_player_video ();
526 FilmViewer::set_position (DCPTime p)
530 update_position_label ();
531 update_position_slider ();
535 FilmViewer::set_position (shared_ptr<Content> content, ContentTime t)
537 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
544 FilmViewer::set_coalesce_player_changes (bool c)
546 _coalesce_player_changes = c;
549 BOOST_FOREACH (int i, _pending_player_changes) {
550 player_change (CHANGE_TYPE_DONE, i, false);
552 _pending_player_changes.clear ();
557 FilmViewer::seek (DCPTime t, bool accurate)
563 bool const was_running = stop ();
565 _closed_captions_dialog->clear ();
566 _butler->seek (t, accurate);
575 FilmViewer::config_changed (Config::Property p)
577 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
581 if (_audio.isStreamOpen ()) {
582 _audio.closeStream ();
585 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
587 if (Config::instance()->sound_output()) {
588 while (st < _audio.getDeviceCount()) {
589 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
594 if (st == _audio.getDeviceCount()) {
595 st = _audio.getDefaultOutputDevice();
598 st = _audio.getDefaultOutputDevice();
601 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
603 RtAudio::StreamParameters sp;
605 sp.nChannels = _audio_channels;
608 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
609 #ifdef DCPOMATIC_USE_RTERROR
610 } catch (RtError& e) {
612 } catch (RtAudioError& e) {
616 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
628 FilmViewer::uncorrected_time () const
630 if (_audio.isStreamRunning ()) {
631 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
634 return _video_position;
638 FilmViewer::time () const
640 if (_audio.isStreamRunning ()) {
641 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
642 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
645 return _video_position;
649 FilmViewer::audio_callback (void* out_p, unsigned int frames)
652 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
653 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
654 /* There was an underrun or this audio is on time; carry on */
657 /* The audio we just got was (very) late; drop it and get some more. */
660 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
662 _latency_history.push_back (_audio.getStreamLatency ());
663 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
664 _latency_history.pop_front ();
672 FilmViewer::average_latency () const
674 boost::mutex::scoped_lock lm (_latency_history_mutex);
675 if (_latency_history.empty()) {
680 BOOST_FOREACH (Frame i, _latency_history) {
684 return total / _latency_history.size();
688 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
690 _dcp_decode_reduction = reduction;
692 _player->set_dcp_decode_reduction (reduction);
697 FilmViewer::dcp_decode_reduction () const
699 return _dcp_decode_reduction;
703 FilmViewer::one_video_frame () const
705 return DCPTime::from_frames (1, _film->video_frame_rate());
709 FilmViewer::show_closed_captions ()
711 _closed_captions_dialog->Show();
715 FilmViewer::back_frame (DCPTime by)
721 go_to (_video_position + by);