2 Copyright (C) 2012-2017 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 (0)
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 (0)
82 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
83 , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
84 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
85 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
86 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
87 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
88 , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
89 , _coalesce_player_changes (false)
90 , _pending_player_change (false)
91 , _last_seek_accurate (true)
92 , _audio (DCPOMATIC_RTAUDIO_API)
94 , _audio_block_size (1024)
96 , _latency_history_count (0)
100 _panel->SetDoubleBuffered (true);
103 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
105 _v_sizer = new wxBoxSizer (wxVERTICAL);
108 _v_sizer->Add (_panel, 1, wxEXPAND);
110 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
111 if (outline_content) {
112 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
113 view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
115 view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
116 view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
117 if (jump_to_selected) {
118 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
119 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
121 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
123 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
125 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
126 time_sizer->Add (_frame_number, 0, wxEXPAND);
127 time_sizer->Add (_timecode, 0, wxEXPAND);
129 h_sizer->Add (_rewind_button, 0, wxALL, 2);
130 h_sizer->Add (_back_button, 0, wxALL, 2);
131 h_sizer->Add (time_sizer, 0, wxEXPAND);
132 h_sizer->Add (_forward_button, 0, wxALL, 2);
133 h_sizer->Add (_play_button, 0, wxEXPAND);
134 h_sizer->Add (_slider, 1, wxEXPAND);
136 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
138 _frame_number->SetMinSize (wxSize (84, -1));
139 _rewind_button->SetMinSize (wxSize (32, -1));
140 _back_button->SetMinSize (wxSize (32, -1));
141 _forward_button->SetMinSize (wxSize (32, -1));
143 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
144 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
145 if (_outline_content) {
146 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::refresh_panel, this));
148 _left_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
149 _right_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
150 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved, this, false));
151 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind (&FilmViewer::slider_moved, this, false));
152 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind (&FilmViewer::slider_moved, this, false));
153 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind (&FilmViewer::slider_moved, this, true));
154 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind (&FilmViewer::play_clicked, this));
155 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
156 _rewind_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::rewind_clicked, this, _1));
157 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::back_clicked, this, _1));
158 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::forward_clicked, this, _1));
159 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::frame_number_clicked, this));
160 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::timecode_clicked, this));
161 if (_jump_to_selected) {
162 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
163 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
166 set_film (shared_ptr<Film> ());
168 JobManager::instance()->ActiveJobsChanged.connect (
169 bind (&FilmViewer::active_jobs_changed, this, _2)
172 setup_sensitivity ();
174 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
175 config_changed (Config::SOUND_OUTPUT);
178 FilmViewer::~FilmViewer ()
184 FilmViewer::set_film (shared_ptr<Film> film)
194 update_position_slider ();
195 update_position_label ();
206 _player.reset (new Player (_film, _film->playlist ()));
207 _player->set_fast ();
208 if (_dcp_decode_reduction) {
209 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
211 } catch (bad_alloc) {
212 error_dialog (this, _("There is not enough free memory to do that."));
217 /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
220 _player->set_always_burn_subtitles (true);
221 _player->set_play_referenced ();
223 _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
224 _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
226 /* Keep about 1 second's worth of history samples */
227 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
234 setup_sensitivity ();
238 FilmViewer::recreate_butler ()
240 bool const was_running = stop ();
247 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
249 if (_audio_channels != 2 || _film->audio_channels() < 3) {
250 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
254 /* Special case: stereo output, at least 3 channel input, map L+R to L/R and
255 C to both, all 3dB down.
257 map.set (0, 0, 1 / sqrt(2)); // L -> L
258 map.set (1, 1, 1 / sqrt(2)); // R -> R
259 map.set (2, 0, 1 / sqrt(2)); // C -> L
260 map.set (2, 1, 1 / sqrt(2)); // C -> R
263 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
264 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
265 _butler->disable_audio ();
274 FilmViewer::refresh_panel ()
283 DCPOMATIC_ASSERT (_butler);
285 pair<shared_ptr<PlayerVideo>, DCPTime> video;
287 video = _butler->get_video ();
290 ((_left_eye->GetValue() && video.first->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && video.first->eyes() == EYES_LEFT))
301 if (_playing && (time() - video.second) > one_video_frame()) {
302 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
303 part if this frame is J2K).
305 _video_position = video.second;
310 /* In an ideal world, what we would do here is:
312 * 1. convert to XYZ exactly as we do in the DCP creation path.
313 * 2. convert back to RGB for the preview display, compensating
314 * for the monitor etc. etc.
316 * but this is inefficient if the source is RGB. Since we don't
317 * (currently) care too much about the precise accuracy of the preview's
318 * colour mapping (and we care more about its speed) we try to short-
319 * circuit this "ideal" situation in some cases.
321 * The content's specified colour conversion indicates the colourspace
322 * which the content is in (according to the user).
324 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
325 * image and convert it (from whatever the user has said it is) to RGB.
328 _frame = video.first->image (
329 bind (&Log::dcp_log, _film->log().get(), _1, _2),
330 bind (&PlayerVideo::always_rgb, _1),
334 ImageChanged (video.first);
336 _video_position = video.second;
337 _inter_position = video.first->inter_position ();
338 _inter_size = video.first->inter_size ();
346 if (!_film || !_playing) {
351 update_position_label ();
352 update_position_slider ();
353 DCPTime const next = _video_position + one_video_frame();
355 if (next >= _film->length()) {
359 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
367 FilmViewer::paint_panel ()
369 wxPaintDC dc (_panel);
371 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
376 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
377 wxBitmap frame_bitmap (frame);
378 dc.DrawBitmap (frame_bitmap, 0, 0);
380 if (_out_size.width < _panel_size.width) {
381 wxPen p (GetBackgroundColour ());
382 wxBrush b (GetBackgroundColour ());
385 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
388 if (_out_size.height < _panel_size.height) {
389 wxPen p (GetBackgroundColour ());
390 wxBrush b (GetBackgroundColour ());
393 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
396 if (_outline_content && _outline_content->GetValue ()) {
397 wxPen p (wxColour (255, 0, 0), 2);
399 dc.SetBrush (*wxTRANSPARENT_BRUSH);
400 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
405 FilmViewer::slider_moved (bool update_slider)
412 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
413 /* Ensure that we hit the end of the film at the end of the slider */
414 if (t >= _film->length ()) {
415 t = _film->length() - one_video_frame();
418 update_position_label ();
420 update_position_slider ();
425 FilmViewer::panel_sized (wxSizeEvent& ev)
427 _panel_size.width = ev.GetSize().GetWidth();
428 _panel_size.height = ev.GetSize().GetHeight();
432 update_position_label ();
433 update_position_slider ();
437 FilmViewer::calculate_sizes ()
443 Ratio const * container = _film->container ();
445 float const panel_ratio = _panel_size.ratio ();
446 float const film_ratio = container ? container->ratio () : 1.78;
448 if (panel_ratio < film_ratio) {
449 /* panel is less widscreen than the film; clamp width */
450 _out_size.width = _panel_size.width;
451 _out_size.height = lrintf (_out_size.width / film_ratio);
453 /* panel is more widescreen than the film; clamp height */
454 _out_size.height = _panel_size.height;
455 _out_size.width = lrintf (_out_size.height * film_ratio);
458 /* Catch silly values */
459 _out_size.width = max (64, _out_size.width);
460 _out_size.height = max (64, _out_size.height);
462 _player->set_video_container_size (_out_size);
466 FilmViewer::play_clicked ()
472 FilmViewer::check_play_state ()
474 if (!_film || _film->video_frame_rate() == 0) {
478 if (_play_button->GetValue()) {
488 if (_audio.isStreamOpen()) {
489 _audio.setStreamTime (_video_position.seconds());
490 _audio.startStream ();
501 if (_audio.isStreamRunning()) {
502 /* stop stream and discard any remainig queued samples */
503 _audio.abortStream ();
511 _play_button->SetValue (false);
516 FilmViewer::update_position_slider ()
519 _slider->SetValue (0);
523 DCPTime const len = _film->length ();
526 int const new_slider_position = 4096 * _video_position.get() / len.get();
527 if (new_slider_position != _slider->GetValue()) {
528 _slider->SetValue (new_slider_position);
534 FilmViewer::update_position_label ()
537 _frame_number->SetLabel ("0");
538 _timecode->SetLabel ("0:0:0.0");
542 double const fps = _film->video_frame_rate ();
543 /* Count frame number from 1 ... not sure if this is the best idea */
544 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
545 _timecode->SetLabel (time_to_timecode (_video_position, fps));
549 FilmViewer::active_jobs_changed (optional<string> j)
551 /* examine content is the only job which stops the viewer working */
552 bool const a = !j || *j != "examine_content";
554 _play_button->Enable (a);
558 FilmViewer::nudge_amount (wxMouseEvent& ev)
560 DCPTime amount = one_video_frame ();
562 if (ev.ShiftDown() && !ev.ControlDown()) {
563 amount = DCPTime::from_seconds (1);
564 } else if (!ev.ShiftDown() && ev.ControlDown()) {
565 amount = DCPTime::from_seconds (10);
566 } else if (ev.ShiftDown() && ev.ControlDown()) {
567 amount = DCPTime::from_seconds (60);
574 FilmViewer::go_to (DCPTime t)
576 if (t < DCPTime ()) {
580 if (t >= _film->length ()) {
581 t = _film->length ();
585 update_position_label ();
586 update_position_slider ();
590 FilmViewer::rewind_clicked (wxMouseEvent& ev)
597 FilmViewer::back_clicked (wxMouseEvent& ev)
599 go_to (_video_position - nudge_amount (ev));
604 FilmViewer::forward_clicked (wxMouseEvent& ev)
606 go_to (_video_position + nudge_amount (ev));
611 FilmViewer::player_changed (bool frequent)
617 if (_coalesce_player_changes) {
618 _pending_player_change = true;
624 update_position_label ();
625 update_position_slider ();
629 FilmViewer::setup_sensitivity ()
631 bool const c = _film && !_film->content().empty ();
634 _rewind_button->Enable (c);
635 _back_button->Enable (c);
636 _forward_button->Enable (c);
637 _play_button->Enable (c);
638 if (_outline_content) {
639 _outline_content->Enable (c);
641 _frame_number->Enable (c);
642 _timecode->Enable (c);
643 if (_jump_to_selected) {
644 _jump_to_selected->Enable (c);
647 _left_eye->Enable (c && _film->three_d ());
648 _right_eye->Enable (c && _film->three_d ());
652 FilmViewer::film_changed (Film::Property p)
654 if (p == Film::CONTENT || p == Film::THREE_D) {
655 setup_sensitivity ();
659 /** Re-get the current frame */
661 FilmViewer::refresh ()
663 seek (_video_position, _last_seek_accurate);
667 FilmViewer::set_position (DCPTime p)
671 update_position_label ();
672 update_position_slider ();
676 FilmViewer::set_coalesce_player_changes (bool c)
678 _coalesce_player_changes = c;
681 _pending_player_change = false;
683 if (_pending_player_change) {
684 player_changed (false);
690 FilmViewer::timecode_clicked ()
692 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
693 if (dialog->ShowModal() == wxID_OK) {
694 go_to (dialog->get ());
700 FilmViewer::frame_number_clicked ()
702 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
703 if (dialog->ShowModal() == wxID_OK) {
704 go_to (dialog->get ());
710 FilmViewer::jump_to_selected_clicked ()
712 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
716 FilmViewer::seek (DCPTime t, bool accurate)
722 bool const was_running = stop ();
724 _butler->seek (t, accurate);
725 _last_seek_accurate = accurate;
734 FilmViewer::config_changed (Config::Property p)
736 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
740 if (_audio.isStreamOpen ()) {
741 _audio.closeStream ();
744 if (Config::instance()->sound()) {
746 if (Config::instance()->sound_output()) {
747 while (st < _audio.getDeviceCount()) {
748 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
753 if (st == _audio.getDeviceCount()) {
754 st = _audio.getDefaultOutputDevice();
757 st = _audio.getDefaultOutputDevice();
760 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
762 RtAudio::StreamParameters sp;
764 sp.nChannels = _audio_channels;
767 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
768 #ifdef DCPOMATIC_USE_RTERROR
769 } catch (RtError& e) {
771 } catch (RtAudioError& e) {
775 wxString::Format (_("Could not set up audio output (%s). There will be no audio during the preview."), e.what())
787 FilmViewer::time () const
789 if (_audio.isStreamRunning ()) {
790 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
791 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
794 return _video_position;
798 FilmViewer::audio_callback (void* out_p, unsigned int frames)
800 _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
802 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
804 _latency_history.push_back (_audio.getStreamLatency ());
805 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
806 _latency_history.pop_front ();
814 FilmViewer::average_latency () const
816 boost::mutex::scoped_lock lm (_latency_history_mutex);
817 if (_latency_history.empty()) {
822 BOOST_FOREACH (Frame i, _latency_history) {
826 return total / _latency_history.size();
830 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
832 _dcp_decode_reduction = reduction;
834 _player->set_dcp_decode_reduction (reduction);
839 FilmViewer::dcp_decode_reduction () const
841 return _dcp_decode_reduction;
845 FilmViewer::one_video_frame () const
847 return DCPTime::from_frames (1, _film->video_frame_rate());