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)
97 _panel->SetDoubleBuffered (true);
100 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
101 _panel->SetBackgroundColour (*wxBLACK);
103 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
104 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
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 (_panel, _("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 if (_film->audio_channels() > 0) {
190 map.set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
192 if (_film->audio_channels() > 1) {
193 map.set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
195 if (_film->audio_channels() > 2) {
196 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
197 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
199 if (_film->audio_channels() > 3) {
200 map.set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
201 map.set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
203 if (_film->audio_channels() > 4) {
204 map.set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
206 if (_film->audio_channels() > 5) {
207 map.set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
211 _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
212 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
213 _butler->disable_audio ();
216 _closed_captions_dialog->set_film_and_butler (_film, _butler);
224 FilmViewer::refresh_panel ()
233 DCPOMATIC_ASSERT (_butler);
237 _player_video = _butler->get_video (&e);
238 if (!_player_video.first && e == Butler::AGAIN) {
239 signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
243 _player_video.first &&
245 _eyes != _player_video.first->eyes() &&
246 _player_video.first->eyes() != EYES_BOTH
251 } catch (DecodeError& e) {
252 error_dialog (_panel, e.what());
255 display_player_video ();
259 FilmViewer::display_player_video ()
261 if (!_player_video.first) {
267 if (_playing && (time() - _player_video.second) > one_video_frame()) {
268 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
269 part if this frame is J2K).
271 _video_position = _player_video.second;
276 /* In an ideal world, what we would do here is:
278 * 1. convert to XYZ exactly as we do in the DCP creation path.
279 * 2. convert back to RGB for the preview display, compensating
280 * for the monitor etc. etc.
282 * but this is inefficient if the source is RGB. Since we don't
283 * (currently) care too much about the precise accuracy of the preview's
284 * colour mapping (and we care more about its speed) we try to short-
285 * circuit this "ideal" situation in some cases.
287 * The content's specified colour conversion indicates the colourspace
288 * which the content is in (according to the user).
290 * PlayerVideo::image (bound to PlayerVideo::force) will take the source
291 * image and convert it (from whatever the user has said it is) to RGB.
294 _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
296 ImageChanged (_player_video.first);
298 _video_position = _player_video.second;
299 _inter_position = _player_video.first->inter_position ();
300 _inter_size = _player_video.first->inter_size ();
304 _closed_captions_dialog->update (time());
310 if (!_film || !_playing) {
316 DCPTime const next = _video_position + one_video_frame();
318 if (next >= _film->length()) {
324 LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
325 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
333 #ifdef DCPOMATIC_VARIANT_SWAROOP
334 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
336 optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
338 wxImage image (std_to_wx(bg->string()));
339 wxBitmap bitmap (image);
340 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
347 FilmViewer::maybe_draw_background_image (wxPaintDC &)
354 FilmViewer::paint_panel ()
356 wxPaintDC dc (_panel);
358 #ifdef DCPOMATIC_VARIANT_SWAROOP
359 if (_background_image) {
361 maybe_draw_background_image (dc);
366 if (!_out_size.width || !_out_size.height || !_film || !_frame || _out_size != _frame->size()) {
370 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
371 wxBitmap frame_bitmap (frame);
372 dc.DrawBitmap (frame_bitmap, 0, max(0, (_panel_size.height - _out_size.height) / 2));
374 #ifdef DCPOMATIC_VARIANT_SWAROOP
375 DCPTime const period = DCPTime::from_seconds(Config::instance()->player_watermark_period() * 60);
376 int64_t n = _video_position.get() / period.get();
377 DCPTime from(n * period.get());
378 DCPTime to = from + DCPTime::from_seconds(Config::instance()->player_watermark_duration() / 1000.0);
379 if (from <= _video_position && _video_position <= to) {
380 if (!_in_watermark) {
381 _in_watermark = true;
382 _watermark_x = rand() % _panel_size.width;
383 _watermark_y = rand() % _panel_size.height;
385 dc.SetTextForeground(*wxWHITE);
386 string wm = Config::instance()->player_watermark_theatre();
387 boost::posix_time::ptime t = boost::posix_time::second_clock::local_time();
388 wm += "\n" + boost::posix_time::to_iso_extended_string(t);
389 dc.DrawText(std_to_wx(wm), _watermark_x, _watermark_y);
391 _in_watermark = false;
396 if (_out_size.width < _panel_size.width) {
397 /* XXX: these colours are right for GNOME; may need adjusting for other OS */
398 wxPen p (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
399 wxBrush b (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
402 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
405 if (_out_size.height < _panel_size.height) {
406 wxPen p (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
407 wxBrush b (_pad_black ? wxColour(0, 0, 0) : wxColour(240, 240, 240));
410 int const gap = (_panel_size.height - _out_size.height) / 2;
411 dc.DrawRectangle (0, 0, _panel_size.width, gap);
412 dc.DrawRectangle (0, gap + _out_size.height + 1, _panel_size.width, gap + 1);
415 if (_outline_content) {
416 wxPen p (wxColour (255, 0, 0), 2);
418 dc.SetBrush (*wxTRANSPARENT_BRUSH);
419 dc.DrawRectangle (_inter_position.x, _inter_position.y + (_panel_size.height - _out_size.height) / 2, _inter_size.width, _inter_size.height);
424 FilmViewer::set_outline_content (bool o)
426 _outline_content = o;
431 FilmViewer::set_eyes (Eyes e)
438 FilmViewer::panel_sized (wxSizeEvent& ev)
440 _panel_size.width = ev.GetSize().GetWidth();
441 _panel_size.height = ev.GetSize().GetHeight();
444 if (!quick_refresh()) {
451 FilmViewer::calculate_sizes ()
453 if (!_film || !_player) {
457 Ratio const * container = _film->container ();
459 float const panel_ratio = _panel_size.ratio ();
460 float const film_ratio = container ? container->ratio () : 1.78;
462 if (panel_ratio < film_ratio) {
463 /* panel is less widscreen than the film; clamp width */
464 _out_size.width = _panel_size.width;
465 _out_size.height = lrintf (_out_size.width / film_ratio);
467 /* panel is more widescreen than the film; clamp height */
468 _out_size.height = _panel_size.height;
469 _out_size.width = lrintf (_out_size.height * film_ratio);
472 /* Catch silly values */
473 _out_size.width = max (64, _out_size.width);
474 _out_size.height = max (64, _out_size.height);
476 _player->set_video_container_size (_out_size);
486 optional<bool> v = PlaybackPermitted ();
488 /* Computer says no */
492 if (_audio.isStreamOpen()) {
493 _audio.setStreamTime (_video_position.seconds());
494 _audio.startStream ();
500 Started (position());
506 if (_audio.isStreamRunning()) {
507 /* stop stream and discard any remaining queued samples */
508 _audio.abortStream ();
516 Stopped (position());
521 FilmViewer::player_change (ChangeType type, int property, bool frequent)
523 if (type != CHANGE_TYPE_DONE || frequent) {
527 if (_coalesce_player_changes) {
528 _pending_player_changes.push_back (property);
533 bool refreshed = false;
535 property == VideoContentProperty::CROP ||
536 property == VideoContentProperty::SCALE ||
537 property == VideoContentProperty::FADE_IN ||
538 property == VideoContentProperty::FADE_OUT ||
539 property == VideoContentProperty::COLOUR_CONVERSION ||
540 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
541 property == PlayerProperty::FILM_CONTAINER
543 refreshed = quick_refresh ();
553 FilmViewer::film_change (ChangeType type, Film::Property p)
555 if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
560 /** Re-get the current frame slowly by seeking */
562 FilmViewer::slow_refresh ()
564 seek (_video_position, true);
567 /** Try to re-get the current frame quickly by resetting the metadata
568 * in the PlayerVideo that we used last time.
569 * @return true if this was possible, false if not.
572 FilmViewer::quick_refresh ()
574 if (!_player_video.first) {
578 if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
582 display_player_video ();
587 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
589 optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
591 seek (*dt, accurate);
596 FilmViewer::set_coalesce_player_changes (bool c)
598 _coalesce_player_changes = c;
601 BOOST_FOREACH (int i, _pending_player_changes) {
602 player_change (CHANGE_TYPE_DONE, i, false);
604 _pending_player_changes.clear ();
609 FilmViewer::seek (DCPTime t, bool accurate)
615 if (t < DCPTime ()) {
619 if (t >= _film->length ()) {
620 t = _film->length ();
623 bool const was_running = stop ();
625 _closed_captions_dialog->clear ();
626 _butler->seek (t, accurate);
637 FilmViewer::config_changed (Config::Property p)
639 #ifdef DCPOMATIC_VARIANT_SWAROOP
640 if (p == Config::PLAYER_BACKGROUND_IMAGE) {
646 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
650 if (_audio.isStreamOpen ()) {
651 _audio.closeStream ();
654 if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
656 if (Config::instance()->sound_output()) {
657 while (st < _audio.getDeviceCount()) {
658 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
663 if (st == _audio.getDeviceCount()) {
664 st = _audio.getDefaultOutputDevice();
667 st = _audio.getDefaultOutputDevice();
670 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
672 RtAudio::StreamParameters sp;
674 sp.nChannels = _audio_channels;
677 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
678 #ifdef DCPOMATIC_USE_RTERROR
679 } catch (RtError& e) {
681 } catch (RtAudioError& e) {
685 _("Could not set up audio output. There will be no audio during the preview."), std_to_wx(e.what())
697 FilmViewer::uncorrected_time () const
699 if (_audio.isStreamRunning ()) {
700 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
703 return _video_position;
707 FilmViewer::time () const
709 if (_audio.isStreamRunning ()) {
710 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
711 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
714 return _video_position;
718 FilmViewer::audio_callback (void* out_p, unsigned int frames)
721 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
722 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
723 /* There was an underrun or this audio is on time; carry on */
726 /* The audio we just got was (very) late; drop it and get some more. */
729 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
731 _latency_history.push_back (_audio.getStreamLatency ());
732 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
733 _latency_history.pop_front ();
741 FilmViewer::average_latency () const
743 boost::mutex::scoped_lock lm (_latency_history_mutex);
744 if (_latency_history.empty()) {
749 BOOST_FOREACH (Frame i, _latency_history) {
753 return total / _latency_history.size();
757 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
759 _dcp_decode_reduction = reduction;
761 _player->set_dcp_decode_reduction (reduction);
766 FilmViewer::dcp_decode_reduction () const
768 return _dcp_decode_reduction;
772 FilmViewer::one_video_frame () const
774 return DCPTime::from_frames (1, _film->video_frame_rate());
777 /** Open a dialog box showing our film's closed captions */
779 FilmViewer::show_closed_captions ()
781 _closed_captions_dialog->Show();
785 FilmViewer::seek_by (DCPTime by, bool accurate)
787 seek (_video_position + by, accurate);
791 FilmViewer::set_pad_black (bool p)