X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fsubtitle_content.h;h=b64e4787b536b1d7fec96519027155ab9312e736;hp=b73119bdb9dccef91e87e516f3b1c475da3fdfda;hb=c6871fe8617b3de03662b7630355059393bf8043;hpb=05654d0e1799746a9df3ccab040c92e0ed825cac diff --git a/src/lib/subtitle_content.h b/src/lib/subtitle_content.h index b73119bdb..b64e4787b 100644 --- a/src/lib/subtitle_content.h +++ b/src/lib/subtitle_content.h @@ -1,84 +1,204 @@ /* - Copyright (C) 2013 Carl Hetherington + Copyright (C) 2013-2018 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 . */ #ifndef DCPOMATIC_SUBTITLE_CONTENT_H #define DCPOMATIC_SUBTITLE_CONTENT_H -#include "content.h" +#include "content_part.h" +#include +#include +#include + +class Font; class SubtitleContentProperty { public: - static int const SUBTITLE_X_OFFSET; - static int const SUBTITLE_Y_OFFSET; - static int const SUBTITLE_SCALE; - static int const SUBTITLE_USE; + static int const X_OFFSET; + static int const Y_OFFSET; + static int const X_SCALE; + static int const Y_SCALE; + static int const USE; + static int const BURN; + static int const LANGUAGE; + static int const FONTS; + static int const COLOUR; + static int const EFFECT; + static int const EFFECT_COLOUR; + static int const LINE_SPACING; + static int const FADE_IN; + static int const FADE_OUT; + static int const OUTLINE_WIDTH; }; -class SubtitleContent : public virtual Content +/** @class SubtitleContent + * @brief Description of how some subtitle content should be presented. + * + * There are `image' subtitles (bitmaps) and `text' subtitles (plain text), + * and not all of the settings in this class correspond to both types. + */ +class SubtitleContent : public ContentPart { public: - SubtitleContent (boost::shared_ptr, boost::filesystem::path); - SubtitleContent (boost::shared_ptr, cxml::ConstNodePtr, int version); - SubtitleContent (boost::shared_ptr, std::vector >); + explicit SubtitleContent (Content* parent); + SubtitleContent (Content* parent, std::vector >); void as_xml (xmlpp::Node *) const; + std::string identifier () const; + void take_settings_from (boost::shared_ptr c); + + void add_font (boost::shared_ptr font); + + void set_use (bool); + void set_burn (bool); + void set_x_offset (double); + void set_y_offset (double); + void set_x_scale (double); + void set_y_scale (double); + void set_language (std::string language); + void set_colour (dcp::Colour); + void unset_colour (); + void set_effect (dcp::Effect); + void unset_effect (); + void set_effect_colour (dcp::Colour); + 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); + return _use; + } + + bool burn () const { + boost::mutex::scoped_lock lm (_mutex); + return _burn; + } - void set_subtitle_use (bool); - void set_subtitle_x_offset (double); - void set_subtitle_y_offset (double); - void set_subtitle_scale (double); + double x_offset () const { + boost::mutex::scoped_lock lm (_mutex); + return _x_offset; + } - bool subtitle_use () const { + double y_offset () const { boost::mutex::scoped_lock lm (_mutex); - return _subtitle_use; + return _y_offset; } - double subtitle_x_offset () const { + double x_scale () const { boost::mutex::scoped_lock lm (_mutex); - return _subtitle_x_offset; + return _x_scale; } - double subtitle_y_offset () const { + double y_scale () const { boost::mutex::scoped_lock lm (_mutex); - return _subtitle_y_offset; + return _y_scale; } - double subtitle_scale () const { + std::list > fonts () const { boost::mutex::scoped_lock lm (_mutex); - return _subtitle_scale; + return _fonts; } + std::string language () const { + boost::mutex::scoped_lock lm (_mutex); + return _language; + } + + boost::optional colour () const { + boost::mutex::scoped_lock lm (_mutex); + return _colour; + } + + boost::optional effect () const { + boost::mutex::scoped_lock lm (_mutex); + return _effect; + } + + boost::optional effect_colour () const { + boost::mutex::scoped_lock lm (_mutex); + return _effect_colour; + } + + double line_spacing () const { + boost::mutex::scoped_lock lm (_mutex); + return _line_spacing; + } + + boost::optional fade_in () const { + boost::mutex::scoped_lock lm (_mutex); + return _fade_in; + } + + boost::optional fade_out () const { + boost::mutex::scoped_lock lm (_mutex); + return _fade_out; + } + + int outline_width () const { + boost::mutex::scoped_lock lm (_mutex); + return _outline_width; + } + + static boost::shared_ptr from_xml (Content* parent, cxml::ConstNodePtr, int version); + +protected: + /** subtitle language (e.g. "German") or empty if it is not known */ + std::string _language; + private: - friend class ffmpeg_pts_offset_test; + friend struct ffmpeg_pts_offset_test; + + SubtitleContent (Content* parent, cxml::ConstNodePtr, int version); + void font_changed (); + void connect_to_fonts (); + + std::list _font_connections; - bool _subtitle_use; + bool _use; + bool _burn; /** x offset for placing subtitles, as a proportion of the container width; * +ve is further right, -ve is further left. */ - double _subtitle_x_offset; + double _x_offset; /** y offset for placing subtitles, as a proportion of the container height; * +ve is further down the frame, -ve is further up. */ - double _subtitle_y_offset; - /** scale factor to apply to subtitles */ - double _subtitle_scale; + double _y_offset; + /** x scale factor to apply to subtitles */ + double _x_scale; + /** y scale factor to apply to subtitles */ + double _y_scale; + std::list > _fonts; + boost::optional _colour; + boost::optional _effect; + boost::optional _effect_colour; + /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */ + double _line_spacing; + boost::optional _fade_in; + boost::optional _fade_out; + int _outline_width; }; #endif