Initial work on SMPTE subtitles.

[libdcp.git] / src / subtitle_asset.h

diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h
index 038ff1fa98b4fcf96316683948901d639a8b81e9..c8100d58b1503939aa841a3ab4313dfbf06536e3 100644 (file)
--- a/src/subtitle_asset.h
+++ b/src/subtitle_asset.h
@@ -1,5 +1,5 @@
 /*
-    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
@@ -17,125 +17,91 @@
 
 */
 
+#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 TextNode : public XMLNode
-{
-public:
-       TextNode () {}
-       TextNode (xmlpp::Node const * node);
-
-       float v_position;
-       std::string text;
-};
-
-class SubtitleNode : public XMLNode
-{
-public:
-       SubtitleNode () {}
-       SubtitleNode (xmlpp::Node const * node);
-
-       Time in;
-       Time out;
-       std::list<boost::shared_ptr<TextNode> > text_nodes;
-};
-
-class FontNode : public XMLNode
-{
-public:
-       FontNode () {}
-       FontNode (xmlpp::Node const * node);
-
-       std::string id;
-       int size;
-       
-       std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
-};
+namespace xmlpp {
+       class Element;
+}
 
-class LoadFontNode : public XMLNode
+namespace dcp
 {
-public:
-       LoadFontNode () {}
-       LoadFontNode (xmlpp::Node const * 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,
-               int size,
-               Time in,
-               Time out,
-               float v_position,
-               std::string text
-               );
-
-       std::string font () const {
-               return _font;
-       }
-
-       Time in () const {
-               return _in;
+       SubtitleAsset ();
+       SubtitleAsset (boost::filesystem::path file);
+
+       bool equals (
+               boost::shared_ptr<const Asset>,
+               EqualityOptions,
+               NoteHandler note
+               ) const;
+
+       std::list<SubtitleString> subtitles_during (Time from, Time to) const;
+       std::list<SubtitleString> const & subtitles () const {
+               return _subtitles;
        }
 
-       Time out () const {
-               return _out;
-       }
+       void add (SubtitleString);
 
-       std::string text () const {
-               return _text;
-       }
+       virtual void write (boost::filesystem::path) const = 0;
+       virtual Glib::ustring xml_as_string () const = 0;
 
-       float v_position () const {
-               return _v_position;
-       }
+       Time latest_subtitle_out () const;
 
-       int size_in_pixels (int screen_height) const;
+       virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
 
-private:
-       std::string _font;
-       int _size;
-       Time _in;
-       Time _out;
-       float _v_position;
-       std::string _text;
-};
-
-class SubtitleAsset : public Asset, public XMLFile
-{
-public:
-       SubtitleAsset (std::string directory, std::string xml);
-
-       void write_to_cpl (std::ostream&) const {}
-       virtual std::list<std::string> equals (boost::shared_ptr<const Asset>, EqualityOptions) const {
-               /* XXX */
-               return std::list<std::string> ();
-       }
+protected:
+       void parse_common (boost::shared_ptr<cxml::Document> xml, std::list<boost::shared_ptr<FontNode> > font_nodes);
+       
+       virtual std::string pkl_type (Standard) const = 0;
 
-       std::string language () const {
-               return _language;
+       std::string asdcp_kind () const {
+               return "Subtitle";
        }
 
-       std::list<boost::shared_ptr<Subtitle> > subtitles_at (Time t) 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, std::list<boost::shared_ptr<LoadFontNode> > const & load_font_nodes) const;
-       
-       std::string _subtitle_id;
-       std::string _movie_title;
-       int64_t _reel_number;
-       std::string _language;
+       struct ParseState {
+               std::list<boost::shared_ptr<FontNode> > font_nodes;
+               std::list<boost::shared_ptr<TextNode> > text_nodes;
+               std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
+       };
 
-       std::list<boost::shared_ptr<Subtitle> > _subtitles;
+       void maybe_add_subtitle (std::string text, ParseState const & parse_state);
+       
+       void examine_font_nodes (
+               boost::shared_ptr<const cxml::Node> xml,
+               std::list<boost::shared_ptr<FontNode> > const & font_nodes,
+               ParseState& parse_state
+               );
+       
+       void examine_text_nodes (
+               boost::shared_ptr<const cxml::Node> xml,
+               std::list<boost::shared_ptr<TextNode> > const & text_nodes,
+               ParseState& parse_state
+               );
 };
 
 }
+
+#endif