/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
+#ifndef LIBDCP_SUBTITLE_ASSET_H
+#define LIBDCP_SUBTITLE_ASSET_H
+
#include "asset.h"
-#include "xml.h"
#include "dcp_time.h"
+#include "subtitle_string.h"
+#include <libcxml/cxml.h>
-namespace libdcp
-{
-
-class FontNode;
-
-class TextNode
-{
-public:
- TextNode () {}
- TextNode (boost::shared_ptr<const cxml::Node> node);
-
- float v_position;
- VAlign v_align;
- std::string text;
- std::list<boost::shared_ptr<FontNode> > font_nodes;
-};
-
-class SubtitleNode
-{
-public:
- SubtitleNode () {}
- SubtitleNode (boost::shared_ptr<const cxml::Node> node);
-
- Time in;
- Time out;
- Time fade_up_time;
- Time fade_down_time;
- std::list<boost::shared_ptr<FontNode> > font_nodes;
- std::list<boost::shared_ptr<TextNode> > text_nodes;
-
-private:
- Time fade_time (boost::shared_ptr<const cxml::Node>, std::string name);
-};
-
-class FontNode
-{
-public:
- FontNode () {}
- FontNode (boost::shared_ptr<const cxml::Node> node);
- FontNode (std::list<boost::shared_ptr<FontNode> > const & font_nodes);
-
- std::string text;
- std::string id;
- int size;
- boost::optional<bool> italic;
- boost::optional<Color> color;
- boost::optional<Effect> effect;
- boost::optional<Color> effect_color;
-
- std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
- std::list<boost::shared_ptr<FontNode> > font_nodes;
- std::list<boost::shared_ptr<TextNode> > text_nodes;
-};
+namespace xmlpp {
+ class Element;
+}
-class LoadFontNode
+namespace dcp
{
-public:
- LoadFontNode () {}
- LoadFontNode (boost::shared_ptr<const cxml::Node> node);
- std::string id;
- std::string uri;
-};
+class SubtitleString;
+class FontNode;
+class TextNode;
+class SubtitleNode;
+class LoadFontNode;
-class Subtitle
+/** @class SubtitleAsset
+ * @brief A parent for classes representing a file containing subtitles.
+ */
+class SubtitleAsset : public Asset
{
public:
- Subtitle (
- std::string font,
- bool italic,
- Color color,
- int size,
- Time in,
- Time out,
- float v_position,
- VAlign v_align,
- std::string text,
- Effect effect,
- Color effect_color,
- Time fade_up_time,
- Time fade_down_time
- );
-
- std::string font () const {
- return _font;
- }
-
- bool italic () const {
- return _italic;
- }
-
- Color color () const {
- return _color;
- }
-
- Time in () const {
- return _in;
- }
-
- Time out () const {
- return _out;
- }
-
- std::string text () const {
- return _text;
- }
+ SubtitleAsset ();
+ SubtitleAsset (boost::filesystem::path file);
- float v_position () const {
- return _v_position;
- }
+ bool equals (
+ boost::shared_ptr<const Asset>,
+ EqualityOptions,
+ NoteHandler note
+ ) const;
- VAlign v_align () const {
- return _v_align;
+ std::list<SubtitleString> subtitles_during (Time from, Time to) const;
+ std::list<SubtitleString> const & subtitles () const {
+ return _subtitles;
}
- Effect effect () const {
- return _effect;
- }
+ void add (SubtitleString);
- Color effect_color () const {
- return _effect_color;
- }
+ virtual void write (boost::filesystem::path) const = 0;
+ virtual Glib::ustring xml_as_string () const = 0;
- Time fade_up_time () const {
- return _fade_up_time;
- }
+ Time latest_subtitle_out () const;
- Time fade_down_time () const {
- return _fade_down_time;
- }
+ virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
- int size () const {
- return _size;
- }
+protected:
+ void parse_common (boost::shared_ptr<cxml::Document> xml, std::list<boost::shared_ptr<FontNode> > font_nodes);
- int size_in_pixels (int screen_height) const;
-
-private:
- std::string _font;
- bool _italic;
- Color _color;
- int _size;
- Time _in;
- Time _out;
- float _v_position;
- VAlign _v_align;
- std::string _text;
- Effect _effect;
- Color _effect_color;
- Time _fade_up_time;
- Time _fade_down_time;
-};
-
-bool operator== (Subtitle const & a, Subtitle const & b);
-std::ostream& operator<< (std::ostream& s, Subtitle const & sub);
-
-class SubtitleAsset : public Asset
-{
-public:
- SubtitleAsset (std::string directory, std::string xml_file);
- SubtitleAsset (std::string directory, std::string movie_title, std::string language);
-
- void write_to_cpl (std::ostream&) const;
- virtual bool equals (boost::shared_ptr<const Asset>, EqualityOptions, boost::function<void (NoteType, std::string)> note) const {
- /* XXX */
- note (ERROR, "subtitle assets not compared yet");
- return true;
- }
-
- std::string language () const {
- return _language;
- }
+ virtual std::string pkl_type (Standard) const = 0;
- std::list<boost::shared_ptr<Subtitle> > subtitles_at (Time t) const;
- std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
- return _subtitles;
+ std::string asdcp_kind () const {
+ return "Subtitle";
}
- void add (boost::shared_ptr<Subtitle>);
-
- void read_xml (std::string);
- void write_xml () const;
- void write_xml (std::ostream& s) const;
+ void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, std::string xmlns) const;
+
+ std::list<SubtitleString> _subtitles;
private:
- std::string font_id_to_name (std::string id) const;
- std::string escape (std::string) const;
-
struct ParseState {
std::list<boost::shared_ptr<FontNode> > font_nodes;
std::list<boost::shared_ptr<TextNode> > text_nodes;
std::list<boost::shared_ptr<TextNode> > const & text_nodes,
ParseState& parse_state
);
-
- std::string _movie_title;
- /* strangely, this is sometimes a string */
- std::string _reel_number;
- std::string _language;
- std::list<boost::shared_ptr<LoadFontNode> > _load_font_nodes;
-
- std::list<boost::shared_ptr<Subtitle> > _subtitles;
- bool _need_sort;
};
}
+
+#endif
projects / libdcp.git / blobdiff