X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ftext_content.h;h=83860dff54fb6f733356a30de07833b282a7d336;hp=941184388850fcb11bd3fd67ae139b285fb1de6c;hb=HEAD;hpb=d7ac100c0eb1b5efdcfbec59be870fd869252840 diff --git a/src/lib/text_content.h b/src/lib/text_content.h index 941184388..4d4bdc507 100644 --- a/src/lib/text_content.h +++ b/src/lib/text_content.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2013-2018 Carl Hetherington + Copyright (C) 2013-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -18,15 +18,22 @@ */ -#ifndef DCPOMATIC_SUBTITLE_CONTENT_H -#define DCPOMATIC_SUBTITLE_CONTENT_H + +#ifndef DCPOMATIC_CAPTION_CONTENT_H +#define DCPOMATIC_CAPTION_CONTENT_H + #include "content_part.h" +#include "dcp_text_track.h" #include +#include #include #include -class Font; + +namespace dcpomatic { + class Font; +} class TextContentProperty { @@ -37,7 +44,6 @@ public: 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; @@ -46,25 +52,33 @@ public: static int const FADE_IN; static int const FADE_OUT; static int const OUTLINE_WIDTH; + static int const TYPE; + static int const DCP_TRACK; + static int const LANGUAGE; + static int const LANGUAGE_IS_ADDITIONAL; }; + /** @class TextContent - * @brief Description of how some subtitle content should be presented. + * @brief Description of how some text content should be presented. * - * There are `image' subtitles (bitmaps) and `text' subtitles (plain text), + * There are `bitmap' subtitles and `plain' subtitles (plain text), * and not all of the settings in this class correspond to both types. */ class TextContent : public ContentPart { public: - explicit TextContent (Content* parent); - TextContent (Content* parent, std::vector >); + TextContent (Content* parent, TextType type, TextType original_type); + TextContent (Content* parent, std::vector>); + TextContent (Content* parent, cxml::ConstNodePtr, int version, std::list& notes); void as_xml (xmlpp::Node *) const; std::string identifier () const; - void take_settings_from (boost::shared_ptr c); + void take_settings_from (std::shared_ptr c); - void add_font (boost::shared_ptr font); + void clear_fonts (); + void add_font (std::shared_ptr font); + std::shared_ptr get_font(std::string id) const; void set_use (bool); void set_burn (bool); @@ -72,7 +86,6 @@ public: 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); @@ -80,11 +93,16 @@ public: void set_effect_colour (dcp::Colour); void unset_effect_colour (); void set_line_spacing (double s); - void set_fade_in (ContentTime); + void set_fade_in (dcpomatic::ContentTime); void unset_fade_in (); - void set_fade_out (ContentTime); + void set_fade_out (dcpomatic::ContentTime); void set_outline_width (int); void unset_fade_out (); + void set_type (TextType type); + void set_dcp_track (DCPTextTrack track); + void unset_dcp_track (); + void set_language (boost::optional language = boost::none); + void set_language_is_additional (bool additional); bool use () const { boost::mutex::scoped_lock lm (_mutex); @@ -116,16 +134,11 @@ public: return _y_scale; } - std::list > fonts () const { + std::list> fonts () const { boost::mutex::scoped_lock lm (_mutex); 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; @@ -146,12 +159,12 @@ public: return _line_spacing; } - boost::optional fade_in () const { + boost::optional fade_in () const { boost::mutex::scoped_lock lm (_mutex); return _fade_in; } - boost::optional fade_out () const { + boost::optional fade_out () const { boost::mutex::scoped_lock lm (_mutex); return _fade_out; } @@ -161,18 +174,39 @@ public: return _outline_width; } - static boost::shared_ptr from_xml (Content* parent, cxml::ConstNodePtr, int version); + TextType type () const { + boost::mutex::scoped_lock lm (_mutex); + return _type; + } + + TextType original_type () const { + boost::mutex::scoped_lock lm (_mutex); + return _original_type; + } -protected: - /** subtitle language (e.g. "German") or empty if it is not known */ - std::string _language; + boost::optional dcp_track () const { + boost::mutex::scoped_lock lm (_mutex); + return _dcp_track; + } + + boost::optional language () const { + boost::mutex::scoped_lock lm (_mutex); + return _language; + } + + bool language_is_additional () const { + boost::mutex::scoped_lock lm (_mutex); + return _language_is_additional; + } + + static std::vector> from_xml(Content* parent, cxml::ConstNodePtr, int version, std::list& notes); private: friend struct ffmpeg_pts_offset_test; - TextContent (Content* parent, cxml::ConstNodePtr, int version); void font_changed (); void connect_to_fonts (); + std::shared_ptr get_font_unlocked(std::string id) const; std::list _font_connections; @@ -190,15 +224,25 @@ private: double _x_scale; /** y scale factor to apply to subtitles */ double _y_scale; - std::list > _fonts; + 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; + boost::optional _fade_in; + boost::optional _fade_out; int _outline_width; + /** what these captions will be used for in the output DCP (not necessarily what + * they were originally). + */ + TextType _type; + /** the original type of these captions in their content */ + TextType _original_type; + /** the track of closed captions that this content should be put in, or empty to put in the default (only) track */ + boost::optional _dcp_track; + boost::optional _language; + bool _language_is_additional = false; }; #endif