BOOST_FOREACH.
[dcpomatic.git] / src / wx / text_panel.cc
1 /*
2     Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21 #include "text_panel.h"
22 #include "film_editor.h"
23 #include "wx_util.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 "static_text.h"
30 #include "check_box.h"
31 #include "dcpomatic_button.h"
32 #include "film_viewer.h"
33 #include "lib/job_manager.h"
34 #include "lib/ffmpeg_content.h"
35 #include "lib/string_text_file_content.h"
36 #include "lib/ffmpeg_subtitle_stream.h"
37 #include "lib/dcp_subtitle_content.h"
38 #include "lib/string_text_file_decoder.h"
39 #include "lib/dcp_subtitle_decoder.h"
40 #include "lib/dcp_content.h"
41 #include "lib/text_content.h"
42 #include "lib/decoder_factory.h"
43 #include "lib/analyse_subtitles_job.h"
44 #include "lib/subtitle_analysis.h"
45 #include <wx/spinctrl.h>
46
47 using std::vector;
48 using std::string;
49 using std::list;
50 using std::cout;
51 using std::shared_ptr;
52 using boost::optional;
53 using std::dynamic_pointer_cast;
54 using boost::bind;
55
56 /** @param t Original text type of the content, if known */
57 TextPanel::TextPanel (ContentPanel* p, TextType t)
58         : ContentSubPanel (p, std_to_wx(text_type_to_name(t)))
59         , _outline_subtitles (0)
60         , _dcp_track_label (0)
61         , _dcp_track (0)
62         , _text_view (0)
63         , _fonts_dialog (0)
64         , _original_type (t)
65         , _loading_analysis (false)
66 {
67         wxString refer = _("Use this DCP's subtitle as OV and make VF");
68         if (t == TEXT_CLOSED_CAPTION) {
69                 refer = _("Use this DCP's closed caption as OV and make VF");
70         }
71
72         _reference = new CheckBox (this, refer);
73         _reference_note = new StaticText (this, wxT(""));
74         _reference_note->Wrap (200);
75         wxFont font = _reference_note->GetFont();
76         font.SetStyle(wxFONTSTYLE_ITALIC);
77         font.SetPointSize(font.GetPointSize() - 1);
78         _reference_note->SetFont(font);
79
80         _use = new CheckBox (this, _("Use as"));
81         _type = new wxChoice (this, wxID_ANY);
82         _type->Append (_("open subtitles"));
83         _type->Append (_("closed captions"));
84
85         _burn = new CheckBox (this, _("Burn subtitles into image"));
86
87 #ifdef __WXGTK3__
88         int const spin_width = 118;
89 #else
90         int const spin_width = 56;
91 #endif
92
93         _offset_label = create_label (this, _("Offset"), true);
94         _x_offset_label = create_label (this, _("X"), true);
95         _x_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
96         _x_offset_pc_label = new StaticText (this, _("%"));
97         _y_offset_label = create_label (this, _("Y"), true);
98         _y_offset = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
99         _y_offset_pc_label = new StaticText (this, _("%"));
100
101         _scale_label = create_label (this, _("Scale"), true);
102         _x_scale_label = create_label (this, _("X"), true);
103         _x_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
104         _x_scale_pc_label = new StaticText (this, _("%"));
105         _y_scale_label = create_label (this, S_("Coord|Y"), true);
106         _y_scale = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(spin_width, -1));
107         _y_scale_pc_label = new StaticText (this, _("%"));
108
109         _line_spacing_label = create_label (this, _("Line spacing"), true);
110         _line_spacing = new wxSpinCtrl (this);
111         _line_spacing_pc_label = new StaticText (this, _("%"));
112
113         _stream_label = create_label (this, _("Stream"), true);
114         _stream = new wxChoice (this, wxID_ANY);
115
116         _text_view_button = new Button (this, _("View..."));
117         _fonts_dialog_button = new Button (this, _("Fonts..."));
118         _appearance_dialog_button = new Button (this, _("Appearance..."));
119
120         _x_offset->SetRange (-100, 100);
121         _y_offset->SetRange (-100, 100);
122         _x_scale->SetRange (10, 1000);
123         _y_scale->SetRange (10, 1000);
124         _line_spacing->SetRange (10, 1000);
125
126         _reference->Bind                (wxEVT_CHECKBOX, boost::bind (&TextPanel::reference_clicked, this));
127         _use->Bind                      (wxEVT_CHECKBOX, boost::bind (&TextPanel::use_toggled, this));
128         _type->Bind                     (wxEVT_CHOICE,   boost::bind (&TextPanel::type_changed, this));
129         _burn->Bind                     (wxEVT_CHECKBOX, boost::bind (&TextPanel::burn_toggled, this));
130         _x_offset->Bind                 (wxEVT_SPINCTRL, boost::bind (&TextPanel::x_offset_changed, this));
131         _y_offset->Bind                 (wxEVT_SPINCTRL, boost::bind (&TextPanel::y_offset_changed, this));
132         _x_scale->Bind                  (wxEVT_SPINCTRL, boost::bind (&TextPanel::x_scale_changed, this));
133         _y_scale->Bind                  (wxEVT_SPINCTRL, boost::bind (&TextPanel::y_scale_changed, this));
134         _line_spacing->Bind             (wxEVT_SPINCTRL, boost::bind (&TextPanel::line_spacing_changed, this));
135         _stream->Bind                   (wxEVT_CHOICE,   boost::bind (&TextPanel::stream_changed, this));
136         _text_view_button->Bind         (wxEVT_BUTTON,   boost::bind (&TextPanel::text_view_clicked, this));
137         _fonts_dialog_button->Bind      (wxEVT_BUTTON,   boost::bind (&TextPanel::fonts_dialog_clicked, this));
138         _appearance_dialog_button->Bind (wxEVT_BUTTON,   boost::bind (&TextPanel::appearance_dialog_clicked, this));
139
140         add_to_grid();
141         content_selection_changed ();
142 }
143
144 void
145 TextPanel::setup_visibility ()
146 {
147         switch (current_type()) {
148         case TEXT_OPEN_SUBTITLE:
149                 if (_dcp_track_label) {
150                         _dcp_track_label->Destroy ();
151                         _dcp_track_label = 0;
152                 }
153                 if (_dcp_track) {
154                         _dcp_track->Destroy ();
155                         _dcp_track = 0;
156                 }
157                 if (!_outline_subtitles) {
158                         _outline_subtitles = new CheckBox (this, _("Show subtitle area"));
159                         _outline_subtitles->Bind (wxEVT_CHECKBOX, boost::bind (&TextPanel::outline_subtitles_changed, this));
160                         _grid->Add (_outline_subtitles, wxGBPosition(_outline_subtitles_row, 0), wxGBSpan(1, 2));
161                 }
162
163                 break;
164         case TEXT_CLOSED_CAPTION:
165                 if (!_dcp_track_label) {
166                         _dcp_track_label = create_label (this, _("CCAP track"), true);
167                         add_label_to_sizer (_grid, _dcp_track_label, true, wxGBPosition(_ccap_track_row, 0));
168                 }
169                 if (!_dcp_track) {
170                         _dcp_track = new wxChoice (this, wxID_ANY);
171                         _dcp_track->Bind (wxEVT_CHOICE, boost::bind(&TextPanel::dcp_track_changed, this));
172                         _grid->Add (_dcp_track, wxGBPosition(_ccap_track_row, 1), wxDefaultSpan, wxEXPAND);
173                         update_dcp_tracks ();
174                         film_content_changed (TextContentProperty::DCP_TRACK);
175                 }
176                 if (_outline_subtitles) {
177                         _outline_subtitles->Destroy ();
178                         _outline_subtitles = 0;
179                         clear_outline_subtitles ();
180                 }
181                 break;
182         default:
183                 break;
184         }
185
186         _grid->Layout ();
187 }
188
189 void
190 TextPanel::add_to_grid ()
191 {
192         int r = 0;
193
194         wxBoxSizer* reference_sizer = new wxBoxSizer (wxVERTICAL);
195         reference_sizer->Add (_reference, 0);
196         reference_sizer->Add (_reference_note, 0);
197         _grid->Add (reference_sizer, wxGBPosition(r, 0), wxGBSpan(1, 4));
198         ++r;
199
200         wxBoxSizer* use = new wxBoxSizer (wxHORIZONTAL);
201         use->Add (_use, 0, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
202         use->Add (_type, 1, wxEXPAND, 0);
203         _grid->Add (use, wxGBPosition (r, 0), wxGBSpan (1, 2));
204         ++r;
205
206         _grid->Add (_burn, wxGBPosition (r, 0), wxGBSpan (1, 2));
207         ++r;
208
209         _outline_subtitles_row = r;
210         ++r;
211
212         add_label_to_sizer (_grid, _offset_label, true, wxGBPosition (r, 0));
213         wxBoxSizer* offset = new wxBoxSizer (wxHORIZONTAL);
214         add_label_to_sizer (offset, _x_offset_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
215         offset->Add (_x_offset, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
216         offset->Add (_x_offset_pc_label, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP * 2);
217 #ifdef __WXGTK3__
218         _grid->Add (offset, wxGBPosition(r, 1));
219         ++r;
220         offset = new wxBoxSizer (wxHORIZONTAL);
221 #endif
222         add_label_to_sizer (offset, _y_offset_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
223         offset->Add (_y_offset, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
224         add_label_to_sizer (offset, _y_offset_pc_label, false, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
225         _grid->Add (offset, wxGBPosition (r, 1));
226         ++r;
227
228         add_label_to_sizer (_grid, _scale_label, true, wxGBPosition (r, 0));
229         wxBoxSizer* scale = new wxBoxSizer (wxHORIZONTAL);
230         add_label_to_sizer (scale, _x_scale_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
231         scale->Add (_x_scale, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
232         scale->Add (_x_scale_pc_label, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP * 2);
233 #ifdef __WXGTK3__
234         _grid->Add (scale, wxGBPosition(r, 1));
235         ++r;
236         scale = new wxBoxSizer (wxHORIZONTAL);
237 #endif
238         add_label_to_sizer (scale, _y_scale_label, true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
239         scale->Add (_y_scale, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
240         add_label_to_sizer (scale, _y_scale_pc_label, false, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
241         _grid->Add (scale, wxGBPosition (r, 1));
242         ++r;
243
244         {
245                 add_label_to_sizer (_grid, _line_spacing_label, true, wxGBPosition (r, 0));
246                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
247                 s->Add (_line_spacing);
248                 add_label_to_sizer (s, _line_spacing_pc_label, false, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL);
249                 _grid->Add (s, wxGBPosition (r, 1));
250                 ++r;
251         }
252
253         _ccap_track_row = r;
254         ++r;
255
256         add_label_to_sizer (_grid, _stream_label, true, wxGBPosition (r, 0));
257         _grid->Add (_stream, wxGBPosition (r, 1));
258         ++r;
259
260         {
261                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
262
263                 s->Add (_text_view_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
264                 s->Add (_fonts_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
265                 s->Add (_appearance_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
266
267                 _grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
268                 ++r;
269         }
270
271         setup_visibility ();
272 }
273
274 void
275 TextPanel::update_dcp_track_selection ()
276 {
277         DCPOMATIC_ASSERT (_dcp_track);
278
279         optional<DCPTextTrack> selected;
280         bool many = false;
281         for (auto i: _parent->selected_text()) {
282                 shared_ptr<TextContent> t = i->text_of_original_type(_original_type);
283                 if (t) {
284                         optional<DCPTextTrack> dt = t->dcp_track();
285                         if (dt && selected && *dt != *selected) {
286                                 many = true;
287                         } else if (!selected) {
288                                 selected = dt;
289                         }
290                 }
291         }
292
293         int n = 0;
294         for (auto i: _parent->film()->closed_caption_tracks()) {
295                 if (!many && selected && *selected == i) {
296                         _dcp_track->SetSelection (n);
297                 }
298                 ++n;
299         }
300
301         if (!selected || many) {
302                 _dcp_track->SetSelection (wxNOT_FOUND);
303         }
304 }
305
306 void
307 TextPanel::update_dcp_tracks ()
308 {
309         DCPOMATIC_ASSERT (_dcp_track);
310
311         _dcp_track->Clear ();
312         for (auto i: _parent->film()->closed_caption_tracks()) {
313                 /* XXX: don't display the "magic" track which has empty name and language;
314                    this is a nasty hack (see also Film::closed_caption_tracks)
315                 */
316                 if (!i.name.empty() || !i.language.empty()) {
317                         _dcp_track->Append (std_to_wx(i.summary()));
318                 }
319         }
320
321         if (_parent->film()->closed_caption_tracks().size() < 6) {
322                 _dcp_track->Append (_("Add new..."));
323         }
324
325         update_dcp_track_selection ();
326 }
327
328 void
329 TextPanel::dcp_track_changed ()
330 {
331         optional<DCPTextTrack> track;
332
333         if (_dcp_track->GetSelection() == int(_dcp_track->GetCount()) - 1) {
334                 DCPTextTrackDialog* d = new DCPTextTrackDialog (this);
335                 if (d->ShowModal() == wxID_OK) {
336                         track = d->get();
337                 }
338                 d->Destroy ();
339         } else {
340                 /* Find the DCPTextTrack that was selected */
341                 for (auto i: _parent->film()->closed_caption_tracks()) {
342                         if (i.summary() == wx_to_std(_dcp_track->GetStringSelection())) {
343                                 track = i;
344                         }
345                 }
346         }
347
348         if (track) {
349                 for (auto i: _parent->selected_text()) {
350                         shared_ptr<TextContent> t = i->text_of_original_type(_original_type);
351                         if (t && t->type() == TEXT_CLOSED_CAPTION) {
352                                 t->set_dcp_track(*track);
353                         }
354                 }
355         }
356
357         update_dcp_tracks ();
358 }
359
360 void
361 TextPanel::film_changed (Film::Property property)
362 {
363         if (property == Film::CONTENT || property == Film::REEL_TYPE || property == Film::INTEROP) {
364                 setup_sensitivity ();
365         }
366 }
367
368 void
369 TextPanel::film_content_changed (int property)
370 {
371         FFmpegContentList fc = _parent->selected_ffmpeg ();
372         ContentList sc = _parent->selected_text ();
373
374         shared_ptr<FFmpegContent> fcs;
375         if (fc.size() == 1) {
376                 fcs = fc.front ();
377         }
378
379         shared_ptr<Content> scs;
380         if (sc.size() == 1) {
381                 scs = sc.front ();
382         }
383
384         shared_ptr<TextContent> text;
385         if (scs) {
386                 text = scs->text_of_original_type(_original_type);
387         }
388
389         if (property == FFmpegContentProperty::SUBTITLE_STREAMS) {
390                 _stream->Clear ();
391                 if (fcs) {
392                         vector<shared_ptr<FFmpegSubtitleStream> > s = fcs->subtitle_streams ();
393                         for (vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = s.begin(); i != s.end(); ++i) {
394                                 _stream->Append (std_to_wx ((*i)->name), new wxStringClientData (std_to_wx ((*i)->identifier ())));
395                         }
396
397                         if (fcs->subtitle_stream()) {
398                                 checked_set (_stream, fcs->subtitle_stream()->identifier ());
399                         } else {
400                                 _stream->SetSelection (wxNOT_FOUND);
401                         }
402                 }
403                 setup_sensitivity ();
404                 clear_outline_subtitles ();
405         } else if (property == TextContentProperty::USE) {
406                 checked_set (_use, text ? text->use() : false);
407                 setup_sensitivity ();
408                 clear_outline_subtitles ();
409         } else if (property == TextContentProperty::TYPE) {
410                 if (text) {
411                         switch (text->type()) {
412                         case TEXT_OPEN_SUBTITLE:
413                                 _type->SetSelection (0);
414                                 break;
415                         case TEXT_CLOSED_CAPTION:
416                                 _type->SetSelection (1);
417                                 break;
418                         default:
419                                 DCPOMATIC_ASSERT (false);
420                         }
421                 } else {
422                         _type->SetSelection (0);
423                 }
424                 setup_sensitivity ();
425                 setup_visibility ();
426         } else if (property == TextContentProperty::BURN) {
427                 checked_set (_burn, text ? text->burn() : false);
428         } else if (property == TextContentProperty::X_OFFSET) {
429                 checked_set (_x_offset, text ? lrint (text->x_offset() * 100) : 0);
430                 update_outline_subtitles_in_viewer ();
431         } else if (property == TextContentProperty::Y_OFFSET) {
432                 checked_set (_y_offset, text ? lrint (text->y_offset() * 100) : 0);
433                 update_outline_subtitles_in_viewer ();
434         } else if (property == TextContentProperty::X_SCALE) {
435                 checked_set (_x_scale, text ? lrint (text->x_scale() * 100) : 100);
436                 clear_outline_subtitles ();
437         } else if (property == TextContentProperty::Y_SCALE) {
438                 checked_set (_y_scale, text ? lrint (text->y_scale() * 100) : 100);
439                 clear_outline_subtitles ();
440         } else if (property == TextContentProperty::LINE_SPACING) {
441                 checked_set (_line_spacing, text ? lrint (text->line_spacing() * 100) : 100);
442                 clear_outline_subtitles ();
443         } else if (property == TextContentProperty::DCP_TRACK) {
444                 if (_dcp_track) {
445                         update_dcp_track_selection ();
446                 }
447         } else if (property == DCPContentProperty::REFERENCE_TEXT) {
448                 if (scs) {
449                         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (scs);
450                         checked_set (_reference, dcp ? dcp->reference_text(_original_type) : false);
451                 } else {
452                         checked_set (_reference, false);
453                 }
454
455                 setup_sensitivity ();
456         } else if (property == DCPContentProperty::TEXTS) {
457                 setup_sensitivity ();
458         } else if (property == ContentProperty::TRIM_START) {
459                 setup_sensitivity ();
460         }
461 }
462
463 void
464 TextPanel::use_toggled ()
465 {
466         for (auto i: _parent->selected_text()) {
467                 i->text_of_original_type(_original_type)->set_use (_use->GetValue());
468         }
469 }
470
471 /** @return the text type that is currently selected in the drop-down */
472 TextType
473 TextPanel::current_type () const
474 {
475         switch (_type->GetSelection()) {
476         case 0:
477                 return TEXT_OPEN_SUBTITLE;
478         case 1:
479                 return TEXT_CLOSED_CAPTION;
480         }
481
482         return TEXT_UNKNOWN;
483 }
484
485 void
486 TextPanel::type_changed ()
487 {
488         for (auto i: _parent->selected_text()) {
489                 i->text_of_original_type(_original_type)->set_type (current_type ());
490         }
491
492         setup_visibility ();
493 }
494
495 void
496 TextPanel::burn_toggled ()
497 {
498         for (auto i: _parent->selected_text ()) {
499                 i->text_of_original_type(_original_type)->set_burn (_burn->GetValue());
500         }
501 }
502
503 void
504 TextPanel::setup_sensitivity ()
505 {
506         int any_subs = 0;
507         /* We currently assume that FFmpeg subtitles are bitmapped */
508         int ffmpeg_subs = 0;
509         /* DCP subs can't have their line spacing changed */
510         int dcp_subs = 0;
511         ContentList sel = _parent->selected_text ();
512         for (auto i: sel) {
513                 /* These are the content types that could include subtitles */
514                 shared_ptr<const FFmpegContent> fc = std::dynamic_pointer_cast<const FFmpegContent> (i);
515                 shared_ptr<const StringTextFileContent> sc = std::dynamic_pointer_cast<const StringTextFileContent> (i);
516                 shared_ptr<const DCPContent> dc = std::dynamic_pointer_cast<const DCPContent> (i);
517                 shared_ptr<const DCPSubtitleContent> dsc = std::dynamic_pointer_cast<const DCPSubtitleContent> (i);
518                 if (fc) {
519                         if (!fc->text.empty()) {
520                                 ++ffmpeg_subs;
521                                 ++any_subs;
522                         }
523                 } else if (dc || dsc) {
524                         ++dcp_subs;
525                         ++any_subs;
526                 } else if (sc) {
527                         /* XXX: in the future there could be bitmap subs from DCPs */
528                         ++any_subs;
529                 }
530         }
531
532         /* Decide whether we can reference these subs */
533
534         shared_ptr<DCPContent> dcp;
535         if (sel.size() == 1) {
536                 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
537         }
538
539         string why_not;
540         bool const can_reference = dcp && dcp->can_reference_text (_parent->film(), _original_type, why_not);
541         wxString cannot;
542         if (why_not.empty()) {
543                 cannot = _("Cannot reference this DCP's subtitles or captions.");
544         } else {
545                 cannot = _("Cannot reference this DCP's subtitles or captions: ") + std_to_wx(why_not);
546         }
547         setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
548
549         bool const reference = _reference->GetValue ();
550
551         TextType const type = current_type ();
552
553         /* Set up _type */
554         _type->Clear ();
555         _type->Append (_("open subtitles"));
556         if (ffmpeg_subs == 0) {
557                 _type->Append (_("closed captions"));
558         }
559
560         switch (type) {
561         case TEXT_OPEN_SUBTITLE:
562                 _type->SetSelection (0);
563                 break;
564         case TEXT_CLOSED_CAPTION:
565                 if (_type->GetCount() > 1) {
566                         _type->SetSelection (1);
567                 }
568                 break;
569         default:
570                 break;
571         }
572
573         /* Set up sensitivity */
574         _use->Enable (!reference && any_subs > 0);
575         bool const use = _use->GetValue ();
576         if (_outline_subtitles) {
577                 _outline_subtitles->Enable (!_loading_analysis && any_subs && use && type == TEXT_OPEN_SUBTITLE);
578         }
579         _type->Enable (!reference && any_subs > 0 && use);
580         _burn->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
581         _x_offset->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
582         _y_offset->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
583         _x_scale->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
584         _y_scale->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
585         _line_spacing->Enable (!reference && use && type == TEXT_OPEN_SUBTITLE && dcp_subs < any_subs);
586         _stream->Enable (!reference && ffmpeg_subs == 1);
587         /* Ideally we would check here to see if the FFmpeg content has "string" subs (i.e. not bitmaps) */
588         _text_view_button->Enable (!reference && any_subs > 0 && ffmpeg_subs == 0);
589         _fonts_dialog_button->Enable (!reference && any_subs > 0 && ffmpeg_subs == 0 && type == TEXT_OPEN_SUBTITLE);
590         _appearance_dialog_button->Enable (!reference && any_subs > 0 && use && type == TEXT_OPEN_SUBTITLE);
591 }
592
593 void
594 TextPanel::stream_changed ()
595 {
596         FFmpegContentList fc = _parent->selected_ffmpeg ();
597         if (fc.size() != 1) {
598                 return;
599         }
600
601         shared_ptr<FFmpegContent> fcs = fc.front ();
602
603         vector<shared_ptr<FFmpegSubtitleStream> > a = fcs->subtitle_streams ();
604         vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = a.begin ();
605         string const s = string_client_data (_stream->GetClientObject (_stream->GetSelection ()));
606         while (i != a.end() && (*i)->identifier () != s) {
607                 ++i;
608         }
609
610         if (i != a.end ()) {
611                 fcs->set_subtitle_stream (*i);
612         }
613 }
614
615 void
616 TextPanel::x_offset_changed ()
617 {
618         for (auto i: _parent->selected_text ()) {
619                 i->text_of_original_type(_original_type)->set_x_offset (_x_offset->GetValue() / 100.0);
620         }
621 }
622
623 void
624 TextPanel::y_offset_changed ()
625 {
626         for (auto i: _parent->selected_text ()) {
627                 i->text_of_original_type(_original_type)->set_y_offset (_y_offset->GetValue() / 100.0);
628         }
629 }
630
631 void
632 TextPanel::x_scale_changed ()
633 {
634         ContentList c = _parent->selected_text ();
635         if (c.size() == 1) {
636                 c.front()->text_of_original_type(_original_type)->set_x_scale (_x_scale->GetValue() / 100.0);
637         }
638 }
639
640 void
641 TextPanel::y_scale_changed ()
642 {
643         for (auto i: _parent->selected_text ()) {
644                 i->text_of_original_type(_original_type)->set_y_scale (_y_scale->GetValue() / 100.0);
645         }
646 }
647
648 void
649 TextPanel::line_spacing_changed ()
650 {
651         for (auto i: _parent->selected_text ()) {
652                 i->text_of_original_type(_original_type)->set_line_spacing (_line_spacing->GetValue() / 100.0);
653         }
654 }
655
656 void
657 TextPanel::content_selection_changed ()
658 {
659         film_content_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
660         film_content_changed (TextContentProperty::USE);
661         film_content_changed (TextContentProperty::BURN);
662         film_content_changed (TextContentProperty::X_OFFSET);
663         film_content_changed (TextContentProperty::Y_OFFSET);
664         film_content_changed (TextContentProperty::X_SCALE);
665         film_content_changed (TextContentProperty::Y_SCALE);
666         film_content_changed (TextContentProperty::LINE_SPACING);
667         film_content_changed (TextContentProperty::FONTS);
668         film_content_changed (TextContentProperty::TYPE);
669         film_content_changed (TextContentProperty::DCP_TRACK);
670         film_content_changed (DCPContentProperty::REFERENCE_TEXT);
671 }
672
673 void
674 TextPanel::text_view_clicked ()
675 {
676         if (_text_view) {
677                 _text_view->Destroy ();
678                 _text_view = 0;
679         }
680
681         ContentList c = _parent->selected_text ();
682         DCPOMATIC_ASSERT (c.size() == 1);
683
684         shared_ptr<Decoder> decoder = decoder_factory (_parent->film(), c.front(), false, false, shared_ptr<Decoder>());
685
686         if (decoder) {
687                 _text_view = new TextView (this, _parent->film(), c.front(), c.front()->text_of_original_type(_original_type), decoder, _parent->film_viewer());
688                 _text_view->Show ();
689         }
690 }
691
692 void
693 TextPanel::fonts_dialog_clicked ()
694 {
695         if (_fonts_dialog) {
696                 _fonts_dialog->Destroy ();
697                 _fonts_dialog = 0;
698         }
699
700         ContentList c = _parent->selected_text ();
701         DCPOMATIC_ASSERT (c.size() == 1);
702
703         _fonts_dialog = new FontsDialog (this, c.front(), c.front()->text_of_original_type(_original_type));
704         _fonts_dialog->Show ();
705 }
706
707 void
708 TextPanel::reference_clicked ()
709 {
710         ContentList c = _parent->selected ();
711         if (c.size() != 1) {
712                 return;
713         }
714
715         shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
716         if (!d) {
717                 return;
718         }
719
720         d->set_reference_text (_original_type, _reference->GetValue ());
721 }
722
723 void
724 TextPanel::appearance_dialog_clicked ()
725 {
726         ContentList c = _parent->selected_text ();
727         DCPOMATIC_ASSERT (c.size() == 1);
728
729         SubtitleAppearanceDialog* d = new SubtitleAppearanceDialog (this, _parent->film(), c.front(), c.front()->text_of_original_type(_original_type));
730         if (d->ShowModal () == wxID_OK) {
731                 d->apply ();
732         }
733         d->Destroy ();
734 }
735
736
737
738 /** The user has clicked on the outline subtitles check box */
739 void
740 TextPanel::outline_subtitles_changed ()
741 {
742         if (_outline_subtitles->GetValue()) {
743                 _analysis_content = _parent->selected_text().front();
744                 try_to_load_analysis ();
745         } else {
746                 clear_outline_subtitles ();
747         }
748 }
749
750
751 void
752 TextPanel::try_to_load_analysis ()
753 {
754         if (_loading_analysis) {
755                 return;
756         }
757
758         _loading_analysis = true;
759         setup_sensitivity ();
760         _analysis.reset ();
761
762         shared_ptr<Content> content = _analysis_content.lock ();
763         if (!content) {
764                 _loading_analysis = false;
765                 setup_sensitivity ();
766                 return;
767         }
768
769         boost::filesystem::path const path = _parent->film()->subtitle_analysis_path(content);
770
771         if (!boost::filesystem::exists(path)) {
772                 for (auto i: JobManager::instance()->get()) {
773                         if (dynamic_pointer_cast<AnalyseSubtitlesJob>(i)) {
774                                 i->cancel ();
775                         }
776                 }
777
778                 JobManager::instance()->analyse_subtitles (
779                         _parent->film(), content, _analysis_finished_connection, bind(&TextPanel::analysis_finished, this)
780                         );
781                 return;
782         }
783
784         try {
785                 _analysis.reset (new SubtitleAnalysis(path));
786         } catch (OldFormatError& e) {
787                 /* An old analysis file: recreate it */
788                 JobManager::instance()->analyse_subtitles (
789                         _parent->film(), content, _analysis_finished_connection, bind(&TextPanel::analysis_finished, this)
790                         );
791                 return;
792         }
793
794         update_outline_subtitles_in_viewer ();
795         _loading_analysis = false;
796         setup_sensitivity ();
797 }
798
799
800 void
801 TextPanel::update_outline_subtitles_in_viewer ()
802 {
803         shared_ptr<FilmViewer> fv = _parent->film_viewer().lock();
804         if (!fv) {
805                 return;
806         }
807
808         if (_analysis) {
809                 optional<dcpomatic::Rect<double> > rect = _analysis->bounding_box ();
810                 if (rect) {
811                         shared_ptr<Content> content = _analysis_content.lock ();
812                         DCPOMATIC_ASSERT (content);
813                         rect->x += content->text.front()->x_offset();
814                         rect->y += content->text.front()->y_offset();
815                 }
816                 fv->set_outline_subtitles (rect);
817         } else {
818                 fv->set_outline_subtitles (optional<dcpomatic::Rect<double> >());
819         }
820 }
821
822
823 /** Remove any current subtitle outline display */
824 void
825 TextPanel::clear_outline_subtitles ()
826 {
827         _analysis.reset ();
828         update_outline_subtitles_in_viewer ();
829         if (_outline_subtitles) {
830                 _outline_subtitles->SetValue (false);
831         }
832 }
833
834
835 void
836 TextPanel::analysis_finished ()
837 {
838         shared_ptr<Content> content = _analysis_content.lock ();
839         if (!content) {
840                 _loading_analysis = false;
841                 setup_sensitivity ();
842                 return;
843         }
844
845         if (!boost::filesystem::exists(_parent->film()->subtitle_analysis_path(content))) {
846                 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
847                    Give up.
848                 */
849                 error_dialog (_parent->window(), _("Could not analyse subtitles."));
850                 clear_outline_subtitles ();
851                 _loading_analysis = false;
852                 setup_sensitivity ();
853                 return;
854         }
855
856         _loading_analysis = false;
857         try_to_load_analysis ();
858 }
859