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

diff --git a/src/subtitle.h b/src/subtitle.h
index 70a8eb6..6afdc51 100644
--- a/src/subtitle.h
+++ b/src/subtitle.h
@@ -25,44 +25,40 @@
 #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 ()
+	Block ()
 		: colour (1, 1, 1)
 		, bold (false)
 		, italic (false)
 		, underline (false)
-		, line (0)
 	{}
 
+	/** Construct a Block taking any relevant information from a RawSubtitle */
+	Block (RawSubtitle s);
+	
+	/** Subtitle text in UTF-8 */
 	std::string text;
 	std::string font;
 
 	/** font size */
-	struct {
-		/** as a proportion of screen height */
-		boost::optional<float> proportional;
-		/** in points */
-		boost::optional<int> points;
-	} font_size;
-
-	float font_size_proportional (int screen_height_in_points) const;
-	int font_size_points (int screen_height_in_points) const;
-
-	/** vertical position of the baseline of the text */
-	struct {
-		/** as a proportion of screen height offset from some reference point */
-		boost::optional<float> proportional;
-		/** reference position for proportional */
-		boost::optional<VerticalReference> reference;
-	} vertical_position;
+	FontSize font_size;
 
 	boost::optional<Effect> effect;
 	boost::optional<Colour> effect_colour;
@@ -71,31 +67,56 @@ public:
 	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
-	int line;
+};
 
-	/** from time */
-	struct {
-		boost::optional<FrameTime> frame;
-		boost::optional<MetricTime> metric;
-	} from;
+/** @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);
 
-	FrameTime  from_frame  (float frames_per_second) const;
-	MetricTime from_metric (float frames_per_second) const;
+	/** vertical position of the baseline of the text */
+	VerticalPosition vertical_position;
 
-	/** to time */
-	struct {
-		boost::optional<FrameTime> frame;
-		boost::optional<MetricTime> metric;
-	} to;
+	std::list<Block> blocks;
 
-	FrameTime  to_frame  (float frames_per_second) const;
-	MetricTime to_metric (float frames_per_second) const;
+	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;
-};
 
-bool operator< (Subtitle const & a, Subtitle const & b);	
+	std::list<Line> lines;
+
+	bool same_metadata (RawSubtitle) const;
+};
 
 }