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"
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"
47 #include "lib/dcpomatic_log.h"
49 #include <libavutil/pixfmt.h>
51 #include <dcp/exceptions.h>
52 #include <wx/tglbtn.h>
65 using boost::shared_ptr;
66 using boost::dynamic_pointer_cast;
67 using boost::weak_ptr;
68 using boost::optional;
73 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
75 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
78 FilmViewer::FilmViewer (wxWindow* p)
79 : _panel (new wxPanel (p))
80 , _coalesce_player_changes (false)
81 , _audio (DCPOMATIC_RTAUDIO_API)
83 , _audio_block_size (1024)
85 , _latency_history_count (0)
87 , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
88 , _outline_content (false)
91 #ifdef DCPOMATIC_VARIANT_SWAROOP
92 , _in_watermark (false)
93 , _background_image (false)
95 , _state_timer ("viewer")
99 _panel->SetDoubleBuffered (true);
102 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
103 _panel->SetBackgroundColour (*wxBLACK);
105 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
106 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
107 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
109 set_film (shared_ptr<Film> ());
111 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
112 config_changed (Config::SOUND_OUTPUT);
115 FilmViewer::~FilmViewer ()
121 FilmViewer::set_film (shared_ptr<Film> film)
128 _video_position = DCPTime ();
129 _player_video.first.reset ();
130 _player_video.second = DCPTime ();
133 _closed_captions_dialog->clear ();
144 _player.reset (new Player (_film, _film->playlist ()));
145 _player->set_fast ();
146 if (_dcp_decode_reduction) {
147 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
149 } catch (bad_alloc &) {
150 error_dialog (_panel, _("There is not enough free memory to do that."));
155 _player->set_always_burn_open_subtitles ();
156 _player->set_play_referenced ();
158 _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
159 _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
161 /* Keep about 1 second's worth of history samples */
162 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
171 FilmViewer::recreate_butler ()
173 bool const was_running = stop ();
180 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
182 if (_audio_channels != 2 || _film->audio_channels() < 3) {
183 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
187 /* Special case: stereo output, at least 3 channel input.
188 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
189 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
191 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
192 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
193 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
194 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
195 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
196 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
197 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
198 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
201 _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
202 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
203 _butler->disable_audio ();
206 _closed_captions_dialog->set_film_and_butler (_film, _butler);
214 FilmViewer::refresh_panel ()
216 _state_timer.set ("refresh-panel");
219 _state_timer.unset ();
225 DCPOMATIC_ASSERT (_butler);
230 _player_video = _butler->get_video (&e);
231 if (!_player_video.first && e == Butler::AGAIN) {
232 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
236 _player_video.first &&
238 _eyes != _player_video.first->eyes() &&
239 _player_video.first->eyes() != EYES_BOTH
244 display_player_video ();
248 FilmViewer::display_player_video ()
250 if (!_player_video.first) {
256 if (_playing && (time() - _player_video.second) > one_video_frame()) {
257 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
258 part if this frame is J2K).
260 _video_position = _player_video.second;
265 /* In an ideal world, what we would do here is:
267 * 1. convert to XYZ exactly as we do in the DCP creation path.
268 * 2. convert back to RGB for the preview display, compensating
269 * for the monitor etc. etc.
271 * but this is inefficient if the source is RGB. Since we don't
272 * (currently) care too much about the precise accuracy of the preview's
273 * colour mapping (and we care more about its speed) we try to short-
274 * circuit this "ideal" situation in some cases.
276 * The content's specified colour conversion indicates the colourspace
277 * which the content is in (according to the user).
279 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
280 * image and convert it (from whatever the user has said it is) to RGB.
283 _state_timer.set ("get image");
284 _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
286 _state_timer.set ("ImageChanged");
287 ImageChanged (_player_video.first);
288 _state_timer.unset ();
290 _video_position = _player_video.second;
291 _inter_position = _player_video.first->inter_position ();
292 _inter_size = _player_video.first->inter_size ();
296 _closed_captions_dialog->update (time());
302 if (!_film || !_playing) {
308 DCPTime const next = _video_position + one_video_frame();
310 if (next >= _film->length()) {
316 LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
317 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
325 #ifdef DCPOMATIC_VARIANT_SWAROOP
326 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
328 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
330 wxImage image (std_to_wx(bg->string()));
331 wxBitmap bitmap (image);
332 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
339 FilmViewer::maybe_draw_background_image (wxPaintDC &)
346 FilmViewer::paint_panel ()
348 _state_timer.set ("paint-panel");
350 wxPaintDC dc (_panel);
352 #ifdef DCPOMATIC_VARIANT_SWAROOP
353 if (_background_image) {
355 maybe_draw_background_image (dc);
356 _state_timer.unset ();
361 if (!_out_size.width || !_out_size.height || !_film || !_frame || _out_size != _frame->size()) {
365 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
366 wxBitmap frame_bitmap (frame);
367 dc.DrawBitmap (frame_bitmap, 0, max(0, (_panel_size.height - _out_size.height) / 2));
369 #ifdef DCPOMATIC_VARIANT_SWAROOP
370 DCPTime const period = DCPTime::from_seconds(Config::instance()->player_watermark_period() * 60);
371 int64_t n = _video_position.get() / period.get();
372 DCPTime from(n * period.get());
373 DCPTime to = from + DCPTime::from_seconds(Config::instance()->player_watermark_duration() / 1000.0);
374 if (from <= _video_position && _video_position <= to) {
375 if (!_in_watermark) {
376 _in_watermark = true;
377 _watermark_x = rand() % _panel_size.width;
378 _watermark_y = rand() % _panel_size.height;
380 dc.SetTextForeground(*wxWHITE);
381 string wm = Config::instance()->player_watermark_theatre();
382 boost::posix_time::ptime t = boost::posix_time::second_clock::local_time();
383 wm += "\n" + boost::posix_time::to_iso_extended_string(t);
384 dc.DrawText(std_to_wx(wm), _watermark_x, _watermark_y);
386 _in_watermark = false;
391 if (_out_size.width < _panel_size.width) {
392 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
393 wxPen p (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
394 wxBrush b (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
397 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
400 if (_out_size.height < _panel_size.height) {
401 wxPen p (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
402 wxBrush b (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
405 int const gap = (_panel_size.height - _out_size.height) / 2;
406 dc.DrawRectangle (0, 0, _panel_size.width, gap);
407 dc.DrawRectangle (0, gap + _out_size.height + 1, _panel_size.width, gap + 1);
410 if (_outline_content) {
411 wxPen p (wxColour (255, 0, 0), 2);
413 dc.SetBrush (*wxTRANSPARENT_BRUSH);
414 dc.DrawRectangle (_inter_position.x, _inter_position.y + (_panel_size.height - _out_size.height) / 2, _inter_size.width, _inter_size.height);
417 _state_timer.unset ();
421 FilmViewer::set_outline_content (bool o)
423 _outline_content = o;
428 FilmViewer::set_eyes (Eyes e)
435 FilmViewer::panel_sized (wxSizeEvent& ev)
437 _panel_size.width = ev.GetSize().GetWidth();
438 _panel_size.height = ev.GetSize().GetHeight();
441 if (!quick_refresh()) {
448 FilmViewer::calculate_sizes ()
450 if (!_film || !_player) {
454 Ratio const * container = _film->container ();
456 float const panel_ratio = _panel_size.ratio ();
457 float const film_ratio = container ? container->ratio () : 1.78;
459 if (panel_ratio < film_ratio) {
460 /* panel is less widscreen than the film; clamp width */
461 _out_size.width = _panel_size.width;
462 _out_size.height = lrintf (_out_size.width / film_ratio);
464 /* panel is more widescreen than the film; clamp height */
465 _out_size.height = _panel_size.height;
466 _out_size.width = lrintf (_out_size.height * film_ratio);
469 /* Catch silly values */
470 _out_size.width = max (64, _out_size.width);
471 _out_size.height = max (64, _out_size.height);
473 _player->set_video_container_size (_out_size);
483 optional<bool> v = PlaybackPermitted ();
485 /* Computer says no */
489 if (_audio.isStreamOpen()) {
490 _audio.setStreamTime (_video_position.seconds());
491 _audio.startStream ();
497 Started (position());
503 if (_audio.isStreamRunning()) {
504 /* stop stream and discard any remaining queued samples */
505 _audio.abortStream ();
513 Stopped (position());
518 FilmViewer::player_change (ChangeType type, int property, bool frequent)
520 if (type != CHANGE_TYPE_DONE || frequent) {
524 if (_coalesce_player_changes) {
525 _pending_player_changes.push_back (property);
530 bool refreshed = false;
532 property == VideoContentProperty::CROP ||
533 property == VideoContentProperty::SCALE ||
534 property == VideoContentProperty::FADE_IN ||
535 property == VideoContentProperty::FADE_OUT ||
536 property == VideoContentProperty::COLOUR_CONVERSION ||
537 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
538 property == PlayerProperty::FILM_CONTAINER
540 refreshed = quick_refresh ();
550 FilmViewer::film_change (ChangeType type, Film::Property p)
552 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
557 /** Re-get the current frame slowly by seeking */
559 FilmViewer::slow_refresh ()
561 seek (_video_position, true);
564 /** Try to re-get the current frame quickly by resetting the metadata
565 * in the PlayerVideo that we used last time.
566 * @return true if this was possible, false if not.
569 FilmViewer::quick_refresh ()
571 if (!_player_video.first) {
575 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
579 display_player_video ();
584 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
586 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
588 seek (*dt, accurate);
593 FilmViewer::set_coalesce_player_changes (bool c)
595 _coalesce_player_changes = c;
598 BOOST_FOREACH (int i, _pending_player_changes) {
599 player_change (CHANGE_TYPE_DONE, i, false);
601 _pending_player_changes.clear ();
606 FilmViewer::seek (DCPTime t, bool accurate)
612 if (t < DCPTime ()) {
616 if (t >= _film->length ()) {
617 t = _film->length ();
620 bool const was_running = stop ();
622 _closed_captions_dialog->clear ();
623 _butler->seek (t, accurate);
634 FilmViewer::config_changed (Config::Property p)
636 #ifdef DCPOMATIC_VARIANT_SWAROOP
637 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
643 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
647 if (_audio.isStreamOpen ()) {
648 _audio.closeStream ();
651 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
653 if (Config::instance()->sound_output()) {
654 while (st < _audio.getDeviceCount()) {
655 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
660 if (st == _audio.getDeviceCount()) {
661 st = _audio.getDefaultOutputDevice();
664 st = _audio.getDefaultOutputDevice();
667 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
669 RtAudio::StreamParameters sp;
671 sp.nChannels = _audio_channels;
674 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
675 #ifdef DCPOMATIC_USE_RTERROR
676 } catch (RtError& e) {
678 } catch (RtAudioError& e) {
682 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
694 FilmViewer::uncorrected_time () const
696 if (_audio.isStreamRunning ()) {
697 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
700 return _video_position;
704 FilmViewer::time () const
706 if (_audio.isStreamRunning ()) {
707 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
708 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
711 return _video_position;
715 FilmViewer::audio_callback (void* out_p, unsigned int frames)
718 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
719 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
720 /* There was an underrun or this audio is on time; carry on */
723 /* The audio we just got was (very) late; drop it and get some more. */
726 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
728 _latency_history.push_back (_audio.getStreamLatency ());
729 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
730 _latency_history.pop_front ();
738 FilmViewer::average_latency () const
740 boost::mutex::scoped_lock lm (_latency_history_mutex);
741 if (_latency_history.empty()) {
746 BOOST_FOREACH (Frame i, _latency_history) {
750 return total / _latency_history.size();
754 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
756 _dcp_decode_reduction = reduction;
758 _player->set_dcp_decode_reduction (reduction);
763 FilmViewer::dcp_decode_reduction () const
765 return _dcp_decode_reduction;
769 FilmViewer::one_video_frame () const
771 return DCPTime::from_frames (1, _film->video_frame_rate());
774 /** Open a dialog box showing our film's closed captions */
776 FilmViewer::show_closed_captions ()
778 _closed_captions_dialog->Show();
782 FilmViewer::seek_by (DCPTime by, bool accurate)
784 seek (_video_position + by, accurate);
788 FilmViewer::set_pad_black (bool p)