Rename Subtitle -> Text
[dcpomatic.git] / src / wx / subtitle_panel.cc
index 3a0063c952315cf8a4287e1d39c638e9f5cbe12a..da7891ca8eb1f41d44acd6f4594340dbbc6f550a 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "subtitle_view.h"
 #include "content_panel.h"
 #include "fonts_dialog.h"
-#include "text_subtitle_appearance_dialog.h"
-#include "image_subtitle_colour_dialog.h"
+#include "subtitle_appearance_dialog.h"
 #include "lib/ffmpeg_content.h"
-#include "lib/text_subtitle_content.h"
+#include "lib/text_text_content.h"
 #include "lib/ffmpeg_subtitle_stream.h"
-#include "lib/dcp_subtitle_content.h"
-#include "lib/text_subtitle_decoder.h"
-#include "lib/dcp_subtitle_decoder.h"
+#include "lib/dcp_text_content.h"
+#include "lib/text_text_decoder.h"
+#include "lib/dcp_text_decoder.h"
 #include "lib/dcp_content.h"
-#include "lib/subtitle_content.h"
+#include "lib/text_content.h"
+#include "lib/decoder_factory.h"
 #include <wx/spinctrl.h>
 #include <boost/foreach.hpp>
 
@@ -47,14 +48,25 @@ SubtitlePanel::SubtitlePanel (ContentPanel* p)
        , _subtitle_view (0)
        , _fonts_dialog (0)
 {
+       wxBoxSizer* reference_sizer = new wxBoxSizer (wxVERTICAL);
+
+       _reference = new wxCheckBox (this, wxID_ANY, _("Use this DCP's subtitle as OV and make VF"));
+       reference_sizer->Add (_reference, 0, wxLEFT | wxRIGHT | wxTOP, DCPOMATIC_SIZER_GAP);
+
+       _reference_note = new wxStaticText (this, wxID_ANY, _(""));
+       _reference_note->Wrap (200);
+       reference_sizer->Add (_reference_note, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
+       wxFont font = _reference_note->GetFont();
+       font.SetStyle(wxFONTSTYLE_ITALIC);
+       font.SetPointSize(font.GetPointSize() - 1);
+       _reference_note->SetFont(font);
+
+       _sizer->Add (reference_sizer);
+
        wxGridBagSizer* grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
        _sizer->Add (grid, 0, wxALL, 8);
        int r = 0;
 
-       _reference = new wxCheckBox (this, wxID_ANY, _("Refer to existing DCP"));
-       grid->Add (_reference, wxGBPosition (r, 0), wxGBSpan (1, 2));
-       ++r;
-
        _use = new wxCheckBox (this, wxID_ANY, _("Use subtitles"));
        grid->Add (_use, wxGBPosition (r, 0), wxGBSpan (1, 2));
        ++r;
@@ -103,6 +115,16 @@ SubtitlePanel::SubtitlePanel (ContentPanel* p)
                ++r;
        }
 
+       {
+               add_label_to_sizer (grid, this, _("Line spacing"), true, wxGBPosition (r, 0));
+               wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
+               _line_spacing = new wxSpinCtrl (this);
+               s->Add (_line_spacing);
+               add_label_to_sizer (s, this, _("%"), false);
+               grid->Add (s, wxGBPosition (r, 1));
+               ++r;
+       }
+
        add_label_to_sizer (grid, this, _("Language"), true, wxGBPosition (r, 0));
        _language = new wxTextCtrl (this, wxID_ANY);
        grid->Add (_language, wxGBPosition (r, 1));
@@ -131,19 +153,21 @@ SubtitlePanel::SubtitlePanel (ContentPanel* p)
        _y_offset->SetRange (-100, 100);
        _x_scale->SetRange (10, 1000);
        _y_scale->SetRange (10, 1000);
-
-       _reference->Bind                (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::reference_clicked, this));
-       _use->Bind                      (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::use_toggled, this));
-       _burn->Bind                     (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&SubtitlePanel::burn_toggled, this));
-       _x_offset->Bind                 (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::x_offset_changed, this));
-       _y_offset->Bind                 (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::y_offset_changed, this));
-       _x_scale->Bind                  (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::x_scale_changed, this));
-       _y_scale->Bind                  (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&SubtitlePanel::y_scale_changed, this));
-       _language->Bind                 (wxEVT_COMMAND_TEXT_UPDATED,     boost::bind (&SubtitlePanel::language_changed, this));
-       _stream->Bind                   (wxEVT_COMMAND_CHOICE_SELECTED,  boost::bind (&SubtitlePanel::stream_changed, this));
-       _subtitle_view_button->Bind     (wxEVT_COMMAND_BUTTON_CLICKED,   boost::bind (&SubtitlePanel::subtitle_view_clicked, this));
-       _fonts_dialog_button->Bind      (wxEVT_COMMAND_BUTTON_CLICKED,   boost::bind (&SubtitlePanel::fonts_dialog_clicked, this));
-       _appearance_dialog_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,   boost::bind (&SubtitlePanel::appearance_dialog_clicked, this));
+       _line_spacing->SetRange (10, 1000);
+
+       _reference->Bind                (wxEVT_CHECKBOX, boost::bind (&SubtitlePanel::reference_clicked, this));
+       _use->Bind                      (wxEVT_CHECKBOX, boost::bind (&SubtitlePanel::use_toggled, this));
+       _burn->Bind                     (wxEVT_CHECKBOX, boost::bind (&SubtitlePanel::burn_toggled, this));
+       _x_offset->Bind                 (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::x_offset_changed, this));
+       _y_offset->Bind                 (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::y_offset_changed, this));
+       _x_scale->Bind                  (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::x_scale_changed, this));
+       _y_scale->Bind                  (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::y_scale_changed, this));
+       _line_spacing->Bind             (wxEVT_SPINCTRL, boost::bind (&SubtitlePanel::line_spacing_changed, this));
+       _language->Bind                 (wxEVT_TEXT,     boost::bind (&SubtitlePanel::language_changed, this));
+       _stream->Bind                   (wxEVT_CHOICE,   boost::bind (&SubtitlePanel::stream_changed, this));
+       _subtitle_view_button->Bind     (wxEVT_BUTTON,   boost::bind (&SubtitlePanel::subtitle_view_clicked, this));
+       _fonts_dialog_button->Bind      (wxEVT_BUTTON,   boost::bind (&SubtitlePanel::fonts_dialog_clicked, this));
+       _appearance_dialog_button->Bind (wxEVT_BUTTON,   boost::bind (&SubtitlePanel::appearance_dialog_clicked, this));
 }
 
 void
@@ -185,20 +209,22 @@ SubtitlePanel::film_content_changed (int property)
                        }
                }
                setup_sensitivity ();
-       } else if (property == SubtitleContentProperty::USE) {
+       } else if (property == TextContentProperty::USE) {
                checked_set (_use, scs ? scs->subtitle->use() : false);
                setup_sensitivity ();
-       } else if (property == SubtitleContentProperty::BURN) {
+       } else if (property == TextContentProperty::BURN) {
                checked_set (_burn, scs ? scs->subtitle->burn() : false);
-       } else if (property == SubtitleContentProperty::X_OFFSET) {
+       } else if (property == TextContentProperty::X_OFFSET) {
                checked_set (_x_offset, scs ? lrint (scs->subtitle->x_offset() * 100) : 0);
-       } else if (property == SubtitleContentProperty::Y_OFFSET) {
+       } else if (property == TextContentProperty::Y_OFFSET) {
                checked_set (_y_offset, scs ? lrint (scs->subtitle->y_offset() * 100) : 0);
-       } else if (property == SubtitleContentProperty::X_SCALE) {
+       } else if (property == TextContentProperty::X_SCALE) {
                checked_set (_x_scale, scs ? lrint (scs->subtitle->x_scale() * 100) : 100);
-       } else if (property == SubtitleContentProperty::Y_SCALE) {
+       } else if (property == TextContentProperty::Y_SCALE) {
                checked_set (_y_scale, scs ? lrint (scs->subtitle->y_scale() * 100) : 100);
-       } else if (property == SubtitleContentProperty::LANGUAGE) {
+       } else if (property == TextContentProperty::LINE_SPACING) {
+               checked_set (_line_spacing, scs ? lrint (scs->subtitle->line_spacing() * 100) : 100);
+       } else if (property == TextContentProperty::LANGUAGE) {
                checked_set (_language, scs ? scs->subtitle->language() : "");
        } else if (property == DCPContentProperty::REFERENCE_SUBTITLE) {
                if (scs) {
@@ -208,6 +234,8 @@ SubtitlePanel::film_content_changed (int property)
                        checked_set (_reference, false);
                }
 
+               setup_sensitivity ();
+       } else if (property == DCPContentProperty::HAS_SUBTITLES) {
                setup_sensitivity ();
        }
 }
@@ -233,59 +261,51 @@ SubtitlePanel::setup_sensitivity ()
 {
        int any_subs = 0;
        int ffmpeg_subs = 0;
-       int text_subs = 0;
-       int dcp_subs = 0;
-       int image_subs = 0;
        ContentList sel = _parent->selected_subtitle ();
        BOOST_FOREACH (shared_ptr<Content> i, sel) {
+               /* These are the content types that could include subtitles */
                shared_ptr<const FFmpegContent> fc = boost::dynamic_pointer_cast<const FFmpegContent> (i);
-               shared_ptr<const TextSubtitleContent> sc = boost::dynamic_pointer_cast<const TextSubtitleContent> (i);
-               shared_ptr<const DCPSubtitleContent> dsc = boost::dynamic_pointer_cast<const DCPSubtitleContent> (i);
+               shared_ptr<const TextTextContent> sc = boost::dynamic_pointer_cast<const TextTextContent> (i);
+               shared_ptr<const DCPContent> dc = boost::dynamic_pointer_cast<const DCPContent> (i);
+               shared_ptr<const DCPTextContent> dsc = boost::dynamic_pointer_cast<const DCPTextContent> (i);
                if (fc) {
                        if (fc->subtitle) {
                                ++ffmpeg_subs;
                                ++any_subs;
                        }
-               } else if (sc) {
-                       ++text_subs;
-                       ++any_subs;
-               } else if (dsc) {
-                       ++dcp_subs;
-                       ++any_subs;
-               } else {
+               } else if (sc || dc || dsc) {
+                       /* XXX: in the future there could be bitmap subs from DCPs */
                        ++any_subs;
                }
-
-               if (i->subtitle->has_image_subtitles ()) {
-                       ++image_subs;
-                       /* We must burn image subtitles at the moment */
-                       i->subtitle->set_burn (true);
-               }
        }
 
+       /* Decide whether we can reference these subs */
+
        shared_ptr<DCPContent> dcp;
        if (sel.size() == 1) {
                dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
        }
 
-       list<string> why_not;
+       string why_not;
        bool const can_reference = dcp && dcp->can_reference_subtitle (why_not);
-       setup_refer_button (_reference, dcp, can_reference, why_not);
+       setup_refer_button (_reference, _reference_note, dcp, can_reference, why_not);
 
        bool const reference = _reference->GetValue ();
 
+       /* Set up sensitivity */
        _use->Enable (!reference && any_subs > 0);
        bool const use = _use->GetValue ();
-       _burn->Enable (!reference && any_subs > 0 && use && image_subs == 0);
+       _burn->Enable (!reference && any_subs > 0 && use);
        _x_offset->Enable (!reference && any_subs > 0 && use);
        _y_offset->Enable (!reference && any_subs > 0 && use);
        _x_scale->Enable (!reference && any_subs > 0 && use);
        _y_scale->Enable (!reference && any_subs > 0 && use);
+       _line_spacing->Enable (!reference && use);
        _language->Enable (!reference && any_subs > 0 && use);
        _stream->Enable (!reference && ffmpeg_subs == 1);
-       _subtitle_view_button->Enable (!reference && (text_subs == 1 || dcp_subs == 1));
-       _fonts_dialog_button->Enable (!reference && (text_subs == 1 || dcp_subs == 1));
-       _appearance_dialog_button->Enable (!reference && (ffmpeg_subs == 1 || text_subs == 1));
+       _subtitle_view_button->Enable (!reference);
+       _fonts_dialog_button->Enable (!reference);
+       _appearance_dialog_button->Enable (!reference && any_subs > 0 && use);
 }
 
 void
@@ -343,6 +363,14 @@ SubtitlePanel::y_scale_changed ()
        }
 }
 
+void
+SubtitlePanel::line_spacing_changed ()
+{
+       BOOST_FOREACH (shared_ptr<Content> i, _parent->selected_subtitle ()) {
+               i->subtitle->set_line_spacing (_line_spacing->GetValue() / 100.0);
+       }
+}
+
 void
 SubtitlePanel::language_changed ()
 {
@@ -355,14 +383,15 @@ void
 SubtitlePanel::content_selection_changed ()
 {
        film_content_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
-       film_content_changed (SubtitleContentProperty::USE);
-       film_content_changed (SubtitleContentProperty::BURN);
-       film_content_changed (SubtitleContentProperty::X_OFFSET);
-       film_content_changed (SubtitleContentProperty::Y_OFFSET);
-       film_content_changed (SubtitleContentProperty::X_SCALE);
-       film_content_changed (SubtitleContentProperty::Y_SCALE);
-       film_content_changed (SubtitleContentProperty::LANGUAGE);
-       film_content_changed (SubtitleContentProperty::FONTS);
+       film_content_changed (TextContentProperty::USE);
+       film_content_changed (TextContentProperty::BURN);
+       film_content_changed (TextContentProperty::X_OFFSET);
+       film_content_changed (TextContentProperty::Y_OFFSET);
+       film_content_changed (TextContentProperty::X_SCALE);
+       film_content_changed (TextContentProperty::Y_SCALE);
+       film_content_changed (TextContentProperty::LINE_SPACING);
+       film_content_changed (TextContentProperty::LANGUAGE);
+       film_content_changed (TextContentProperty::FONTS);
        film_content_changed (DCPContentProperty::REFERENCE_SUBTITLE);
 }
 
@@ -377,20 +406,10 @@ SubtitlePanel::subtitle_view_clicked ()
        ContentList c = _parent->selected_subtitle ();
        DCPOMATIC_ASSERT (c.size() == 1);
 
-       shared_ptr<SubtitleDecoder> decoder;
-
-       shared_ptr<TextSubtitleContent> sr = dynamic_pointer_cast<TextSubtitleContent> (c.front ());
-       if (sr) {
-               decoder.reset (new TextSubtitleDecoder (sr));
-       }
-
-       shared_ptr<DCPSubtitleContent> dc = dynamic_pointer_cast<DCPSubtitleContent> (c.front ());
-       if (dc) {
-               decoder.reset (new DCPSubtitleDecoder (dc));
-       }
+       shared_ptr<Decoder> decoder = decoder_factory (c.front(), _parent->film()->log(), false);
 
        if (decoder) {
-               _subtitle_view = new SubtitleView (this, _parent->film(), decoder, c.front()->position ());
+               _subtitle_view = new SubtitleView (this, _parent->film(), c.front(), decoder, _parent->film_viewer());
                _subtitle_view->Show ();
        }
 }
@@ -432,20 +451,9 @@ SubtitlePanel::appearance_dialog_clicked ()
        ContentList c = _parent->selected_subtitle ();
        DCPOMATIC_ASSERT (c.size() == 1);
 
-       shared_ptr<TextSubtitleContent> sr = dynamic_pointer_cast<TextSubtitleContent> (c.front ());
-       if (sr) {
-               TextSubtitleAppearanceDialog* d = new TextSubtitleAppearanceDialog (this, sr);
-               if (d->ShowModal () == wxID_OK) {
-                       d->apply ();
-               }
-               d->Destroy ();
-       } else {
-               shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c.front ());
-               DCPOMATIC_ASSERT (fc);
-               ImageSubtitleColourDialog* d = new ImageSubtitleColourDialog (this, fc, fc->subtitle_stream ());
-               if (d->ShowModal() == wxID_OK) {
-                       d->apply ();
-               }
-               d->Destroy ();
+       SubtitleAppearanceDialog* d = new SubtitleAppearanceDialog (this, c.front());
+       if (d->ShowModal () == wxID_OK) {
+               d->apply ();
        }
+       d->Destroy ();
 }