X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsubtitle.h;h=6afdc512505d72d5b416d3186f834a9f0c86a0bc;hb=589a2d8108899141756bd41126ab117e42f17701;hp=3afd0f33b5f95921efbbad641b6d19c73d4ee297;hpb=c8c3db36a4593e396681b4acd5e9d318a28b1648;p=libsub.git

diff --git a/src/subtitle.h b/src/subtitle.h
index 3afd0f3..6afdc51 100644
--- a/src/subtitle.h
+++ b/src/subtitle.h
@@ -21,53 +21,101 @@
 #define LIBSUB_SUBTITLE_H
 
 #include "frame_time.h"
+#include "metric_time.h"
+#include "colour.h"
+#include "vertical_reference.h"
+#include "effect.h"
+#include "time_pair.h"
+#include "font_size.h"
+#include "vertical_position.h"
+#include "raw_subtitle.h"
 #include <boost/optional.hpp>
 #include <string>
+#include <list>
 
 namespace sub {
 
-class Subtitle
+/** @class Block
+ *  @brief A block of text within a subtitle's line
+ *
+ *  This represents a block of text which has a particular style (font, size, effect, colour etc.)
+ */
+class Block
 {
 public:
-	Subtitle ()
-		: font_size (0)
+	Block ()
+		: colour (1, 1, 1)
 		, bold (false)
 		, italic (false)
 		, underline (false)
-		, line (0)
-	{}
-
-	Subtitle (
-		std::string text,
-		std::string font,
-		int font_size,
-		bool bold,
-		bool italic,
-		bool underline,
-		int line,
-		FrameTime from,
-		FrameTime to
-		)
-		: text (text)
-		, font (font)
-		, font_size (font_size)
-		, bold (bold)
-		, italic (italic)
-		, underline (underline)
-		, line (line)
-		, frame_from (from)
-		, frame_to (to)
 	{}
 
+	/** Construct a Block taking any relevant information from a RawSubtitle */
+	Block (RawSubtitle s);
+	
+	/** Subtitle text in UTF-8 */
 	std::string text;
 	std::string font;
-	int font_size;
-	bool bold;
-	bool italic;
-	bool underline;
-	int line;
-	boost::optional<FrameTime> frame_from;
-	boost::optional<FrameTime> frame_to;
+
+	/** font size */
+	FontSize font_size;
+
+	boost::optional<Effect> effect;
+	boost::optional<Colour> effect_colour;
+	
+	Colour colour;
+	bool bold;      ///< true to use a bold version of font
+	bool italic;    ///< true to use an italic version of font
+	bool underline; ///< true to underline
+};
+
+/** @class Line
+ *  @brief A line of text within a subtitle.
+ *
+ *  This represents a line of text which has a particular vertical position.
+ */
+class Line
+{
+public:
+	Line () {}
+	
+	/** Construct a Line taking any relevant information from a RawSubtitle */
+	Line (RawSubtitle s);
+
+	/** vertical position of the baseline of the text */
+	VerticalPosition vertical_position;
+
+	std::list<Block> blocks;
+
+	bool same_metadata (RawSubtitle) const;
+};
+
+/** @class Subtitle
+ *  @brief A subtitle which has been collected into lines and blocks.
+ *
+ *  This represents a chunk of text which appears and disappears at some particular
+ *  times.
+ */
+class Subtitle
+{
+public:
+	Subtitle ()
+	{}
+
+	/** Construct a Line taking any relevant information from a RawSubtitle */
+	Subtitle (RawSubtitle s);
+	
+	/** from time */
+	TimePair from;
+	/** to time */
+	TimePair to;
+	
+	boost::optional<MetricTime> fade_up;
+	boost::optional<MetricTime> fade_down;
+
+	std::list<Line> lines;
+
+	bool same_metadata (RawSubtitle) const;
 };
 
 }