X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fsubtitle_content.cc;h=422bb65658e9e4a2afc160e1117a37c13d3ac470;hb=422be0eece2bf6ee80db1d3c21553cd82efff789;hp=215829659a296cc179dc9b824073a3057ad2cd48;hpb=e60bb3e51bd1508b149e6b8f6608f09b5196ae26;p=dcpomatic.git diff --git a/src/lib/subtitle_content.cc b/src/lib/subtitle_content.cc index 215829659..422bb6565 100644 --- a/src/lib/subtitle_content.cc +++ b/src/lib/subtitle_content.cc @@ -1,30 +1,34 @@ /* - Copyright (C) 2013-2014 Carl Hetherington + Copyright (C) 2013-2016 Carl Hetherington - 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 . */ #include "subtitle_content.h" #include "util.h" #include "exceptions.h" -#include "safe_stringstream.h" #include "font.h" #include "raw_convert.h" +#include "content.h" +#include #include +#include #include +#include #include "i18n.h" @@ -35,65 +39,109 @@ using std::list; using boost::shared_ptr; using boost::dynamic_pointer_cast; -int const SubtitleContentProperty::SUBTITLE_X_OFFSET = 500; -int const SubtitleContentProperty::SUBTITLE_Y_OFFSET = 501; -int const SubtitleContentProperty::SUBTITLE_X_SCALE = 502; -int const SubtitleContentProperty::SUBTITLE_Y_SCALE = 503; -int const SubtitleContentProperty::USE_SUBTITLES = 504; -int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 505; -int const SubtitleContentProperty::FONTS = 506; - -SubtitleContent::SubtitleContent (shared_ptr film) - : Content (film) - , _use_subtitles (false) - , _subtitle_x_offset (0) - , _subtitle_y_offset (0) - , _subtitle_x_scale (1) - , _subtitle_y_scale (1) +int const SubtitleContentProperty::X_OFFSET = 500; +int const SubtitleContentProperty::Y_OFFSET = 501; +int const SubtitleContentProperty::X_SCALE = 502; +int const SubtitleContentProperty::Y_SCALE = 503; +int const SubtitleContentProperty::USE = 504; +int const SubtitleContentProperty::BURN = 505; +int const SubtitleContentProperty::LANGUAGE = 506; +int const SubtitleContentProperty::FONTS = 507; +int const SubtitleContentProperty::COLOUR = 508; +int const SubtitleContentProperty::OUTLINE = 509; +int const SubtitleContentProperty::SHADOW = 510; +int const SubtitleContentProperty::EFFECT_COLOUR = 511; +int const SubtitleContentProperty::LINE_SPACING = 512; + +SubtitleContent::SubtitleContent (Content* parent) + : ContentPart (parent) + , _use (false) + , _burn (false) + , _x_offset (0) + , _y_offset (0) + , _x_scale (1) + , _y_scale (1) + , _colour (255, 255, 255) + , _outline (false) + , _shadow (false) + , _effect_colour (0, 0, 0) + , _line_spacing (1) { } -SubtitleContent::SubtitleContent (shared_ptr film, boost::filesystem::path p) - : Content (film, p) - , _use_subtitles (false) - , _subtitle_x_offset (0) - , _subtitle_y_offset (0) - , _subtitle_x_scale (1) - , _subtitle_y_scale (1) +shared_ptr +SubtitleContent::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 shared_ptr (); + } + + /* Otherwise we can drop through to the newer logic */ + } + + if (!node->optional_number_child("SubtitleXOffset") && !node->optional_number_child("SubtitleOffset")) { + return shared_ptr (); + } + return shared_ptr (new SubtitleContent (parent, node, version)); } -SubtitleContent::SubtitleContent (shared_ptr film, cxml::ConstNodePtr node, int version) - : Content (film, node) - , _use_subtitles (false) - , _subtitle_x_offset (0) - , _subtitle_y_offset (0) - , _subtitle_x_scale (1) - , _subtitle_y_scale (1) +SubtitleContent::SubtitleContent (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) + , _colour ( + node->optional_number_child("Red").get_value_or(255), + node->optional_number_child("Green").get_value_or(255), + node->optional_number_child("Blue").get_value_or(255) + ) + , _outline (node->optional_bool_child("Outline").get_value_or(false)) + , _shadow (node->optional_bool_child("Shadow").get_value_or(false)) + , _line_spacing (node->optional_number_child("LineSpacing").get_value_or (1)) { if (version >= 32) { - _use_subtitles = node->bool_child ("UseSubtitles"); - } else { - _use_subtitles = false; + _use = node->bool_child ("UseSubtitles"); + _burn = node->bool_child ("BurnSubtitles"); } if (version >= 7) { - _subtitle_x_offset = node->number_child ("SubtitleXOffset"); - _subtitle_y_offset = node->number_child ("SubtitleYOffset"); + _x_offset = node->number_child ("SubtitleXOffset"); + _y_offset = node->number_child ("SubtitleYOffset"); } else { - _subtitle_y_offset = node->number_child ("SubtitleOffset"); + _y_offset = node->number_child ("SubtitleOffset"); } if (version >= 10) { - _subtitle_x_scale = node->number_child ("SubtitleXScale"); - _subtitle_y_scale = node->number_child ("SubtitleYScale"); + _x_scale = node->number_child ("SubtitleXScale"); + _y_scale = node->number_child ("SubtitleYScale"); + } else { + _x_scale = _y_scale = node->number_child ("SubtitleScale"); + } + + if (version >= 36) { + _effect_colour = dcp::Colour ( + node->optional_number_child("EffectRed").get_value_or(255), + node->optional_number_child("EffectGreen").get_value_or(255), + node->optional_number_child("EffectBlue").get_value_or(255) + ); } else { - _subtitle_x_scale = _subtitle_y_scale = node->number_child ("SubtitleScale"); + _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) + ); } - _subtitle_language = node->optional_string_child ("SubtitleLanguage").get_value_or (""); + _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) { @@ -103,37 +151,44 @@ SubtitleContent::SubtitleContent (shared_ptr film, cxml::ConstNodePt connect_to_fonts (); } -SubtitleContent::SubtitleContent (shared_ptr film, vector > c) - : Content (film, c) +SubtitleContent::SubtitleContent (Content* parent, vector > c) + : ContentPart (parent) { - shared_ptr ref = dynamic_pointer_cast (c[0]); + shared_ptr ref = c[0]->subtitle; DCPOMATIC_ASSERT (ref); list > ref_fonts = ref->fonts (); - for (size_t i = 0; i < c.size(); ++i) { - shared_ptr sc = dynamic_pointer_cast (c[i]); + for (size_t i = 1; i < c.size(); ++i) { - if (sc->use_subtitles() != ref->use_subtitles()) { + if (c[i]->subtitle->use() != ref->use()) { throw JoinError (_("Content to be joined must have the same 'use subtitles' setting.")); } - if (sc->subtitle_x_offset() != ref->subtitle_x_offset()) { + if (c[i]->subtitle->burn() != ref->burn()) { + throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting.")); + } + + if (c[i]->subtitle->x_offset() != ref->x_offset()) { throw JoinError (_("Content to be joined must have the same subtitle X offset.")); } - if (sc->subtitle_y_offset() != ref->subtitle_y_offset()) { + if (c[i]->subtitle->y_offset() != ref->y_offset()) { throw JoinError (_("Content to be joined must have the same subtitle Y offset.")); } - if (sc->subtitle_x_scale() != ref->subtitle_x_scale()) { + if (c[i]->subtitle->x_scale() != ref->x_scale()) { throw JoinError (_("Content to be joined must have the same subtitle X scale.")); } - if (sc->subtitle_y_scale() != ref->subtitle_y_scale()) { + if (c[i]->subtitle->y_scale() != ref->y_scale()) { throw JoinError (_("Content to be joined must have the same subtitle Y scale.")); } - list > fonts = sc->fonts (); + if (c[i]->subtitle->line_spacing() != ref->line_spacing()) { + throw JoinError (_("Content to be joined must have the same subtitle line spacing.")); + } + + list > fonts = c[i]->subtitle->fonts (); if (fonts.size() != ref_fonts.size()) { throw JoinError (_("Content to be joined must use the same fonts.")); } @@ -150,13 +205,15 @@ SubtitleContent::SubtitleContent (shared_ptr film, vectoruse_subtitles (); - _subtitle_x_offset = ref->subtitle_x_offset (); - _subtitle_y_offset = ref->subtitle_y_offset (); - _subtitle_x_scale = ref->subtitle_x_scale (); - _subtitle_y_scale = ref->subtitle_y_scale (); - _subtitle_language = ref->subtitle_language (); + _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 (); connect_to_fonts (); } @@ -167,119 +224,149 @@ SubtitleContent::as_xml (xmlpp::Node* root) const { boost::mutex::scoped_lock lm (_mutex); - root->add_child("UseSubtitles")->add_child_text (raw_convert (_use_subtitles)); - root->add_child("SubtitleXOffset")->add_child_text (raw_convert (_subtitle_x_offset)); - root->add_child("SubtitleYOffset")->add_child_text (raw_convert (_subtitle_y_offset)); - root->add_child("SubtitleXScale")->add_child_text (raw_convert (_subtitle_x_scale)); - root->add_child("SubtitleYScale")->add_child_text (raw_convert (_subtitle_y_scale)); - root->add_child("SubtitleLanguage")->add_child_text (_subtitle_language); + root->add_child("UseSubtitles")->add_child_text (raw_convert (_use)); + root->add_child("BurnSubtitles")->add_child_text (raw_convert (_burn)); + root->add_child("SubtitleXOffset")->add_child_text (raw_convert (_x_offset)); + root->add_child("SubtitleYOffset")->add_child_text (raw_convert (_y_offset)); + root->add_child("SubtitleXScale")->add_child_text (raw_convert (_x_scale)); + root->add_child("SubtitleYScale")->add_child_text (raw_convert (_y_scale)); + root->add_child("SubtitleLanguage")->add_child_text (_language); + root->add_child("Red")->add_child_text (raw_convert (_colour.r)); + root->add_child("Green")->add_child_text (raw_convert (_colour.g)); + root->add_child("Blue")->add_child_text (raw_convert (_colour.b)); + root->add_child("Outline")->add_child_text (raw_convert (_outline)); + root->add_child("Shadow")->add_child_text (raw_convert (_shadow)); + root->add_child("EffectRed")->add_child_text (raw_convert (_effect_colour.r)); + root->add_child("EffectGreen")->add_child_text (raw_convert (_effect_colour.g)); + root->add_child("EffectBlue")->add_child_text (raw_convert (_effect_colour.b)); + root->add_child("LineSpacing")->add_child_text (raw_convert (_line_spacing)); for (list >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) { (*i)->as_xml (root->add_child("Font")); } } -void -SubtitleContent::set_use_subtitles (bool u) +string +SubtitleContent::identifier () const { - { - boost::mutex::scoped_lock lm (_mutex); - _use_subtitles = u; + locked_stringstream s; + s << raw_convert (x_scale()) + << "_" << raw_convert (y_scale()) + << "_" << raw_convert (x_offset()) + << "_" << raw_convert (y_offset()) + << "_" << raw_convert (line_spacing()); + + /* 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"); + } } - signal_changed (SubtitleContentProperty::USE_SUBTITLES); + + /* The language is for metadata only, and doesn't affect + how this content looks. + */ + + return s.str (); } void -SubtitleContent::set_subtitle_x_offset (double o) +SubtitleContent::add_font (shared_ptr font) { - { - boost::mutex::scoped_lock lm (_mutex); - _subtitle_x_offset = o; - } - signal_changed (SubtitleContentProperty::SUBTITLE_X_OFFSET); + _fonts.push_back (font); + connect_to_fonts (); } void -SubtitleContent::set_subtitle_y_offset (double o) +SubtitleContent::connect_to_fonts () { - { - boost::mutex::scoped_lock lm (_mutex); - _subtitle_y_offset = o; + 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 (&SubtitleContent::font_changed, this))); } - signal_changed (SubtitleContentProperty::SUBTITLE_Y_OFFSET); } void -SubtitleContent::set_subtitle_x_scale (double s) +SubtitleContent::font_changed () { - { - boost::mutex::scoped_lock lm (_mutex); - _subtitle_x_scale = s; - } - signal_changed (SubtitleContentProperty::SUBTITLE_X_SCALE); + _parent->signal_changed (SubtitleContentProperty::FONTS); } void -SubtitleContent::set_subtitle_y_scale (double s) +SubtitleContent::set_colour (dcp::Colour colour) { - { - boost::mutex::scoped_lock lm (_mutex); - _subtitle_y_scale = s; - } - signal_changed (SubtitleContentProperty::SUBTITLE_Y_SCALE); + maybe_set (_colour, colour, SubtitleContentProperty::COLOUR); } void -SubtitleContent::set_subtitle_language (string language) +SubtitleContent::set_outline (bool o) { - { - boost::mutex::scoped_lock lm (_mutex); - _subtitle_language = language; - } - signal_changed (SubtitleContentProperty::SUBTITLE_LANGUAGE); + maybe_set (_outline, o, SubtitleContentProperty::OUTLINE); } -string -SubtitleContent::identifier () const +void +SubtitleContent::set_shadow (bool s) { - SafeStringStream s; - s << Content::identifier() - << "_" << raw_convert (subtitle_x_scale()) - << "_" << raw_convert (subtitle_y_scale()) - << "_" << raw_convert (subtitle_x_offset()) - << "_" << raw_convert (subtitle_y_offset()); + maybe_set (_shadow, s, SubtitleContentProperty::SHADOW); +} - /* The language is for metadata only, and doesn't affect - how this content looks. - */ +void +SubtitleContent::set_effect_colour (dcp::Colour colour) +{ + maybe_set (_effect_colour, colour, SubtitleContentProperty::EFFECT_COLOUR); +} - return s.str (); +void +SubtitleContent::set_use (bool u) +{ + maybe_set (_use, u, SubtitleContentProperty::USE); } void -SubtitleContent::add_font (shared_ptr font) +SubtitleContent::set_burn (bool b) { - _fonts.push_back (font); - connect_to_fonts (); + maybe_set (_burn, b, SubtitleContentProperty::BURN); } void -SubtitleContent::connect_to_fonts () +SubtitleContent::set_x_offset (double o) { - BOOST_FOREACH (boost::signals2::connection& i, _font_connections) { - i.disconnect (); - } + maybe_set (_x_offset, o, SubtitleContentProperty::X_OFFSET); +} - _font_connections.clear (); +void +SubtitleContent::set_y_offset (double o) +{ + maybe_set (_y_offset, o, SubtitleContentProperty::Y_OFFSET); +} - BOOST_FOREACH (shared_ptr i, _fonts) { - _font_connections.push_back (i->Changed.connect (boost::bind (&SubtitleContent::font_changed, this))); - } +void +SubtitleContent::set_x_scale (double s) +{ + maybe_set (_x_scale, s, SubtitleContentProperty::X_SCALE); } void -SubtitleContent::font_changed () +SubtitleContent::set_y_scale (double s) +{ + maybe_set (_y_scale, s, SubtitleContentProperty::Y_SCALE); +} + +void +SubtitleContent::set_language (string language) { - signal_changed (SubtitleContentProperty::FONTS); + maybe_set (_language, language, SubtitleContentProperty::LANGUAGE); } +void +SubtitleContent::set_line_spacing (double s) +{ + maybe_set (_line_spacing, s, SubtitleContentProperty::LINE_SPACING); +}