2 Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "text_panel.h"
22 #include "film_editor.h"
24 #include "text_view.h"
25 #include "content_panel.h"
26 #include "fonts_dialog.h"
27 #include "dcp_text_track_dialog.h"
28 #include "subtitle_appearance_dialog.h"
29 #include "lib/ffmpeg_content.h"
30 #include "lib/string_text_file_content.h"
31 #include "lib/ffmpeg_subtitle_stream.h"
32 #include "lib/dcp_subtitle_content.h"
33 #include "lib/string_text_file_decoder.h"
34 #include "lib/dcp_subtitle_decoder.h"
35 #include "lib/dcp_content.h"
36 #include "lib/text_content.h"
37 #include "lib/decoder_factory.h"
38 #include <wx/spinctrl.h>
39 #include <boost/foreach.hpp>
45 using boost::shared_ptr;
46 using boost::optional;
47 using boost::dynamic_pointer_cast;
49 /** @param t Original text type of the content, if known */
50 TextPanel::TextPanel (ContentPanel* p, TextType t)
51 : ContentSubPanel (p, std_to_wx(text_type_to_name(t)))
56 wxBoxSizer* reference_sizer = new wxBoxSizer (wxVERTICAL);
58 wxString refer = _("Use this DCP's subtitle as OV and make VF");
59 if (t == TEXT_CLOSED_CAPTION) {
60 refer = _("Use this DCP's closed caption as OV and make VF");
63 _reference = new wxCheckBox (this, wxID_ANY, refer);
64 reference_sizer->Add (_reference, 0, wxLEFT | wxRIGHT | wxTOP, DCPOMATIC_SIZER_GAP);
66 _reference_note = new wxStaticText (this, wxID_ANY, _(""));
67 _reference_note->Wrap (200);
68 reference_sizer->Add (_reference_note, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
69 wxFont font = _reference_note->GetFont();
70 font.SetStyle(wxFONTSTYLE_ITALIC);
71 font.SetPointSize(font.GetPointSize() - 1);
72 _reference_note->SetFont(font);
74 _sizer->Add (reference_sizer);
76 wxGridBagSizer* grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
77 _sizer->Add (grid, 0, wxALL, 8);
80 wxBoxSizer* use = new wxBoxSizer (wxHORIZONTAL);
81 _use = new wxCheckBox (this, wxID_ANY, _("Use as"));
82 use->Add (_use, 0, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
83 _type = new wxChoice (this, wxID_ANY);
84 _type->Append (_("open subtitles"));
85 _type->Append (_("closed captions"));
86 use->Add (_type, 1, wxEXPAND, 0);
87 grid->Add (use, wxGBPosition (r, 0), wxGBSpan (1, 2));
90 _burn = new wxCheckBox (this, wxID_ANY, _("Burn subtitles into image"));
91 grid->Add (_burn, wxGBPosition (r, 0), wxGBSpan (1, 2));
94 add_label_to_sizer (grid, this, _("Offset"), true, wxGBPosition (r, 0));
95 wxBoxSizer* offset = new wxBoxSizer (wxHORIZONTAL);
96 add_label_to_sizer (offset, this, _("X"), true);
97 _x_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
98 offset->Add (_x_offset, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
99 wxStaticText* pc = new wxStaticText (this, wxID_ANY, _("%"));
100 offset->Add (pc, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP * 2);
101 add_label_to_sizer (offset, this, _("Y"), true);
102 _y_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
103 offset->Add (_y_offset, 0);
104 add_label_to_sizer (offset, this, _("%"), false);
105 grid->Add (offset, wxGBPosition (r, 1));
108 add_label_to_sizer (grid, this, _("Scale"), true, wxGBPosition (r, 0));
109 wxBoxSizer* scale = new wxBoxSizer (wxHORIZONTAL);
110 add_label_to_sizer (scale, this, _("X"), true);
111 _x_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
112 scale->Add (_x_scale, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
113 pc = new wxStaticText (this, wxID_ANY, _("%"));
114 scale->Add (pc, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP * 2);
115 add_label_to_sizer (scale, this, _("Y"), true);
116 _y_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(64, -1));
117 scale->Add (_y_scale, 0);
118 add_label_to_sizer (scale, this, _("%"), false);
119 grid->Add (scale, wxGBPosition (r, 1));
123 add_label_to_sizer (grid, this, _("Line spacing"), true, wxGBPosition (r, 0));
124 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
125 _line_spacing = new wxSpinCtrl (this);
126 s->Add (_line_spacing);
127 add_label_to_sizer (s, this, _("%"), false);
128 grid->Add (s, wxGBPosition (r, 1));
132 add_label_to_sizer (grid, this, _("DCP track"), true, wxGBPosition(r, 0));
133 _dcp_track = new wxChoice (this, wxID_ANY);
134 grid->Add (_dcp_track, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
137 add_label_to_sizer (grid, this, _("Language"), true, wxGBPosition (r, 0));
138 _language = new wxTextCtrl (this, wxID_ANY);
139 grid->Add (_language, wxGBPosition (r, 1));
142 add_label_to_sizer (grid, this, _("Stream"), true, wxGBPosition (r, 0));
143 _stream = new wxChoice (this, wxID_ANY);
144 grid->Add (_stream, wxGBPosition (r, 1));
148 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
150 _text_view_button = new wxButton (this, wxID_ANY, _("View..."));
151 s->Add (_text_view_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
152 _fonts_dialog_button = new wxButton (this, wxID_ANY, _("Fonts..."));
153 s->Add (_fonts_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
154 _appearance_dialog_button = new wxButton (this, wxID_ANY, _("Appearance..."));
155 s->Add (_appearance_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
157 grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
161 _x_offset->SetRange (-100, 100);
162 _y_offset->SetRange (-100, 100);
163 _x_scale->SetRange (10, 1000);
164 _y_scale->SetRange (10, 1000);
165 _line_spacing->SetRange (10, 1000);
167 update_dcp_tracks ();
169 content_selection_changed ();
171 _reference->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::reference_clicked, this));
172 _use->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::use_toggled, this));
173 _type->Bind (wxEVT_CHOICE, boost::bind (&TextPanel::type_changed, this));
174 _burn->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::burn_toggled, this));
175 _x_offset->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::x_offset_changed, this));
176 _y_offset->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::y_offset_changed, this));
177 _x_scale->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::x_scale_changed, this));
178 _y_scale->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::y_scale_changed, this));
179 _line_spacing->Bind (wxEVT_SPINCTRL, boost::bind (&TextPanel::line_spacing_changed, this));
180 _dcp_track->Bind (wxEVT_CHOICE, boost::bind (&TextPanel::dcp_track_changed, this));
181 _language->Bind (wxEVT_TEXT, boost::bind (&TextPanel::language_changed, this));
182 _stream->Bind (wxEVT_CHOICE, boost::bind (&TextPanel::stream_changed, this));
183 _text_view_button->Bind (wxEVT_BUTTON, boost::bind (&TextPanel::text_view_clicked, this));
184 _fonts_dialog_button->Bind (wxEVT_BUTTON, boost::bind (&TextPanel::fonts_dialog_clicked, this));
185 _appearance_dialog_button->Bind (wxEVT_BUTTON, boost::bind (&TextPanel::appearance_dialog_clicked, this));
189 TextPanel::update_dcp_track_selection ()
191 optional<DCPTextTrack> selected;
193 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text()) {
194 shared_ptr<TextContent> t = i->text_of_original_type(_original_type);
196 optional<DCPTextTrack> dt = t->dcp_track();
197 if (dt && selected && *dt != *selected) {
199 } else if (!selected) {
206 BOOST_FOREACH (DCPTextTrack i, _parent->film()->closed_caption_tracks()) {
207 if (!many && selected && *selected == i) {
208 _dcp_track->SetSelection (n);
214 _dcp_track->SetSelection (wxNOT_FOUND);
219 TextPanel::update_dcp_tracks ()
221 _dcp_track->Clear ();
222 BOOST_FOREACH (DCPTextTrack i, _parent->film()->closed_caption_tracks()) {
223 _dcp_track->Append (std_to_wx(i.summary()));
226 if (_parent->film()->closed_caption_tracks().size() < 6) {
227 _dcp_track->Append (_("Add new..."));
230 update_dcp_track_selection ();
234 TextPanel::dcp_track_changed ()
236 optional<DCPTextTrack> track;
238 if (_dcp_track->GetSelection() == int(_dcp_track->GetCount()) - 1) {
239 DCPTextTrackDialog* d = new DCPTextTrackDialog (this);
240 if (d->ShowModal() == wxID_OK) {
245 /* Find the DCPTextTrack that was selected */
246 BOOST_FOREACH (DCPTextTrack i, _parent->film()->closed_caption_tracks()) {
247 if (i.summary() == wx_to_std(_dcp_track->GetStringSelection())) {
254 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text()) {
255 shared_ptr<TextContent> t = i->text_of_original_type(_original_type);
256 if (t && t->type() == TEXT_CLOSED_CAPTION) {
257 t->set_dcp_track(*track);
262 update_dcp_tracks ();
266 TextPanel::film_changed (Film::Property property)
268 if (property == Film::CONTENT || property == Film::REEL_TYPE) {
269 setup_sensitivity ();
274 TextPanel::film_content_changed (int property)
276 FFmpegContentList fc = _parent->selected_ffmpeg ();
277 ContentList sc = _parent->selected_text ();
279 shared_ptr<FFmpegContent> fcs;
280 if (fc.size() == 1) {
284 shared_ptr<Content> scs;
285 if (sc.size() == 1) {
289 shared_ptr<TextContent> text;
291 text = scs->text_of_original_type(_original_type);
294 if (property == FFmpegContentProperty::SUBTITLE_STREAMS) {
297 vector<shared_ptr<FFmpegSubtitleStream> > s = fcs->subtitle_streams ();
298 for (vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = s.begin(); i != s.end(); ++i) {
299 _stream->Append (std_to_wx ((*i)->name), new wxStringClientData (std_to_wx ((*i)->identifier ())));
302 if (fcs->subtitle_stream()) {
303 checked_set (_stream, fcs->subtitle_stream()->identifier ());
305 _stream->SetSelection (wxNOT_FOUND);
308 setup_sensitivity ();
309 } else if (property == TextContentProperty::USE) {
310 checked_set (_use, text ? text->use() : false);
311 setup_sensitivity ();
312 } else if (property == TextContentProperty::TYPE) {
314 switch (text->type()) {
315 case TEXT_OPEN_SUBTITLE:
316 _type->SetSelection (0);
318 case TEXT_CLOSED_CAPTION:
319 _type->SetSelection (1);
322 DCPOMATIC_ASSERT (false);
325 _type->SetSelection (0);
327 setup_sensitivity ();
328 } else if (property == TextContentProperty::BURN) {
329 checked_set (_burn, text ? text->burn() : false);
330 } else if (property == TextContentProperty::X_OFFSET) {
331 checked_set (_x_offset, text ? lrint (text->x_offset() * 100) : 0);
332 } else if (property == TextContentProperty::Y_OFFSET) {
333 checked_set (_y_offset, text ? lrint (text->y_offset() * 100) : 0);
334 } else if (property == TextContentProperty::X_SCALE) {
335 checked_set (_x_scale, text ? lrint (text->x_scale() * 100) : 100);
336 } else if (property == TextContentProperty::Y_SCALE) {
337 checked_set (_y_scale, text ? lrint (text->y_scale() * 100) : 100);
338 } else if (property == TextContentProperty::LINE_SPACING) {
339 checked_set (_line_spacing, text ? lrint (text->line_spacing() * 100) : 100);
340 } else if (property == TextContentProperty::LANGUAGE) {
341 checked_set (_language, text ? text->language() : "");
342 } else if (property == TextContentProperty::DCP_TRACK) {
343 update_dcp_track_selection ();
344 } else if (property == DCPContentProperty::REFERENCE_TEXT) {
346 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (scs);
347 checked_set (_reference, dcp ? dcp->reference_text(_original_type) : false);
349 checked_set (_reference, false);
352 setup_sensitivity ();
353 } else if (property == DCPContentProperty::TEXTS) {
354 setup_sensitivity ();
359 TextPanel::use_toggled ()
361 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text()) {
362 i->text_of_original_type(_original_type)->set_use (_use->GetValue());
366 /** @return the text type that is currently selected in the drop-down */
368 TextPanel::current_type () const
370 switch (_type->GetSelection()) {
372 return TEXT_OPEN_SUBTITLE;
374 return TEXT_CLOSED_CAPTION;
381 TextPanel::type_changed ()
383 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text()) {
384 i->text_of_original_type(_original_type)->set_type (current_type ());
389 TextPanel::burn_toggled ()
391 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
392 i->text_of_original_type(_original_type)->set_burn (_burn->GetValue());
397 TextPanel::setup_sensitivity ()
401 ContentList sel = _parent->selected_text ();
402 BOOST_FOREACH (shared_ptr<Content> i, sel) {
403 /* These are the content types that could include subtitles */
404 shared_ptr<const FFmpegContent> fc = boost::dynamic_pointer_cast<const FFmpegContent> (i);
405 shared_ptr<const StringTextFileContent> sc = boost::dynamic_pointer_cast<const StringTextFileContent> (i);
406 shared_ptr<const DCPContent> dc = boost::dynamic_pointer_cast<const DCPContent> (i);
407 shared_ptr<const DCPSubtitleContent> dsc = boost::dynamic_pointer_cast<const DCPSubtitleContent> (i);
409 if (!fc->text.empty()) {
413 } else if (sc || dc || dsc) {
414 /* XXX: in the future there could be bitmap subs from DCPs */
419 /* Decide whether we can reference these subs */
421 shared_ptr<DCPContent> dcp;
422 if (sel.size() == 1) {
423 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
427 bool const can_reference = dcp && dcp->can_reference_text (_original_type, why_not);
428 setup_refer_button (_reference, _reference_note, dcp, can_reference, why_not);
430 bool const reference = _reference->GetValue ();
432 TextType const type = current_type ();
434 /* Set up sensitivity */
435 _use->Enable (!reference && any_subs > 0);
436 bool const use = _use->GetValue ();
437 _type->Enable (!reference && any_subs > 0 && use);
438 _burn->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
439 _x_offset->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
440 _y_offset->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
441 _x_scale->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
442 _y_scale->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
443 _line_spacing->Enable (!reference && use && type == TEXT_OPEN_SUBTITLE);
444 _dcp_track->Enable (!reference && any_subs > 0 && use && type == TEXT_CLOSED_CAPTION);
445 _language->Enable (!reference && any_subs > 0 && use);
446 _stream->Enable (!reference && ffmpeg_subs == 1);
447 _text_view_button->Enable (!reference);
448 _fonts_dialog_button->Enable (!reference && type == TEXT_OPEN_SUBTITLE);
449 _appearance_dialog_button->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
453 TextPanel::stream_changed ()
455 FFmpegContentList fc = _parent->selected_ffmpeg ();
456 if (fc.size() != 1) {
460 shared_ptr<FFmpegContent> fcs = fc.front ();
462 vector<shared_ptr<FFmpegSubtitleStream> > a = fcs->subtitle_streams ();
463 vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = a.begin ();
464 string const s = string_client_data (_stream->GetClientObject (_stream->GetSelection ()));
465 while (i != a.end() && (*i)->identifier () != s) {
470 fcs->set_subtitle_stream (*i);
475 TextPanel::x_offset_changed ()
477 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
478 i->text_of_original_type(_original_type)->set_x_offset (_x_offset->GetValue() / 100.0);
483 TextPanel::y_offset_changed ()
485 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
486 i->text_of_original_type(_original_type)->set_y_offset (_y_offset->GetValue() / 100.0);
491 TextPanel::x_scale_changed ()
493 ContentList c = _parent->selected_text ();
495 c.front()->text_of_original_type(_original_type)->set_x_scale (_x_scale->GetValue() / 100.0);
500 TextPanel::y_scale_changed ()
502 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
503 i->text_of_original_type(_original_type)->set_y_scale (_y_scale->GetValue() / 100.0);
508 TextPanel::line_spacing_changed ()
510 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
511 i->text_of_original_type(_original_type)->set_line_spacing (_line_spacing->GetValue() / 100.0);
516 TextPanel::language_changed ()
518 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_text ()) {
519 i->text_of_original_type(_original_type)->set_language (wx_to_std (_language->GetValue()));
524 TextPanel::content_selection_changed ()
526 film_content_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
527 film_content_changed (TextContentProperty::USE);
528 film_content_changed (TextContentProperty::BURN);
529 film_content_changed (TextContentProperty::X_OFFSET);
530 film_content_changed (TextContentProperty::Y_OFFSET);
531 film_content_changed (TextContentProperty::X_SCALE);
532 film_content_changed (TextContentProperty::Y_SCALE);
533 film_content_changed (TextContentProperty::LINE_SPACING);
534 film_content_changed (TextContentProperty::LANGUAGE);
535 film_content_changed (TextContentProperty::FONTS);
536 film_content_changed (TextContentProperty::TYPE);
537 film_content_changed (TextContentProperty::DCP_TRACK);
538 film_content_changed (DCPContentProperty::REFERENCE_TEXT);
542 TextPanel::text_view_clicked ()
545 _text_view->Destroy ();
549 ContentList c = _parent->selected_text ();
550 DCPOMATIC_ASSERT (c.size() == 1);
552 shared_ptr<Decoder> decoder = decoder_factory (c.front(), _parent->film()->log(), false);
555 _text_view = new TextView (this, _parent->film(), c.front(), c.front()->text_of_original_type(_original_type), decoder, _parent->film_viewer());
561 TextPanel::fonts_dialog_clicked ()
564 _fonts_dialog->Destroy ();
568 ContentList c = _parent->selected_text ();
569 DCPOMATIC_ASSERT (c.size() == 1);
571 _fonts_dialog = new FontsDialog (this, c.front(), c.front()->text_of_original_type(_original_type));
572 _fonts_dialog->Show ();
576 TextPanel::reference_clicked ()
578 ContentList c = _parent->selected ();
583 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
588 d->set_reference_text (_original_type, _reference->GetValue ());
592 TextPanel::appearance_dialog_clicked ()
594 ContentList c = _parent->selected_text ();
595 DCPOMATIC_ASSERT (c.size() == 1);
597 SubtitleAppearanceDialog* d = new SubtitleAppearanceDialog (this, c.front(), c.front()->text_of_original_type(_original_type));
598 if (d->ShowModal () == wxID_OK) {