Remove subtitle language from text content.
[dcpomatic.git] / src / wx / text_panel.cc
index 98398aaa69d7aace690b2d539d62eeea585f7d57..f29aea6ff165c50cc26cffee54d2de6de8388326 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -29,6 +29,8 @@
 #include "static_text.h"
 #include "check_box.h"
 #include "dcpomatic_button.h"
+#include "film_viewer.h"
+#include "lib/job_manager.h"
 #include "lib/ffmpeg_content.h"
 #include "lib/string_text_file_content.h"
 #include "lib/ffmpeg_subtitle_stream.h"
@@ -38,6 +40,8 @@
 #include "lib/dcp_content.h"
 #include "lib/text_content.h"
 #include "lib/decoder_factory.h"
+#include "lib/analyse_subtitles_job.h"
+#include "lib/subtitle_analysis.h"
 #include <wx/spinctrl.h>
 #include <boost/foreach.hpp>
 
@@ -48,17 +52,18 @@ using std::cout;
 using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
+using boost::bind;
 
 /** @param t Original text type of the content, if known */
 TextPanel::TextPanel (ContentPanel* p, TextType t)
        : ContentSubPanel (p, std_to_wx(text_type_to_name(t)))
+       , _outline_subtitles (0)
        , _dcp_track_label (0)
        , _dcp_track (0)
-       , _language_label (0)
-       , _language (0)
        , _text_view (0)
        , _fonts_dialog (0)
        , _original_type (t)
+       , _loading_analysis (false)
 {
        wxString refer = _("Use this DCP's subtitle as OV and make VF");
        if (t == TEXT_CLOSED_CAPTION) {
@@ -80,20 +85,26 @@ TextPanel::TextPanel (ContentPanel* p, TextType t)
 
        _burn = new CheckBox (this, _("Burn subtitles into image"));
 
+#ifdef __WXGTK3__
+       int const spin_width = 118;
+#else
+       int const spin_width = 56;
+#endif
+
        _offset_label = create_label (this, _("Offset"), true);
        _x_offset_label = create_label (this, _("X"), true);
-       _x_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
+       _x_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
        _x_offset_pc_label = new StaticText (this, _("%"));
        _y_offset_label = create_label (this, _("Y"), true);
-       _y_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
+       _y_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
        _y_offset_pc_label = new StaticText (this, _("%"));
 
        _scale_label = create_label (this, _("Scale"), true);
        _x_scale_label = create_label (this, _("X"), true);
-       _x_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
+       _x_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
        _x_scale_pc_label = new StaticText (this, _("%"));
        _y_scale_label = create_label (this, S_("Coord|Y"), true);
-       _y_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
+       _y_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
        _y_scale_pc_label = new StaticText (this, _("%"));
 
        _line_spacing_label = create_label (this, _("Line spacing"), true);
@@ -144,37 +155,30 @@ TextPanel::setup_visibility ()
                        _dcp_track->Destroy ();
                        _dcp_track = 0;
                }
-               if (!_language_label) {
-                       _language_label = create_label (this, _("Language"), true);
-                       add_label_to_sizer (_grid, _language_label, true, wxGBPosition(_language_row, 0));
-               }
-               if (!_language) {
-                       _language = new wxTextCtrl (this, wxID_ANY);
-                       _language->Bind (wxEVT_TEXT, boost::bind(&TextPanel::language_changed, this));
-                       _grid->Add (_language, wxGBPosition(_language_row, 1), wxDefaultSpan, wxEXPAND);
-                       film_content_changed (TextContentProperty::LANGUAGE);
+               if (!_outline_subtitles) {
+                       _outline_subtitles = new CheckBox (this, _("Show subtitle area"));
+                       _outline_subtitles->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::outline_subtitles_changed, this));
+                       _grid->Add (_outline_subtitles, wxGBPosition(_outline_subtitles_row, 0), wxGBSpan(1, 2));
                }
+
                break;
        case TEXT_CLOSED_CAPTION:
-               if (_language_label) {
-                       _language_label->Destroy ();
-                       _language_label = 0;
-               }
-               if (_language) {
-                       _language->Destroy ();
-                       _language = 0;
-               }
                if (!_dcp_track_label) {
                        _dcp_track_label = create_label (this, _("CCAP track"), true);
-                       add_label_to_sizer (_grid, _dcp_track_label, true, wxGBPosition(_language_row, 0));
+                       add_label_to_sizer (_grid, _dcp_track_label, true, wxGBPosition(_ccap_track_row, 0));
                }
                if (!_dcp_track) {
                        _dcp_track = new wxChoice (this, wxID_ANY);
                        _dcp_track->Bind (wxEVT_CHOICE, boost::bind(&TextPanel::dcp_track_changed, this));
-                       _grid->Add (_dcp_track, wxGBPosition(_language_row, 1), wxDefaultSpan, wxEXPAND);
+                       _grid->Add (_dcp_track, wxGBPosition(_ccap_track_row, 1), wxDefaultSpan, wxEXPAND);
                        update_dcp_tracks ();
                        film_content_changed (TextContentProperty::DCP_TRACK);
                }
+               if (_outline_subtitles) {
+                       _outline_subtitles->Destroy ();
+                       _outline_subtitles = 0;
+                       clear_outline_subtitles ();
+               }
                break;
        default:
                break;
@@ -210,25 +214,38 @@ TextPanel::add_to_grid ()
        _grid->Add (_burn, wxGBPosition (r, 0), wxGBSpan (1, 2));
        ++r;
 
+       _outline_subtitles_row = r;
+       ++r;
+
        add_label_to_sizer (_grid, _offset_label, true, wxGBPosition (r, 0));
        wxBoxSizer* offset = new wxBoxSizer (wxHORIZONTAL);
-       add_label_to_sizer (offset, _x_offset_label, true);
+       add_label_to_sizer (offset, _x_offset_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
        offset->Add (_x_offset, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
        offset->Add (_x_offset_pc_label, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP * 2);
-       add_label_to_sizer (offset, _y_offset_label, true);
-       offset->Add (_y_offset, 0);
-       add_label_to_sizer (offset, _y_offset_pc_label, false);
+#ifdef __WXGTK3__
+       _grid->Add (offset, wxGBPosition(r, 1));
+       ++r;
+       offset = new wxBoxSizer (wxHORIZONTAL);
+#endif
+       add_label_to_sizer (offset, _y_offset_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
+       offset->Add (_y_offset, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
+       add_label_to_sizer (offset, _y_offset_pc_label, false, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
        _grid->Add (offset, wxGBPosition (r, 1));
        ++r;
 
        add_label_to_sizer (_grid, _scale_label, true, wxGBPosition (r, 0));
        wxBoxSizer* scale = new wxBoxSizer (wxHORIZONTAL);
-       add_label_to_sizer (scale, _x_scale_label, true);
+       add_label_to_sizer (scale, _x_scale_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
        scale->Add (_x_scale, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
        scale->Add (_x_scale_pc_label, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP * 2);
-       add_label_to_sizer (scale, _y_scale_label, true);
-       scale->Add (_y_scale, 0);
-       add_label_to_sizer (scale, _y_scale_pc_label, false);
+#ifdef __WXGTK3__
+       _grid->Add (scale, wxGBPosition(r, 1));
+       ++r;
+       scale = new wxBoxSizer (wxHORIZONTAL);
+#endif
+       add_label_to_sizer (scale, _y_scale_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
+       scale->Add (_y_scale, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
+       add_label_to_sizer (scale, _y_scale_pc_label, false, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
        _grid->Add (scale, wxGBPosition (r, 1));
        ++r;
 
@@ -236,13 +253,12 @@ TextPanel::add_to_grid ()
                add_label_to_sizer (_grid, _line_spacing_label, true, wxGBPosition (r, 0));
                wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
                s->Add (_line_spacing);
-               add_label_to_sizer (s, _line_spacing_pc_label, false);
+               add_label_to_sizer (s, _line_spacing_pc_label, false, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
                _grid->Add (s, wxGBPosition (r, 1));
                ++r;
        }
 
-       _language_row = r;
-       setup_visibility ();
+       _ccap_track_row = r;
        ++r;
 
        add_label_to_sizer (_grid, _stream_label, true, wxGBPosition (r, 0));
@@ -259,6 +275,8 @@ TextPanel::add_to_grid ()
                _grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
                ++r;
        }
+
+       setup_visibility ();
 }
 
 void
@@ -350,7 +368,7 @@ TextPanel::dcp_track_changed ()
 void
 TextPanel::film_changed (Film::Property property)
 {
-       if (property == Film::CONTENT || property == Film::REEL_TYPE) {
+       if (property == Film::CONTENT || property == Film::REEL_TYPE || property == Film::INTEROP) {
                setup_sensitivity ();
        }
 }
@@ -391,9 +409,11 @@ TextPanel::film_content_changed (int property)
                        }
                }
                setup_sensitivity ();
+               clear_outline_subtitles ();
        } else if (property == TextContentProperty::USE) {
                checked_set (_use, text ? text->use() : false);
                setup_sensitivity ();
+               clear_outline_subtitles ();
        } else if (property == TextContentProperty::TYPE) {
                if (text) {
                        switch (text->type()) {
@@ -415,18 +435,19 @@ TextPanel::film_content_changed (int property)
                checked_set (_burn, text ? text->burn() : false);
        } else if (property == TextContentProperty::X_OFFSET) {
                checked_set (_x_offset, text ? lrint (text->x_offset() * 100) : 0);
+               update_outline_subtitles_in_viewer ();
        } else if (property == TextContentProperty::Y_OFFSET) {
                checked_set (_y_offset, text ? lrint (text->y_offset() * 100) : 0);
+               update_outline_subtitles_in_viewer ();
        } else if (property == TextContentProperty::X_SCALE) {
                checked_set (_x_scale, text ? lrint (text->x_scale() * 100) : 100);
+               clear_outline_subtitles ();
        } else if (property == TextContentProperty::Y_SCALE) {
                checked_set (_y_scale, text ? lrint (text->y_scale() * 100) : 100);
+               clear_outline_subtitles ();
        } else if (property == TextContentProperty::LINE_SPACING) {
                checked_set (_line_spacing, text ? lrint (text->line_spacing() * 100) : 100);
-       } else if (property == TextContentProperty::LANGUAGE) {
-               if (_language) {
-                       checked_set (_language, text ? text->language() : "");
-               }
+               clear_outline_subtitles ();
        } else if (property == TextContentProperty::DCP_TRACK) {
                if (_dcp_track) {
                        update_dcp_track_selection ();
@@ -523,7 +544,13 @@ TextPanel::setup_sensitivity ()
 
        string why_not;
        bool const can_reference = dcp && dcp->can_reference_text (_parent->film(), _original_type, why_not);
-       setup_refer_button (_reference, _reference_note, dcp, can_reference, why_not);
+       wxString cannot;
+       if (why_not.empty()) {
+               cannot = _("Cannot reference this DCP's subtitles or captions.");
+       } else {
+               cannot = _("Cannot reference this DCP's subtitles or captions: ") + std_to_wx(why_not);
+       }
+       setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
 
        bool const reference = _reference->GetValue ();
 
@@ -552,6 +579,9 @@ TextPanel::setup_sensitivity ()
        /* Set up sensitivity */
        _use->Enable (!reference && any_subs > 0);
        bool const use = _use->GetValue ();
+       if (_outline_subtitles) {
+               _outline_subtitles->Enable (!_loading_analysis && any_subs && use && type == TEXT_OPEN_SUBTITLE);
+       }
        _type->Enable (!reference && any_subs > 0 && use);
        _burn->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
        _x_offset->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
@@ -629,15 +659,6 @@ TextPanel::line_spacing_changed ()
        }
 }
 
-void
-TextPanel::language_changed ()
-{
-       DCPOMATIC_ASSERT (_language);
-       BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
-               i->text_of_original_type(_original_type)->set_language (wx_to_std (_language->GetValue()));
-       }
-}
-
 void
 TextPanel::content_selection_changed ()
 {
@@ -649,7 +670,6 @@ TextPanel::content_selection_changed ()
        film_content_changed (TextContentProperty::X_SCALE);
        film_content_changed (TextContentProperty::Y_SCALE);
        film_content_changed (TextContentProperty::LINE_SPACING);
-       film_content_changed (TextContentProperty::LANGUAGE);
        film_content_changed (TextContentProperty::FONTS);
        film_content_changed (TextContentProperty::TYPE);
        film_content_changed (TextContentProperty::DCP_TRACK);
@@ -667,7 +687,7 @@ TextPanel::text_view_clicked ()
        ContentList c = _parent->selected_text ();
        DCPOMATIC_ASSERT (c.size() == 1);
 
-       shared_ptr<Decoder> decoder = decoder_factory (_parent->film(), c.front(), false, shared_ptr<Decoder>());
+       shared_ptr<Decoder> decoder = decoder_factory (_parent->film(), c.front(), false, false, shared_ptr<Decoder>());
 
        if (decoder) {
                _text_view = new TextView (this, _parent->film(), c.front(), c.front()->text_of_original_type(_original_type), decoder, _parent->film_viewer());
@@ -718,3 +738,128 @@ TextPanel::appearance_dialog_clicked ()
        }
        d->Destroy ();
 }
+
+
+
+/** The user has clicked on the outline subtitles check box */
+void
+TextPanel::outline_subtitles_changed ()
+{
+       if (_outline_subtitles->GetValue()) {
+               _analysis_content = _parent->selected_text().front();
+               try_to_load_analysis ();
+       } else {
+               clear_outline_subtitles ();
+       }
+}
+
+
+void
+TextPanel::try_to_load_analysis ()
+{
+       if (_loading_analysis) {
+               return;
+       }
+
+       _loading_analysis = true;
+       setup_sensitivity ();
+       _analysis.reset ();
+
+       shared_ptr<Content> content = _analysis_content.lock ();
+       if (!content) {
+               _loading_analysis = false;
+               setup_sensitivity ();
+               return;
+       }
+
+       boost::filesystem::path const path = _parent->film()->subtitle_analysis_path(content);
+
+       if (!boost::filesystem::exists(path)) {
+               BOOST_FOREACH (shared_ptr<Job> i, JobManager::instance()->get()) {
+                       if (dynamic_pointer_cast<AnalyseSubtitlesJob>(i)) {
+                               i->cancel ();
+                       }
+               }
+
+               JobManager::instance()->analyse_subtitles (
+                       _parent->film(), content, _analysis_finished_connection, bind(&TextPanel::analysis_finished, this)
+                       );
+               return;
+       }
+
+       try {
+               _analysis.reset (new SubtitleAnalysis(path));
+       } catch (OldFormatError& e) {
+               /* An old analysis file: recreate it */
+               JobManager::instance()->analyse_subtitles (
+                       _parent->film(), content, _analysis_finished_connection, bind(&TextPanel::analysis_finished, this)
+                       );
+               return;
+        }
+
+       update_outline_subtitles_in_viewer ();
+       _loading_analysis = false;
+       setup_sensitivity ();
+}
+
+
+void
+TextPanel::update_outline_subtitles_in_viewer ()
+{
+       shared_ptr<FilmViewer> fv = _parent->film_viewer().lock();
+       if (!fv) {
+               return;
+       }
+
+       if (_analysis) {
+               optional<dcpomatic::Rect<double> > rect = _analysis->bounding_box ();
+               if (rect) {
+                       shared_ptr<Content> content = _analysis_content.lock ();
+                       DCPOMATIC_ASSERT (content);
+                       rect->x += content->text.front()->x_offset();
+                       rect->y += content->text.front()->y_offset();
+               }
+               fv->set_outline_subtitles (rect);
+       } else {
+               fv->set_outline_subtitles (optional<dcpomatic::Rect<double> >());
+       }
+}
+
+
+/** Remove any current subtitle outline display */
+void
+TextPanel::clear_outline_subtitles ()
+{
+       _analysis.reset ();
+       update_outline_subtitles_in_viewer ();
+       if (_outline_subtitles) {
+               _outline_subtitles->SetValue (false);
+       }
+}
+
+
+void
+TextPanel::analysis_finished ()
+{
+       shared_ptr<Content> content = _analysis_content.lock ();
+       if (!content) {
+               _loading_analysis = false;
+               setup_sensitivity ();
+               return;
+       }
+
+       if (!boost::filesystem::exists(_parent->film()->subtitle_analysis_path(content))) {
+               /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
+                  Give up.
+               */
+               error_dialog (_parent->window(), _("Could not analyse subtitles."));
+               clear_outline_subtitles ();
+               _loading_analysis = false;
+               setup_sensitivity ();
+               return;
+       }
+
+       _loading_analysis = false;
+       try_to_load_analysis ();
+}
+