Forcing for fade in/out. optional-sub-params
authorCarl Hetherington <cth@carlh.net>
Sat, 13 Jan 2018 01:00:08 +0000 (01:00 +0000)
committerCarl Hetherington <cth@carlh.net>
Sat, 13 Jan 2018 01:00:08 +0000 (01:00 +0000)
src/lib/subtitle_content.cc
src/lib/subtitle_content.h
src/lib/subtitle_decoder.cc
src/wx/subtitle_appearance_dialog.cc
src/wx/subtitle_appearance_dialog.h

index 4bb414a..dbe6dd4 100644 (file)
@@ -100,8 +100,6 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
        , _x_scale (1)
        , _y_scale (1)
        , _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
-       , _fade_in (node->optional_number_child<Frame>("SubtitleFadeIn").get_value_or (0))
-       , _fade_out (node->optional_number_child<Frame>("SubtitleFadeOut").get_value_or (0))
        , _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or (2))
 {
        if (version >= 32) {
@@ -164,6 +162,15 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
                        );
        }
 
+       optional<Frame> fi = node->optional_number_child<Frame>("SubtitleFadeIn");
+       if (fi) {
+               _fade_in = ContentTime (*fi);
+       }
+       optional<Frame> fo = node->optional_number_child<Frame>("SubtitleFadeOut");
+       if (fo) {
+               _fade_out = ContentTime (*fo);
+       }
+
        _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
 
        list<cxml::NodePtr> fonts = node->node_children ("Font");
@@ -289,8 +296,12 @@ SubtitleContent::as_xml (xmlpp::Node* root) const
                root->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
        }
        root->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
-       root->add_child("SubtitleFadeIn")->add_child_text (raw_convert<string> (_fade_in.get()));
-       root->add_child("SubtitleFadeOut")->add_child_text (raw_convert<string> (_fade_out.get()));
+       if (_fade_in) {
+               root->add_child("SubtitleFadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
+       }
+       if (_fade_out) {
+               root->add_child("SubtitleFadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
+       }
        root->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
 
        for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
@@ -306,8 +317,8 @@ SubtitleContent::identifier () const
                + "_" + raw_convert<string> (x_offset())
                + "_" + raw_convert<string> (y_offset())
                + "_" + raw_convert<string> (line_spacing())
-               + "_" + raw_convert<string> (fade_in().get())
-               + "_" + raw_convert<string> (fade_out().get())
+               + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
+               + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
                + "_" + raw_convert<string> (outline_width());
 
        /* XXX: I suppose really _fonts shouldn't be in here, since not all
@@ -444,12 +455,24 @@ SubtitleContent::set_fade_in (ContentTime t)
 }
 
 void
+SubtitleContent::unset_fade_in ()
+{
+       maybe_set (_fade_in, optional<ContentTime>(), SubtitleContentProperty::FADE_IN);
+}
+
+void
 SubtitleContent::set_fade_out (ContentTime t)
 {
        maybe_set (_fade_out, t, SubtitleContentProperty::FADE_OUT);
 }
 
 void
+SubtitleContent::unset_fade_out ()
+{
+       maybe_set (_fade_out, optional<ContentTime>(), SubtitleContentProperty::FADE_OUT);
+}
+
+void
 SubtitleContent::set_outline_width (int w)
 {
        maybe_set (_outline_width, w, SubtitleContentProperty::OUTLINE_WIDTH);
@@ -479,7 +502,11 @@ SubtitleContent::take_settings_from (shared_ptr<const SubtitleContent> c)
                unset_effect_colour ();
        }
        set_line_spacing (c->_line_spacing);
-       set_fade_in (c->_fade_in);
-       set_fade_out (c->_fade_out);
+       if (c->_fade_in) {
+               set_fade_in (*c->_fade_in);
+       }
+       if (c->_fade_out) {
+               set_fade_out (*c->_fade_out);
+       }
        set_outline_width (c->_outline_width);
 }
index 47b7b5c..58dc515 100644 (file)
@@ -81,8 +81,10 @@ public:
        void unset_effect_colour ();
        void set_line_spacing (double s);
        void set_fade_in (ContentTime);
+       void unset_fade_in ();
        void set_fade_out (ContentTime);
        void set_outline_width (int);
+       void unset_fade_out ();
 
        bool use () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -144,12 +146,12 @@ public:
                return _line_spacing;
        }
 
-       ContentTime fade_in () const {
+       boost::optional<ContentTime> fade_in () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fade_in;
        }
 
-       ContentTime fade_out () const {
+       boost::optional<ContentTime> fade_out () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fade_out;
        }
@@ -194,8 +196,8 @@ private:
        boost::optional<dcp::Colour> _effect_colour;
        /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
        double _line_spacing;
-       ContentTime _fade_in;
-       ContentTime _fade_out;
+       boost::optional<ContentTime> _fade_in;
+       boost::optional<ContentTime> _fade_out;
        int _outline_width;
 };
 
index 9351d68..39c3641 100644 (file)
@@ -85,8 +85,12 @@ SubtitleDecoder::emit_text_start (ContentTime from, list<dcp::SubtitleString> s)
                if (content()->effect()) {
                        i.set_effect (*content()->effect());
                }
-               i.set_fade_up_time (dcp::Time(content()->fade_in().seconds(), 1000));
-               i.set_fade_down_time (dcp::Time(content()->fade_out().seconds(), 1000));
+               if (content()->fade_in()) {
+                       i.set_fade_up_time (dcp::Time(content()->fade_in()->seconds(), 1000));
+               }
+               if (content()->fade_out()) {
+                       i.set_fade_down_time (dcp::Time(content()->fade_out()->seconds(), 1000));
+               }
        }
 
        TextStart (ContentTextSubtitle (from, s));
index 34bdeca..831afe7 100644 (file)
@@ -58,37 +58,13 @@ SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr
        int r = 0;
 
        add_label_to_sizer (_table, this, _("Colour"), true, wxGBPosition (r, 0));
-       {
-               wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
-               _force_colour = new wxCheckBox (this, wxID_ANY, _("Set to"));
-               s->Add (_force_colour, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
-               _colour = new wxColourPickerCtrl (this, wxID_ANY);
-               s->Add (_colour, 0, wxALIGN_CENTER_VERTICAL);
-               _table->Add (s, wxGBPosition (r, 1));
-       }
-       ++r;
+       _force_colour = set_to (_colour = new wxColourPickerCtrl (this, wxID_ANY), r);
 
        add_label_to_sizer (_table, this, _("Effect"), true, wxGBPosition (r, 0));
-       {
-               wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
-               _force_effect = new wxCheckBox (this, wxID_ANY, _("Set to"));
-               s->Add (_force_effect, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
-               _effect = new wxChoice (this, wxID_ANY);
-               s->Add (_effect, 0, wxALIGN_CENTER_VERTICAL);
-               _table->Add (s, wxGBPosition (r, 1));
-       }
-       ++r;
+       _force_effect = set_to (_effect = new wxChoice (this, wxID_ANY), r);
 
        add_label_to_sizer (_table, this, _("Effect colour"), true, wxGBPosition (r, 0));
-       {
-               wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
-               _force_effect_colour = new wxCheckBox (this, wxID_ANY, _("Set to"));
-               s->Add (_force_effect_colour, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
-               _effect_colour = new wxColourPickerCtrl (this, wxID_ANY);
-               s->Add (_effect_colour, 0, wxALIGN_CENTER_VERTICAL);
-               _table->Add (s, wxGBPosition (r, 1));
-       }
-       ++r;
+       _force_effect_colour = set_to (_effect_colour = new wxColourPickerCtrl (this, wxID_ANY), r);
 
        add_label_to_sizer (_table, this, _("Outline width"), true, wxGBPosition (r, 0));
        _outline_width = new wxSpinCtrl (this, wxID_ANY);
@@ -96,14 +72,10 @@ SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr
        ++r;
 
        add_label_to_sizer (_table, this, _("Fade in time"), true, wxGBPosition (r, 0));
-       _fade_in = new Timecode<ContentTime> (this);
-       _table->Add (_fade_in, wxGBPosition (r, 1));
-       ++r;
+       _force_fade_in = set_to (_fade_in = new Timecode<ContentTime> (this), r);
 
        add_label_to_sizer (_table, this, _("Fade out time"), true, wxGBPosition (r, 0));
-       _fade_out = new Timecode<ContentTime> (this);
-       _table->Add (_fade_out, wxGBPosition (r, 1));
-       ++r;
+       _force_fade_out = set_to (_fade_out = new Timecode<ContentTime> (this), r);
 
        if (_stream) {
                wxScrolled<wxPanel>* colours_panel = new wxScrolled<wxPanel> (this);
@@ -155,17 +127,16 @@ SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr
        _effect->Append (_("Shadow"));;
 
        optional<dcp::Colour> colour = _content->subtitle->colour();
+       _force_effect_colour->SetValue (static_cast<bool>(colour));
        if (colour) {
-               _force_colour->SetValue (true);
                _colour->SetColour (wxColour (colour->r, colour->g, colour->b));
        } else {
-               _force_colour->SetValue (false);
                _colour->SetColour (wxColour (255, 255, 255));
        }
 
        optional<dcp::Effect> effect = _content->subtitle->effect();
+       _force_effect->SetValue (static_cast<bool>(effect));
        if (effect) {
-               _force_effect->SetValue (true);
                switch (*effect) {
                case dcp::NONE:
                        _effect->SetSelection (NONE);
@@ -178,32 +149,58 @@ SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr
                        break;
                }
        } else {
-               _force_effect->SetValue (false);
                _effect->SetSelection (NONE);
        }
 
        optional<dcp::Colour> effect_colour = _content->subtitle->effect_colour();
+       _force_effect_colour->SetValue (static_cast<bool>(_force_effect_colour));
        if (effect_colour) {
-               _force_effect_colour->SetValue (true);
                _effect_colour->SetColour (wxColour (effect_colour->r, effect_colour->g, effect_colour->b));
        } else {
-               _force_effect_colour->SetValue (false);
                _effect_colour->SetColour (wxColour (0, 0, 0));
        }
 
-       _fade_in->set (_content->subtitle->fade_in(), _content->active_video_frame_rate ());
-       _fade_out->set (_content->subtitle->fade_out(), _content->active_video_frame_rate ());
+       optional<ContentTime> fade_in = _content->subtitle->fade_in();
+       _force_fade_in->SetValue (static_cast<bool>(fade_in));
+       if (fade_in) {
+               _fade_in->set (*fade_in, _content->active_video_frame_rate());
+       } else {
+               _fade_in->set (ContentTime(), _content->active_video_frame_rate());
+       }
+
+       optional<ContentTime> fade_out = _content->subtitle->fade_out();
+       _force_fade_out->SetValue (static_cast<bool>(fade_out));
+       if (fade_out) {
+               _fade_out->set (*fade_out, _content->active_video_frame_rate ());
+       } else {
+               _fade_out->set (ContentTime(), _content->active_video_frame_rate ());
+       }
+
        _outline_width->SetValue (_content->subtitle->outline_width ());
 
        _force_colour->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
        _force_effect_colour->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
        _force_effect->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
+       _force_fade_in->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
+       _force_fade_out->Bind (wxEVT_CHECKBOX, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
        _effect->Bind (wxEVT_CHOICE, bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
        _content_connection = _content->Changed.connect (bind (&SubtitleAppearanceDialog::setup_sensitivity, this));
 
        setup_sensitivity ();
 }
 
+wxCheckBox*
+SubtitleAppearanceDialog::set_to (wxWindow* w, int& r)
+{
+       wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
+       wxCheckBox* set_to = new wxCheckBox (this, wxID_ANY, _("Set to"));
+       s->Add (set_to, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 8);
+       s->Add (w, 0, wxALIGN_CENTER_VERTICAL);
+       _table->Add (s, wxGBPosition (r, 1));
+       ++r;
+       return set_to;
+}
+
 void
 SubtitleAppearanceDialog::apply ()
 {
@@ -230,8 +227,16 @@ SubtitleAppearanceDialog::apply ()
        } else {
                _content->subtitle->unset_effect_colour ();
        }
-       _content->subtitle->set_fade_in (_fade_in->get (_content->active_video_frame_rate ()));
-       _content->subtitle->set_fade_out (_fade_out->get (_content->active_video_frame_rate ()));
+       if (_force_fade_in->GetValue ()) {
+               _content->subtitle->set_fade_in (_fade_in->get (_content->active_video_frame_rate ()));
+       } else {
+               _content->subtitle->unset_fade_in ();
+       }
+       if (_force_fade_out->GetValue ()) {
+               _content->subtitle->set_fade_out (_fade_out->get (_content->active_video_frame_rate ()));
+       } else {
+               _content->subtitle->unset_fade_out ();
+       }
        _content->subtitle->set_outline_width (_outline_width->GetValue ());
 
        if (_stream) {
@@ -260,6 +265,8 @@ SubtitleAppearanceDialog::setup_sensitivity ()
        _colour->Enable (_force_colour->GetValue ());
        _effect_colour->Enable (_force_effect_colour->GetValue ());
        _effect->Enable (_force_effect->GetValue ());
+       _fade_in->Enable (_force_fade_in->GetValue ());
+       _fade_out->Enable (_force_fade_out->GetValue ());
 
        bool const can_outline_width = _effect->GetSelection() == OUTLINE && _content->subtitle->burn ();
        _outline_width->Enable (can_outline_width);
index 7a23b81..a1a3128 100644 (file)
@@ -30,6 +30,8 @@ class wxGridBagSizer;
 class Content;
 class RGBAColourPicker;
 class FFmpegSubtitleStream;
+class wxCheckBox;
+class wxWidget;
 
 class SubtitleAppearanceDialog : public wxDialog
 {
@@ -41,6 +43,7 @@ public:
 private:
        void setup_sensitivity ();
        void restore ();
+       wxCheckBox* set_to (wxWindow* w, int& r);
 
        wxCheckBox* _force_colour;
        wxColourPickerCtrl* _colour;
@@ -48,7 +51,9 @@ private:
        wxChoice* _effect;
        wxCheckBox* _force_effect_colour;
        wxColourPickerCtrl* _effect_colour;
+       wxCheckBox* _force_fade_in;
        Timecode<ContentTime>* _fade_in;
+       wxCheckBox* _force_fade_out;
        Timecode<ContentTime>* _fade_out;
        wxSpinCtrl* _outline_width;
        wxGridBagSizer* _table;