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 "text_subtitle_appearance_dialog.h"
28 #include "image_subtitle_colour_dialog.h"
29 #include "lib/ffmpeg_content.h"
30 #include "lib/text_subtitle_content.h"
31 #include "lib/ffmpeg_subtitle_stream.h"
32 #include "lib/dcp_subtitle_content.h"
33 #include "lib/text_subtitle_decoder.h"
34 #include "lib/dcp_subtitle_decoder.h"
35 #include "lib/dcp_content.h"
36 #include "lib/subtitle_content.h"
37 #include "lib/decoder_factory.h"
38 #include <wx/spinctrl.h>
39 #include <boost/foreach.hpp>
44 using boost::shared_ptr;
45 using boost::dynamic_pointer_cast;
47 SubtitlePanel::SubtitlePanel (ContentPanel* p)
48 : ContentSubPanel (p, _("Subtitles"))
52 wxGridBagSizer* grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
53 _sizer->Add (grid, 0, wxALL, 8);
56 _reference = new wxCheckBox (this, wxID_ANY, _("Refer to existing DCP"));
57 grid->Add (_reference, wxGBPosition (r, 0), wxGBSpan (1, 2));
60 _use = new wxCheckBox (this, wxID_ANY, _("Use subtitles"));
61 grid->Add (_use, wxGBPosition (r, 0), wxGBSpan (1, 2));
64 _burn = new wxCheckBox (this, wxID_ANY, _("Burn subtitles into image"));
65 grid->Add (_burn, wxGBPosition (r, 0), wxGBSpan (1, 2));
69 add_label_to_sizer (grid, this, _("X Offset"), true, wxGBPosition (r, 0));
70 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
71 _x_offset = new wxSpinCtrl (this);
73 add_label_to_sizer (s, this, _("%"), false);
74 grid->Add (s, wxGBPosition (r, 1));
79 add_label_to_sizer (grid, this, _("Y Offset"), true, wxGBPosition (r, 0));
80 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
81 _y_offset = new wxSpinCtrl (this);
83 add_label_to_sizer (s, this, _("%"), false);
84 grid->Add (s, wxGBPosition (r, 1));
89 add_label_to_sizer (grid, this, _("X Scale"), true, wxGBPosition (r, 0));
90 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
91 _x_scale = new wxSpinCtrl (this);
93 add_label_to_sizer (s, this, _("%"), false);
94 grid->Add (s, wxGBPosition (r, 1));
99 add_label_to_sizer (grid, this, _("Y Scale"), true, wxGBPosition (r, 0));
100 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
101 _y_scale = new wxSpinCtrl (this);
103 add_label_to_sizer (s, this, _("%"), false);
104 grid->Add (s, wxGBPosition (r, 1));
109 add_label_to_sizer (grid, this, _("Line spacing"), true, wxGBPosition (r, 0));
110 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
111 _line_spacing = new wxSpinCtrl (this);
112 s->Add (_line_spacing);
113 add_label_to_sizer (s, this, _("%"), false);
114 grid->Add (s, wxGBPosition (r, 1));
118 add_label_to_sizer (grid, this, _("Language"), true, wxGBPosition (r, 0));
119 _language = new wxTextCtrl (this, wxID_ANY);
120 grid->Add (_language, wxGBPosition (r, 1));
123 add_label_to_sizer (grid, this, _("Stream"), true, wxGBPosition (r, 0));
124 _stream = new wxChoice (this, wxID_ANY);
125 grid->Add (_stream, wxGBPosition (r, 1));
129 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
131 _subtitle_view_button = new wxButton (this, wxID_ANY, _("View..."));
132 s->Add (_subtitle_view_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
133 _fonts_dialog_button = new wxButton (this, wxID_ANY, _("Fonts..."));
134 s->Add (_fonts_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
135 _appearance_dialog_button = new wxButton (this, wxID_ANY, _("Appearance..."));
136 s->Add (_appearance_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
138 grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
142 _x_offset->SetRange (-100, 100);
143 _y_offset->SetRange (-100, 100);
144 _x_scale->SetRange (10, 1000);
145 _y_scale->SetRange (10, 1000);
146 _line_spacing->SetRange (10, 1000);
148 _reference->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::reference_clicked, this));
149 _use->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::use_toggled, this));
150 _burn->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::burn_toggled, this));
151 _x_offset->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::x_offset_changed, this));
152 _y_offset->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::y_offset_changed, this));
153 _x_scale->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::x_scale_changed, this));
154 _y_scale->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::y_scale_changed, this));
155 _line_spacing->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::line_spacing_changed, this));
156 _language->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&SubtitlePanel::language_changed, this));
157 _stream->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&SubtitlePanel::stream_changed, this));
158 _subtitle_view_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&SubtitlePanel::subtitle_view_clicked, this));
159 _fonts_dialog_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&SubtitlePanel::fonts_dialog_clicked, this));
160 _appearance_dialog_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&SubtitlePanel::appearance_dialog_clicked, this));
164 SubtitlePanel::film_changed (Film::Property property)
166 if (property == Film::CONTENT || property == Film::REEL_TYPE) {
167 setup_sensitivity ();
172 SubtitlePanel::film_content_changed (int property)
174 FFmpegContentList fc = _parent->selected_ffmpeg ();
175 ContentList sc = _parent->selected_subtitle ();
177 shared_ptr<FFmpegContent> fcs;
178 if (fc.size() == 1) {
182 shared_ptr<Content> scs;
183 if (sc.size() == 1) {
187 if (property == FFmpegContentProperty::SUBTITLE_STREAMS) {
190 vector<shared_ptr<FFmpegSubtitleStream> > s = fcs->subtitle_streams ();
191 for (vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = s.begin(); i != s.end(); ++i) {
192 _stream->Append (std_to_wx ((*i)->name), new wxStringClientData (std_to_wx ((*i)->identifier ())));
195 if (fcs->subtitle_stream()) {
196 checked_set (_stream, fcs->subtitle_stream()->identifier ());
198 _stream->SetSelection (wxNOT_FOUND);
201 setup_sensitivity ();
202 } else if (property == SubtitleContentProperty::USE) {
203 checked_set (_use, scs ? scs->subtitle->use() : false);
204 setup_sensitivity ();
205 } else if (property == SubtitleContentProperty::BURN) {
206 checked_set (_burn, scs ? scs->subtitle->burn() : false);
207 } else if (property == SubtitleContentProperty::X_OFFSET) {
208 checked_set (_x_offset, scs ? lrint (scs->subtitle->x_offset() * 100) : 0);
209 } else if (property == SubtitleContentProperty::Y_OFFSET) {
210 checked_set (_y_offset, scs ? lrint (scs->subtitle->y_offset() * 100) : 0);
211 } else if (property == SubtitleContentProperty::X_SCALE) {
212 checked_set (_x_scale, scs ? lrint (scs->subtitle->x_scale() * 100) : 100);
213 } else if (property == SubtitleContentProperty::Y_SCALE) {
214 checked_set (_y_scale, scs ? lrint (scs->subtitle->y_scale() * 100) : 100);
215 } else if (property == SubtitleContentProperty::LINE_SPACING) {
216 checked_set (_line_spacing, scs ? lrint (scs->subtitle->line_spacing() * 100) : 100);
217 } else if (property == SubtitleContentProperty::LANGUAGE) {
218 checked_set (_language, scs ? scs->subtitle->language() : "");
219 } else if (property == DCPContentProperty::REFERENCE_SUBTITLE) {
221 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (scs);
222 checked_set (_reference, dcp ? dcp->reference_subtitle () : false);
224 checked_set (_reference, false);
227 setup_sensitivity ();
232 SubtitlePanel::use_toggled ()
234 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
235 i->subtitle->set_use (_use->GetValue());
240 SubtitlePanel::burn_toggled ()
242 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
243 i->subtitle->set_burn (_burn->GetValue());
248 SubtitlePanel::setup_sensitivity ()
254 ContentList sel = _parent->selected_subtitle ();
255 BOOST_FOREACH (shared_ptr<Content> i, sel) {
256 /* These are the content types that could include subtitles */
257 shared_ptr<const FFmpegContent> fc = boost::dynamic_pointer_cast<const FFmpegContent> (i);
258 shared_ptr<const TextSubtitleContent> sc = boost::dynamic_pointer_cast<const TextSubtitleContent> (i);
259 shared_ptr<const DCPSubtitleContent> dsc = boost::dynamic_pointer_cast<const DCPSubtitleContent> (i);
262 DCPOMATIC_ASSERT (fc->subtitle_stream());
263 /* This content has some subtitles; check the selected stream to decide what type */
264 if (fc->subtitle_stream()->has_text()) {
266 } else if (fc->subtitle_stream()->has_image()) {
272 } else if (sc || dsc) {
273 /* XXX: in the future there could be bitmap subs from DCPs */
280 BOOST_FOREACH (shared_ptr<Content> i, sel) {
281 /* We must burn image subtitles at the moment */
282 i->subtitle->set_burn (true);
286 /* Decide whether we can reference these subs */
288 shared_ptr<DCPContent> dcp;
289 if (sel.size() == 1) {
290 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
293 list<string> why_not;
294 bool const can_reference = dcp && dcp->can_reference_subtitle (why_not);
295 setup_refer_button (_reference, dcp, can_reference, why_not);
297 bool const reference = _reference->GetValue ();
299 /* Set up sensitivity */
300 _use->Enable (!reference && any_subs > 0);
301 bool const use = _use->GetValue ();
302 _burn->Enable (!reference && any_subs > 0 && use && image_subs == 0);
303 _x_offset->Enable (!reference && any_subs > 0 && use);
304 _y_offset->Enable (!reference && any_subs > 0 && use);
305 _x_scale->Enable (!reference && any_subs > 0 && use);
306 _y_scale->Enable (!reference && any_subs > 0 && use);
307 _line_spacing->Enable (!reference && text_subs > 0 && use);
308 _language->Enable (!reference && any_subs > 0 && use);
309 _stream->Enable (!reference && ffmpeg_subs == 1);
310 _subtitle_view_button->Enable (!reference && text_subs == 1);
311 _fonts_dialog_button->Enable (!reference && text_subs == 1);
312 _appearance_dialog_button->Enable (!reference && any_subs > 0 && use);
316 SubtitlePanel::stream_changed ()
318 FFmpegContentList fc = _parent->selected_ffmpeg ();
319 if (fc.size() != 1) {
323 shared_ptr<FFmpegContent> fcs = fc.front ();
325 vector<shared_ptr<FFmpegSubtitleStream> > a = fcs->subtitle_streams ();
326 vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = a.begin ();
327 string const s = string_client_data (_stream->GetClientObject (_stream->GetSelection ()));
328 while (i != a.end() && (*i)->identifier () != s) {
333 fcs->set_subtitle_stream (*i);
338 SubtitlePanel::x_offset_changed ()
340 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
341 i->subtitle->set_x_offset (_x_offset->GetValue() / 100.0);
346 SubtitlePanel::y_offset_changed ()
348 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
349 i->subtitle->set_y_offset (_y_offset->GetValue() / 100.0);
354 SubtitlePanel::x_scale_changed ()
356 ContentList c = _parent->selected_subtitle ();
358 c.front()->subtitle->set_x_scale (_x_scale->GetValue() / 100.0);
363 SubtitlePanel::y_scale_changed ()
365 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
366 i->subtitle->set_y_scale (_y_scale->GetValue() / 100.0);
371 SubtitlePanel::line_spacing_changed ()
373 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
374 i->subtitle->set_line_spacing (_line_spacing->GetValue() / 100.0);
379 SubtitlePanel::language_changed ()
381 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
382 i->subtitle->set_language (wx_to_std (_language->GetValue()));
387 SubtitlePanel::content_selection_changed ()
389 film_content_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
390 film_content_changed (SubtitleContentProperty::USE);
391 film_content_changed (SubtitleContentProperty::BURN);
392 film_content_changed (SubtitleContentProperty::X_OFFSET);
393 film_content_changed (SubtitleContentProperty::Y_OFFSET);
394 film_content_changed (SubtitleContentProperty::X_SCALE);
395 film_content_changed (SubtitleContentProperty::Y_SCALE);
396 film_content_changed (SubtitleContentProperty::LINE_SPACING);
397 film_content_changed (SubtitleContentProperty::LANGUAGE);
398 film_content_changed (SubtitleContentProperty::FONTS);
399 film_content_changed (DCPContentProperty::REFERENCE_SUBTITLE);
403 SubtitlePanel::subtitle_view_clicked ()
405 if (_subtitle_view) {
406 _subtitle_view->Destroy ();
410 ContentList c = _parent->selected_subtitle ();
411 DCPOMATIC_ASSERT (c.size() == 1);
413 shared_ptr<Decoder> decoder = decoder_factory (c.front(), _parent->film()->log());
416 _subtitle_view = new SubtitleView (this, _parent->film(), decoder, c.front()->position ());
417 _subtitle_view->Show ();
422 SubtitlePanel::fonts_dialog_clicked ()
425 _fonts_dialog->Destroy ();
429 ContentList c = _parent->selected_subtitle ();
430 DCPOMATIC_ASSERT (c.size() == 1);
432 _fonts_dialog = new FontsDialog (this, c.front ());
433 _fonts_dialog->Show ();
437 SubtitlePanel::reference_clicked ()
439 ContentList c = _parent->selected ();
444 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
449 d->set_reference_subtitle (_reference->GetValue ());
453 SubtitlePanel::appearance_dialog_clicked ()
455 ContentList c = _parent->selected_subtitle ();
456 DCPOMATIC_ASSERT (c.size() == 1);
462 dynamic_pointer_cast<TextSubtitleContent> (c.front()) ||
463 dynamic_pointer_cast<DCPContent> (c.front()) ||
464 dynamic_pointer_cast<DCPSubtitleContent> (c.front())) {
469 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c.front());
471 if (fc->subtitle_stream()->has_text()) {
473 } else if (fc->subtitle_stream()->has_image()) {
479 TextSubtitleAppearanceDialog* d = new TextSubtitleAppearanceDialog (this, c.front()->subtitle);
480 if (d->ShowModal () == wxID_OK) {
485 DCPOMATIC_ASSERT (fc);
486 ImageSubtitleColourDialog* d = new ImageSubtitleColourDialog (this, fc, fc->subtitle_stream ());
487 if (d->ShowModal() == wxID_OK) {