Missing files.

[dcpomatic.git] / src / lib / text_content.h

diff --git a/src/lib/text_content.h b/src/lib/text_content.h
index cb3bb5ee4a8439c6dd6b2bd1cb6149eabbeaa4d6..5eda8764ffeaa91ea5c20758fb46c2cad71e1844 100644 (file)
--- a/src/lib/text_content.h
+++ b/src/lib/text_content.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,15 +18,18 @@
 
 */
 
-#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 <libcxml/cxml.h>
 #include <dcp/types.h>
 #include <boost/signals2.hpp>
 
-class Font;
+namespace dcpomatic {
+       class Font;
+}
 
 class TextContentProperty
 {
@@ -47,25 +50,26 @@ public:
        static int const FADE_OUT;
        static int const OUTLINE_WIDTH;
        static int const TYPE;
+       static int const DCP_TRACK;
 };
 
 /** @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, TextType type, TextType original_type);
        TextContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
 
        void as_xml (xmlpp::Node *) const;
        std::string identifier () const;
        void take_settings_from (boost::shared_ptr<const TextContent> c);
 
-       void add_font (boost::shared_ptr<Font> font);
+       void add_font (boost::shared_ptr<dcpomatic::Font> font);
 
        void set_use (bool);
        void set_burn (bool);
@@ -81,12 +85,14 @@ 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 ();
 
        bool use () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -118,7 +124,7 @@ public:
                return _y_scale;
        }
 
-       std::list<boost::shared_ptr<Font> > fonts () const {
+       std::list<boost::shared_ptr<dcpomatic::Font> > fonts () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fonts;
        }
@@ -148,12 +154,12 @@ public:
                return _line_spacing;
        }
 
-       boost::optional<ContentTime> fade_in () const {
+       boost::optional<dcpomatic::ContentTime> fade_in () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fade_in;
        }
 
-       boost::optional<ContentTime> fade_out () const {
+       boost::optional<dcpomatic::ContentTime> fade_out () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fade_out;
        }
@@ -168,7 +174,17 @@ public:
                return _type;
        }
 
-       static boost::shared_ptr<TextContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
+       TextType original_type () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _original_type;
+       }
+
+       boost::optional<DCPTextTrack> dcp_track () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _dcp_track;
+       }
+
+       static std::list<boost::shared_ptr<TextContent> > from_xml (Content* parent, cxml::ConstNodePtr, int version);
 
 protected:
        /** subtitle language (e.g. "German") or empty if it is not known */
@@ -197,16 +213,23 @@ private:
        double _x_scale;
        /** y scale factor to apply to subtitles */
        double _y_scale;
-       std::list<boost::shared_ptr<Font> > _fonts;
+       std::list<boost::shared_ptr<dcpomatic::Font> > _fonts;
        boost::optional<dcp::Colour> _colour;
        boost::optional<dcp::Effect> _effect;
        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;
-       boost::optional<ContentTime> _fade_in;
-       boost::optional<ContentTime> _fade_out;
+       boost::optional<dcpomatic::ContentTime> _fade_in;
+       boost::optional<dcpomatic::ContentTime> _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<DCPTextTrack> _dcp_track;
 };
 
 #endif