src/wx/subtitle_appearance_dialog.cc

   1 /*
   2     Copyright (C) 2015-2018 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 "subtitle_appearance_dialog.h"
  22 #include "rgba_colour_picker.h"
  23 #include "static_text.h"
  24 #include "check_box.h"
  25 #include "dcpomatic_button.h"
  26 #include "lib/string_text_file_content.h"
  27 #include "lib/text_content.h"
  28 #include "lib/ffmpeg_subtitle_stream.h"
  29 #include "lib/ffmpeg_content.h"
  30 #include "lib/examine_ffmpeg_subtitles_job.h"
  31 #include "lib/job_manager.h"
  32 #include <wx/wx.h>
  33 #include <wx/clrpicker.h>
  34 #include <wx/spinctrl.h>
  35 #include <wx/gbsizer.h>
  36
  37 using std::map;
  38 using std::string;
  39 using boost::shared_ptr;
  40 using boost::bind;
  41 using boost::dynamic_pointer_cast;
  42 using boost::optional;
  43 using namespace dcpomatic;
  44
  45 int const SubtitleAppearanceDialog::NONE = 0;
  46 int const SubtitleAppearanceDialog::OUTLINE = 1;
  47 int const SubtitleAppearanceDialog::SHADOW = 2;
  48
  49 SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr<const Film> film, shared_ptr<Content> content, shared_ptr<TextContent> caption)
  50         : wxDialog (parent, wxID_ANY, _("Caption appearance"))
  51         , _film (film)
  52         , _finding (0)
  53         , _content (content)
  54         , _caption (caption)
  55 {
  56         shared_ptr<FFmpegContent> ff = dynamic_pointer_cast<FFmpegContent> (content);
  57         if (ff) {
  58                 _stream = ff->subtitle_stream ();
  59                 /* XXX: assuming that all FFmpeg streams have bitmap subs */
  60                 if (_stream->colours().empty()) {
  61                         _job_manager_connection = JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&SubtitleAppearanceDialog::active_jobs_changed, this, _1));
  62                         _job = JobManager::instance()->add(shared_ptr<Job>(new ExamineFFmpegSubtitlesJob(film, ff)));
  63                 }
  64         }
  65
  66         _overall_sizer = new wxBoxSizer (wxVERTICAL);
  67         SetSizer (_overall_sizer);
  68
  69         _table = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
  70
  71         _overall_sizer->Add (_table, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  72
  73         int r = 0;
  74
  75         add_label_to_sizer (_table, this, _("Colour"), true, wxGBPosition (r, 0));
  76         _force_colour = set_to (_colour = new wxColourPickerCtrl (this, wxID_ANY), r);
  77
  78         add_label_to_sizer (_table, this, _("Effect"), true, wxGBPosition (r, 0));
  79         _force_effect = set_to (_effect = new wxChoice (this, wxID_ANY), r);
  80
  81         add_label_to_sizer (_table, this, _("Effect colour"), true, wxGBPosition (r, 0));
  82         _force_effect_colour = set_to (_effect_colour = new wxColourPickerCtrl (this, wxID_ANY), r);
  83
  84         add_label_to_sizer (_table, this, _("Outline width"), true, wxGBPosition (r, 0));
  85         _outline_width = new wxSpinCtrl (this, wxID_ANY);
  86         _table->Add (_outline_width, wxGBPosition (r, 1));
  87         ++r;
  88
  89         add_label_to_sizer (_table, this, _("Fade in time"), true, wxGBPosition (r, 0));
  90         _force_fade_in = set_to (_fade_in = new Timecode<ContentTime> (this), r);
  91
  92         add_label_to_sizer (_table, this, _("Fade out time"), true, wxGBPosition (r, 0));
  93         _force_fade_out = set_to (_fade_out = new Timecode<ContentTime> (this), r);
  94
  95         if (_stream) {
  96                 _colours_panel = new wxScrolled<wxPanel> (this);
  97                 _colours_panel->EnableScrolling (false, true);
  98                 _colours_panel->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_ALWAYS);
  99                 _colours_panel->SetScrollRate (0, 16);
 100
 101                 _colour_table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
 102                 _colour_table->AddGrowableCol (1, 1);
 103
 104                 wxStaticText* t = new StaticText (_colours_panel, "");
 105                 t->SetLabelMarkup (_("<b>Original colour</b>"));
 106                 _colour_table->Add (t, 1, wxEXPAND);
 107                 t = new StaticText (_colours_panel, "", wxDefaultPosition, wxDefaultSize, wxALIGN_CENTRE_HORIZONTAL);
 108                 t->SetLabelMarkup (_("<b>New colour</b>"));
 109                 _colour_table->Add (t, 1, wxALIGN_CENTER);
 110
 111                 shared_ptr<Job> job = _job.lock ();
 112                 if (!job || job->finished()) {
 113                         add_colours ();
 114                 }
 115
 116                 _colours_panel->SetSizer (_colour_table);
 117
 118                 /* XXX: still assuming that all FFmpeg streams have bitmap subs */
 119                 if (_stream->colours().empty()) {
 120                         _finding = new wxStaticText(this, wxID_ANY, _("Finding the colours in these subtitles..."));
 121                         _overall_sizer->Add (_finding, 0, wxALL, DCPOMATIC_DIALOG_BORDER);
 122                         _colours_panel->Show (false);
 123                 }
 124
 125                 _overall_sizer->Add (_colours_panel, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
 126
 127                 wxButton* restore = new Button (this, _("Restore to original colours"));
 128                 restore->Bind (wxEVT_BUTTON, bind (&SubtitleAppearanceDialog::restore, this));
 129                 _overall_sizer->Add (restore, 0, wxALL, DCPOMATIC_SIZER_X_GAP);
 130         }
 131
 132         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
 133         if (buttons) {
 134                 _overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 135         }
 136
 137         _overall_sizer->Layout ();
 138         _overall_sizer->SetSizeHints (this);
 139
 140         /* Keep these Appends() up to date with NONE/OUTLINE/SHADOW variables */
 141         _effect->Append (_("None"));
 142         _effect->Append (_("Outline"));
 143         _effect->Append (_("Shadow"));;
 144
 145         optional<dcp::Colour> colour = _caption->colour();
 146         _force_colour->SetValue (static_cast<bool>(colour));
 147         if (colour) {
 148                 _colour->SetColour (wxColour (colour->r, colour->g, colour->b));
 149         } else {
 150                 _colour->SetColour (wxColour (255, 255, 255));
 151         }
 152
 153         optional<dcp::Effect> effect = _caption->effect();
 154         _force_effect->SetValue (static_cast<bool>(effect));
 155         if (effect) {
 156                 switch (*effect) {
 157                 case dcp::NONE:
 158                         _effect->SetSelection (NONE);
 159                         break;
 160                 case dcp::BORDER:
 161                         _effect->SetSelection (OUTLINE);
 162                         break;
 163                 case dcp::SHADOW:
 164                         _effect->SetSelection (SHADOW);
 165                         break;
 166                 }
 167         } else {
 168                 _effect->SetSelection (NONE);
 169         }
 170
 171         optional<dcp::Colour> effect_colour = _caption->effect_colour();
 172         _force_effect_colour->SetValue (static_cast<bool>(effect_colour));
 173         if (effect_colour) {
 174                 _effect_colour->SetColour (wxColour (effect_colour->r, effect_colour->g, effect_colour->b));
 175         } else {
 176                 _effect_colour->SetColour (wxColour (0, 0, 0));
 177         }
 178
 179         optional<ContentTime> fade_in = _caption->fade_in();
 180         _force_fade_in->SetValue (static_cast<bool>(fade_in));
 181         if (fade_in) {
 182                 _fade_in->set (*fade_in, _content->active_video_frame_rate(film));
 183         } else {
 184                 _fade_in->set (ContentTime(), _content->active_video_frame_rate(film));
 185         }
 186
 187         optional<ContentTime> fade_out = _caption->fade_out();
 188         _force_fade_out->SetValue (static_cast<bool>(fade_out));
 189         if (fade_out) {
 190                 _fade_out->set (*fade_out, _content->active_video_frame_rate(film));
 191         } else {
 192                 _fade_out->set (ContentTime(), _content->active_video_frame_rate(film));
 193         }
 194
 195         _outline_width->SetValue (_caption->outline_width ());
 196
 197         _force_colour->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 198         _force_effect_colour->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 199         _force_effect->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 200         _force_fade_in->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 201         _force_fade_out->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 202         _effect->Bind (wxEVT_CHOICE, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 203         _content_connection = _content->Change.connect (bind (&SubtitleAppearanceDialog::content_change, this, _1));
 204
 205         setup_sensitivity ();
 206 }
 207
 208 void
 209 SubtitleAppearanceDialog::content_change (ChangeType type)
 210 {
 211         if (type == CHANGE_TYPE_DONE) {
 212                 setup_sensitivity ();
 213         }
 214 }
 215
 216 wxCheckBox*
 217 SubtitleAppearanceDialog::set_to (wxWindow* w, int& r)
 218 {
 219         wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
 220         wxCheckBox* set_to = new CheckBox (this, _("Set to"));
 221         s->Add (set_to, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
 222         s->Add (w, 0, wxALIGN_CENTER_VERTICAL);
 223         _table->Add (s, wxGBPosition (r, 1));
 224         ++r;
 225         return set_to;
 226 }
 227
 228 void
 229 SubtitleAppearanceDialog::apply ()
 230 {
 231         shared_ptr<const Film> film = _film.lock ();
 232
 233         if (_force_colour->GetValue ()) {
 234                 wxColour const c = _colour->GetColour ();
 235                 _caption->set_colour (dcp::Colour (c.Red(), c.Green(), c.Blue()));
 236         } else {
 237                 _caption->unset_colour ();
 238         }
 239         if (_force_effect->GetValue()) {
 240                 switch (_effect->GetSelection()) {
 241                 case NONE:
 242                         _caption->set_effect (dcp::NONE);
 243                         break;
 244                 case OUTLINE:
 245                         _caption->set_effect (dcp::BORDER);
 246                         break;
 247                 case SHADOW:
 248                         _caption->set_effect (dcp::SHADOW);
 249                         break;
 250                 }
 251         } else {
 252                 _caption->unset_effect ();
 253         }
 254         if (_force_effect_colour->GetValue ()) {
 255                 wxColour const ec = _effect_colour->GetColour ();
 256                 _caption->set_effect_colour (dcp::Colour (ec.Red(), ec.Green(), ec.Blue()));
 257         } else {
 258                 _caption->unset_effect_colour ();
 259         }
 260         if (_force_fade_in->GetValue ()) {
 261                 _caption->set_fade_in (_fade_in->get(_content->active_video_frame_rate(film)));
 262         } else {
 263                 _caption->unset_fade_in ();
 264         }
 265         if (_force_fade_out->GetValue ()) {
 266                 _caption->set_fade_out (_fade_out->get(_content->active_video_frame_rate(film)));
 267         } else {
 268                 _caption->unset_fade_out ();
 269         }
 270         _caption->set_outline_width (_outline_width->GetValue ());
 271
 272         if (_stream) {
 273                 for (map<RGBA, RGBAColourPicker*>::const_iterator i = _pickers.begin(); i != _pickers.end(); ++i) {
 274                         _stream->set_colour (i->first, i->second->colour ());
 275                 }
 276         }
 277
 278         shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (_content);
 279         if (fc) {
 280                 fc->signal_subtitle_stream_changed ();
 281         }
 282 }
 283
 284 void
 285 SubtitleAppearanceDialog::restore ()
 286 {
 287         for (map<RGBA, RGBAColourPicker*>::const_iterator i = _pickers.begin(); i != _pickers.end(); ++i) {
 288                 i->second->set (i->first);
 289         }
 290 }
 291
 292 void
 293 SubtitleAppearanceDialog::setup_sensitivity ()
 294 {
 295         _colour->Enable (_force_colour->GetValue ());
 296         _effect_colour->Enable (_force_effect_colour->GetValue ());
 297         _effect->Enable (_force_effect->GetValue ());
 298         _fade_in->Enable (_force_fade_in->GetValue ());
 299         _fade_out->Enable (_force_fade_out->GetValue ());
 300
 301         bool const can_outline_width = _effect->GetSelection() == OUTLINE && _caption->burn ();
 302         _outline_width->Enable (can_outline_width);
 303         if (can_outline_width) {
 304                 _outline_width->UnsetToolTip ();
 305         } else {
 306                 _outline_width->SetToolTip (_("Outline width cannot be set unless you are burning in captions"));
 307         }
 308 }
 309
 310 void
 311 SubtitleAppearanceDialog::active_jobs_changed (optional<string> last)
 312 {
 313         if (last && *last == "examine_subtitles") {
 314                 _colours_panel->Show (true);
 315                 if (_finding) {
 316                         _finding->Show (false);
 317                 }
 318                 add_colours ();
 319                 _overall_sizer->Layout ();
 320                 _overall_sizer->SetSizeHints (this);
 321         }
 322 }
 323
 324 void
 325 SubtitleAppearanceDialog::add_colours ()
 326 {
 327         map<RGBA, RGBA> colours = _stream->colours ();
 328         for (map<RGBA, RGBA>::const_iterator i = colours.begin(); i != colours.end(); ++i) {
 329                 wxPanel* from = new wxPanel (_colours_panel, wxID_ANY);
 330                 from->SetBackgroundColour (wxColour (i->first.r, i->first.g, i->first.b, i->first.a));
 331                 _colour_table->Add (from, 1, wxEXPAND);
 332                 RGBAColourPicker* to = new RGBAColourPicker (_colours_panel, i->second);
 333                 _colour_table->Add (to, 1, wxEXPAND);
 334                 _pickers[i->first] = to;
 335         }
 336 }