Store a name with text content.

4 files changed, 55 insertions, 12 deletions

diff --git a/src/lib/text_content.cc b/src/lib/text_content.cc
index a077b2c46..abc68cf65 100644
--- a/src/lib/text_content.cc
+++ b/src/lib/text_content.cc
@@ -46,16 +46,17 @@ int const TextContentProperty::X_SCALE = 502;
 int const TextContentProperty::Y_SCALE = 503;
 int const TextContentProperty::USE = 504;
 int const TextContentProperty::BURN = 505;
-int const TextContentProperty::LANGUAGE = 506;
-int const TextContentProperty::FONTS = 507;
-int const TextContentProperty::COLOUR = 508;
-int const TextContentProperty::EFFECT = 509;
-int const TextContentProperty::EFFECT_COLOUR = 510;
-int const TextContentProperty::LINE_SPACING = 511;
-int const TextContentProperty::FADE_IN = 512;
-int const TextContentProperty::FADE_OUT = 513;
-int const TextContentProperty::OUTLINE_WIDTH = 514;
-int const TextContentProperty::TYPE = 515;
+int const TextContentProperty::NAME = 506;
+int const TextContentProperty::LANGUAGE = 507;
+int const TextContentProperty::FONTS = 508;
+int const TextContentProperty::COLOUR = 509;
+int const TextContentProperty::EFFECT = 510;
+int const TextContentProperty::EFFECT_COLOUR = 511;
+int const TextContentProperty::LINE_SPACING = 512;
+int const TextContentProperty::FADE_IN = 513;
+int const TextContentProperty::FADE_OUT = 514;
+int const TextContentProperty::OUTLINE_WIDTH = 515;
+int const TextContentProperty::TYPE = 516;
 
 TextContent::TextContent (Content* parent, TextType type, TextType original_type)
 	: ContentPart (parent)
@@ -218,6 +219,8 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 		_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
 	}
 
+	_name = node->optional_string_child("Name").get_value_or("");
+
 	list<cxml::NodePtr> fonts = node->node_children ("Font");
 	for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
 		_fonts.push_back (shared_ptr<Font> (new Font (*i)));
@@ -304,6 +307,7 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
 	_y_offset = ref->y_offset ();
 	_x_scale = ref->x_scale ();
 	_y_scale = ref->y_scale ();
+	_name = ref->name ();
 	_language = ref->language ();
 	_fonts = ref_fonts;
 	_line_spacing = ref->line_spacing ();
@@ -330,6 +334,7 @@ TextContent::as_xml (xmlpp::Node* root) const
 	text->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
 	text->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
 	text->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
+	text->add_child("Name")->add_child_text (_name);
 	text->add_child("Language")->add_child_text (_language);
 	if (_colour) {
 		text->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
@@ -395,7 +400,7 @@ TextContent::identifier () const
 		}
 	}
 
-	/* The language is for metadata only, and doesn't affect
+	/* The name and language are for metadata only, and don't affect
 	   how this content looks.
 	*/
 
@@ -503,6 +508,12 @@ TextContent::set_y_scale (double s)
 }
 
 void
+TextContent::set_name (string name)
+{
+	maybe_set (_name, name, TextContentProperty::NAME);
+}
+
+void
 TextContent::set_language (string language)
 {
 	maybe_set (_language, language, TextContentProperty::LANGUAGE);
diff --git a/src/lib/text_content.h b/src/lib/text_content.h
index e5981acaf..0327d4a97 100644
--- a/src/lib/text_content.h
+++ b/src/lib/text_content.h
@@ -37,6 +37,7 @@ public:
 	static int const Y_SCALE;
 	static int const USE;
 	static int const BURN;
+	static int const NAME;
 	static int const LANGUAGE;
 	static int const FONTS;
 	static int const COLOUR;
@@ -73,6 +74,7 @@ public:
 	void set_y_offset (double);
 	void set_x_scale (double);
 	void set_y_scale (double);
+	void set_name (std::string name);
 	void set_language (std::string language);
 	void set_colour (dcp::Colour);
 	void unset_colour ();
@@ -123,6 +125,11 @@ public:
 		return _fonts;
 	}
 
+	std::string name () const {
+		boost::mutex::scoped_lock lm (_mutex);
+		return _name;
+	}
+
 	std::string language () const {
 		boost::mutex::scoped_lock lm (_mutex);
 		return _language;
@@ -176,6 +183,8 @@ public:
 	static std::list<boost::shared_ptr<TextContent> > from_xml (Content* parent, cxml::ConstNodePtr, int version);
 
 protected:
+	/** Name (annotation text) for this subtitle */
+	std::string _name;
 	/** subtitle language (e.g. "German") or empty if it is not known */
 	std::string _language;
 
diff --git a/src/wx/text_panel.cc b/src/wx/text_panel.cc
index 8c9ac7d64..9ff75ae6d 100644
--- a/src/wx/text_panel.cc
+++ b/src/wx/text_panel.cc
@@ -25,6 +25,7 @@
 #include "content_panel.h"
 #include "fonts_dialog.h"
 #include "subtitle_appearance_dialog.h"
+#include "focus_manager.h"
 #include "lib/ffmpeg_content.h"
 #include "lib/string_text_file_content.h"
 #include "lib/ffmpeg_subtitle_stream.h"
@@ -121,15 +122,22 @@ TextPanel::TextPanel (ContentPanel* p, TextType t)
 	{
 		add_label_to_sizer (grid, this, _("Line spacing"), true, wxGBPosition (r, 0));
 		wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
-		_line_spacing = new wxSpinCtrl (this);
+		_line_spacing = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
 		s->Add (_line_spacing);
 		add_label_to_sizer (s, this, _("%"), false);
 		grid->Add (s, wxGBPosition (r, 1));
 		++r;
 	}
 
+	add_label_to_sizer (grid, this, _("Name"), true, wxGBPosition(r, 0));
+	_name = new wxTextCtrl (this, wxID_ANY);
+	FocusManager::instance()->add (_name);
+	grid->Add (_name, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
+	++r;
+
 	add_label_to_sizer (grid, this, _("Language"), true, wxGBPosition (r, 0));
 	_language = new wxTextCtrl (this, wxID_ANY);
+	FocusManager::instance()->add (_language);
 	grid->Add (_language, wxGBPosition (r, 1));
 	++r;
 
@@ -169,6 +177,7 @@ TextPanel::TextPanel (ContentPanel* p, TextType t)
 	_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));
+	_name->Bind                     (wxEVT_TEXT,     boost::bind (&TextPanel::name_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));
@@ -251,6 +260,8 @@ TextPanel::film_content_changed (int property)
 		checked_set (_y_scale, text ? lrint (text->y_scale() * 100) : 100);
 	} else if (property == TextContentProperty::LINE_SPACING) {
 		checked_set (_line_spacing, text ? lrint (text->line_spacing() * 100) : 100);
+	} else if (property == TextContentProperty::NAME) {
+		checked_set (_name, text ? text->name() : "");
 	} else if (property == TextContentProperty::LANGUAGE) {
 		checked_set (_language, text ? text->language() : "");
 	} else if (property == DCPContentProperty::REFERENCE_TEXT) {
@@ -353,6 +364,7 @@ TextPanel::setup_sensitivity ()
 	_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);
+	_name->Enable (!reference && any_subs > 0 && use);
 	_language->Enable (!reference && any_subs > 0 && use);
 	_stream->Enable (!reference && ffmpeg_subs == 1);
 	_text_view_button->Enable (!reference);
@@ -424,6 +436,14 @@ TextPanel::line_spacing_changed ()
 }
 
 void
+TextPanel::name_changed ()
+{
+	BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
+		i->text_of_original_type(_original_type)->set_name (wx_to_std (_name->GetValue()));
+	}
+}
+
+void
 TextPanel::language_changed ()
 {
 	BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
@@ -442,6 +462,7 @@ 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::NAME);
 	film_content_changed (TextContentProperty::LANGUAGE);
 	film_content_changed (TextContentProperty::FONTS);
 	film_content_changed (TextContentProperty::TYPE);
diff --git a/src/wx/text_panel.h b/src/wx/text_panel.h
index 3d3483a46..c1bf68779 100644
--- a/src/wx/text_panel.h
+++ b/src/wx/text_panel.h
@@ -43,6 +43,7 @@ private:
 	void x_scale_changed ();
 	void y_scale_changed ();
 	void line_spacing_changed ();
+	void name_changed ();
 	void language_changed ();
 	void stream_changed ();
 	void text_view_clicked ();
@@ -63,6 +64,7 @@ private:
 	wxSpinCtrl* _x_scale;
 	wxSpinCtrl* _y_scale;
 	wxSpinCtrl* _line_spacing;
+	wxTextCtrl* _name;
 	wxTextCtrl* _language;
 	wxChoice* _stream;
 	wxButton* _text_view_button;