2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "subtitle_panel.h"
22 #include "film_editor.h"
24 #include "subtitle_view.h"
25 #include "content_panel.h"
26 #include "fonts_dialog.h"
27 #include "subtitle_appearance_dialog.h"
28 #include "lib/ffmpeg_content.h"
29 #include "lib/text_subtitle_content.h"
30 #include "lib/ffmpeg_subtitle_stream.h"
31 #include "lib/dcp_subtitle_content.h"
32 #include "lib/text_subtitle_decoder.h"
33 #include "lib/dcp_subtitle_decoder.h"
34 #include "lib/dcp_content.h"
35 #include "lib/subtitle_content.h"
36 #include "lib/decoder_factory.h"
37 #include <wx/spinctrl.h>
38 #include <boost/foreach.hpp>
43 using boost::shared_ptr;
44 using boost::dynamic_pointer_cast;
46 SubtitlePanel::SubtitlePanel (ContentPanel* p)
47 : ContentSubPanel (p, _("Subtitles"))
51 wxGridBagSizer* grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
52 _sizer->Add (grid, 0, wxALL, 8);
55 _reference = new wxCheckBox (this, wxID_ANY, _("Refer to existing DCP"));
56 grid->Add (_reference, wxGBPosition (r, 0), wxGBSpan (1, 2));
59 _use = new wxCheckBox (this, wxID_ANY, _("Use subtitles"));
60 grid->Add (_use, wxGBPosition (r, 0), wxGBSpan (1, 2));
63 _burn = new wxCheckBox (this, wxID_ANY, _("Burn subtitles into image"));
64 grid->Add (_burn, wxGBPosition (r, 0), wxGBSpan (1, 2));
68 add_label_to_sizer (grid, this, _("X Offset"), true, wxGBPosition (r, 0));
69 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
70 _x_offset = new wxSpinCtrl (this);
72 add_label_to_sizer (s, this, _("%"), false);
73 grid->Add (s, wxGBPosition (r, 1));
78 add_label_to_sizer (grid, this, _("Y Offset"), true, wxGBPosition (r, 0));
79 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
80 _y_offset = new wxSpinCtrl (this);
82 add_label_to_sizer (s, this, _("%"), false);
83 grid->Add (s, wxGBPosition (r, 1));
88 add_label_to_sizer (grid, this, _("X Scale"), true, wxGBPosition (r, 0));
89 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
90 _x_scale = new wxSpinCtrl (this);
92 add_label_to_sizer (s, this, _("%"), false);
93 grid->Add (s, wxGBPosition (r, 1));
98 add_label_to_sizer (grid, this, _("Y Scale"), true, wxGBPosition (r, 0));
99 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
100 _y_scale = new wxSpinCtrl (this);
102 add_label_to_sizer (s, this, _("%"), false);
103 grid->Add (s, wxGBPosition (r, 1));
108 add_label_to_sizer (grid, this, _("Line spacing"), true, wxGBPosition (r, 0));
109 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
110 _line_spacing = new wxSpinCtrl (this);
111 s->Add (_line_spacing);
112 add_label_to_sizer (s, this, _("%"), false);
113 grid->Add (s, wxGBPosition (r, 1));
117 add_label_to_sizer (grid, this, _("Language"), true, wxGBPosition (r, 0));
118 _language = new wxTextCtrl (this, wxID_ANY);
119 grid->Add (_language, wxGBPosition (r, 1));
122 add_label_to_sizer (grid, this, _("Stream"), true, wxGBPosition (r, 0));
123 _stream = new wxChoice (this, wxID_ANY);
124 grid->Add (_stream, wxGBPosition (r, 1));
128 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
130 _subtitle_view_button = new wxButton (this, wxID_ANY, _("View..."));
131 s->Add (_subtitle_view_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
132 _fonts_dialog_button = new wxButton (this, wxID_ANY, _("Fonts..."));
133 s->Add (_fonts_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
134 _appearance_dialog_button = new wxButton (this, wxID_ANY, _("Appearance..."));
135 s->Add (_appearance_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
137 grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
141 _x_offset->SetRange (-100, 100);
142 _y_offset->SetRange (-100, 100);
143 _x_scale->SetRange (10, 1000);
144 _y_scale->SetRange (10, 1000);
145 _line_spacing->SetRange (10, 1000);
147 _reference->Bind (wxEVT_CHECKBOX, boost::bind (&SubtitlePanel::reference_clicked, this));
148 _use->Bind (wxEVT_CHECKBOX, boost::bind (&SubtitlePanel::use_toggled, this));
149 _burn->Bind (wxEVT_CHECKBOX, boost::bind (&SubtitlePanel::burn_toggled, this));
150 _x_offset->Bind (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::x_offset_changed, this));
151 _y_offset->Bind (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::y_offset_changed, this));
152 _x_scale->Bind (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::x_scale_changed, this));
153 _y_scale->Bind (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::y_scale_changed, this));
154 _line_spacing->Bind (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::line_spacing_changed, this));
155 _language->Bind (wxEVT_TEXT, boost::bind (&SubtitlePanel::language_changed, this));
156 _stream->Bind (wxEVT_CHOICE, boost::bind (&SubtitlePanel::stream_changed, this));
157 _subtitle_view_button->Bind (wxEVT_BUTTON, boost::bind (&SubtitlePanel::subtitle_view_clicked, this));
158 _fonts_dialog_button->Bind (wxEVT_BUTTON, boost::bind (&SubtitlePanel::fonts_dialog_clicked, this));
159 _appearance_dialog_button->Bind (wxEVT_BUTTON, boost::bind (&SubtitlePanel::appearance_dialog_clicked, this));
163 SubtitlePanel::film_changed (Film::Property property)
165 if (property == Film::CONTENT || property == Film::REEL_TYPE) {
166 setup_sensitivity ();
171 SubtitlePanel::film_content_changed (int property)
173 FFmpegContentList fc = _parent->selected_ffmpeg ();
174 ContentList sc = _parent->selected_subtitle ();
176 shared_ptr<FFmpegContent> fcs;
177 if (fc.size() == 1) {
181 shared_ptr<Content> scs;
182 if (sc.size() == 1) {
186 if (property == FFmpegContentProperty::SUBTITLE_STREAMS) {
189 vector<shared_ptr<FFmpegSubtitleStream> > s = fcs->subtitle_streams ();
190 for (vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = s.begin(); i != s.end(); ++i) {
191 _stream->Append (std_to_wx ((*i)->name), new wxStringClientData (std_to_wx ((*i)->identifier ())));
194 if (fcs->subtitle_stream()) {
195 checked_set (_stream, fcs->subtitle_stream()->identifier ());
197 _stream->SetSelection (wxNOT_FOUND);
200 setup_sensitivity ();
201 } else if (property == SubtitleContentProperty::USE) {
202 checked_set (_use, scs ? scs->subtitle->use() : false);
203 setup_sensitivity ();
204 } else if (property == SubtitleContentProperty::BURN) {
205 checked_set (_burn, scs ? scs->subtitle->burn() : false);
206 } else if (property == SubtitleContentProperty::X_OFFSET) {
207 checked_set (_x_offset, scs ? lrint (scs->subtitle->x_offset() * 100) : 0);
208 } else if (property == SubtitleContentProperty::Y_OFFSET) {
209 checked_set (_y_offset, scs ? lrint (scs->subtitle->y_offset() * 100) : 0);
210 } else if (property == SubtitleContentProperty::X_SCALE) {
211 checked_set (_x_scale, scs ? lrint (scs->subtitle->x_scale() * 100) : 100);
212 } else if (property == SubtitleContentProperty::Y_SCALE) {
213 checked_set (_y_scale, scs ? lrint (scs->subtitle->y_scale() * 100) : 100);
214 } else if (property == SubtitleContentProperty::LINE_SPACING) {
215 checked_set (_line_spacing, scs ? lrint (scs->subtitle->line_spacing() * 100) : 100);
216 } else if (property == SubtitleContentProperty::LANGUAGE) {
217 checked_set (_language, scs ? scs->subtitle->language() : "");
218 } else if (property == DCPContentProperty::REFERENCE_SUBTITLE) {
220 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (scs);
221 checked_set (_reference, dcp ? dcp->reference_subtitle () : false);
223 checked_set (_reference, false);
226 setup_sensitivity ();
227 } else if (property == DCPContentProperty::HAS_SUBTITLES) {
228 setup_sensitivity ();
233 SubtitlePanel::use_toggled ()
235 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
236 i->subtitle->set_use (_use->GetValue());
241 SubtitlePanel::burn_toggled ()
243 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
244 i->subtitle->set_burn (_burn->GetValue());
249 SubtitlePanel::setup_sensitivity ()
253 ContentList sel = _parent->selected_subtitle ();
254 BOOST_FOREACH (shared_ptr<Content> i, sel) {
255 /* These are the content types that could include subtitles */
256 shared_ptr<const FFmpegContent> fc = boost::dynamic_pointer_cast<const FFmpegContent> (i);
257 shared_ptr<const TextSubtitleContent> sc = boost::dynamic_pointer_cast<const TextSubtitleContent> (i);
258 shared_ptr<const DCPContent> dc = boost::dynamic_pointer_cast<const DCPContent> (i);
259 shared_ptr<const DCPSubtitleContent> dsc = boost::dynamic_pointer_cast<const DCPSubtitleContent> (i);
265 } else if (sc || dc || dsc) {
266 /* XXX: in the future there could be bitmap subs from DCPs */
271 /* Decide whether we can reference these subs */
273 shared_ptr<DCPContent> dcp;
274 if (sel.size() == 1) {
275 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
278 list<string> why_not;
279 bool const can_reference = dcp && dcp->can_reference_subtitle (why_not);
280 setup_refer_button (_reference, dcp, can_reference, why_not);
282 bool const reference = _reference->GetValue ();
284 /* Set up sensitivity */
285 _use->Enable (!reference && any_subs > 0);
286 bool const use = _use->GetValue ();
287 _burn->Enable (!reference && any_subs > 0 && use);
288 _x_offset->Enable (!reference && any_subs > 0 && use);
289 _y_offset->Enable (!reference && any_subs > 0 && use);
290 _x_scale->Enable (!reference && any_subs > 0 && use);
291 _y_scale->Enable (!reference && any_subs > 0 && use);
292 _line_spacing->Enable (!reference && use);
293 _language->Enable (!reference && any_subs > 0 && use);
294 _stream->Enable (!reference && ffmpeg_subs == 1);
295 _subtitle_view_button->Enable (!reference);
296 _fonts_dialog_button->Enable (!reference);
297 _appearance_dialog_button->Enable (!reference && any_subs > 0 && use);
301 SubtitlePanel::stream_changed ()
303 FFmpegContentList fc = _parent->selected_ffmpeg ();
304 if (fc.size() != 1) {
308 shared_ptr<FFmpegContent> fcs = fc.front ();
310 vector<shared_ptr<FFmpegSubtitleStream> > a = fcs->subtitle_streams ();
311 vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = a.begin ();
312 string const s = string_client_data (_stream->GetClientObject (_stream->GetSelection ()));
313 while (i != a.end() && (*i)->identifier () != s) {
318 fcs->set_subtitle_stream (*i);
323 SubtitlePanel::x_offset_changed ()
325 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
326 i->subtitle->set_x_offset (_x_offset->GetValue() / 100.0);
331 SubtitlePanel::y_offset_changed ()
333 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
334 i->subtitle->set_y_offset (_y_offset->GetValue() / 100.0);
339 SubtitlePanel::x_scale_changed ()
341 ContentList c = _parent->selected_subtitle ();
343 c.front()->subtitle->set_x_scale (_x_scale->GetValue() / 100.0);
348 SubtitlePanel::y_scale_changed ()
350 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
351 i->subtitle->set_y_scale (_y_scale->GetValue() / 100.0);
356 SubtitlePanel::line_spacing_changed ()
358 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
359 i->subtitle->set_line_spacing (_line_spacing->GetValue() / 100.0);
364 SubtitlePanel::language_changed ()
366 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
367 i->subtitle->set_language (wx_to_std (_language->GetValue()));
372 SubtitlePanel::content_selection_changed ()
374 film_content_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
375 film_content_changed (SubtitleContentProperty::USE);
376 film_content_changed (SubtitleContentProperty::BURN);
377 film_content_changed (SubtitleContentProperty::X_OFFSET);
378 film_content_changed (SubtitleContentProperty::Y_OFFSET);
379 film_content_changed (SubtitleContentProperty::X_SCALE);
380 film_content_changed (SubtitleContentProperty::Y_SCALE);
381 film_content_changed (SubtitleContentProperty::LINE_SPACING);
382 film_content_changed (SubtitleContentProperty::LANGUAGE);
383 film_content_changed (SubtitleContentProperty::FONTS);
384 film_content_changed (DCPContentProperty::REFERENCE_SUBTITLE);
388 SubtitlePanel::subtitle_view_clicked ()
390 if (_subtitle_view) {
391 _subtitle_view->Destroy ();
395 ContentList c = _parent->selected_subtitle ();
396 DCPOMATIC_ASSERT (c.size() == 1);
398 shared_ptr<Decoder> decoder = decoder_factory (c.front(), _parent->film()->log());
401 _subtitle_view = new SubtitleView (this, _parent->film(), decoder, c.front()->position ());
402 _subtitle_view->Show ();
407 SubtitlePanel::fonts_dialog_clicked ()
410 _fonts_dialog->Destroy ();
414 ContentList c = _parent->selected_subtitle ();
415 DCPOMATIC_ASSERT (c.size() == 1);
417 _fonts_dialog = new FontsDialog (this, c.front ());
418 _fonts_dialog->Show ();
422 SubtitlePanel::reference_clicked ()
424 ContentList c = _parent->selected ();
429 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
434 d->set_reference_subtitle (_reference->GetValue ());
438 SubtitlePanel::appearance_dialog_clicked ()
440 ContentList c = _parent->selected_subtitle ();
441 DCPOMATIC_ASSERT (c.size() == 1);
443 SubtitleAppearanceDialog* d = new SubtitleAppearanceDialog (this, c.front());
444 if (d->ShowModal () == wxID_OK) {