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 if ((time() - video.second) > one_video_frame()) {
285 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
286 part if this frame is J2K).
288 _video_position = video.second;
292 /* In an ideal world, what we would do here is:
294 * 1. convert to XYZ exactly as we do in the DCP creation path.
295 * 2. convert back to RGB for the preview display, compensating
296 * for the monitor etc. etc.
298 * but this is inefficient if the source is RGB. Since we don't
299 * (currently) care too much about the precise accuracy of the preview's
300 * colour mapping (and we care more about its speed) we try to short-
301 * circuit this "ideal" situation in some cases.
303 * The content's specified colour conversion indicates the colourspace
304 * which the content is in (according to the user).
306 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
307 * image and convert it (from whatever the user has said it is) to RGB.
310 _frame = video.first->image (
311 bind (&Log::dcp_log, _film->log().get(), _1, _2),
312 bind (&PlayerVideo::always_rgb, _1),
316 ImageChanged (video.first);
318 _video_position = video.second;
319 _inter_position = video.first->inter_position ();
320 _inter_size = video.first->inter_size ();
328 if (!_film || !_playing) {
333 update_position_label ();
334 update_position_slider ();
335 DCPTime const next = _video_position + one_video_frame();
337 if (next >= _film->length()) {
341 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
349 FilmViewer::paint_panel ()
351 wxPaintDC dc (_panel);
353 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
358 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
359 wxBitmap frame_bitmap (frame);
360 dc.DrawBitmap (frame_bitmap, 0, 0);
362 if (_out_size.width < _panel_size.width) {
363 wxPen p (GetBackgroundColour ());
364 wxBrush b (GetBackgroundColour ());
367 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
370 if (_out_size.height < _panel_size.height) {
371 wxPen p (GetBackgroundColour ());
372 wxBrush b (GetBackgroundColour ());
375 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
378 if (_outline_content->GetValue ()) {
379 wxPen p (wxColour (255, 0, 0), 2);
381 dc.SetBrush (*wxTRANSPARENT_BRUSH);
382 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
387 FilmViewer::slider_moved (bool update_slider)
394 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
395 /* Ensure that we hit the end of the film at the end of the slider */
396 if (t >= _film->length ()) {
397 t = _film->length() - one_video_frame();
400 update_position_label ();
402 update_position_slider ();
407 FilmViewer::panel_sized (wxSizeEvent& ev)
409 _panel_size.width = ev.GetSize().GetWidth();
410 _panel_size.height = ev.GetSize().GetHeight();
414 update_position_label ();
415 update_position_slider ();
419 FilmViewer::calculate_sizes ()
425 Ratio const * container = _film->container ();
427 float const panel_ratio = _panel_size.ratio ();
428 float const film_ratio = container ? container->ratio () : 1.78;
430 if (panel_ratio < film_ratio) {
431 /* panel is less widscreen than the film; clamp width */
432 _out_size.width = _panel_size.width;
433 _out_size.height = lrintf (_out_size.width / film_ratio);
435 /* panel is more widescreen than the film; clamp height */
436 _out_size.height = _panel_size.height;
437 _out_size.width = lrintf (_out_size.height * film_ratio);
440 /* Catch silly values */
441 _out_size.width = max (64, _out_size.width);
442 _out_size.height = max (64, _out_size.height);
444 _player->set_video_container_size (_out_size);
448 FilmViewer::play_clicked ()
454 FilmViewer::check_play_state ()
456 if (!_film || _film->video_frame_rate() == 0) {
460 if (_play_button->GetValue()) {
470 if (_audio.isStreamOpen()) {
471 _audio.setStreamTime (_video_position.seconds());
472 _audio.startStream ();
482 if (_audio.isStreamRunning()) {
483 /* stop stream and discard any remainig queued samples */
484 _audio.abortStream ();
492 _play_button->SetValue (false);
497 FilmViewer::update_position_slider ()
500 _slider->SetValue (0);
504 DCPTime const len = _film->length ();
507 int const new_slider_position = 4096 * _video_position.get() / len.get();
508 if (new_slider_position != _slider->GetValue()) {
509 _slider->SetValue (new_slider_position);
515 FilmViewer::update_position_label ()
518 _frame_number->SetLabel ("0");
519 _timecode->SetLabel ("0:0:0.0");
523 double const fps = _film->video_frame_rate ();
524 /* Count frame number from 1 ... not sure if this is the best idea */
525 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
526 _timecode->SetLabel (time_to_timecode (_video_position, fps));
530 FilmViewer::active_jobs_changed (optional<string> j)
532 /* examine content is the only job which stops the viewer working */
533 bool const a = !j || *j != "examine_content";
535 _play_button->Enable (a);
539 FilmViewer::nudge_amount (wxMouseEvent& ev)
541 DCPTime amount = one_video_frame ();
543 if (ev.ShiftDown() && !ev.ControlDown()) {
544 amount = DCPTime::from_seconds (1);
545 } else if (!ev.ShiftDown() && ev.ControlDown()) {
546 amount = DCPTime::from_seconds (10);
547 } else if (ev.ShiftDown() && ev.ControlDown()) {
548 amount = DCPTime::from_seconds (60);
555 FilmViewer::go_to (DCPTime t)
557 if (t < DCPTime ()) {
561 if (t >= _film->length ()) {
562 t = _film->length ();
566 update_position_label ();
567 update_position_slider ();
571 FilmViewer::back_clicked (wxMouseEvent& ev)
573 go_to (_video_position - nudge_amount (ev));
578 FilmViewer::forward_clicked (wxMouseEvent& ev)
580 go_to (_video_position + nudge_amount (ev));
585 FilmViewer::player_changed (bool frequent)
591 if (_coalesce_player_changes) {
592 _pending_player_change = true;
598 update_position_label ();
599 update_position_slider ();
603 FilmViewer::setup_sensitivity ()
605 bool const c = _film && !_film->content().empty ();
608 _back_button->Enable (c);
609 _forward_button->Enable (c);
610 _play_button->Enable (c);
611 _outline_content->Enable (c);
612 _frame_number->Enable (c);
613 _timecode->Enable (c);
614 _jump_to_selected->Enable (c);
616 _left_eye->Enable (c && _film->three_d ());
617 _right_eye->Enable (c && _film->three_d ());
621 FilmViewer::film_changed (Film::Property p)
623 if (p == Film::CONTENT || p == Film::THREE_D) {
624 setup_sensitivity ();
628 /** Re-get the current frame */
630 FilmViewer::refresh ()
632 seek (_video_position, _last_seek_accurate);
636 FilmViewer::set_position (DCPTime p)
640 update_position_label ();
641 update_position_slider ();
645 FilmViewer::set_coalesce_player_changes (bool c)
647 _coalesce_player_changes = c;
650 _pending_player_change = false;
652 if (_pending_player_change) {
653 player_changed (false);
659 FilmViewer::timecode_clicked ()
661 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
662 if (dialog->ShowModal() == wxID_OK) {
663 go_to (dialog->get ());
669 FilmViewer::frame_number_clicked ()
671 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
672 if (dialog->ShowModal() == wxID_OK) {
673 go_to (dialog->get ());
679 FilmViewer::jump_to_selected_clicked ()
681 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
685 FilmViewer::seek (DCPTime t, bool accurate)
691 bool const was_running = stop ();
693 _butler->seek (t, accurate);
694 _last_seek_accurate = accurate;
703 FilmViewer::config_changed (Config::Property p)
705 if (p != Config::PREVIEW_SOUND && p != Config::PREVIEW_SOUND_OUTPUT) {
709 if (_audio.isStreamOpen ()) {
710 _audio.closeStream ();
713 if (Config::instance()->preview_sound()) {
715 if (Config::instance()->preview_sound_output()) {
716 while (st < _audio.getDeviceCount()) {
717 if (_audio.getDeviceInfo(st).name == Config::instance()->preview_sound_output().get()) {
722 if (st == _audio.getDeviceCount()) {
723 st = _audio.getDefaultOutputDevice();
726 st = _audio.getDefaultOutputDevice();
729 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
733 RtAudio::StreamParameters sp;
735 sp.nChannels = _audio_channels;
738 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
739 #ifdef DCPOMATIC_USE_RTERROR
740 } catch (RtError& e) {
742 } catch (RtAudioError& e) {
746 wxString::Format (_("Could not set up audio output (%s). There will be no audio during the preview."), e.what())
757 FilmViewer::time () const
759 if (_audio.isStreamRunning ()) {
760 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
761 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
764 return _video_position;
768 FilmViewer::audio_callback (void* out_p, unsigned int frames)
770 _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
772 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
774 _latency_history.push_back (_audio.getStreamLatency ());
775 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
776 _latency_history.pop_front ();
784 FilmViewer::average_latency () const
786 boost::mutex::scoped_lock lm (_latency_history_mutex);
787 if (_latency_history.empty()) {
792 BOOST_FOREACH (Frame i, _latency_history) {
796 return total / _latency_history.size();
800 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
802 _player->set_dcp_decode_reduction (reduction);
806 FilmViewer::one_video_frame () const
808 return DCPTime::from_frames (1, _film->video_frame_rate());