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