subtitle.h

/*
    Copyright (C) 2014 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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
*/
 
#ifndef LIBSUB_SUBTITLE_H
#define LIBSUB_SUBTITLE_H
 
#include "colour.h"
#include "vertical_reference.h"
#include "effect.h"
#include "font_size.h"
#include "vertical_position.h"
#include "horizontal_position.h"
#include "raw_subtitle.h"
#include <boost/optional.hpp>
#include <string>
#include <vector>
 
namespace sub {
 
class Block
{
public:
    Block ()
        : colour (1, 1, 1)
        , bold (false)
        , italic (false)
        , underline (false)
    {}
 
    Block (RawSubtitle s);
 
    std::string text;
    boost::optional<std::string> font;
 
    FontSize font_size;
 
    boost::optional<Effect> effect;
    boost::optional<Colour> effect_colour;
 
    Colour colour;
    bool bold;      
    bool italic;    
    bool underline; 
};
 
extern bool operator== (Block const & a, Block const & b);
 
class Line
{
public:
    Line ()
    {
        horizontal_position.reference = HORIZONTAL_CENTRE_OF_SCREEN;
    }
 
    Line (RawSubtitle s);
 
    HorizontalPosition horizontal_position;
 
    VerticalPosition vertical_position;
 
    std::vector<Block> blocks;
 
    bool same_metadata (RawSubtitle) const;
};
 
extern bool operator== (Line const & a, Line const & b);
 
class Subtitle
{
public:
    Subtitle ()
    {}
 
    Subtitle (RawSubtitle s);
 
    Time from;
    Time to;
 
    boost::optional<Time> fade_up;
    boost::optional<Time> fade_down;
 
    std::vector<Line> lines;
 
    bool same_metadata (RawSubtitle) const;
};
 
extern bool operator== (Subtitle const & a, Subtitle const & b);
 
}
 
#endif