From df17bbd25da69fc38eb2dcd8b4a2531cf0bab0bc Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Mon, 23 Jul 2018 11:20:12 +0100 Subject: More automated renaming. ActiveCaptions -> ActiveText BitmapCaption -> BitmapText ContentCaption -> ContentText ContentTextCaption -> ContentStringText TextCaptionFileContent -> StringTextFileContent TextCaptionFileDecoder -> StringTextFileDecoder TextCaptionFile -> StringTextFile TextCaption -> StringText PlayerCaption -> PlayerText CaptionContent -> TextContent CaptionDecoder -> TextDecoder CaptionPanel -> TextPanel CaptionView -> TextView CaptionAppearanceDialog -> SubtitleAppearanceDialog CaptionType -> TextType --- src/lib/caption_content.cc | 579 --------------------------------------------- 1 file changed, 579 deletions(-) delete mode 100644 src/lib/caption_content.cc (limited to 'src/lib/caption_content.cc') diff --git a/src/lib/caption_content.cc b/src/lib/caption_content.cc deleted file mode 100644 index 4d0795190..000000000 --- a/src/lib/caption_content.cc +++ /dev/null @@ -1,579 +0,0 @@ -/* - Copyright (C) 2013-2018 Carl Hetherington - - 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. - - 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 DCP-o-matic. If not, see . - -*/ - -#include "caption_content.h" -#include "util.h" -#include "exceptions.h" -#include "font.h" -#include "content.h" -#include -#include -#include -#include -#include - -#include "i18n.h" - -using std::string; -using std::vector; -using std::cout; -using std::list; -using boost::shared_ptr; -using boost::dynamic_pointer_cast; -using boost::optional; -using dcp::raw_convert; - -int const CaptionContentProperty::X_OFFSET = 500; -int const CaptionContentProperty::Y_OFFSET = 501; -int const CaptionContentProperty::X_SCALE = 502; -int const CaptionContentProperty::Y_SCALE = 503; -int const CaptionContentProperty::USE = 504; -int const CaptionContentProperty::BURN = 505; -int const CaptionContentProperty::LANGUAGE = 506; -int const CaptionContentProperty::FONTS = 507; -int const CaptionContentProperty::COLOUR = 508; -int const CaptionContentProperty::EFFECT = 509; -int const CaptionContentProperty::EFFECT_COLOUR = 510; -int const CaptionContentProperty::LINE_SPACING = 511; -int const CaptionContentProperty::FADE_IN = 512; -int const CaptionContentProperty::FADE_OUT = 513; -int const CaptionContentProperty::OUTLINE_WIDTH = 514; -int const CaptionContentProperty::TYPE = 515; - -CaptionContent::CaptionContent (Content* parent, CaptionType original_type) - : ContentPart (parent) - , _use (false) - , _burn (false) - , _x_offset (0) - , _y_offset (0) - , _x_scale (1) - , _y_scale (1) - , _line_spacing (1) - , _outline_width (2) - , _type (original_type) - , _original_type (original_type) -{ - -} - -/** @return CaptionContents from node or nodes under node (according to version). - * The list could be empty if no CaptionContents are found. - */ -list > -CaptionContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version) -{ - if (version < 34) { - /* With old metadata FFmpeg content has the subtitle-related tags even with no - subtitle streams, so check for that. - */ - if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) { - return list >(); - } - - /* Otherwise we can drop through to the newer logic */ - } - - if (version < 37) { - if (!node->optional_number_child("SubtitleXOffset") && !node->optional_number_child("SubtitleOffset")) { - return list >(); - } - list > c; - c.push_back (shared_ptr (new CaptionContent (parent, node, version))); - return c; - } - - if (!node->optional_node_child("Caption")) { - return list >(); - } - - list > c; - BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Caption")) { - c.push_back (shared_ptr (new CaptionContent (parent, i, version))); - } - return c; -} - -CaptionContent::CaptionContent (Content* parent, cxml::ConstNodePtr node, int version) - : ContentPart (parent) - , _use (false) - , _burn (false) - , _x_offset (0) - , _y_offset (0) - , _x_scale (1) - , _y_scale (1) - , _line_spacing (node->optional_number_child("LineSpacing").get_value_or (1)) - , _outline_width (node->optional_number_child("OutlineWidth").get_value_or (2)) - , _type (CAPTION_OPEN) - , _original_type (CAPTION_OPEN) -{ - if (version >= 37) { - _use = node->bool_child ("Use"); - _burn = node->bool_child ("Burn"); - } else if (version >= 32) { - _use = node->bool_child ("UseSubtitles"); - _burn = node->bool_child ("BurnSubtitles"); - } - - if (version >= 37) { - _x_offset = node->number_child ("XOffset"); - _y_offset = node->number_child ("YOffset"); - } else if (version >= 7) { - _x_offset = node->number_child ("SubtitleXOffset"); - _y_offset = node->number_child ("SubtitleYOffset"); - } else { - _y_offset = node->number_child ("SubtitleOffset"); - } - - if (node->optional_bool_child("Outline").get_value_or(false)) { - _effect = dcp::BORDER; - } else if (node->optional_bool_child("Shadow").get_value_or(false)) { - _effect = dcp::SHADOW; - } else { - _effect = dcp::NONE; - } - - optional effect = node->optional_string_child("Effect"); - if (effect) { - if (*effect == "none") { - _effect = dcp::NONE; - } else if (*effect == "outline") { - _effect = dcp::BORDER; - } else if (*effect == "shadow") { - _effect = dcp::SHADOW; - } - } - - if (version >= 37) { - _x_scale = node->number_child ("XScale"); - _y_scale = node->number_child ("YScale"); - } else if (version >= 10) { - _x_scale = node->number_child ("SubtitleXScale"); - _y_scale = node->number_child ("SubtitleYScale"); - } else { - _x_scale = _y_scale = node->number_child ("SubtitleScale"); - } - - optional r = node->optional_number_child("Red"); - optional g = node->optional_number_child("Green"); - optional b = node->optional_number_child("Blue"); - if (r && g && b) { - _colour = dcp::Colour (*r, *g, *b); - } - - if (version >= 36) { - optional er = node->optional_number_child("EffectRed"); - optional eg = node->optional_number_child("EffectGreen"); - optional eb = node->optional_number_child("EffectBlue"); - if (er && eg && eb) { - _effect_colour = dcp::Colour (*er, *eg, *eb); - } - } else { - _effect_colour = dcp::Colour ( - node->optional_number_child("OutlineRed").get_value_or(255), - node->optional_number_child("OutlineGreen").get_value_or(255), - node->optional_number_child("OutlineBlue").get_value_or(255) - ); - } - - optional fi; - if (version >= 37) { - fi = node->optional_number_child("FadeIn"); - } else { - fi = node->optional_number_child("SubtitleFadeIn"); - } - if (fi) { - _fade_in = ContentTime (*fi); - } - - optional fo; - if (version >= 37) { - fo = node->optional_number_child("FadeOut"); - } else { - fo = node->optional_number_child("SubtitleFadeOut"); - } - if (fo) { - _fade_out = ContentTime (*fo); - } - - if (version >= 37) { - _language = node->optional_string_child ("Language").get_value_or (""); - } else { - _language = node->optional_string_child ("SubtitleLanguage").get_value_or (""); - } - - list fonts = node->node_children ("Font"); - for (list::const_iterator i = fonts.begin(); i != fonts.end(); ++i) { - _fonts.push_back (shared_ptr (new Font (*i))); - } - - connect_to_fonts (); - - _type = string_to_caption_type (node->optional_string_child("Type").get_value_or("open")); - _original_type = string_to_caption_type (node->optional_string_child("OriginalType").get_value_or("open")); -} - -CaptionContent::CaptionContent (Content* parent, vector > c) - : ContentPart (parent) -{ - /* This constructor is for join which is only supported for content types - that have a single caption, so we can use only_caption() here. - */ - shared_ptr ref = c[0]->only_caption(); - DCPOMATIC_ASSERT (ref); - list > ref_fonts = ref->fonts (); - - for (size_t i = 1; i < c.size(); ++i) { - - if (c[i]->only_caption()->use() != ref->use()) { - throw JoinError (_("Content to be joined must have the same 'use subtitles' setting.")); - } - - if (c[i]->only_caption()->burn() != ref->burn()) { - throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting.")); - } - - if (c[i]->only_caption()->x_offset() != ref->x_offset()) { - throw JoinError (_("Content to be joined must have the same subtitle X offset.")); - } - - if (c[i]->only_caption()->y_offset() != ref->y_offset()) { - throw JoinError (_("Content to be joined must have the same subtitle Y offset.")); - } - - if (c[i]->only_caption()->x_scale() != ref->x_scale()) { - throw JoinError (_("Content to be joined must have the same subtitle X scale.")); - } - - if (c[i]->only_caption()->y_scale() != ref->y_scale()) { - throw JoinError (_("Content to be joined must have the same subtitle Y scale.")); - } - - if (c[i]->only_caption()->line_spacing() != ref->line_spacing()) { - throw JoinError (_("Content to be joined must have the same subtitle line spacing.")); - } - - if ((c[i]->only_caption()->fade_in() != ref->fade_in()) || (c[i]->only_caption()->fade_out() != ref->fade_out())) { - throw JoinError (_("Content to be joined must have the same subtitle fades.")); - } - - if ((c[i]->only_caption()->outline_width() != ref->outline_width())) { - throw JoinError (_("Content to be joined must have the same outline width.")); - } - - list > fonts = c[i]->only_caption()->fonts (); - if (fonts.size() != ref_fonts.size()) { - throw JoinError (_("Content to be joined must use the same fonts.")); - } - - list >::const_iterator j = ref_fonts.begin (); - list >::const_iterator k = fonts.begin (); - - while (j != ref_fonts.end ()) { - if (**j != **k) { - throw JoinError (_("Content to be joined must use the same fonts.")); - } - ++j; - ++k; - } - } - - _use = ref->use (); - _burn = ref->burn (); - _x_offset = ref->x_offset (); - _y_offset = ref->y_offset (); - _x_scale = ref->x_scale (); - _y_scale = ref->y_scale (); - _language = ref->language (); - _fonts = ref_fonts; - _line_spacing = ref->line_spacing (); - _fade_in = ref->fade_in (); - _fade_out = ref->fade_out (); - _outline_width = ref->outline_width (); - _type = ref->type (); - _original_type = ref->original_type (); - - connect_to_fonts (); -} - -/** _mutex must not be held on entry */ -void -CaptionContent::as_xml (xmlpp::Node* root) const -{ - boost::mutex::scoped_lock lm (_mutex); - - xmlpp::Element* caption = root->add_child ("Caption"); - - caption->add_child("Use")->add_child_text (_use ? "1" : "0"); - caption->add_child("Burn")->add_child_text (_burn ? "1" : "0"); - caption->add_child("XOffset")->add_child_text (raw_convert (_x_offset)); - caption->add_child("YOffset")->add_child_text (raw_convert (_y_offset)); - caption->add_child("XScale")->add_child_text (raw_convert (_x_scale)); - caption->add_child("YScale")->add_child_text (raw_convert (_y_scale)); - caption->add_child("Language")->add_child_text (_language); - if (_colour) { - caption->add_child("Red")->add_child_text (raw_convert (_colour->r)); - caption->add_child("Green")->add_child_text (raw_convert (_colour->g)); - caption->add_child("Blue")->add_child_text (raw_convert (_colour->b)); - } - if (_effect) { - switch (*_effect) { - case dcp::NONE: - caption->add_child("Effect")->add_child_text("none"); - break; - case dcp::BORDER: - caption->add_child("Effect")->add_child_text("outline"); - break; - case dcp::SHADOW: - caption->add_child("Effect")->add_child_text("shadow"); - break; - } - } - if (_effect_colour) { - caption->add_child("EffectRed")->add_child_text (raw_convert (_effect_colour->r)); - caption->add_child("EffectGreen")->add_child_text (raw_convert (_effect_colour->g)); - caption->add_child("EffectBlue")->add_child_text (raw_convert (_effect_colour->b)); - } - caption->add_child("LineSpacing")->add_child_text (raw_convert (_line_spacing)); - if (_fade_in) { - caption->add_child("FadeIn")->add_child_text (raw_convert (_fade_in->get())); - } - if (_fade_out) { - caption->add_child("FadeOut")->add_child_text (raw_convert (_fade_out->get())); - } - caption->add_child("OutlineWidth")->add_child_text (raw_convert (_outline_width)); - - for (list >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) { - (*i)->as_xml (caption->add_child("Font")); - } - - caption->add_child("Type")->add_child_text (caption_type_to_string(_type)); - caption->add_child("OriginalType")->add_child_text (caption_type_to_string(_original_type)); -} - -string -CaptionContent::identifier () const -{ - string s = raw_convert (x_scale()) - + "_" + raw_convert (y_scale()) - + "_" + raw_convert (x_offset()) - + "_" + raw_convert (y_offset()) - + "_" + raw_convert (line_spacing()) - + "_" + raw_convert (fade_in().get_value_or(ContentTime()).get()) - + "_" + raw_convert (fade_out().get_value_or(ContentTime()).get()) - + "_" + raw_convert (outline_width()) - + "_" + raw_convert (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string()) - + "_" + raw_convert (dcp::effect_to_string(effect().get_value_or(dcp::NONE))) - + "_" + raw_convert (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string()); - - /* XXX: I suppose really _fonts shouldn't be in here, since not all - types of subtitle content involve fonts. - */ - BOOST_FOREACH (shared_ptr f, _fonts) { - for (int i = 0; i < FontFiles::VARIANTS; ++i) { - s += "_" + f->file(static_cast(i)).get_value_or("Default").string(); - } - } - - /* The language is for metadata only, and doesn't affect - how this content looks. - */ - - return s; -} - -void -CaptionContent::add_font (shared_ptr font) -{ - _fonts.push_back (font); - connect_to_fonts (); -} - -void -CaptionContent::connect_to_fonts () -{ - BOOST_FOREACH (boost::signals2::connection& i, _font_connections) { - i.disconnect (); - } - - _font_connections.clear (); - - BOOST_FOREACH (shared_ptr i, _fonts) { - _font_connections.push_back (i->Changed.connect (boost::bind (&CaptionContent::font_changed, this))); - } -} - -void -CaptionContent::font_changed () -{ - _parent->signal_changed (CaptionContentProperty::FONTS); -} - -void -CaptionContent::set_colour (dcp::Colour colour) -{ - maybe_set (_colour, colour, CaptionContentProperty::COLOUR); -} - -void -CaptionContent::unset_colour () -{ - maybe_set (_colour, optional(), CaptionContentProperty::COLOUR); -} - -void -CaptionContent::set_effect (dcp::Effect e) -{ - maybe_set (_effect, e, CaptionContentProperty::EFFECT); -} - -void -CaptionContent::unset_effect () -{ - maybe_set (_effect, optional(), CaptionContentProperty::EFFECT); -} - -void -CaptionContent::set_effect_colour (dcp::Colour colour) -{ - maybe_set (_effect_colour, colour, CaptionContentProperty::EFFECT_COLOUR); -} - -void -CaptionContent::unset_effect_colour () -{ - maybe_set (_effect_colour, optional(), CaptionContentProperty::EFFECT_COLOUR); -} - -void -CaptionContent::set_use (bool u) -{ - maybe_set (_use, u, CaptionContentProperty::USE); -} - -void -CaptionContent::set_burn (bool b) -{ - maybe_set (_burn, b, CaptionContentProperty::BURN); -} - -void -CaptionContent::set_x_offset (double o) -{ - maybe_set (_x_offset, o, CaptionContentProperty::X_OFFSET); -} - -void -CaptionContent::set_y_offset (double o) -{ - maybe_set (_y_offset, o, CaptionContentProperty::Y_OFFSET); -} - -void -CaptionContent::set_x_scale (double s) -{ - maybe_set (_x_scale, s, CaptionContentProperty::X_SCALE); -} - -void -CaptionContent::set_y_scale (double s) -{ - maybe_set (_y_scale, s, CaptionContentProperty::Y_SCALE); -} - -void -CaptionContent::set_language (string language) -{ - maybe_set (_language, language, CaptionContentProperty::LANGUAGE); -} - -void -CaptionContent::set_line_spacing (double s) -{ - maybe_set (_line_spacing, s, CaptionContentProperty::LINE_SPACING); -} - -void -CaptionContent::set_fade_in (ContentTime t) -{ - maybe_set (_fade_in, t, CaptionContentProperty::FADE_IN); -} - -void -CaptionContent::unset_fade_in () -{ - maybe_set (_fade_in, optional(), CaptionContentProperty::FADE_IN); -} - -void -CaptionContent::set_fade_out (ContentTime t) -{ - maybe_set (_fade_out, t, CaptionContentProperty::FADE_OUT); -} - -void -CaptionContent::unset_fade_out () -{ - maybe_set (_fade_out, optional(), CaptionContentProperty::FADE_OUT); -} - -void -CaptionContent::set_type (CaptionType type) -{ - maybe_set (_type, type, CaptionContentProperty::TYPE); -} - -void -CaptionContent::set_outline_width (int w) -{ - maybe_set (_outline_width, w, CaptionContentProperty::OUTLINE_WIDTH); -} - -void -CaptionContent::take_settings_from (shared_ptr c) -{ - set_use (c->_use); - set_burn (c->_burn); - set_x_offset (c->_x_offset); - set_y_offset (c->_y_offset); - set_x_scale (c->_x_scale); - set_y_scale (c->_y_scale); - maybe_set (_fonts, c->_fonts, CaptionContentProperty::FONTS); - if (c->_colour) { - set_colour (*c->_colour); - } else { - unset_colour (); - } - if (c->_effect) { - set_effect (*c->_effect); - } - if (c->_effect_colour) { - set_effect_colour (*c->_effect_colour); - } else { - unset_effect_colour (); - } - set_line_spacing (c->_line_spacing); - 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); -} -- cgit v1.2.3