You should have received a copy of the GNU General Public License
along with libdcp. If not, see <http://www.gnu.org/licenses/>.
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of portions of this program with the
+ OpenSSL library under certain conditions as described in each
+ individual source file, and distribute linked combinations
+ including the two.
+
+ You must obey the GNU General Public License in all respects
+ for all of the code used other than OpenSSL. If you modify
+ file(s) with this exception, you may extend this exception to your
+ version of the file(s), but you are not obligated to do so. If you
+ do not wish to do so, delete this exception statement from your
+ version. If you delete this exception statement from all source
+ files in the program, then also delete it here.
*/
#ifndef LIBDCP_SUBTITLE_ASSET_H
struct interop_dcp_font_test;
struct smpte_dcp_font_test;
+struct pull_fonts_test1;
+struct pull_fonts_test2;
+struct pull_fonts_test3;
namespace dcp
{
class SubtitleString;
+class SubtitleImage;
class FontNode;
class TextNode;
class SubtitleNode;
class LoadFontNode;
+namespace order {
+ class Part;
+ class Context;
+}
+
/** @class SubtitleAsset
* @brief A parent for classes representing a file containing subtitles.
*
- * This class holds a list of SubtitleString objects which it can extract
+ * This class holds a list of Subtitle objects which it can extract
* from the appropriate part of either an Interop or SMPTE XML file.
* Its subclasses InteropSubtitleAsset and SMPTESubtitleAsset handle the
* differences between the two types.
{
public:
SubtitleAsset ();
- SubtitleAsset (boost::filesystem::path file);
+ explicit SubtitleAsset (boost::filesystem::path file);
bool equals (
boost::shared_ptr<const Asset>,
NoteHandler note
) const;
- std::list<SubtitleString> subtitles_during (Time from, Time to, bool starting) const;
- std::list<SubtitleString> const & subtitles () const {
+ std::list<boost::shared_ptr<Subtitle> > subtitles_during (Time from, Time to, bool starting) const;
+ std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
return _subtitles;
}
- virtual void add (SubtitleString);
+ virtual void add (boost::shared_ptr<Subtitle>);
virtual void add_font (std::string id, boost::filesystem::path file) = 0;
std::map<std::string, Data> fonts_with_load_ids () const;
Time latest_subtitle_out () const;
+ void fix_empty_font_ids ();
+
virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
protected:
friend struct ::interop_dcp_font_test;
friend struct ::smpte_dcp_font_test;
- void parse_subtitles (
- boost::shared_ptr<cxml::Document> xml,
- std::list<boost::shared_ptr<FontNode> > font_nodes,
- std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes
- );
+ struct ParseState {
+ boost::optional<std::string> font_id;
+ boost::optional<int64_t> size;
+ boost::optional<float> aspect_adjust;
+ boost::optional<bool> italic;
+ boost::optional<bool> bold;
+ boost::optional<bool> underline;
+ boost::optional<Colour> colour;
+ boost::optional<Effect> effect;
+ boost::optional<Colour> effect_colour;
+ boost::optional<float> h_position;
+ boost::optional<HAlign> h_align;
+ boost::optional<float> v_position;
+ boost::optional<VAlign> v_align;
+ boost::optional<Direction> direction;
+ boost::optional<Time> in;
+ boost::optional<Time> out;
+ boost::optional<Time> fade_up_time;
+ boost::optional<Time> fade_down_time;
+ enum Type {
+ TEXT,
+ IMAGE
+ };
+ boost::optional<Type> type;
+ };
+
+ void parse_subtitles (xmlpp::Element const * node, std::list<ParseState>& state, boost::optional<int> tcr, Standard standard);
+ ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
+ ParseState text_node_state (xmlpp::Element const * node) const;
+ ParseState image_node_state (xmlpp::Element const * node) const;
+ ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
+ Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
+ void position_align (ParseState& ps, xmlpp::Element const * node) const;
void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
/** All our subtitles, in no particular order */
- std::list<SubtitleString> _subtitles;
+ std::list<boost::shared_ptr<Subtitle> > _subtitles;
class Font
{
mutable boost::optional<boost::filesystem::path> file;
};
+ /** TTF font data that we need */
std::list<Font> _fonts;
private:
- /** @struct ParseState
- * @brief A struct to hold state when parsing a subtitle XML file.
- */
- 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;
- };
+ friend struct ::pull_fonts_test1;
+ friend struct ::pull_fonts_test2;
+ friend struct ::pull_fonts_test3;
+
+ void maybe_add_subtitle (std::string text, std::list<ParseState> const & parse_state, Standard standard);
- void maybe_add_subtitle (std::string text, ParseState const & parse_state);
-
- void examine_nodes (
- boost::shared_ptr<const cxml::Node> xml,
- std::list<boost::shared_ptr<FontNode> > const & font_nodes,
- ParseState& parse_state
- );
-
- void examine_nodes (
- boost::shared_ptr<const cxml::Node> xml,
- std::list<boost::shared_ptr<TextNode> > const & text_nodes,
- ParseState& parse_state
- );
-
- void examine_nodes (
- boost::shared_ptr<const cxml::Node> xml,
- std::list<boost::shared_ptr<SubtitleNode> > const & subtitle_nodes,
- ParseState& parse_state
- );
+ static void pull_fonts (boost::shared_ptr<order::Part> part);
};
}
projects / libdcp.git / blobdiff