Add explanation of the effect of changing frame rate.
[dcpomatic.git] / src / wx / film_editor.cc
index 3ccdac7137555c71d2e323aa6f1464a81977047a..12ba7c1bc69dca45b6272b3324fd9471c00e2345 100644 (file)
@@ -45,6 +45,7 @@
 #include "sound_processor.h"
 #include "dci_metadata_dialog.h"
 #include "scaler.h"
+#include "audio_dialog.h"
 
 using std::string;
 using std::cout;
@@ -62,6 +63,7 @@ FilmEditor::FilmEditor (shared_ptr<Film> f, wxWindow* parent)
        : wxPanel (parent)
        , _film (f)
        , _generally_sensitive (true)
+       , _audio_dialog (0)
 {
        wxBoxSizer* s = new wxBoxSizer (wxVERTICAL);
        SetSizer (s);
@@ -95,50 +97,79 @@ FilmEditor::make_film_panel ()
        _film_sizer = new wxBoxSizer (wxVERTICAL);
        _film_panel->SetSizer (_film_sizer);
 
-       wxFlexGridSizer* grid = new wxFlexGridSizer (2, 4, 4);
+       wxGridBagSizer* grid = new wxGridBagSizer (6, 6);
        _film_sizer->Add (grid, 0, wxALL, 8);
 
-       add_label_to_sizer (grid, _film_panel, _("Name"));
+       int r = 0;
+       
+       add_label_to_grid_bag_sizer (grid, _film_panel, _("Name"), wxGBPosition (r, 0));
        _name = new wxTextCtrl (_film_panel, wxID_ANY);
-       grid->Add (_name, 1, wxEXPAND);
-
-       add_label_to_sizer (grid, _film_panel, _("DCP Name"));
+       grid->Add (_name, wxGBPosition(r, 1));
+       ++r;
+       
+       add_label_to_grid_bag_sizer (grid, _film_panel, _("DCP Name"), wxGBPosition (r, 0));
        _dcp_name = new wxStaticText (_film_panel, wxID_ANY, wxT (""));
-       grid->Add (_dcp_name, 0, wxALIGN_CENTER_VERTICAL | wxSHRINK);
+       grid->Add (_dcp_name, wxGBPosition(r, 1), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
+       ++r;
 
        _use_dci_name = new wxCheckBox (_film_panel, wxID_ANY, _("Use DCI name"));
-       grid->Add (_use_dci_name, 1, wxEXPAND);
+       grid->Add (_use_dci_name, wxGBPosition (r, 0));
        _edit_dci_button = new wxButton (_film_panel, wxID_ANY, _("Details..."));
-       grid->Add (_edit_dci_button, 0);
+       grid->Add (_edit_dci_button, wxGBPosition (r, 1), wxDefaultSpan);
+       ++r;
 
-       add_label_to_sizer (grid, _film_panel, _("Content"));
+       add_label_to_grid_bag_sizer (grid, _film_panel, _("Content"), wxGBPosition (r, 0));
        _content = new wxFilePickerCtrl (_film_panel, wxID_ANY, wxT (""), _("Select Content File"), wxT("*.*"));
-       grid->Add (_content, 1, wxEXPAND);
+       grid->Add (_content, wxGBPosition (r, 1), wxDefaultSpan, wxEXPAND);
+       ++r;
 
        _trust_content_header = new wxCheckBox (_film_panel, wxID_ANY, _("Trust content's header"));
        video_control (_trust_content_header);
-       grid->Add (_trust_content_header, 1);
-       grid->AddSpacer (0);
+       grid->Add (_trust_content_header, wxGBPosition (r, 0), wxGBSpan(1, 2));
+       ++r;
 
-       add_label_to_sizer (grid, _film_panel, _("Content Type"));
+       add_label_to_grid_bag_sizer (grid, _film_panel, _("Content Type"), wxGBPosition (r, 0));
        _dcp_content_type = new wxChoice (_film_panel, wxID_ANY);
-       grid->Add (_dcp_content_type);
+       grid->Add (_dcp_content_type, wxGBPosition (r, 1));
+       ++r;
+
+       video_control (add_label_to_grid_bag_sizer (grid, _film_panel, _("Original Frame Rate"), wxGBPosition (r, 0)));
+       _source_frame_rate = new wxStaticText (_film_panel, wxID_ANY, wxT (""));
+       grid->Add (video_control (_source_frame_rate), wxGBPosition (r, 1), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
+       ++r;
 
-       video_control (add_label_to_sizer (grid, _film_panel, _("Frames Per Second")));
-       _frames_per_second = new wxStaticText (_film_panel, wxID_ANY, wxT (""));
-       grid->Add (video_control (_frames_per_second), 1, wxALIGN_CENTER_VERTICAL);
+       {
+               add_label_to_grid_bag_sizer (grid, _film_panel, _("DCP Frame Rate"), wxGBPosition (r, 0));
+               wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
+               _dcp_frame_rate = new wxChoice (_film_panel, wxID_ANY);
+               s->Add (_dcp_frame_rate, 1, wxALIGN_CENTER_VERTICAL);
+               _best_dcp_frame_rate = new wxButton (_film_panel, wxID_ANY, _("Use best"));
+               s->Add (_best_dcp_frame_rate, 1, wxALIGN_CENTER_VERTICAL | wxALL | wxEXPAND, 6);
+               grid->Add (s, wxGBPosition (r, 1));
+       }
+       ++r;
+
+       _frame_rate_explanation = new wxStaticText (_film_panel, wxID_ANY, wxT (""), wxDefaultPosition, wxDefaultSize, wxST_NO_AUTORESIZE);
+       grid->Add (video_control (_frame_rate_explanation), wxGBPosition (r, 0), wxGBSpan (1, 2), wxEXPAND | wxALIGN_CENTER_VERTICAL);
+       wxFont font = _frame_rate_explanation->GetFont();
+       font.SetStyle(wxFONTSTYLE_ITALIC);
+       font.SetPointSize(font.GetPointSize() - 1);
+       _frame_rate_explanation->SetFont(font);
+       ++r;
        
-       video_control (add_label_to_sizer (grid, _film_panel, _("Original Size")));
+       video_control (add_label_to_grid_bag_sizer (grid, _film_panel, _("Original Size"), wxGBPosition (r, 0)));
        _original_size = new wxStaticText (_film_panel, wxID_ANY, wxT (""));
-       grid->Add (video_control (_original_size), 1, wxALIGN_CENTER_VERTICAL);
+       grid->Add (video_control (_original_size), wxGBPosition (r, 1), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
+       ++r;
        
-       video_control (add_label_to_sizer (grid, _film_panel, _("Length")));
+       video_control (add_label_to_grid_bag_sizer (grid, _film_panel, _("Length"), wxGBPosition (r, 0)));
        _length = new wxStaticText (_film_panel, wxID_ANY, wxT (""));
-       grid->Add (video_control (_length), 1, wxALIGN_CENTER_VERTICAL);
+       grid->Add (video_control (_length), wxGBPosition (r, 1), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
+       ++r;
 
 
        {
-               video_control (add_label_to_sizer (grid, _film_panel, _("Trim frames")));
+               video_control (add_label_to_grid_bag_sizer (grid, _film_panel, _("Trim frames"), wxGBPosition (r, 0)));
                wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
                video_control (add_label_to_sizer (s, _film_panel, _("Start")));
                _trim_start = new wxSpinCtrl (_film_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
@@ -147,30 +178,37 @@ FilmEditor::make_film_panel ()
                _trim_end = new wxSpinCtrl (_film_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
                s->Add (video_control (_trim_end));
 
-               grid->Add (s);
+               grid->Add (s, wxGBPosition (r, 1));
        }
+       ++r;
 
        _dcp_ab = new wxCheckBox (_film_panel, wxID_ANY, _("A/B"));
        video_control (_dcp_ab);
-       grid->Add (_dcp_ab, 1);
-       grid->AddSpacer (0);
+       grid->Add (_dcp_ab, wxGBPosition (r, 0));
+       ++r;
 
        /* STILL-only stuff */
        {
-               still_control (add_label_to_sizer (grid, _film_panel, _("Duration")));
+               still_control (add_label_to_grid_bag_sizer (grid, _film_panel, _("Duration"), wxGBPosition (r, 0)));
                wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
                _still_duration = new wxSpinCtrl (_film_panel);
                still_control (_still_duration);
                s->Add (_still_duration, 1, wxEXPAND);
-               /* TRANSLATORS: `s' here is an abbreviation for seconds, the unit of time */
+               /// TRANSLATORS: `s' here is an abbreviation for seconds, the unit of time
                still_control (add_label_to_sizer (s, _film_panel, _("s")));
-               grid->Add (s);
+               grid->Add (s, wxGBPosition (r, 1));
        }
+       ++r;
 
        vector<DCPContentType const *> const ct = DCPContentType::all ();
        for (vector<DCPContentType const *>::const_iterator i = ct.begin(); i != ct.end(); ++i) {
                _dcp_content_type->Append (std_to_wx ((*i)->pretty_name ()));
        }
+
+       list<int> const dfr = Config::instance()->allowed_dcp_frame_rates ();
+       for (list<int>::const_iterator i = dfr.begin(); i != dfr.end(); ++i) {
+               _dcp_frame_rate->Append (std_to_wx (boost::lexical_cast<string> (*i)));
+       }
 }
 
 void
@@ -189,6 +227,8 @@ FilmEditor::connect_to_widgets ()
        _filters_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::edit_filters_clicked), 0, this);
        _scaler->Connect (wxID_ANY, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEventHandler (FilmEditor::scaler_changed), 0, this);
        _dcp_content_type->Connect (wxID_ANY, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEventHandler (FilmEditor::dcp_content_type_changed), 0, this);
+       _dcp_frame_rate->Connect (wxID_ANY, wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEventHandler (FilmEditor::dcp_frame_rate_changed), 0, this);
+       _best_dcp_frame_rate->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::best_dcp_frame_rate_clicked), 0, this);
        _dcp_ab->Connect (wxID_ANY, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEventHandler (FilmEditor::dcp_ab_toggled), 0, this);
        _still_duration->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::still_duration_changed), 0, this);
        _trim_start->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::trim_start_changed), 0, this);
@@ -204,6 +244,7 @@ FilmEditor::connect_to_widgets ()
        _audio_gain_calculate_button->Connect (
                wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::audio_gain_calculate_button_clicked), 0, this
                );
+       _show_audio->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::show_audio_clicked), 0, this);
        _audio_delay->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_delay_changed), 0, this);
        _use_content_audio->Connect (wxID_ANY, wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEventHandler (FilmEditor::use_audio_changed), 0, this);
        _use_external_audio->Connect (wxID_ANY, wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEventHandler (FilmEditor::use_audio_changed), 0, this);
@@ -228,28 +269,21 @@ FilmEditor::make_video_panel ()
        _format = new wxChoice (_video_panel, wxID_ANY);
        grid->Add (_format);
 
-       {
-               add_label_to_sizer (grid, _video_panel, _("Crop"));
-               wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
-
-               /* TRANSLATORS: L, R, T and B are abbreviations for Left, Right, Top, Bottom, the four edges
-                  of the picture frame.
-               */
-               add_label_to_sizer (s, _video_panel, _("L"));
-               _left_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
-               s->Add (_left_crop, 0);
-               add_label_to_sizer (s, _video_panel, _("R"));
-               _right_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
-               s->Add (_right_crop, 0);
-               add_label_to_sizer (s, _video_panel, _("T"));
-               _top_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
-               s->Add (_top_crop, 0);
-               add_label_to_sizer (s, _video_panel, _("B"));
-               _bottom_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
-               s->Add (_bottom_crop, 0);
+       add_label_to_sizer (grid, _video_panel, _("Left crop"));
+       _left_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
+       grid->Add (_left_crop);
 
-               grid->Add (s);
-       }
+       add_label_to_sizer (grid, _video_panel, _("Right crop"));
+       _right_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
+       grid->Add (_right_crop);
+       
+       add_label_to_sizer (grid, _video_panel, _("Top crop"));
+       _top_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
+       grid->Add (_top_crop);
+       
+       add_label_to_sizer (grid, _video_panel, _("Bottom crop"));
+       _bottom_crop = new wxSpinCtrl (_video_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
+       grid->Add (_bottom_crop);
 
        /* VIDEO-only stuff */
        {
@@ -310,6 +344,10 @@ FilmEditor::make_audio_panel ()
        wxFlexGridSizer* grid = new wxFlexGridSizer (2, 4, 4);
        _audio_sizer->Add (grid, 0, wxALL, 8);
 
+       _show_audio = new wxButton (_audio_panel, wxID_ANY, _("Show Audio..."));
+       grid->Add (_show_audio, 1);
+       grid->AddSpacer (0);
+
        {
                video_control (add_label_to_sizer (grid, _audio_panel, _("Audio Gain")));
                wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
@@ -327,7 +365,7 @@ FilmEditor::make_audio_panel ()
                wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
                _audio_delay = new wxSpinCtrl (_audio_panel);
                s->Add (video_control (_audio_delay), 1);
-               /* TRANSLATORS: this is an abbreviation for milliseconds, the unit of time */
+               /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
                video_control (add_label_to_sizer (s, _audio_panel, _("ms")));
                grid->Add (s);
        }
@@ -347,22 +385,8 @@ FilmEditor::make_audio_panel ()
        grid->Add (_use_external_audio);
        grid->AddSpacer (0);
 
-       assert (MAX_AUDIO_CHANNELS == 6);
-
-       /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
-          enhancement channel (sub-woofer)./
-       */
-       wxString const channels[] = {
-               _("Left"),
-               _("Right"),
-               _("Centre"),
-               _("Lfe (sub)"),
-               _("Left surround"),
-               _("Right surround"),
-       };
-
        for (int i = 0; i < MAX_AUDIO_CHANNELS; ++i) {
-               add_label_to_sizer (grid, _audio_panel, channels[i]);
+               add_label_to_sizer (grid, _audio_panel, std_to_wx (audio_channel_name (i)));
                _external_audio[i] = new wxFilePickerCtrl (_audio_panel, wxID_ANY, wxT (""), _("Select Audio File"), wxT ("*.wav"));
                grid->Add (_external_audio[i], 1, wxEXPAND);
        }
@@ -534,7 +558,21 @@ FilmEditor::j2k_bandwidth_changed (wxCommandEvent &)
        }
        
        _film->set_j2k_bandwidth (_j2k_bandwidth->GetValue() * 1e6);
-}      
+}
+
+void
+FilmEditor::dcp_frame_rate_changed (wxCommandEvent &)
+{
+       if (!_film) {
+               return;
+       }
+
+       _film->set_dcp_frame_rate (
+               boost::lexical_cast<int> (
+                       wx_to_std (_dcp_frame_rate->GetString (_dcp_frame_rate->GetSelection ()))
+                       )
+               );
+}
 
 
 /** Called when the metadata stored in the Film object has changed;
@@ -610,9 +648,9 @@ FilmEditor::film_changed (Film::Property p)
                checked_set (_name, _film->name());
                setup_dcp_name ();
                break;
-       case Film::FRAMES_PER_SECOND:
-               s << fixed << setprecision(2) << _film->frames_per_second();
-               _frames_per_second->SetLabel (std_to_wx (s.str ()));
+       case Film::SOURCE_FRAME_RATE:
+               s << fixed << setprecision(2) << _film->source_frame_rate();
+               _source_frame_rate->SetLabel (std_to_wx (s.str ()));
                break;
        case Film::SIZE:
                if (_film->size().width == 0 && _film->size().height == 0) {
@@ -623,10 +661,10 @@ FilmEditor::film_changed (Film::Property p)
                }
                break;
        case Film::LENGTH:
-               if (_film->frames_per_second() > 0 && _film->length()) {
-                       s << _film->length().get() << " frames; " << seconds_to_hms (_film->length().get() / _film->frames_per_second());
+               if (_film->source_frame_rate() > 0 && _film->length()) {
+                       s << _film->length().get() << " " << _("frames") << "; " << seconds_to_hms (_film->length().get() / _film->source_frame_rate());
                } else if (_film->length()) {
-                       s << _film->length().get() << " frames";
+                       s << _film->length().get() << " " << _("frames");
                } 
                _length->SetLabel (std_to_wx (s.str ()));
                if (_film->length()) {
@@ -714,6 +752,16 @@ FilmEditor::film_changed (Film::Property p)
                setup_audio_details ();
                break;
        }
+       case Film::DCP_FRAME_RATE:
+               for (unsigned int i = 0; i < _dcp_frame_rate->GetCount(); ++i) {
+                       if (wx_to_std (_dcp_frame_rate->GetString(i)) == boost::lexical_cast<string> (_film->dcp_frame_rate())) {
+                               if (_dcp_frame_rate->GetSelection() != int(i)) {
+                                       _dcp_frame_rate->SetSelection (i);
+                                       break;
+                               }
+                       }
+               }
+               _frame_rate_explanation->SetLabel (std_to_wx (FrameRateConversion (_film->source_frame_rate(), _film->dcp_frame_rate()).explanation));
        }
 }
 
@@ -761,7 +809,11 @@ FilmEditor::set_film (shared_ptr<Film> f)
        if (_film) {
                FileChanged (_film->directory ());
        } else {
-               FileChanged ("");
+               FileChanged (wx_to_std (N_("")));
+       }
+
+       if (_audio_dialog) {
+               _audio_dialog->set_film (_film);
        }
        
        film_changed (Film::NAME);
@@ -792,7 +844,8 @@ FilmEditor::set_film (shared_ptr<Film> f)
        film_changed (Film::LENGTH);
        film_changed (Film::CONTENT_AUDIO_STREAMS);
        film_changed (Film::SUBTITLE_STREAMS);
-       film_changed (Film::FRAMES_PER_SECOND);
+       film_changed (Film::SOURCE_FRAME_RATE);
+       film_changed (Film::DCP_FRAME_RATE);
 }
 
 /** Updates the sensitivity of lots of widgets to a given value.
@@ -817,6 +870,7 @@ FilmEditor::set_things_sensitive (bool s)
        _scaler->Enable (s);
        _audio_stream->Enable (s);
        _dcp_content_type->Enable (s);
+       _dcp_frame_rate->Enable (s);
        _trim_start->Enable (s);
        _trim_end->Enable (s);
        _dcp_ab->Enable (s);
@@ -824,6 +878,7 @@ FilmEditor::set_things_sensitive (bool s)
        _j2k_bandwidth->Enable (s);
        _audio_gain->Enable (s);
        _audio_gain_calculate_button->Enable (s);
+       _show_audio->Enable (s);
        _audio_delay->Enable (s);
        _still_duration->Enable (s);
 
@@ -1139,11 +1194,11 @@ FilmEditor::setup_audio_details ()
        } else {
                stringstream s;
                if (_film->audio_stream()->channels() == 1) {
-                       s << "1 channel";
+                       s << _("1 channel");
                } else {
-                       s << _film->audio_stream()->channels () << " channels";
+                       s << _film->audio_stream()->channels () << " " << _("channels");
                }
-               s << ", " << _film->audio_stream()->sample_rate() << "Hz";
+               s << ", " << _film->audio_stream()->sample_rate() << _("Hz");
                _audio->SetLabel (std_to_wx (s.str ()));
        }
 }
@@ -1176,9 +1231,32 @@ FilmEditor::setup_dcp_name ()
 {
        string s = _film->dcp_name (true);
        if (s.length() > 28) {
-               _dcp_name->SetLabel (std_to_wx (s.substr (0, 28) + "..."));
+               _dcp_name->SetLabel (std_to_wx (s.substr (0, 28)) + N_("..."));
                _dcp_name->SetToolTip (std_to_wx (s));
        } else {
                _dcp_name->SetLabel (std_to_wx (s));
        }
 }
+
+void
+FilmEditor::show_audio_clicked (wxCommandEvent &)
+{
+       if (_audio_dialog) {
+               _audio_dialog->Destroy ();
+               _audio_dialog = 0;
+       }
+       
+       _audio_dialog = new AudioDialog (this);
+       _audio_dialog->Show ();
+       _audio_dialog->set_film (_film);
+}
+
+void
+FilmEditor::best_dcp_frame_rate_clicked (wxCommandEvent &)
+{
+       if (!_film) {
+               return;
+       }
+       
+       _film->set_dcp_frame_rate (best_dcp_frame_rate (_film->source_frame_rate ()));
+}