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"
46 #include "lib/compose.hpp"
48 #include <libavutil/pixfmt.h>
50 #include <dcp/exceptions.h>
51 #include <wx/tglbtn.h>
64 using boost::shared_ptr;
65 using boost::dynamic_pointer_cast;
66 using boost::weak_ptr;
67 using boost::optional;
72 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
74 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
77 FilmViewer::FilmViewer (wxWindow* p)
78 : _panel (new wxPanel (p))
79 , _coalesce_player_changes (false)
80 , _audio (DCPOMATIC_RTAUDIO_API)
82 , _audio_block_size (1024)
84 , _latency_history_count (0)
86 , _closed_captions_dialog (new ClosedCaptionsDialog(p))
87 , _outline_content (false)
90 #ifdef DCPOMATIC_VARIANT_SWAROOP
91 , _in_watermark (false)
95 _panel->SetDoubleBuffered (true);
98 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
99 _panel->SetBackgroundColour (*wxBLACK);
101 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
102 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
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)
128 _closed_captions_dialog->clear ();
139 _player.reset (new Player (_film, _film->playlist ()));
140 _player->set_fast ();
141 if (_dcp_decode_reduction) {
142 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
144 } catch (bad_alloc) {
145 error_dialog (_panel, _("There is not enough free memory to do that."));
150 _player->set_always_burn_open_subtitles ();
151 _player->set_play_referenced ();
153 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
154 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
156 /* Keep about 1 second's worth of history samples */
157 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
166 FilmViewer::recreate_butler ()
168 bool const was_running = stop ();
175 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
177 if (_audio_channels != 2 || _film->audio_channels() < 3) {
178 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
182 /* Special case: stereo output, at least 3 channel input.
183 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
184 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
186 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
187 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
188 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
189 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
190 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
191 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
192 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
193 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
196 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
197 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
198 _butler->disable_audio ();
201 _closed_captions_dialog->set_butler (_butler);
209 FilmViewer::refresh_panel ()
218 DCPOMATIC_ASSERT (_butler);
222 _player_video = _butler->get_video (&e);
223 if (!_player_video.first && e == Butler::AGAIN) {
224 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
228 _player_video.first &&
230 (_eyes != _player_video.first->eyes())
235 display_player_video ();
239 FilmViewer::display_player_video ()
241 if (!_player_video.first) {
247 if (_playing && (time() - _player_video.second) > one_video_frame()) {
248 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
249 part if this frame is J2K).
251 _video_position = _player_video.second;
256 /* In an ideal world, what we would do here is:
258 * 1. convert to XYZ exactly as we do in the DCP creation path.
259 * 2. convert back to RGB for the preview display, compensating
260 * for the monitor etc. etc.
262 * but this is inefficient if the source is RGB. Since we don't
263 * (currently) care too much about the precise accuracy of the preview's
264 * colour mapping (and we care more about its speed) we try to short-
265 * circuit this "ideal" situation in some cases.
267 * The content's specified colour conversion indicates the colourspace
268 * which the content is in (according to the user).
270 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
271 * image and convert it (from whatever the user has said it is) to RGB.
274 _frame = _player_video.first->image (
275 bind (&PlayerVideo::always_rgb, _1),
279 ImageChanged (_player_video.first);
281 _video_position = _player_video.second;
282 _inter_position = _player_video.first->inter_position ();
283 _inter_size = _player_video.first->inter_size ();
287 _closed_captions_dialog->update (time());
293 if (!_film || !_playing) {
299 DCPTime const next = _video_position + one_video_frame();
301 if (next >= _film->length()) {
305 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
313 FilmViewer::paint_panel ()
315 wxPaintDC dc (_panel);
317 if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
319 #ifdef DCPOMATIC_VARIANT_SWAROOP
320 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
322 wxImage image (std_to_wx(bg->string()));
323 wxBitmap bitmap (image);
324 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
330 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
331 wxBitmap frame_bitmap (frame);
332 dc.DrawBitmap (frame_bitmap, 0, max(0, (_panel_size.height - _out_size.height) / 2));
334 #ifdef DCPOMATIC_VARIANT_SWAROOP
335 DCPTime const period = DCPTime::from_seconds(Config::instance()->player_watermark_period() * 60);
336 int64_t n = _video_position.get() / period.get();
337 DCPTime from(n * period.get());
338 DCPTime to = from + DCPTime::from_seconds(Config::instance()->player_watermark_duration() / 1000.0);
339 if (from <= _video_position && _video_position <= to) {
340 if (!_in_watermark) {
341 _in_watermark = true;
342 _watermark_x = rand() % _panel_size.width;
343 _watermark_y = rand() % _panel_size.height;
345 dc.SetTextForeground(*wxWHITE);
346 string wm = Config::instance()->player_watermark_theatre();
347 boost::posix_time::ptime t = boost::posix_time::second_clock::local_time();
348 wm += "\n" + boost::posix_time::to_iso_extended_string(t);
349 dc.DrawText(std_to_wx(wm), _watermark_x, _watermark_y);
351 _in_watermark = false;
355 if (_out_size.width < _panel_size.width) {
356 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
357 wxPen p (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
358 wxBrush b (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
361 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
364 if (_out_size.height < _panel_size.height) {
365 wxPen p (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
366 wxBrush b (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
369 int const gap = (_panel_size.height - _out_size.height) / 2;
370 dc.DrawRectangle (0, 0, _panel_size.width, gap);
371 dc.DrawRectangle (0, gap + _out_size.height + 1, _panel_size.width, gap);
374 if (_outline_content) {
375 wxPen p (wxColour (255, 0, 0), 2);
377 dc.SetBrush (*wxTRANSPARENT_BRUSH);
378 dc.DrawRectangle (_inter_position.x, _inter_position.y + (_panel_size.height - _out_size.height) / 2, _inter_size.width, _inter_size.height);
383 FilmViewer::set_outline_content (bool o)
385 _outline_content = o;
390 FilmViewer::set_eyes (Eyes e)
397 FilmViewer::panel_sized (wxSizeEvent& ev)
399 _panel_size.width = ev.GetSize().GetWidth();
400 _panel_size.height = ev.GetSize().GetHeight();
403 if (!quick_refresh()) {
410 FilmViewer::calculate_sizes ()
412 if (!_film || !_player) {
416 Ratio const * container = _film->container ();
418 float const panel_ratio = _panel_size.ratio ();
419 float const film_ratio = container ? container->ratio () : 1.78;
421 if (panel_ratio < film_ratio) {
422 /* panel is less widscreen than the film; clamp width */
423 _out_size.width = _panel_size.width;
424 _out_size.height = lrintf (_out_size.width / film_ratio);
426 /* panel is more widescreen than the film; clamp height */
427 _out_size.height = _panel_size.height;
428 _out_size.width = lrintf (_out_size.height * film_ratio);
431 /* Catch silly values */
432 _out_size.width = max (64, _out_size.width);
433 _out_size.height = max (64, _out_size.height);
435 _player->set_video_container_size (_out_size);
445 optional<bool> v = PlaybackPermitted ();
447 /* Computer says no */
451 if (_audio.isStreamOpen()) {
452 _audio.setStreamTime (_video_position.seconds());
453 _audio.startStream ();
459 Started (position());
465 if (_audio.isStreamRunning()) {
466 /* stop stream and discard any remaining queued samples */
467 _audio.abortStream ();
475 Stopped (position());
480 FilmViewer::player_change (ChangeType type, int property, bool frequent)
482 if (type != CHANGE_TYPE_DONE || frequent) {
486 if (_coalesce_player_changes) {
487 _pending_player_changes.push_back (property);
492 bool refreshed = false;
494 property == VideoContentProperty::CROP ||
495 property == VideoContentProperty::SCALE ||
496 property == VideoContentProperty::FADE_IN ||
497 property == VideoContentProperty::FADE_OUT ||
498 property == VideoContentProperty::COLOUR_CONVERSION ||
499 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
500 property == PlayerProperty::FILM_CONTAINER
502 refreshed = quick_refresh ();
512 FilmViewer::film_change (ChangeType type, Film::Property p)
514 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
519 /** Re-get the current frame slowly by seeking */
521 FilmViewer::slow_refresh ()
523 seek (_video_position, true);
526 /** Try to re-get the current frame quickly by resetting the metadata
527 * in the PlayerVideo that we used last time.
528 * @return true if this was possible, false if not.
531 FilmViewer::quick_refresh ()
533 if (!_player_video.first) {
537 if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
541 display_player_video ();
546 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
548 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
550 seek (*dt, accurate);
555 FilmViewer::set_coalesce_player_changes (bool c)
557 _coalesce_player_changes = c;
560 BOOST_FOREACH (int i, _pending_player_changes) {
561 player_change (CHANGE_TYPE_DONE, i, false);
563 _pending_player_changes.clear ();
568 FilmViewer::seek (DCPTime t, bool accurate)
574 if (t < DCPTime ()) {
578 if (t >= _film->length ()) {
579 t = _film->length ();
582 bool const was_running = stop ();
584 _closed_captions_dialog->clear ();
585 _butler->seek (t, accurate);
597 FilmViewer::config_changed (Config::Property p)
599 #ifdef DCPOMATIC_VARIANT_SWAROOP
600 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
606 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
610 if (_audio.isStreamOpen ()) {
611 _audio.closeStream ();
614 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
616 if (Config::instance()->sound_output()) {
617 while (st < _audio.getDeviceCount()) {
618 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
623 if (st == _audio.getDeviceCount()) {
624 st = _audio.getDefaultOutputDevice();
627 st = _audio.getDefaultOutputDevice();
630 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
632 RtAudio::StreamParameters sp;
634 sp.nChannels = _audio_channels;
637 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
638 #ifdef DCPOMATIC_USE_RTERROR
639 } catch (RtError& e) {
641 } catch (RtAudioError& e) {
645 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
657 FilmViewer::uncorrected_time () const
659 if (_audio.isStreamRunning ()) {
660 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
663 return _video_position;
667 FilmViewer::time () const
669 if (_audio.isStreamRunning ()) {
670 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
671 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
674 return _video_position;
678 FilmViewer::audio_callback (void* out_p, unsigned int frames)
681 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
682 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
683 /* There was an underrun or this audio is on time; carry on */
686 /* The audio we just got was (very) late; drop it and get some more. */
689 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
691 _latency_history.push_back (_audio.getStreamLatency ());
692 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
693 _latency_history.pop_front ();
701 FilmViewer::average_latency () const
703 boost::mutex::scoped_lock lm (_latency_history_mutex);
704 if (_latency_history.empty()) {
709 BOOST_FOREACH (Frame i, _latency_history) {
713 return total / _latency_history.size();
717 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
719 _dcp_decode_reduction = reduction;
721 _player->set_dcp_decode_reduction (reduction);
726 FilmViewer::dcp_decode_reduction () const
728 return _dcp_decode_reduction;
732 FilmViewer::one_video_frame () const
734 return DCPTime::from_frames (1, _film->video_frame_rate());
737 /** Open a dialog box showing our film's closed captions */
739 FilmViewer::show_closed_captions ()
741 _closed_captions_dialog->Show();
745 FilmViewer::seek_by (DCPTime by, bool accurate)
747 seek (_video_position + by, accurate);
751 FilmViewer::set_pad_black (bool p)