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 (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 , _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)
99 _panel->SetDoubleBuffered (true);
102 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
104 _v_sizer = new wxBoxSizer (wxVERTICAL);
107 _v_sizer->Add (_panel, 1, wxEXPAND);
109 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
110 if (outline_content) {
111 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
112 view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
114 view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
115 view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
116 if (jump_to_selected) {
117 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
118 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
120 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
122 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
124 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
125 time_sizer->Add (_frame_number, 0, wxEXPAND);
126 time_sizer->Add (_timecode, 0, wxEXPAND);
128 h_sizer->Add (_back_button, 0, wxALL, 2);
129 h_sizer->Add (time_sizer, 0, wxEXPAND);
130 h_sizer->Add (_forward_button, 0, wxALL, 2);
131 h_sizer->Add (_play_button, 0, wxEXPAND);
132 h_sizer->Add (_slider, 1, wxEXPAND);
134 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
136 _frame_number->SetMinSize (wxSize (84, -1));
137 _back_button->SetMinSize (wxSize (32, -1));
138 _forward_button->SetMinSize (wxSize (32, -1));
140 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
141 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
142 if (_outline_content) {
143 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::refresh_panel, this));
145 _left_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
146 _right_eye->Bind (wxEVT_RADIOBUTTON, boost::bind (&FilmViewer::refresh, this));
147 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved, this, false));
148 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind (&FilmViewer::slider_moved, this, false));
149 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind (&FilmViewer::slider_moved, this, false));
150 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind (&FilmViewer::slider_moved, this, true));
151 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind (&FilmViewer::play_clicked, this));
152 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
153 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::back_clicked, this, _1));
154 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::forward_clicked, this, _1));
155 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::frame_number_clicked, this));
156 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::timecode_clicked, this));
157 if (_jump_to_selected) {
158 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
159 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
162 set_film (shared_ptr<Film> ());
164 JobManager::instance()->ActiveJobsChanged.connect (
165 bind (&FilmViewer::active_jobs_changed, this, _2)
168 setup_sensitivity ();
170 _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
171 config_changed (Config::SOUND_OUTPUT);
174 FilmViewer::~FilmViewer ()
180 FilmViewer::set_film (shared_ptr<Film> film)
190 update_position_slider ();
191 update_position_label ();
198 _player.reset (new Player (_film, _film->playlist ()));
199 _player->set_fast ();
200 if (_dcp_decode_reduction) {
201 _player->set_dcp_decode_reduction (_dcp_decode_reduction);
203 } catch (bad_alloc) {
204 error_dialog (this, _("There is not enough free memory to do that."));
209 /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
212 _player->set_always_burn_subtitles (true);
213 _player->set_play_referenced ();
215 _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
216 _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
218 /* Keep about 1 second's worth of history samples */
219 _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
226 setup_sensitivity ();
230 FilmViewer::recreate_butler ()
232 bool const was_running = stop ();
239 AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
241 if (_audio_channels != 2 || _film->audio_channels() < 3) {
242 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
246 /* Special case: stereo output, at least 3 channel input, map L+R to L/R and
247 C to both, all 3dB down.
249 map.set (0, 0, 1 / sqrt(2)); // L -> L
250 map.set (1, 1, 1 / sqrt(2)); // R -> R
251 map.set (2, 0, 1 / sqrt(2)); // C -> L
252 map.set (2, 1, 1 / sqrt(2)); // C -> R
255 _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
256 if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
257 _butler->disable_audio ();
266 FilmViewer::refresh_panel ()
275 DCPOMATIC_ASSERT (_butler);
277 pair<shared_ptr<PlayerVideo>, DCPTime> video;
279 video = _butler->get_video ();
282 ((_left_eye->GetValue() && video.first->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && video.first->eyes() == EYES_LEFT))
293 if (_playing && (time() - video.second) > one_video_frame()) {
294 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
295 part if this frame is J2K).
297 _video_position = video.second;
302 /* In an ideal world, what we would do here is:
304 * 1. convert to XYZ exactly as we do in the DCP creation path.
305 * 2. convert back to RGB for the preview display, compensating
306 * for the monitor etc. etc.
308 * but this is inefficient if the source is RGB. Since we don't
309 * (currently) care too much about the precise accuracy of the preview's
310 * colour mapping (and we care more about its speed) we try to short-
311 * circuit this "ideal" situation in some cases.
313 * The content's specified colour conversion indicates the colourspace
314 * which the content is in (according to the user).
316 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
317 * image and convert it (from whatever the user has said it is) to RGB.
320 _frame = video.first->image (
321 bind (&Log::dcp_log, _film->log().get(), _1, _2),
322 bind (&PlayerVideo::always_rgb, _1),
326 ImageChanged (video.first);
328 _video_position = video.second;
329 _inter_position = video.first->inter_position ();
330 _inter_size = video.first->inter_size ();
338 if (!_film || !_playing) {
343 update_position_label ();
344 update_position_slider ();
345 DCPTime const next = _video_position + one_video_frame();
347 if (next >= _film->length()) {
351 _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
359 FilmViewer::paint_panel ()
361 wxPaintDC dc (_panel);
363 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
368 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
369 wxBitmap frame_bitmap (frame);
370 dc.DrawBitmap (frame_bitmap, 0, 0);
372 if (_out_size.width < _panel_size.width) {
373 wxPen p (GetBackgroundColour ());
374 wxBrush b (GetBackgroundColour ());
377 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
380 if (_out_size.height < _panel_size.height) {
381 wxPen p (GetBackgroundColour ());
382 wxBrush b (GetBackgroundColour ());
385 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
388 if (_outline_content && _outline_content->GetValue ()) {
389 wxPen p (wxColour (255, 0, 0), 2);
391 dc.SetBrush (*wxTRANSPARENT_BRUSH);
392 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
397 FilmViewer::slider_moved (bool update_slider)
404 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
405 /* Ensure that we hit the end of the film at the end of the slider */
406 if (t >= _film->length ()) {
407 t = _film->length() - one_video_frame();
410 update_position_label ();
412 update_position_slider ();
417 FilmViewer::panel_sized (wxSizeEvent& ev)
419 _panel_size.width = ev.GetSize().GetWidth();
420 _panel_size.height = ev.GetSize().GetHeight();
424 update_position_label ();
425 update_position_slider ();
429 FilmViewer::calculate_sizes ()
435 Ratio const * container = _film->container ();
437 float const panel_ratio = _panel_size.ratio ();
438 float const film_ratio = container ? container->ratio () : 1.78;
440 if (panel_ratio < film_ratio) {
441 /* panel is less widscreen than the film; clamp width */
442 _out_size.width = _panel_size.width;
443 _out_size.height = lrintf (_out_size.width / film_ratio);
445 /* panel is more widescreen than the film; clamp height */
446 _out_size.height = _panel_size.height;
447 _out_size.width = lrintf (_out_size.height * film_ratio);
450 /* Catch silly values */
451 _out_size.width = max (64, _out_size.width);
452 _out_size.height = max (64, _out_size.height);
454 _player->set_video_container_size (_out_size);
458 FilmViewer::play_clicked ()
464 FilmViewer::check_play_state ()
466 if (!_film || _film->video_frame_rate() == 0) {
470 if (_play_button->GetValue()) {
480 if (_audio.isStreamOpen()) {
481 _audio.setStreamTime (_video_position.seconds());
482 _audio.startStream ();
493 if (_audio.isStreamRunning()) {
494 /* stop stream and discard any remainig queued samples */
495 _audio.abortStream ();
503 _play_button->SetValue (false);
508 FilmViewer::update_position_slider ()
511 _slider->SetValue (0);
515 DCPTime const len = _film->length ();
518 int const new_slider_position = 4096 * _video_position.get() / len.get();
519 if (new_slider_position != _slider->GetValue()) {
520 _slider->SetValue (new_slider_position);
526 FilmViewer::update_position_label ()
529 _frame_number->SetLabel ("0");
530 _timecode->SetLabel ("0:0:0.0");
534 double const fps = _film->video_frame_rate ();
535 /* Count frame number from 1 ... not sure if this is the best idea */
536 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
537 _timecode->SetLabel (time_to_timecode (_video_position, fps));
541 FilmViewer::active_jobs_changed (optional<string> j)
543 /* examine content is the only job which stops the viewer working */
544 bool const a = !j || *j != "examine_content";
546 _play_button->Enable (a);
550 FilmViewer::nudge_amount (wxMouseEvent& ev)
552 DCPTime amount = one_video_frame ();
554 if (ev.ShiftDown() && !ev.ControlDown()) {
555 amount = DCPTime::from_seconds (1);
556 } else if (!ev.ShiftDown() && ev.ControlDown()) {
557 amount = DCPTime::from_seconds (10);
558 } else if (ev.ShiftDown() && ev.ControlDown()) {
559 amount = DCPTime::from_seconds (60);
566 FilmViewer::go_to (DCPTime t)
568 if (t < DCPTime ()) {
572 if (t >= _film->length ()) {
573 t = _film->length ();
577 update_position_label ();
578 update_position_slider ();
582 FilmViewer::back_clicked (wxMouseEvent& ev)
584 go_to (_video_position - nudge_amount (ev));
589 FilmViewer::forward_clicked (wxMouseEvent& ev)
591 go_to (_video_position + nudge_amount (ev));
596 FilmViewer::player_changed (bool frequent)
602 if (_coalesce_player_changes) {
603 _pending_player_change = true;
609 update_position_label ();
610 update_position_slider ();
614 FilmViewer::setup_sensitivity ()
616 bool const c = _film && !_film->content().empty ();
619 _back_button->Enable (c);
620 _forward_button->Enable (c);
621 _play_button->Enable (c);
622 if (_outline_content) {
623 _outline_content->Enable (c);
625 _frame_number->Enable (c);
626 _timecode->Enable (c);
627 if (_jump_to_selected) {
628 _jump_to_selected->Enable (c);
631 _left_eye->Enable (c && _film->three_d ());
632 _right_eye->Enable (c && _film->three_d ());
636 FilmViewer::film_changed (Film::Property p)
638 if (p == Film::CONTENT || p == Film::THREE_D) {
639 setup_sensitivity ();
643 /** Re-get the current frame */
645 FilmViewer::refresh ()
647 seek (_video_position, _last_seek_accurate);
651 FilmViewer::set_position (DCPTime p)
655 update_position_label ();
656 update_position_slider ();
660 FilmViewer::set_coalesce_player_changes (bool c)
662 _coalesce_player_changes = c;
665 _pending_player_change = false;
667 if (_pending_player_change) {
668 player_changed (false);
674 FilmViewer::timecode_clicked ()
676 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
677 if (dialog->ShowModal() == wxID_OK) {
678 go_to (dialog->get ());
684 FilmViewer::frame_number_clicked ()
686 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
687 if (dialog->ShowModal() == wxID_OK) {
688 go_to (dialog->get ());
694 FilmViewer::jump_to_selected_clicked ()
696 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
700 FilmViewer::seek (DCPTime t, bool accurate)
706 bool const was_running = stop ();
708 _butler->seek (t, accurate);
709 _last_seek_accurate = accurate;
718 FilmViewer::config_changed (Config::Property p)
720 if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
724 if (_audio.isStreamOpen ()) {
725 _audio.closeStream ();
728 if (Config::instance()->sound()) {
730 if (Config::instance()->sound_output()) {
731 while (st < _audio.getDeviceCount()) {
732 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
737 if (st == _audio.getDeviceCount()) {
738 st = _audio.getDefaultOutputDevice();
741 st = _audio.getDefaultOutputDevice();
744 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
746 RtAudio::StreamParameters sp;
748 sp.nChannels = _audio_channels;
751 _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
752 #ifdef DCPOMATIC_USE_RTERROR
753 } catch (RtError& e) {
755 } catch (RtAudioError& e) {
759 wxString::Format (_("Could not set up audio output (%s). There will be no audio during the preview."), e.what())
771 FilmViewer::time () const
773 if (_audio.isStreamRunning ()) {
774 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
775 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
778 return _video_position;
782 FilmViewer::audio_callback (void* out_p, unsigned int frames)
784 _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
786 boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
788 _latency_history.push_back (_audio.getStreamLatency ());
789 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
790 _latency_history.pop_front ();
798 FilmViewer::average_latency () const
800 boost::mutex::scoped_lock lm (_latency_history_mutex);
801 if (_latency_history.empty()) {
806 BOOST_FOREACH (Frame i, _latency_history) {
810 return total / _latency_history.size();
814 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
816 _dcp_decode_reduction = reduction;
818 _player->set_dcp_decode_reduction (reduction);
823 FilmViewer::one_video_frame () const
825 return DCPTime::from_frames (1, _film->video_frame_rate());