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));
108 add_label_to_sizer (grid, this, _("Language"), true, wxGBPosition (r, 0));
109 _language = new wxTextCtrl (this, wxID_ANY);
110 grid->Add (_language, wxGBPosition (r, 1));
113 add_label_to_sizer (grid, this, _("Stream"), true, wxGBPosition (r, 0));
114 _stream = new wxChoice (this, wxID_ANY);
115 grid->Add (_stream, wxGBPosition (r, 1));
119 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
121 _subtitle_view_button = new wxButton (this, wxID_ANY, _("View..."));
122 s->Add (_subtitle_view_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
123 _fonts_dialog_button = new wxButton (this, wxID_ANY, _("Fonts..."));
124 s->Add (_fonts_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
125 _appearance_dialog_button = new wxButton (this, wxID_ANY, _("Appearance..."));
126 s->Add (_appearance_dialog_button, 1, wxALL, DCPOMATIC_SIZER_GAP);
128 grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
132 _x_offset->SetRange (-100, 100);
133 _y_offset->SetRange (-100, 100);
134 _x_scale->SetRange (10, 1000);
135 _y_scale->SetRange (10, 1000);
137 _reference->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::reference_clicked, this));
138 _use->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::use_toggled, this));
139 _burn->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::burn_toggled, this));
140 _x_offset->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::x_offset_changed, this));
141 _y_offset->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::y_offset_changed, this));
142 _x_scale->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::x_scale_changed, this));
143 _y_scale->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::y_scale_changed, this));
144 _language->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&SubtitlePanel::language_changed, this));
145 _stream->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&SubtitlePanel::stream_changed, this));
146 _subtitle_view_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&SubtitlePanel::subtitle_view_clicked, this));
147 _fonts_dialog_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&SubtitlePanel::fonts_dialog_clicked, this));
148 _appearance_dialog_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&SubtitlePanel::appearance_dialog_clicked, this));
152 SubtitlePanel::film_changed (Film::Property property)
154 if (property == Film::CONTENT || property == Film::REEL_TYPE) {
155 setup_sensitivity ();
160 SubtitlePanel::film_content_changed (int property)
162 FFmpegContentList fc = _parent->selected_ffmpeg ();
163 ContentList sc = _parent->selected_subtitle ();
165 shared_ptr<FFmpegContent> fcs;
166 if (fc.size() == 1) {
170 shared_ptr<Content> scs;
171 if (sc.size() == 1) {
175 if (property == FFmpegContentProperty::SUBTITLE_STREAMS) {
178 vector<shared_ptr<FFmpegSubtitleStream> > s = fcs->subtitle_streams ();
179 for (vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = s.begin(); i != s.end(); ++i) {
180 _stream->Append (std_to_wx ((*i)->name), new wxStringClientData (std_to_wx ((*i)->identifier ())));
183 if (fcs->subtitle_stream()) {
184 checked_set (_stream, fcs->subtitle_stream()->identifier ());
186 _stream->SetSelection (wxNOT_FOUND);
189 setup_sensitivity ();
190 } else if (property == SubtitleContentProperty::USE) {
191 checked_set (_use, scs ? scs->subtitle->use() : false);
192 setup_sensitivity ();
193 } else if (property == SubtitleContentProperty::BURN) {
194 checked_set (_burn, scs ? scs->subtitle->burn() : false);
195 } else if (property == SubtitleContentProperty::X_OFFSET) {
196 checked_set (_x_offset, scs ? lrint (scs->subtitle->x_offset() * 100) : 0);
197 } else if (property == SubtitleContentProperty::Y_OFFSET) {
198 checked_set (_y_offset, scs ? lrint (scs->subtitle->y_offset() * 100) : 0);
199 } else if (property == SubtitleContentProperty::X_SCALE) {
200 checked_set (_x_scale, scs ? lrint (scs->subtitle->x_scale() * 100) : 100);
201 } else if (property == SubtitleContentProperty::Y_SCALE) {
202 checked_set (_y_scale, scs ? lrint (scs->subtitle->y_scale() * 100) : 100);
203 } else if (property == SubtitleContentProperty::LANGUAGE) {
204 checked_set (_language, scs ? scs->subtitle->language() : "");
205 } else if (property == DCPContentProperty::REFERENCE_SUBTITLE) {
207 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (scs);
208 checked_set (_reference, dcp ? dcp->reference_subtitle () : false);
210 checked_set (_reference, false);
213 setup_sensitivity ();
218 SubtitlePanel::use_toggled ()
220 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
221 i->subtitle->set_use (_use->GetValue());
226 SubtitlePanel::burn_toggled ()
228 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
229 i->subtitle->set_burn (_burn->GetValue());
234 SubtitlePanel::setup_sensitivity ()
240 ContentList sel = _parent->selected_subtitle ();
241 BOOST_FOREACH (shared_ptr<Content> i, sel) {
242 /* These are the content types that could include subtitles */
243 shared_ptr<const FFmpegContent> fc = boost::dynamic_pointer_cast<const FFmpegContent> (i);
244 shared_ptr<const TextSubtitleContent> sc = boost::dynamic_pointer_cast<const TextSubtitleContent> (i);
245 shared_ptr<const DCPSubtitleContent> dsc = boost::dynamic_pointer_cast<const DCPSubtitleContent> (i);
248 /* This content has some subtitles; check the selected stream to decide what type */
249 if (fc->subtitle_stream()->has_text()) {
251 } else if (fc->subtitle_stream()->has_image()) {
257 } else if (sc || dsc) {
258 /* XXX: in the future there could be bitmap subs from DCPs */
265 BOOST_FOREACH (shared_ptr<Content> i, sel) {
266 /* We must burn image subtitles at the moment */
267 i->subtitle->set_burn (true);
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 && image_subs == 0);
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 _language->Enable (!reference && any_subs > 0 && use);
293 _stream->Enable (!reference && ffmpeg_subs == 1);
294 _subtitle_view_button->Enable (!reference && text_subs == 1);
295 _fonts_dialog_button->Enable (!reference && text_subs == 1);
296 _appearance_dialog_button->Enable (!reference);
300 SubtitlePanel::stream_changed ()
302 FFmpegContentList fc = _parent->selected_ffmpeg ();
303 if (fc.size() != 1) {
307 shared_ptr<FFmpegContent> fcs = fc.front ();
309 vector<shared_ptr<FFmpegSubtitleStream> > a = fcs->subtitle_streams ();
310 vector<shared_ptr<FFmpegSubtitleStream> >::iterator i = a.begin ();
311 string const s = string_client_data (_stream->GetClientObject (_stream->GetSelection ()));
312 while (i != a.end() && (*i)->identifier () != s) {
317 fcs->set_subtitle_stream (*i);
322 SubtitlePanel::x_offset_changed ()
324 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
325 i->subtitle->set_x_offset (_x_offset->GetValue() / 100.0);
330 SubtitlePanel::y_offset_changed ()
332 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
333 i->subtitle->set_y_offset (_y_offset->GetValue() / 100.0);
338 SubtitlePanel::x_scale_changed ()
340 ContentList c = _parent->selected_subtitle ();
342 c.front()->subtitle->set_x_scale (_x_scale->GetValue() / 100.0);
347 SubtitlePanel::y_scale_changed ()
349 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
350 i->subtitle->set_y_scale (_y_scale->GetValue() / 100.0);
355 SubtitlePanel::language_changed ()
357 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
358 i->subtitle->set_language (wx_to_std (_language->GetValue()));
363 SubtitlePanel::content_selection_changed ()
365 film_content_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
366 film_content_changed (SubtitleContentProperty::USE);
367 film_content_changed (SubtitleContentProperty::BURN);
368 film_content_changed (SubtitleContentProperty::X_OFFSET);
369 film_content_changed (SubtitleContentProperty::Y_OFFSET);
370 film_content_changed (SubtitleContentProperty::X_SCALE);
371 film_content_changed (SubtitleContentProperty::Y_SCALE);
372 film_content_changed (SubtitleContentProperty::LANGUAGE);
373 film_content_changed (SubtitleContentProperty::FONTS);
374 film_content_changed (DCPContentProperty::REFERENCE_SUBTITLE);
378 SubtitlePanel::subtitle_view_clicked ()
380 if (_subtitle_view) {
381 _subtitle_view->Destroy ();
385 ContentList c = _parent->selected_subtitle ();
386 DCPOMATIC_ASSERT (c.size() == 1);
388 list<shared_ptr<ImageDecoder> > image_decoders;
389 shared_ptr<Decoder> decoder = decoder_factory (c.front(), image_decoders, _parent->film()->log(), false);
392 _subtitle_view = new SubtitleView (this, _parent->film(), decoder, c.front()->position ());
393 _subtitle_view->Show ();
398 SubtitlePanel::fonts_dialog_clicked ()
401 _fonts_dialog->Destroy ();
405 ContentList c = _parent->selected_subtitle ();
406 DCPOMATIC_ASSERT (c.size() == 1);
408 _fonts_dialog = new FontsDialog (this, c.front ());
409 _fonts_dialog->Show ();
413 SubtitlePanel::reference_clicked ()
415 ContentList c = _parent->selected ();
420 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
425 d->set_reference_subtitle (_reference->GetValue ());
429 SubtitlePanel::appearance_dialog_clicked ()
431 ContentList c = _parent->selected_subtitle ();
432 DCPOMATIC_ASSERT (c.size() == 1);
438 dynamic_pointer_cast<TextSubtitleContent> (c.front()) ||
439 dynamic_pointer_cast<DCPContent> (c.front()) ||
440 dynamic_pointer_cast<DCPSubtitleContent> (c.front())) {
445 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c.front());
447 if (fc->subtitle_stream()->has_text()) {
449 } else if (fc->subtitle_stream()->has_image()) {
455 TextSubtitleAppearanceDialog* d = new TextSubtitleAppearanceDialog (this, c.front()->subtitle);
456 if (d->ShowModal () == wxID_OK) {
461 DCPOMATIC_ASSERT (fc);
462 ImageSubtitleColourDialog* d = new ImageSubtitleColourDialog (this, fc, fc->subtitle_stream ());
463 if (d->ShowModal() == wxID_OK) {