No-op; rename a whole load of wx constants to their shorter equivalents.
[dcpomatic.git] / src / wx / film_viewer.cc
index a9b0907a1726abb0eab3abc2a9b819d612169f8d..40155b18c398ed7b5040cdc3095dedb561a623e6 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
  *  @brief A wx widget to view a preview of a Film.
  */
 
+#include "film_viewer.h"
+#include "playhead_to_timecode_dialog.h"
+#include "playhead_to_frame_dialog.h"
+#include "wx_util.h"
 #include "lib/film.h"
 #include "lib/ratio.h"
 #include "lib/util.h"
@@ -35,8 +40,9 @@
 #include "lib/video_decoder.h"
 #include "lib/timer.h"
 #include "lib/log.h"
-#include "film_viewer.h"
-#include "wx_util.h"
+extern "C" {
+#include <libavutil/pixfmt.h>
+}
 #include <dcp/exceptions.h>
 #include <wx/tglbtn.h>
 #include <iostream>
@@ -54,32 +60,41 @@ using std::exception;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
 using boost::weak_ptr;
+using boost::optional;
 using dcp::Size;
 
 FilmViewer::FilmViewer (wxWindow* p)
        : wxPanel (p)
        , _panel (new wxPanel (this))
        , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
+       , _left_eye (new wxRadioButton (this, wxID_ANY, _("Left eye"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP))
+       , _right_eye (new wxRadioButton (this, wxID_ANY, _("Right eye")))
        , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
        , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
        , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
        , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
        , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
        , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
+       , _coalesce_player_changes (false)
+       , _pending_player_change (false)
        , _last_get_accurate (true)
 {
 #ifndef __WXOSX__
        _panel->SetDoubleBuffered (true);
 #endif
-       
+
        _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
-       
+
        _v_sizer = new wxBoxSizer (wxVERTICAL);
        SetSizer (_v_sizer);
 
        _v_sizer->Add (_panel, 1, wxEXPAND);
 
-       _v_sizer->Add (_outline_content, 0, wxALL, DCPOMATIC_SIZER_GAP);
+       wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
+       view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
+       view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
+       view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
+       _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
 
        wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
 
@@ -99,21 +114,25 @@ FilmViewer::FilmViewer (wxWindow* p)
        _back_button->SetMinSize (wxSize (32, -1));
        _forward_button->SetMinSize (wxSize (32, -1));
 
-       _panel->Bind          (wxEVT_PAINT,                        boost::bind (&FilmViewer::paint_panel,     this));
-       _panel->Bind          (wxEVT_SIZE,                         boost::bind (&FilmViewer::panel_sized,     this, _1));
-       _outline_content->Bind(wxEVT_COMMAND_CHECKBOX_CLICKED,     boost::bind (&FilmViewer::refresh_panel,   this));
-       _slider->Bind         (wxEVT_SCROLL_THUMBTRACK,            boost::bind (&FilmViewer::slider_moved,    this));
-       _slider->Bind         (wxEVT_SCROLL_PAGEUP,                boost::bind (&FilmViewer::slider_moved,    this));
-       _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,              boost::bind (&FilmViewer::slider_moved,    this));
-       _play_button->Bind    (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked,    this));
-       _timer.Bind           (wxEVT_TIMER,                        boost::bind (&FilmViewer::timer,           this));
-       _back_button->Bind    (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::back_clicked,    this));
-       _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::forward_clicked, this));
+       _panel->Bind          (wxEVT_PAINT,             boost::bind (&FilmViewer::paint_panel,     this));
+       _panel->Bind          (wxEVT_SIZE,              boost::bind (&FilmViewer::panel_sized,     this, _1));
+       _outline_content->Bind(wxEVT_CHECKBOX,          boost::bind (&FilmViewer::refresh_panel,   this));
+       _left_eye->Bind       (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
+       _right_eye->Bind      (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
+       _slider->Bind         (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved,    this));
+       _slider->Bind         (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this));
+       _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this));
+       _play_button->Bind    (wxEVT_TOGGLEBUTTON,      boost::bind (&FilmViewer::play_clicked,    this));
+       _timer.Bind           (wxEVT_TIMER,             boost::bind (&FilmViewer::timer,           this));
+       _back_button->Bind    (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::back_clicked,    this, _1));
+       _forward_button->Bind (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::forward_clicked, this, _1));
+       _frame_number->Bind   (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::frame_number_clicked, this));
+       _timecode->Bind       (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::timecode_clicked, this));
 
        set_film (shared_ptr<Film> ());
-       
+
        JobManager::instance()->ActiveJobsChanged.connect (
-               bind (&FilmViewer::active_jobs_changed, this, _1)
+               bind (&FilmViewer::active_jobs_changed, this, _2)
                );
 
        setup_sensitivity ();
@@ -129,33 +148,36 @@ FilmViewer::set_film (shared_ptr<Film> film)
        _film = film;
 
        _frame.reset ();
-       
+
        update_position_slider ();
        update_position_label ();
-       
+
        if (!_film) {
                return;
        }
 
        try {
-               _player.reset (new Player (_film));
+               _player.reset (new Player (_film, _film->playlist ()));
+               _player->set_fast ();
        } catch (bad_alloc) {
                error_dialog (this, _("There is not enough free memory to do that."));
                _film.reset ();
                return;
        }
 
-       /* Always burn in subtitles, even if we are set not to, otherwise we won't see them
+       /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
           in the preview.
        */
-       _player->set_burn_subtitles (true);
-       
+       _player->set_always_burn_subtitles (true);
+       _player->set_ignore_audio ();
+       _player->set_play_referenced ();
+
        _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 
        _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 
        calculate_sizes ();
-       get (_position, _last_get_accurate);
+       refresh ();
 
        setup_sensitivity ();
 }
@@ -174,26 +196,65 @@ FilmViewer::get (DCPTime p, bool accurate)
                return;
        }
 
-       list<shared_ptr<PlayerVideo> > pvf;
+       list<shared_ptr<PlayerVideo> > all_pv;
        try {
-               pvf = _player->get_video (p, accurate);
+               all_pv = _player->get_video (p, accurate);
        } catch (exception& e) {
                error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
        }
-       
-       if (!pvf.empty ()) {
-               try {
-                       _frame = pvf.front()->image (PIX_FMT_RGB24, true, boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
 
-                       dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
-                       if (pvf.front()->colour_conversion()) {
-                               yuv_to_rgb = pvf.front()->colour_conversion().get().yuv_to_rgb();
+       if (!all_pv.empty ()) {
+               try {
+                       shared_ptr<PlayerVideo> pv;
+                       if (all_pv.size() == 2) {
+                               /* We have 3D; choose the correct eye */
+                               if (_left_eye->GetValue()) {
+                                       if (all_pv.front()->eyes() == EYES_LEFT) {
+                                               pv = all_pv.front();
+                                       } else {
+                                               pv = all_pv.back();
+                                       }
+                               } else {
+                                       if (all_pv.front()->eyes() == EYES_RIGHT) {
+                                               pv = all_pv.front();
+                                       } else {
+                                               pv = all_pv.back();
+                                       }
+                               }
+                       } else {
+                               /* 2D; no choice to make */
+                               pv = all_pv.front ();
                        }
-                       
-                       _frame = _frame->scale (_frame->size(), yuv_to_rgb, PIX_FMT_RGB24, false);
-                       _position = pvf.front()->time ();
-                       _inter_position = pvf.front()->inter_position ();
-                       _inter_size = pvf.front()->inter_size ();
+
+                       /* In an ideal world, what we would do here is:
+                        *
+                        * 1. convert to XYZ exactly as we do in the DCP creation path.
+                        * 2. convert back to RGB for the preview display, compensating
+                        *    for the monitor etc. etc.
+                        *
+                        * but this is inefficient if the source is RGB.  Since we don't
+                        * (currently) care too much about the precise accuracy of the preview's
+                        * colour mapping (and we care more about its speed) we try to short-
+                        * circuit this "ideal" situation in some cases.
+                        *
+                        * The content's specified colour conversion indicates the colourspace
+                        * which the content is in (according to the user).
+                        *
+                        * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
+                        * image and convert it (from whatever the user has said it is) to RGB.
+                        */
+
+                       _frame = pv->image (
+                               bind (&Log::dcp_log, _film->log().get(), _1, _2),
+                               bind (&PlayerVideo::always_rgb, _1),
+                               false, true
+                               );
+
+                       ImageChanged (pv);
+
+                       _position = pv->time ();
+                       _inter_position = pv->inter_position ();
+                       _inter_size = pv->inter_size ();
                } catch (dcp::DCPReadError& e) {
                        /* This can happen on the following sequence of events:
                         * - load encrypted DCP
@@ -229,7 +290,7 @@ FilmViewer::timer ()
        } else {
                get (_position + frame, true);
        }
-       
+
        update_position_label ();
        update_position_slider ();
 }
@@ -295,7 +356,7 @@ FilmViewer::panel_sized (wxSizeEvent& ev)
        _panel_size.height = ev.GetSize().GetHeight();
 
        calculate_sizes ();
-       get (_position, _last_get_accurate);
+       refresh ();
        update_position_label ();
        update_position_slider ();
 }
@@ -308,18 +369,18 @@ FilmViewer::calculate_sizes ()
        }
 
        Ratio const * container = _film->container ();
-       
+
        float const panel_ratio = _panel_size.ratio ();
        float const film_ratio = container ? container->ratio () : 1.78;
-                       
+
        if (panel_ratio < film_ratio) {
                /* panel is less widscreen than the film; clamp width */
                _out_size.width = _panel_size.width;
-               _out_size.height = rint (_out_size.width / film_ratio);
+               _out_size.height = lrintf (_out_size.width / film_ratio);
        } else {
                /* panel is more widescreen than the film; clamp height */
                _out_size.height = _panel_size.height;
-               _out_size.width = rint (_out_size.height * film_ratio);
+               _out_size.width = lrintf (_out_size.height * film_ratio);
        }
 
        /* Catch silly values */
@@ -341,7 +402,7 @@ FilmViewer::check_play_state ()
        if (!_film || _film->video_frame_rate() == 0) {
                return;
        }
-       
+
        if (_play_button->GetValue()) {
                _timer.Start (1000 / _film->video_frame_rate());
        } else {
@@ -356,7 +417,7 @@ FilmViewer::update_position_slider ()
                _slider->SetValue (0);
                return;
        }
-       
+
        DCPTime const len = _film->length ();
 
        if (len.get ()) {
@@ -378,49 +439,63 @@ FilmViewer::update_position_label ()
 
        double const fps = _film->video_frame_rate ();
        /* Count frame number from 1 ... not sure if this is the best idea */
-       _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
+       _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
        _timecode->SetLabel (time_to_timecode (_position, fps));
 }
 
 void
-FilmViewer::active_jobs_changed (bool a)
+FilmViewer::active_jobs_changed (optional<string> j)
 {
-       if (a) {
-               list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
-               list<shared_ptr<Job> >::iterator i = jobs.begin ();             
-               while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
-                       ++i;
-               }
-               
-               if (i == jobs.end() || (*i)->finished()) {
-                       /* no examine content job running, so we're ok to use the viewer */
-                       a = false;
-               }
+       /* examine content is the only job which stops the viewer working */
+       bool const a = !j || *j != "examine_content";
+       _slider->Enable (a);
+       _play_button->Enable (a);
+}
+
+DCPTime
+FilmViewer::nudge_amount (wxMouseEvent& ev)
+{
+       DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
+
+       if (ev.ShiftDown() && !ev.ControlDown()) {
+               amount = DCPTime::from_seconds (1);
+       } else if (!ev.ShiftDown() && ev.ControlDown()) {
+               amount = DCPTime::from_seconds (10);
+       } else if (ev.ShiftDown() && ev.ControlDown()) {
+               amount = DCPTime::from_seconds (60);
        }
-                       
-       _slider->Enable (!a);
-       _play_button->Enable (!a);
+
+       return amount;
 }
 
 void
-FilmViewer::back_clicked ()
+FilmViewer::go_to (DCPTime t)
 {
-       DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
-       if (p < DCPTime ()) {
-               p = DCPTime ();
+       if (t < DCPTime ()) {
+               t = DCPTime ();
        }
 
-       get (p, true);
+       if (t >= _film->length ()) {
+               t = _film->length ();
+       }
+
+       get (t, true);
        update_position_label ();
        update_position_slider ();
 }
 
 void
-FilmViewer::forward_clicked ()
+FilmViewer::back_clicked (wxMouseEvent& ev)
 {
-       get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
-       update_position_label ();
-       update_position_slider ();
+       go_to (_position - nudge_amount (ev));
+       ev.Skip ();
+}
+
+void
+FilmViewer::forward_clicked (wxMouseEvent& ev)
+{
+       go_to (_position + nudge_amount (ev));
+       ev.Skip ();
 }
 
 void
@@ -430,8 +505,13 @@ FilmViewer::player_changed (bool frequent)
                return;
        }
 
+       if (_coalesce_player_changes) {
+               _pending_player_change = true;
+               return;
+       }
+
        calculate_sizes ();
-       get (_position, _last_get_accurate);
+       refresh ();
        update_position_label ();
        update_position_slider ();
 }
@@ -440,7 +520,7 @@ void
 FilmViewer::setup_sensitivity ()
 {
        bool const c = _film && !_film->content().empty ();
-       
+
        _slider->Enable (c);
        _back_button->Enable (c);
        _forward_button->Enable (c);
@@ -448,12 +528,65 @@ FilmViewer::setup_sensitivity ()
        _outline_content->Enable (c);
        _frame_number->Enable (c);
        _timecode->Enable (c);
+
+       _left_eye->Enable (c && _film->three_d ());
+       _right_eye->Enable (c && _film->three_d ());
 }
 
 void
 FilmViewer::film_changed (Film::Property p)
 {
-       if (p == Film::CONTENT) {
+       if (p == Film::CONTENT || p == Film::THREE_D) {
                setup_sensitivity ();
        }
 }
+
+/** Re-get the current frame */
+void
+FilmViewer::refresh ()
+{
+       get (_position, _last_get_accurate);
+}
+
+void
+FilmViewer::set_position (DCPTime p)
+{
+       _position = p;
+       get (_position, true);
+       update_position_label ();
+       update_position_slider ();
+}
+
+void
+FilmViewer::set_coalesce_player_changes (bool c)
+{
+       _coalesce_player_changes = c;
+
+       if (c) {
+               _pending_player_change = false;
+       } else {
+               if (_pending_player_change) {
+                       player_changed (false);
+               }
+       }
+}
+
+void
+FilmViewer::timecode_clicked ()
+{
+       PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
+       if (dialog->ShowModal() == wxID_OK) {
+               go_to (dialog->get ());
+       }
+       dialog->Destroy ();
+}
+
+void
+FilmViewer::frame_number_clicked ()
+{
+       PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
+       if (dialog->ShowModal() == wxID_OK) {
+               go_to (dialog->get ());
+       }
+       dialog->Destroy ();
+}