/*
- Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
#include "fonts_dialog.h"
#include "dcp_text_track_dialog.h"
#include "subtitle_appearance_dialog.h"
+#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"
#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>
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) {
refer = _("Use this DCP's closed caption as OV and make VF");
}
- _reference = new wxCheckBox (this, wxID_ANY, refer);
- _reference_note = new wxStaticText (this, wxID_ANY, _(""));
+ _reference = new CheckBox (this, refer);
+ _reference_note = new StaticText (this, wxT(""));
_reference_note->Wrap (200);
wxFont font = _reference_note->GetFont();
font.SetStyle(wxFONTSTYLE_ITALIC);
font.SetPointSize(font.GetPointSize() - 1);
_reference_note->SetFont(font);
- _use = new wxCheckBox (this, wxID_ANY, _("Use as"));
+ _use = new CheckBox (this, _("Use as"));
_type = new wxChoice (this, wxID_ANY);
_type->Append (_("open subtitles"));
_type->Append (_("closed captions"));
- _burn = new wxCheckBox (this, wxID_ANY, _("Burn subtitles into image"));
+ _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_pc_label = new wxStaticText (this, wxID_ANY, _("%"));
+ _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_pc_label = new wxStaticText (this, wxID_ANY, _("%"));
+ _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_pc_label = new wxStaticText (this, wxID_ANY, _("%"));
- _y_scale_label = create_label (this, _("Y"), true);
- _y_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
- _y_scale_pc_label = new wxStaticText (this, wxID_ANY, _("%"));
+ _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(spin_width, -1));
+ _y_scale_pc_label = new StaticText (this, _("%"));
_line_spacing_label = create_label (this, _("Line spacing"), true);
_line_spacing = new wxSpinCtrl (this);
- _line_spacing_pc_label = new wxStaticText (this, wxID_ANY, _("%"));
-
- _dcp_track_label = create_label (this, _("DCP track"), true);
- _dcp_track = new wxChoice (this, wxID_ANY);
-
- _language_label = create_label (this, _("Language"), true);
- _language = new wxTextCtrl (this, wxID_ANY);
+ _line_spacing_pc_label = new StaticText (this, _("%"));
_stream_label = create_label (this, _("Stream"), true);
_stream = new wxChoice (this, wxID_ANY);
- _text_view_button = new wxButton (this, wxID_ANY, _("View..."));
- _fonts_dialog_button = new wxButton (this, wxID_ANY, _("Fonts..."));
- _appearance_dialog_button = new wxButton (this, wxID_ANY, _("Appearance..."));
+ _text_view_button = new Button (this, _("View..."));
+ _fonts_dialog_button = new Button (this, _("Fonts..."));
+ _appearance_dialog_button = new Button (this, _("Appearance..."));
_x_offset->SetRange (-100, 100);
_y_offset->SetRange (-100, 100);
_y_scale->SetRange (10, 1000);
_line_spacing->SetRange (10, 1000);
- update_dcp_tracks ();
-
- content_selection_changed ();
-
_reference->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::reference_clicked, this));
_use->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::use_toggled, this));
_type->Bind (wxEVT_CHOICE, boost::bind (&TextPanel::type_changed, this));
_x_scale->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::x_scale_changed, this));
_y_scale->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::y_scale_changed, this));
_line_spacing->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::line_spacing_changed, this));
- _dcp_track->Bind (wxEVT_CHOICE, boost::bind (&TextPanel::dcp_track_changed, this));
- _language->Bind (wxEVT_TEXT, boost::bind (&TextPanel::language_changed, this));
_stream->Bind (wxEVT_CHOICE, boost::bind (&TextPanel::stream_changed, this));
_text_view_button->Bind (wxEVT_BUTTON, boost::bind (&TextPanel::text_view_clicked, this));
_fonts_dialog_button->Bind (wxEVT_BUTTON, boost::bind (&TextPanel::fonts_dialog_clicked, this));
_appearance_dialog_button->Bind (wxEVT_BUTTON, boost::bind (&TextPanel::appearance_dialog_clicked, this));
add_to_grid();
+ content_selection_changed ();
+}
+
+void
+TextPanel::setup_visibility ()
+{
+ switch (current_type()) {
+ case TEXT_OPEN_SUBTITLE:
+ if (_dcp_track_label) {
+ _dcp_track_label->Destroy ();
+ _dcp_track_label = 0;
+ }
+ if (_dcp_track) {
+ _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));
+ }
+ 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);
+ update_dcp_tracks ();
+ film_content_changed (TextContentProperty::DCP_TRACK);
+ }
+ if (_outline_subtitles) {
+ _outline_subtitles->Destroy ();
+ _outline_subtitles = 0;
+ clear_outline_subtitles ();
+ }
+ break;
+ default:
+ break;
+ }
+
+ _grid->Layout ();
}
void
_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);
++r;
}
- add_label_to_sizer (_grid, _dcp_track_label, true, wxGBPosition(r, 0));
- _grid->Add (_dcp_track, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
- ++r;
-
- add_label_to_sizer (_grid, _language_label, true, wxGBPosition (r, 0));
- _grid->Add (_language, wxGBPosition (r, 1));
+ _language_row = r;
++r;
add_label_to_sizer (_grid, _stream_label, true, wxGBPosition (r, 0));
_grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
++r;
}
+
+ setup_visibility ();
}
void
TextPanel::update_dcp_track_selection ()
{
+ DCPOMATIC_ASSERT (_dcp_track);
+
optional<DCPTextTrack> selected;
bool many = false;
BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text()) {
void
TextPanel::update_dcp_tracks ()
{
+ DCPOMATIC_ASSERT (_dcp_track);
+
_dcp_track->Clear ();
BOOST_FOREACH (DCPTextTrack i, _parent->film()->closed_caption_tracks()) {
- _dcp_track->Append (std_to_wx(i.summary()));
+ /* XXX: don't display the "magic" track which has empty name and language;
+ this is a nasty hack (see also Film::closed_caption_tracks)
+ */
+ if (!i.name.empty() || !i.language.empty()) {
+ _dcp_track->Append (std_to_wx(i.summary()));
+ }
}
if (_parent->film()->closed_caption_tracks().size() < 6) {
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 ();
}
}
}
}
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()) {
_type->SetSelection (0);
}
setup_sensitivity ();
- update_dcp_track_selection ();
+ setup_visibility ();
} else if (property == TextContentProperty::BURN) {
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);
+ clear_outline_subtitles ();
} else if (property == TextContentProperty::LANGUAGE) {
- checked_set (_language, text ? text->language() : "");
+ if (_language) {
+ checked_set (_language, text ? text->language() : "");
+ }
} else if (property == TextContentProperty::DCP_TRACK) {
- update_dcp_track_selection ();
+ if (_dcp_track) {
+ update_dcp_track_selection ();
+ }
} else if (property == DCPContentProperty::REFERENCE_TEXT) {
if (scs) {
shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (scs);
BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text()) {
i->text_of_original_type(_original_type)->set_type (current_type ());
}
+
+ setup_visibility ();
}
void
TextPanel::setup_sensitivity ()
{
int any_subs = 0;
+ /* We currently assume that FFmpeg subtitles are bitmapped */
int ffmpeg_subs = 0;
+ /* DCP subs can't have their line spacing changed */
+ int dcp_subs = 0;
ContentList sel = _parent->selected_text ();
BOOST_FOREACH (shared_ptr<Content> i, sel) {
/* These are the content types that could include subtitles */
++ffmpeg_subs;
++any_subs;
}
- } else if (sc || dc || dsc) {
+ } else if (dc || dsc) {
+ ++dcp_subs;
+ ++any_subs;
+ } else if (sc) {
/* XXX: in the future there could be bitmap subs from DCPs */
++any_subs;
}
}
string why_not;
- bool const can_reference = dcp && dcp->can_reference_text (_original_type, why_not);
- setup_refer_button (_reference, _reference_note, dcp, can_reference, why_not);
+ bool const can_reference = dcp && dcp->can_reference_text (_parent->film(), _original_type, 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 ();
TextType const type = current_type ();
+ /* Set up _type */
+ _type->Clear ();
+ _type->Append (_("open subtitles"));
+ if (ffmpeg_subs == 0) {
+ _type->Append (_("closed captions"));
+ }
+
+ switch (type) {
+ case TEXT_OPEN_SUBTITLE:
+ _type->SetSelection (0);
+ break;
+ case TEXT_CLOSED_CAPTION:
+ if (_type->GetCount() > 1) {
+ _type->SetSelection (1);
+ }
+ break;
+ default:
+ break;
+ }
+
/* 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);
_y_offset->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
_x_scale->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
_y_scale->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
- _line_spacing->Enable (!reference && use && type == TEXT_OPEN_SUBTITLE);
- _dcp_track->Enable (!reference && any_subs > 0 && use && type == TEXT_CLOSED_CAPTION);
- _language->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
+ _line_spacing->Enable (!reference && use && type == TEXT_OPEN_SUBTITLE && dcp_subs < any_subs);
_stream->Enable (!reference && ffmpeg_subs == 1);
- _text_view_button->Enable (!reference);
- _fonts_dialog_button->Enable (!reference && type == TEXT_OPEN_SUBTITLE);
+ /* Ideally we would check here to see if the FFmpeg content has "string" subs (i.e. not bitmaps) */
+ _text_view_button->Enable (!reference && any_subs > 0 && ffmpeg_subs == 0);
+ _fonts_dialog_button->Enable (!reference && any_subs > 0 && ffmpeg_subs == 0 && type == TEXT_OPEN_SUBTITLE);
_appearance_dialog_button->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
}
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()));
}
ContentList c = _parent->selected_text ();
DCPOMATIC_ASSERT (c.size() == 1);
- shared_ptr<Decoder> decoder = decoder_factory (c.front(), _parent->film()->log(), false);
+ 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());
ContentList c = _parent->selected_text ();
DCPOMATIC_ASSERT (c.size() == 1);
- SubtitleAppearanceDialog* d = new SubtitleAppearanceDialog (this, c.front(), c.front()->text_of_original_type(_original_type));
+ SubtitleAppearanceDialog* d = new SubtitleAppearanceDialog (this, _parent->film(), c.front(), c.front()->text_of_original_type(_original_type));
if (d->ShowModal () == wxID_OK) {
d->apply ();
}
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 ()
+{
+ _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;
+ }
+
+ try_to_load_analysis ();
+}
+