2 Copyright (C) 2012-2016 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"
30 #include "lib/ratio.h"
32 #include "lib/job_manager.h"
33 #include "lib/image.h"
34 #include "lib/exceptions.h"
35 #include "lib/examine_content_job.h"
36 #include "lib/filter.h"
37 #include "lib/player.h"
38 #include "lib/player_video.h"
39 #include "lib/video_content.h"
40 #include "lib/video_decoder.h"
41 #include "lib/timer.h"
42 #include "lib/butler.h"
44 #include "lib/config.h"
46 #include <libavutil/pixfmt.h>
48 #include <dcp/exceptions.h>
49 #include <wx/tglbtn.h>
62 using boost::shared_ptr;
63 using boost::dynamic_pointer_cast;
64 using boost::weak_ptr;
65 using boost::optional;
70 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
72 return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
75 FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected)
77 , _panel (new wxPanel (this))
78 , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
79 , _left_eye (new wxRadioButton (this, wxID_ANY, _("Left eye"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP))
80 , _right_eye (new wxRadioButton (this, wxID_ANY, _("Right eye")))
81 , _jump_to_selected (new wxCheckBox (this, wxID_ANY, _("Jump to selected content")))
82 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
83 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
84 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
85 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
86 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
87 , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
88 , _coalesce_player_changes (false)
89 , _pending_player_change (false)
90 , _last_seek_accurate (true)
91 , _audio (DCPOMATIC_RTAUDIO_API)
93 , _audio_block_size (1024)
95 , _latency_history_count (0)
98 _panel->SetDoubleBuffered (true);
101 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
103 _v_sizer = new wxBoxSizer (wxVERTICAL);
106 _v_sizer->Add (_panel, 1, wxEXPAND);
108 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
109 if (outline_content) {
110 view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
112 view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
113 view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
114 if (jump_to_selected) {
115 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
117 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
119 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
121 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
122 time_sizer->Add (_frame_number, 0, wxEXPAND);
123 time_sizer->Add (_timecode, 0, wxEXPAND);
125 h_sizer->Add (_back_button, 0, wxALL, 2);
126 h_sizer->Add (time_sizer, 0, wxEXPAND);
127 h_sizer->Add (_forward_button, 0, wxALL, 2);
128 h_sizer->Add (_play_button, 0, wxEXPAND);
129 h_sizer->Add (_slider, 1, wxEXPAND);
131 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
133 _frame_number->SetMinSize (wxSize (84, -1));
134 _back_button->SetMinSize (wxSize (32, -1));
135 _forward_button->SetMinSize (wxSize (32, -1));
137 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
138 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
139 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::refresh_panel, this));
140 _left_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
141 _right_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
142 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved, this, false));
143 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind (&FilmViewer::slider_moved, this, false));
144 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind (&FilmViewer::slider_moved, this, false));
145 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind (&FilmViewer::slider_moved, this, true));
146 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind (&FilmViewer::play_clicked, this));
147 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
148 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::back_clicked, this, _1));
149 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::forward_clicked, this, _1));
150 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::frame_number_clicked, this));
151 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::timecode_clicked, this));
152 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
154 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
156 set_film (shared_ptr<Film> ());
158 JobManager::instance()->ActiveJobsChanged.connect (
159 bind (&FilmViewer::active_jobs_changed, this, _2)
162 setup_sensitivity ();
164 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
165 config_changed (Config::PREVIEW_SOUND_OUTPUT);
168 FilmViewer::~FilmViewer ()
174 FilmViewer::set_film (shared_ptr<Film> film)
184 update_position_slider ();
185 update_position_label ();
192 _player.reset (new Player (_film, _film->playlist ()));
193 _player->set_fast ();
194 } catch (bad_alloc) {
195 error_dialog (this, _("There is not enough free memory to do that."));
200 /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
203 _player->set_always_burn_subtitles (true);
204 _player->set_play_referenced ();
206 _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
207 _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
209 /* Keep about 1 second's worth of history samples */
210 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
217 setup_sensitivity ();
221 FilmViewer::recreate_butler ()
223 bool const was_running = stop ();
230 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
232 if (_audio_channels != 2 || _film->audio_channels() < 3) {
233 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
237 /* Special case: stereo output, at least 3 channel input, map L+R to L/R and
238 C to both, all 3dB down.
240 map.set (0, 0, 1 / sqrt(2)); // L -> L
241 map.set (1, 1, 1 / sqrt(2)); // R -> R
242 map.set (2, 0, 1 / sqrt(2)); // C -> L
243 map.set (2, 1, 1 / sqrt(2)); // C -> R
246 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
247 if (!Config::instance()->preview_sound()) {
248 _butler->disable_audio ();
257 FilmViewer::refresh_panel ()
266 DCPOMATIC_ASSERT (_butler);
268 pair<shared_ptr<PlayerVideo>, DCPTime> video;
270 video = _butler->get_video ();
273 ((_left_eye->GetValue() && video.first->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && video.first->eyes() == EYES_LEFT))
284 /* In an ideal world, what we would do here is:
286 * 1. convert to XYZ exactly as we do in the DCP creation path.
287 * 2. convert back to RGB for the preview display, compensating
288 * for the monitor etc. etc.
290 * but this is inefficient if the source is RGB. Since we don't
291 * (currently) care too much about the precise accuracy of the preview's
292 * colour mapping (and we care more about its speed) we try to short-
293 * circuit this "ideal" situation in some cases.
295 * The content's specified colour conversion indicates the colourspace
296 * which the content is in (according to the user).
298 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
299 * image and convert it (from whatever the user has said it is) to RGB.
302 _frame = video.first->image (
303 bind (&Log::dcp_log, _film->log().get(), _1, _2),
304 bind (&PlayerVideo::always_rgb, _1),
308 ImageChanged (video.first);
310 _video_position = video.second;
311 _inter_position = video.first->inter_position ();
312 _inter_size = video.first->inter_size ();
320 if (!_film || !_playing) {
325 update_position_label ();
326 update_position_slider ();
327 DCPTime const next = _video_position + DCPTime::from_frames (1, _film->video_frame_rate ());
329 if (next >= _film->length()) {
333 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
341 FilmViewer::paint_panel ()
343 wxPaintDC dc (_panel);
345 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
350 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
351 wxBitmap frame_bitmap (frame);
352 dc.DrawBitmap (frame_bitmap, 0, 0);
354 if (_out_size.width < _panel_size.width) {
355 wxPen p (GetBackgroundColour ());
356 wxBrush b (GetBackgroundColour ());
359 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
362 if (_out_size.height < _panel_size.height) {
363 wxPen p (GetBackgroundColour ());
364 wxBrush b (GetBackgroundColour ());
367 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
370 if (_outline_content->GetValue ()) {
371 wxPen p (wxColour (255, 0, 0), 2);
373 dc.SetBrush (*wxTRANSPARENT_BRUSH);
374 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
379 FilmViewer::slider_moved (bool update_slider)
385 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
386 /* Ensure that we hit the end of the film at the end of the slider */
387 if (t >= _film->length ()) {
388 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
391 update_position_label ();
393 update_position_slider ();
398 FilmViewer::panel_sized (wxSizeEvent& ev)
400 _panel_size.width = ev.GetSize().GetWidth();
401 _panel_size.height = ev.GetSize().GetHeight();
405 update_position_label ();
406 update_position_slider ();
410 FilmViewer::calculate_sizes ()
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);
439 FilmViewer::play_clicked ()
445 FilmViewer::check_play_state ()
447 if (!_film || _film->video_frame_rate() == 0) {
451 if (_play_button->GetValue()) {
461 if (_audio.isStreamOpen()) {
462 _audio.setStreamTime (_video_position.seconds());
463 _audio.startStream ();
473 if (_audio.isStreamRunning()) {
474 /* stop stream and discard any remainig queued samples */
475 _audio.abortStream ();
483 _play_button->SetValue (false);
488 FilmViewer::update_position_slider ()
491 _slider->SetValue (0);
495 DCPTime const len = _film->length ();
498 int const new_slider_position = 4096 * _video_position.get() / len.get();
499 if (new_slider_position != _slider->GetValue()) {
500 _slider->SetValue (new_slider_position);
506 FilmViewer::update_position_label ()
509 _frame_number->SetLabel ("0");
510 _timecode->SetLabel ("0:0:0.0");
514 double const fps = _film->video_frame_rate ();
515 /* Count frame number from 1 ... not sure if this is the best idea */
516 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
517 _timecode->SetLabel (time_to_timecode (_video_position, fps));
521 FilmViewer::active_jobs_changed (optional<string> j)
523 /* examine content is the only job which stops the viewer working */
524 bool const a = !j || *j != "examine_content";
526 _play_button->Enable (a);
530 FilmViewer::nudge_amount (wxMouseEvent& ev)
532 DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
534 if (ev.ShiftDown() && !ev.ControlDown()) {
535 amount = DCPTime::from_seconds (1);
536 } else if (!ev.ShiftDown() && ev.ControlDown()) {
537 amount = DCPTime::from_seconds (10);
538 } else if (ev.ShiftDown() && ev.ControlDown()) {
539 amount = DCPTime::from_seconds (60);
546 FilmViewer::go_to (DCPTime t)
548 if (t < DCPTime ()) {
552 if (t >= _film->length ()) {
553 t = _film->length ();
557 update_position_label ();
558 update_position_slider ();
562 FilmViewer::back_clicked (wxMouseEvent& ev)
564 go_to (_video_position - nudge_amount (ev));
569 FilmViewer::forward_clicked (wxMouseEvent& ev)
571 go_to (_video_position + nudge_amount (ev));
576 FilmViewer::player_changed (bool frequent)
582 if (_coalesce_player_changes) {
583 _pending_player_change = true;
589 update_position_label ();
590 update_position_slider ();
594 FilmViewer::setup_sensitivity ()
596 bool const c = _film && !_film->content().empty ();
599 _back_button->Enable (c);
600 _forward_button->Enable (c);
601 _play_button->Enable (c);
602 _outline_content->Enable (c);
603 _frame_number->Enable (c);
604 _timecode->Enable (c);
605 _jump_to_selected->Enable (c);
607 _left_eye->Enable (c && _film->three_d ());
608 _right_eye->Enable (c && _film->three_d ());
612 FilmViewer::film_changed (Film::Property p)
614 if (p == Film::CONTENT || p == Film::THREE_D) {
615 setup_sensitivity ();
619 /** Re-get the current frame */
621 FilmViewer::refresh ()
623 seek (_video_position, _last_seek_accurate);
627 FilmViewer::set_position (DCPTime p)
631 update_position_label ();
632 update_position_slider ();
636 FilmViewer::set_coalesce_player_changes (bool c)
638 _coalesce_player_changes = c;
641 _pending_player_change = false;
643 if (_pending_player_change) {
644 player_changed (false);
650 FilmViewer::timecode_clicked ()
652 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
653 if (dialog->ShowModal() == wxID_OK) {
654 go_to (dialog->get ());
660 FilmViewer::frame_number_clicked ()
662 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
663 if (dialog->ShowModal() == wxID_OK) {
664 go_to (dialog->get ());
670 FilmViewer::jump_to_selected_clicked ()
672 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
676 FilmViewer::seek (DCPTime t, bool accurate)
682 bool const was_running = stop ();
684 _butler->seek (t, accurate);
685 _last_seek_accurate = accurate;
694 FilmViewer::config_changed (Config::Property p)
696 if (p != Config::PREVIEW_SOUND && p != Config::PREVIEW_SOUND_OUTPUT) {
700 if (_audio.isStreamOpen ()) {
701 _audio.closeStream ();
704 if (Config::instance()->preview_sound()) {
706 if (Config::instance()->preview_sound_output()) {
707 while (st < _audio.getDeviceCount()) {
708 if (_audio.getDeviceInfo(st).name == Config::instance()->preview_sound_output().get()) {
713 if (st == _audio.getDeviceCount()) {
714 st = _audio.getDefaultOutputDevice();
717 st = _audio.getDefaultOutputDevice();
720 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
724 RtAudio::StreamParameters sp;
726 sp.nChannels = _audio_channels;
729 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
730 #ifdef DCPOMATIC_USE_RTERROR
731 } catch (RtError& e) {
733 } catch (RtAudioError& e) {
737 wxString::Format (_("Could not set up audio output (%s). There will be no audio during the preview."), e.what())
748 FilmViewer::time () const
750 if (_audio.isStreamRunning ()) {
751 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
752 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
755 return _video_position;
759 FilmViewer::audio_callback (void* out_p, unsigned int frames)
761 _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
763 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
765 _latency_history.push_back (_audio.getStreamLatency ());
766 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
767 _latency_history.pop_front ();
775 FilmViewer::average_latency () const
777 boost::mutex::scoped_lock lm (_latency_history_mutex);
778 if (_latency_history.empty()) {
783 BOOST_FOREACH (Frame i, _latency_history) {
787 return total / _latency_history.size();
791 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
793 _player->set_dcp_decode_reduction (reduction);