X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsubtitle_asset.h;h=d212579f280ca736f59cfa52855a6c8168221b7d;hb=d927e9b913606f4fc982885c7582ecaf0e3c5a1a;hp=1b834522abff14126c6597143e19208b4d677c55;hpb=af9b2212f0d8f8c1f53aaf29e520b812dfdc321c;p=libdcp.git diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h index 1b834522..d212579f 100644 --- a/src/subtitle_asset.h +++ b/src/subtitle_asset.h @@ -1,211 +1,143 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2015 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp 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, + libdcp 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. - + along with libdcp. If not, see . + + 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 +#define LIBDCP_SUBTITLE_ASSET_H + #include "asset.h" -#include "xml.h" #include "dcp_time.h" +#include "subtitle_string.h" +#include "data.h" +#include +#include +#include + +namespace xmlpp { + class Element; +} -namespace libdcp -{ - -class FontNode; - -class TextNode : public XMLNode -{ -public: - TextNode () {} - TextNode (xmlpp::Node const * node); - - float v_position; - VAlign v_align; - std::string text; - std::list > font_nodes; -}; - -class SubtitleNode : public XMLNode -{ -public: - SubtitleNode () {} - SubtitleNode (xmlpp::Node const * node); - - Time in; - Time out; - Time fade_up_time; - Time fade_down_time; - std::list > font_nodes; - std::list > text_nodes; - -private: - Time fade_time (std::string name); -}; - -class FontNode : public XMLNode -{ -public: - FontNode () {} - FontNode (xmlpp::Node const * node); - FontNode (std::list > const & font_nodes); - - std::string text; - std::string id; - int size; - boost::optional italic; - boost::optional color; - boost::optional effect; - boost::optional effect_color; - - std::list > subtitle_nodes; - std::list > font_nodes; - std::list > text_nodes; -}; +struct interop_dcp_font_test; +struct smpte_dcp_font_test; -class LoadFontNode : public XMLNode +namespace dcp { -public: - LoadFontNode () {} - LoadFontNode (xmlpp::Node const * node); - - std::string id; - std::string uri; -}; -class Subtitle +class SubtitleString; +class FontNode; +class TextNode; +class SubtitleNode; +class LoadFontNode; + +/** @class SubtitleAsset + * @brief A parent for classes representing a file containing subtitles. + * + * This class holds a list of SubtitleString 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. + */ +class SubtitleAsset : public Asset { public: - Subtitle ( - std::string font, - bool italic, - Color color, - int size, - Time in, - Time out, - float v_position, - VAlign v_align, - std::string text, - Effect effect, - Color effect_color, - Time fade_up_time, - Time fade_down_time - ); - - std::string font () const { - return _font; - } - - bool italic () const { - return _italic; - } - - Color color () const { - return _color; - } + SubtitleAsset (); + explicit SubtitleAsset (boost::filesystem::path file); - Time in () const { - return _in; - } - - Time out () const { - return _out; - } - - std::string text () const { - return _text; - } - - float v_position () const { - return _v_position; - } - - VAlign v_align () const { - return _v_align; - } + bool equals ( + boost::shared_ptr, + EqualityOptions, + NoteHandler note + ) const; - Effect effect () const { - return _effect; + std::list subtitles_during (Time from, Time to, bool starting) const; + std::list const & subtitles () const { + return _subtitles; } - Color effect_color () const { - return _effect_color; - } + virtual void add (SubtitleString); + virtual void add_font (std::string id, boost::filesystem::path file) = 0; + std::map fonts_with_load_ids () const; - Time fade_up_time () const { - return _fade_up_time; - } + virtual void write (boost::filesystem::path) const = 0; + virtual std::string xml_as_string () const = 0; - Time fade_down_time () const { - return _fade_down_time; - } + Time latest_subtitle_out () const; - int size () const { - return _size; - } - - int size_in_pixels (int screen_height) const; + virtual std::list > load_font_nodes () const = 0; -private: - std::string _font; - bool _italic; - Color _color; - int _size; - Time _in; - Time _out; - float _v_position; - VAlign _v_align; - std::string _text; - Effect _effect; - Color _effect_color; - Time _fade_up_time; - Time _fade_down_time; -}; +protected: + friend struct ::interop_dcp_font_test; + friend struct ::smpte_dcp_font_test; -bool operator== (Subtitle const & a, Subtitle const & b); -std::ostream& operator<< (std::ostream& s, Subtitle const & sub); - -class SubtitleAsset : public Asset -{ -public: - SubtitleAsset (std::string directory, std::string xml_file); - SubtitleAsset (std::string directory, std::string movie_title, std::string language); - - void write_to_cpl (std::ostream&) const; - virtual bool equals (boost::shared_ptr, EqualityOptions, std::list& notes) const { - /* XXX */ - notes.push_back ("subtitle assets not compared yet"); - return true; - } - - std::string language () const { - return _language; - } - - std::list > subtitles_at (Time t) const; - std::list > const & subtitles () const { - return _subtitles; - } + void parse_subtitles ( + boost::shared_ptr xml, + std::list > font_nodes, + std::list > subtitle_nodes + ); - void add (boost::shared_ptr); + void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const; + + /** All our subtitles, in no particular order */ + std::list _subtitles; + + class Font + { + public: + Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_) + : load_id (load_id_) + , uuid (uuid_) + , data (file_) + , file (file_) + {} + + Font (std::string load_id_, std::string uuid_, Data data_) + : load_id (load_id_) + , uuid (uuid_) + , data (data_) + {} + + std::string load_id; + std::string uuid; + Data data; + /** .ttf file that this data was last written to, if applicable */ + mutable boost::optional file; + }; - void write_xml (); + std::list _fonts; private: - std::string font_id_to_name (std::string id) const; - + /** @struct ParseState + * @brief A struct to hold state when parsing a subtitle XML file. + */ struct ParseState { std::list > font_nodes; std::list > text_nodes; @@ -213,26 +145,26 @@ private: }; void maybe_add_subtitle (std::string text, ParseState const & parse_state); - - void examine_font_nodes ( - boost::shared_ptr xml, + + void examine_nodes ( + boost::shared_ptr xml, std::list > const & font_nodes, ParseState& parse_state ); - - void examine_text_nodes ( - boost::shared_ptr xml, + + void examine_nodes ( + boost::shared_ptr xml, std::list > const & text_nodes, ParseState& parse_state ); - std::string _movie_title; - /* strangely, this is sometimes a string */ - std::string _reel_number; - std::string _language; - std::list > _load_font_nodes; - - std::list > _subtitles; + void examine_nodes ( + boost::shared_ptr xml, + std::list > const & subtitle_nodes, + ParseState& parse_state + ); }; } + +#endif