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 "lib/text_subtitle_content.h"
  24 #include "lib/subtitle_content.h"
  25 #include "lib/ffmpeg_subtitle_stream.h"
  26 #include "lib/ffmpeg_content.h"
  27 #include <wx/wx.h>
  28 #include <wx/clrpicker.h>
  29 #include <wx/spinctrl.h>
  30 #include <wx/gbsizer.h>
  31
  32 using std::map;
  33 using boost::shared_ptr;
  34 using boost::bind;
  35 using boost::dynamic_pointer_cast;
  36 using boost::optional;
  37
  38 int const SubtitleAppearanceDialog::NONE = 0;
  39 int const SubtitleAppearanceDialog::OUTLINE = 1;
  40 int const SubtitleAppearanceDialog::SHADOW = 2;
  41
  42 SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr<Content> content)
  43         : wxDialog (parent, wxID_ANY, _("Subtitle appearance"))
  44         , _content (content)
  45 {
  46         shared_ptr<FFmpegContent> ff = dynamic_pointer_cast<FFmpegContent> (content);
  47         if (ff) {
  48                 _stream = ff->subtitle_stream ();
  49         }
  50
  51         wxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
  52         SetSizer (overall_sizer);
  53
  54         _table = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
  55
  56         overall_sizer->Add (_table, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  57
  58         int r = 0;
  59
  60         add_label_to_sizer (_table, this, _("Colour"), true, wxGBPosition (r, 0));
  61         {
  62                 wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
  63                 _force_colour = new wxCheckBox (this, wxID_ANY, _("Set to"));
  64                 s->Add (_force_colour, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
  65                 _colour = new wxColourPickerCtrl (this, wxID_ANY);
  66                 s->Add (_colour, 0, wxALIGN_CENTER_VERTICAL);
  67                 _table->Add (s, wxGBPosition (r, 1));
  68         }
  69         ++r;
  70
  71         add_label_to_sizer (_table, this, _("Effect"), true, wxGBPosition (r, 0));
  72         _effect = new wxChoice (this, wxID_ANY);
  73         _table->Add (_effect, wxGBPosition (r, 1));
  74         ++r;
  75
  76         add_label_to_sizer (_table, this, _("Effect colour"), true, wxGBPosition (r, 0));
  77         {
  78                 wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
  79                 _force_effect_colour = new wxCheckBox (this, wxID_ANY, _("Set to"));
  80                 s->Add (_force_effect_colour, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
  81                 _effect_colour = new wxColourPickerCtrl (this, wxID_ANY);
  82                 s->Add (_effect_colour, 0, wxALIGN_CENTER_VERTICAL);
  83                 _table->Add (s, wxGBPosition (r, 1));
  84         }
  85         ++r;
  86
  87         add_label_to_sizer (_table, this, _("Outline width"), true, wxGBPosition (r, 0));
  88         _outline_width = new wxSpinCtrl (this, wxID_ANY);
  89         _table->Add (_outline_width, wxGBPosition (r, 1));
  90         ++r;
  91
  92         add_label_to_sizer (_table, this, _("Fade in time"), true, wxGBPosition (r, 0));
  93         _fade_in = new Timecode<ContentTime> (this);
  94         _table->Add (_fade_in, wxGBPosition (r, 1));
  95         ++r;
  96
  97         add_label_to_sizer (_table, this, _("Fade out time"), true, wxGBPosition (r, 0));
  98         _fade_out = new Timecode<ContentTime> (this);
  99         _table->Add (_fade_out, wxGBPosition (r, 1));
 100         ++r;
 101
 102         if (_stream) {
 103                 wxScrolled<wxPanel>* colours_panel = new wxScrolled<wxPanel> (this);
 104                 colours_panel->EnableScrolling (false, true);
 105                 colours_panel->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_ALWAYS);
 106                 colours_panel->SetScrollRate (0, 16);
 107
 108                 wxFlexGridSizer* table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
 109                 table->AddGrowableCol (1, 1);
 110
 111                 map<RGBA, RGBA> colours = _stream->colours ();
 112
 113                 wxStaticText* t = new wxStaticText (colours_panel, wxID_ANY, "");
 114                 t->SetLabelMarkup (_("<b>Original colour</b>"));
 115                 table->Add (t, 1, wxEXPAND);
 116                 t = new wxStaticText (colours_panel, wxID_ANY, "", wxDefaultPosition, wxDefaultSize, wxALIGN_CENTRE_HORIZONTAL);
 117                 t->SetLabelMarkup (_("<b>New colour</b>"));
 118                 table->Add (t, 1, wxALIGN_CENTER);
 119
 120                 for (map<RGBA, RGBA>::const_iterator i = colours.begin(); i != colours.end(); ++i) {
 121                         wxPanel* from = new wxPanel (colours_panel, wxID_ANY);
 122                         from->SetBackgroundColour (wxColour (i->first.r, i->first.g, i->first.b, i->first.a));
 123                         table->Add (from, 1, wxEXPAND);
 124                         RGBAColourPicker* to = new RGBAColourPicker (colours_panel, i->second);
 125                         table->Add (to, 1, wxEXPAND);
 126                         _pickers[i->first] = to;
 127                 }
 128
 129                 colours_panel->SetSizer (table);
 130
 131                 overall_sizer->Add (colours_panel, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
 132
 133                 wxButton* restore = new wxButton (this, wxID_ANY, _("Restore to original colours"));
 134                 restore->Bind (wxEVT_BUTTON, bind (&SubtitleAppearanceDialog::restore, this));
 135                 overall_sizer->Add (restore, 0, wxALL, DCPOMATIC_SIZER_X_GAP);
 136         }
 137
 138         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
 139         if (buttons) {
 140                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 141         }
 142
 143         overall_sizer->Layout ();
 144         overall_sizer->SetSizeHints (this);
 145
 146         /* Keep these Appends() up to date with NONE/OUTLINE/SHADOW variables */
 147         _effect->Append (_("None"));
 148         _effect->Append (_("Outline"));
 149         _effect->Append (_("Shadow"));;
 150
 151         optional<dcp::Colour> colour = _content->subtitle->colour();
 152         if (colour) {
 153                 _force_colour->SetValue (true);
 154                 _colour->SetColour (wxColour (colour->r, colour->g, colour->b));
 155         } else {
 156                 _force_colour->SetValue (false);
 157                 _colour->SetColour (wxColour (255, 255, 255));
 158         }
 159
 160         switch (_content->subtitle->effect()) {
 161         case dcp::NONE:
 162                 _effect->SetSelection (NONE);
 163                 break;
 164         case dcp::BORDER:
 165                 _effect->SetSelection (OUTLINE);
 166                 break;
 167         case dcp::SHADOW:
 168                 _effect->SetSelection (SHADOW);
 169                 break;
 170         }
 171
 172         optional<dcp::Colour> effect_colour = _content->subtitle->effect_colour();
 173         if (effect_colour) {
 174                 _force_effect_colour->SetValue (true);
 175                 _effect_colour->SetColour (wxColour (effect_colour->r, effect_colour->g, effect_colour->b));
 176         } else {
 177                 _force_effect_colour->SetValue (false);
 178                 _effect_colour->SetColour (wxColour (0, 0, 0));
 179         }
 180
 181         _fade_in->set (_content->subtitle->fade_in(), _content->active_video_frame_rate ());
 182         _fade_out->set (_content->subtitle->fade_out(), _content->active_video_frame_rate ());
 183         _outline_width->SetValue (_content->subtitle->outline_width ());
 184
 185         _force_colour->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 186         _force_effect_colour->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 187         _effect->Bind (wxEVT_CHOICE, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 188         _content_connection = _content->Changed.connect (bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 189
 190         setup_sensitivity ();
 191 }
 192
 193 void
 194 SubtitleAppearanceDialog::apply ()
 195 {
 196         if (_force_colour->GetValue ()) {
 197                 wxColour const c = _colour->GetColour ();
 198                 _content->subtitle->set_colour (dcp::Colour (c.Red(), c.Green(), c.Blue()));
 199         } else {
 200                 _content->subtitle->unset_colour ();
 201         }
 202         switch (_effect->GetSelection()) {
 203         case NONE:
 204                 _content->subtitle->set_effect (dcp::NONE);
 205                 break;
 206         case OUTLINE:
 207                 _content->subtitle->set_effect (dcp::BORDER);
 208                 break;
 209         case SHADOW:
 210                 _content->subtitle->set_effect (dcp::SHADOW);
 211                 break;
 212         }
 213         if (_force_effect_colour->GetValue ()) {
 214                 wxColour const ec = _effect_colour->GetColour ();
 215                 _content->subtitle->set_effect_colour (dcp::Colour (ec.Red(), ec.Green(), ec.Blue()));
 216         } else {
 217                 _content->subtitle->unset_effect_colour ();
 218         }
 219         _content->subtitle->set_fade_in (_fade_in->get (_content->active_video_frame_rate ()));
 220         _content->subtitle->set_fade_out (_fade_out->get (_content->active_video_frame_rate ()));
 221         _content->subtitle->set_outline_width (_outline_width->GetValue ());
 222
 223         if (_stream) {
 224                 for (map<RGBA, RGBAColourPicker*>::const_iterator i = _pickers.begin(); i != _pickers.end(); ++i) {
 225                         _stream->set_colour (i->first, i->second->colour ());
 226                 }
 227         }
 228
 229         shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (_content);
 230         if (fc) {
 231                 fc->signal_subtitle_stream_changed ();
 232         }
 233 }
 234
 235 void
 236 SubtitleAppearanceDialog::restore ()
 237 {
 238         for (map<RGBA, RGBAColourPicker*>::const_iterator i = _pickers.begin(); i != _pickers.end(); ++i) {
 239                 i->second->set (i->first);
 240         }
 241 }
 242
 243 void
 244 SubtitleAppearanceDialog::setup_sensitivity ()
 245 {
 246         _colour->Enable (_force_colour->GetValue ());
 247         _effect_colour->Enable (_force_effect_colour->GetValue ());
 248
 249         bool const can_outline_width = _effect->GetSelection() == OUTLINE && _content->subtitle->burn ();
 250         _outline_width->Enable (can_outline_width);
 251         if (can_outline_width) {
 252                 _outline_width->UnsetToolTip ();
 253         } else {
 254                 _outline_width->SetToolTip (_("Outline width cannot be set unless you are burning in subtitles"));
 255         }
 256 }