#define LIBDCP_SUBTITLE_STRING_H
#include "types.h"
+#include "subtitle.h"
#include "dcp_time.h"
#include <boost/optional.hpp>
#include <string>
/** @class SubtitleString
* @brief A single line of subtitle text with all the associated attributes.
*/
-class SubtitleString
+class SubtitleString : public Subtitle
{
public:
SubtitleString (
boost::optional<std::string> font,
bool italic,
bool bold,
+ bool underline,
Colour colour,
int size,
float aspect_adjust,
return _bold;
}
- Colour colour () const {
- return _colour;
+ bool underline () const {
+ return _underline;
}
- Time in () const {
- return _in;
- }
-
- Time out () const {
- return _out;
+ Colour colour () const {
+ return _colour;
}
std::string text () const {
return _text;
}
- float h_position () const {
- return _h_position;
- }
-
- HAlign h_align () const {
- return _h_align;
- }
-
- /** @return vertical position as a proportion of the screen height from the
- * vertical alignment point.
- * (between 0 and 1)
- */
- float v_position () const {
- return _v_position;
- }
-
- VAlign v_align () const {
- return _v_align;
- }
-
Direction direction () const {
return _direction;
}
return _effect_colour;
}
- Time fade_up_time () const {
- return _fade_up_time;
- }
-
- Time fade_down_time () const {
- return _fade_down_time;
- }
-
int size () const {
return _size;
}
return _aspect_adjust;
}
- void set_in (Time i) {
- _in = i;
+ void set_font (std::string id) {
+ _font = id;
}
- void set_out (Time o) {
- _out = o;
- }
-
- void set_h_position (float p) {
- _h_position = p;
- }
-
- /** @param p New vertical position as a proportion of the screen height
- * from the top (between 0 and 1)
- */
- void set_v_position (float p) {
- _v_position = p;
+ void unset_font () {
+ _font = boost::optional<std::string>();
}
void set_size (int s) {
_aspect_adjust = a;
}
+ void set_text (std::string t) {
+ _text = t;
+ }
+
+ void set_colour (Colour c) {
+ _colour = c;
+ }
+
+ void set_effect (Effect e) {
+ _effect = e;
+ }
+
+ void set_effect_colour (Colour c) {
+ _effect_colour = c;
+ }
+
private:
/** font ID */
boost::optional<std::string> _font;
bool _italic;
/** true if the weight is bold, false for normal */
bool _bold;
+ /** true to enable underlining, false otherwise */
+ bool _underline;
/** text colour */
Colour _colour;
/** Size in points as if the screen height is 11 inches, so a 72pt font
*/
int _size;
float _aspect_adjust;
- Time _in;
- Time _out;
- /** Horizontal position as a proportion of the screen width from the _h_align
- * (between 0 and 1)
- */
- float _h_position;
- HAlign _h_align;
- /** Vertical position as a proportion of the screen height from the _v_align
- * (between 0 and 1)
- */
- float _v_position;
- VAlign _v_align;
Direction _direction;
std::string _text;
Effect _effect;
Colour _effect_colour;
- Time _fade_up_time;
- Time _fade_down_time;
};
bool operator== (SubtitleString const & a, SubtitleString const & b);
+bool operator!= (SubtitleString const & a, SubtitleString const & b);
std::ostream& operator<< (std::ostream& s, SubtitleString const & sub);
}