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)
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 view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
110 view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
111 view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
112 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
113 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
115 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
117 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
118 time_sizer->Add (_frame_number, 0, wxEXPAND);
119 time_sizer->Add (_timecode, 0, wxEXPAND);
121 h_sizer->Add (_back_button, 0, wxALL, 2);
122 h_sizer->Add (time_sizer, 0, wxEXPAND);
123 h_sizer->Add (_forward_button, 0, wxALL, 2);
124 h_sizer->Add (_play_button, 0, wxEXPAND);
125 h_sizer->Add (_slider, 1, wxEXPAND);
127 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
129 _frame_number->SetMinSize (wxSize (84, -1));
130 _back_button->SetMinSize (wxSize (32, -1));
131 _forward_button->SetMinSize (wxSize (32, -1));
133 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
134 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
135 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::refresh_panel, this));
136 _left_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
137 _right_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
138 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved, this, false));
139 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind (&FilmViewer::slider_moved, this, false));
140 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind (&FilmViewer::slider_moved, this, false));
141 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind (&FilmViewer::slider_moved, this, true));
142 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind (&FilmViewer::play_clicked, this));
143 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
144 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::back_clicked, this, _1));
145 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::forward_clicked, this, _1));
146 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::frame_number_clicked, this));
147 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::timecode_clicked, this));
148 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
150 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
152 set_film (shared_ptr<Film> ());
154 JobManager::instance()->ActiveJobsChanged.connect (
155 bind (&FilmViewer::active_jobs_changed, this, _2)
158 setup_sensitivity ();
160 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
161 config_changed (Config::PREVIEW_SOUND_OUTPUT);
164 FilmViewer::~FilmViewer ()
170 FilmViewer::set_film (shared_ptr<Film> film)
180 update_position_slider ();
181 update_position_label ();
188 _player.reset (new Player (_film, _film->playlist ()));
189 _player->set_fast ();
190 } catch (bad_alloc) {
191 error_dialog (this, _("There is not enough free memory to do that."));
196 /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
199 _player->set_always_burn_subtitles (true);
200 _player->set_play_referenced ();
202 _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
203 _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
205 /* Keep about 1 second's worth of history samples */
206 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
213 setup_sensitivity ();
217 FilmViewer::recreate_butler ()
219 bool const was_running = stop ();
226 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
228 if (_audio_channels != 2 || _film->audio_channels() < 3) {
229 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
233 /* Special case: stereo output, at least 3 channel input, map L+R to L/R and
234 C to both, all 3dB down.
236 map.set (0, 0, 1 / sqrt(2)); // L -> L
237 map.set (1, 1, 1 / sqrt(2)); // R -> R
238 map.set (2, 0, 1 / sqrt(2)); // C -> L
239 map.set (2, 1, 1 / sqrt(2)); // C -> R
242 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
243 if (!Config::instance()->preview_sound()) {
244 _butler->disable_audio ();
253 FilmViewer::refresh_panel ()
262 DCPOMATIC_ASSERT (_butler);
264 pair<shared_ptr<PlayerVideo>, DCPTime> video;
266 video = _butler->get_video ();
269 ((_left_eye->GetValue() && video.first->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && video.first->eyes() == EYES_LEFT))
280 /* In an ideal world, what we would do here is:
282 * 1. convert to XYZ exactly as we do in the DCP creation path.
283 * 2. convert back to RGB for the preview display, compensating
284 * for the monitor etc. etc.
286 * but this is inefficient if the source is RGB. Since we don't
287 * (currently) care too much about the precise accuracy of the preview's
288 * colour mapping (and we care more about its speed) we try to short-
289 * circuit this "ideal" situation in some cases.
291 * The content's specified colour conversion indicates the colourspace
292 * which the content is in (according to the user).
294 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
295 * image and convert it (from whatever the user has said it is) to RGB.
298 _frame = video.first->image (
299 bind (&Log::dcp_log, _film->log().get(), _1, _2),
300 bind (&PlayerVideo::always_rgb, _1),
304 ImageChanged (video.first);
306 _video_position = video.second;
307 _inter_position = video.first->inter_position ();
308 _inter_size = video.first->inter_size ();
316 if (!_film || !_playing) {
321 update_position_label ();
322 update_position_slider ();
323 DCPTime const next = _video_position + DCPTime::from_frames (1, _film->video_frame_rate ());
325 if (next >= _film->length()) {
329 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
337 FilmViewer::paint_panel ()
339 wxPaintDC dc (_panel);
341 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
346 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
347 wxBitmap frame_bitmap (frame);
348 dc.DrawBitmap (frame_bitmap, 0, 0);
350 if (_out_size.width < _panel_size.width) {
351 wxPen p (GetBackgroundColour ());
352 wxBrush b (GetBackgroundColour ());
355 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
358 if (_out_size.height < _panel_size.height) {
359 wxPen p (GetBackgroundColour ());
360 wxBrush b (GetBackgroundColour ());
363 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
366 if (_outline_content->GetValue ()) {
367 wxPen p (wxColour (255, 0, 0), 2);
369 dc.SetBrush (*wxTRANSPARENT_BRUSH);
370 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
375 FilmViewer::slider_moved (bool update_slider)
381 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
382 /* Ensure that we hit the end of the film at the end of the slider */
383 if (t >= _film->length ()) {
384 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
387 update_position_label ();
389 update_position_slider ();
394 FilmViewer::panel_sized (wxSizeEvent& ev)
396 _panel_size.width = ev.GetSize().GetWidth();
397 _panel_size.height = ev.GetSize().GetHeight();
401 update_position_label ();
402 update_position_slider ();
406 FilmViewer::calculate_sizes ()
412 Ratio const * container = _film->container ();
414 float const panel_ratio = _panel_size.ratio ();
415 float const film_ratio = container ? container->ratio () : 1.78;
417 if (panel_ratio < film_ratio) {
418 /* panel is less widscreen than the film; clamp width */
419 _out_size.width = _panel_size.width;
420 _out_size.height = lrintf (_out_size.width / film_ratio);
422 /* panel is more widescreen than the film; clamp height */
423 _out_size.height = _panel_size.height;
424 _out_size.width = lrintf (_out_size.height * film_ratio);
427 /* Catch silly values */
428 _out_size.width = max (64, _out_size.width);
429 _out_size.height = max (64, _out_size.height);
431 _player->set_video_container_size (_out_size);
435 FilmViewer::play_clicked ()
441 FilmViewer::check_play_state ()
443 if (!_film || _film->video_frame_rate() == 0) {
447 if (_play_button->GetValue()) {
457 if (_audio.isStreamOpen()) {
458 _audio.setStreamTime (_video_position.seconds());
459 _audio.startStream ();
469 if (_audio.isStreamRunning()) {
470 /* stop stream and discard any remainig queued samples */
471 _audio.abortStream ();
479 _play_button->SetValue (false);
484 FilmViewer::update_position_slider ()
487 _slider->SetValue (0);
491 DCPTime const len = _film->length ();
494 int const new_slider_position = 4096 * _video_position.get() / len.get();
495 if (new_slider_position != _slider->GetValue()) {
496 _slider->SetValue (new_slider_position);
502 FilmViewer::update_position_label ()
505 _frame_number->SetLabel ("0");
506 _timecode->SetLabel ("0:0:0.0");
510 double const fps = _film->video_frame_rate ();
511 /* Count frame number from 1 ... not sure if this is the best idea */
512 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
513 _timecode->SetLabel (time_to_timecode (_video_position, fps));
517 FilmViewer::active_jobs_changed (optional<string> j)
519 /* examine content is the only job which stops the viewer working */
520 bool const a = !j || *j != "examine_content";
522 _play_button->Enable (a);
526 FilmViewer::nudge_amount (wxMouseEvent& ev)
528 DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
530 if (ev.ShiftDown() && !ev.ControlDown()) {
531 amount = DCPTime::from_seconds (1);
532 } else if (!ev.ShiftDown() && ev.ControlDown()) {
533 amount = DCPTime::from_seconds (10);
534 } else if (ev.ShiftDown() && ev.ControlDown()) {
535 amount = DCPTime::from_seconds (60);
542 FilmViewer::go_to (DCPTime t)
544 if (t < DCPTime ()) {
548 if (t >= _film->length ()) {
549 t = _film->length ();
553 update_position_label ();
554 update_position_slider ();
558 FilmViewer::back_clicked (wxMouseEvent& ev)
560 go_to (_video_position - nudge_amount (ev));
565 FilmViewer::forward_clicked (wxMouseEvent& ev)
567 go_to (_video_position + nudge_amount (ev));
572 FilmViewer::player_changed (bool frequent)
578 if (_coalesce_player_changes) {
579 _pending_player_change = true;
585 update_position_label ();
586 update_position_slider ();
590 FilmViewer::setup_sensitivity ()
592 bool const c = _film && !_film->content().empty ();
595 _back_button->Enable (c);
596 _forward_button->Enable (c);
597 _play_button->Enable (c);
598 _outline_content->Enable (c);
599 _frame_number->Enable (c);
600 _timecode->Enable (c);
601 _jump_to_selected->Enable (c);
603 _left_eye->Enable (c && _film->three_d ());
604 _right_eye->Enable (c && _film->three_d ());
608 FilmViewer::film_changed (Film::Property p)
610 if (p == Film::CONTENT || p == Film::THREE_D) {
611 setup_sensitivity ();
615 /** Re-get the current frame */
617 FilmViewer::refresh ()
619 seek (_video_position, _last_seek_accurate);
623 FilmViewer::set_position (DCPTime p)
627 update_position_label ();
628 update_position_slider ();
632 FilmViewer::set_coalesce_player_changes (bool c)
634 _coalesce_player_changes = c;
637 _pending_player_change = false;
639 if (_pending_player_change) {
640 player_changed (false);
646 FilmViewer::timecode_clicked ()
648 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
649 if (dialog->ShowModal() == wxID_OK) {
650 go_to (dialog->get ());
656 FilmViewer::frame_number_clicked ()
658 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
659 if (dialog->ShowModal() == wxID_OK) {
660 go_to (dialog->get ());
666 FilmViewer::jump_to_selected_clicked ()
668 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
672 FilmViewer::seek (DCPTime t, bool accurate)
678 bool const was_running = stop ();
680 _butler->seek (t, accurate);
681 _last_seek_accurate = accurate;
690 FilmViewer::config_changed (Config::Property p)
692 if (p != Config::PREVIEW_SOUND && p != Config::PREVIEW_SOUND_OUTPUT) {
696 if (_audio.isStreamOpen ()) {
697 _audio.closeStream ();
700 if (Config::instance()->preview_sound()) {
702 if (Config::instance()->preview_sound_output()) {
703 while (st < _audio.getDeviceCount()) {
704 if (_audio.getDeviceInfo(st).name == Config::instance()->preview_sound_output().get()) {
709 if (st == _audio.getDeviceCount()) {
710 st = _audio.getDefaultOutputDevice();
713 st = _audio.getDefaultOutputDevice();
716 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
720 RtAudio::StreamParameters sp;
722 sp.nChannels = _audio_channels;
725 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
726 #ifdef DCPOMATIC_USE_RTERROR
727 } catch (RtError& e) {
729 } catch (RtAudioError& e) {
733 wxString::Format (_("Could not set up audio output (%s). There will be no audio during the preview."), e.what())
744 FilmViewer::time () const
746 if (_audio.isStreamRunning ()) {
747 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
748 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
751 return _video_position;
755 FilmViewer::audio_callback (void* out_p, unsigned int frames)
757 _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
759 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
761 _latency_history.push_back (_audio.getStreamLatency ());
762 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
763 _latency_history.pop_front ();
771 FilmViewer::average_latency () const
773 boost::mutex::scoped_lock lm (_latency_history_mutex);
774 if (_latency_history.empty()) {
779 BOOST_FOREACH (Frame i, _latency_history) {
783 return total / _latency_history.size();