Add locale_convert. Reimplement raw_convert without stringstream.
[libdcp.git] / src / subtitle_asset.h
index cc27f958edee5b28303973c0caf65858282c9be5..d212579f280ca736f59cfa52855a6c8168221b7d 100644 (file)
@@ -1,20 +1,34 @@
 /*
     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
-    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 <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
@@ -26,6 +40,7 @@
 #include "data.h"
 #include <libcxml/cxml.h>
 #include <boost/shared_array.hpp>
+#include <map>
 
 namespace xmlpp {
        class Element;
@@ -55,7 +70,7 @@ class SubtitleAsset : public Asset
 {
 public:
        SubtitleAsset ();
-       SubtitleAsset (boost::filesystem::path file);
+       explicit SubtitleAsset (boost::filesystem::path file);
 
        bool equals (
                boost::shared_ptr<const Asset>,
@@ -63,17 +78,17 @@ public:
                NoteHandler note
                ) const;
 
-       std::list<SubtitleString> subtitles_during (Time from, Time to) const;
+       std::list<SubtitleString> subtitles_during (Time from, Time to, bool starting) const;
        std::list<SubtitleString> const & subtitles () const {
                return _subtitles;
        }
 
-       void add (SubtitleString);
+       virtual void add (SubtitleString);
        virtual void add_font (std::string id, boost::filesystem::path file) = 0;
-       std::map<std::string, Data> fonts () const;
+       std::map<std::string, Data> fonts_with_load_ids () const;
 
        virtual void write (boost::filesystem::path) const = 0;
-       virtual Glib::ustring xml_as_string () const = 0;
+       virtual std::string xml_as_string () const = 0;
 
        Time latest_subtitle_out () const;
 
@@ -83,30 +98,41 @@ 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);
-       void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, std::string xmlns) const;
-       void add_font_data (std::string id, boost::filesystem::path file);
+       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
+               );
+
+       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;
 
-       class FileData : public Data {
+       class Font
+       {
        public:
-               FileData () {}
+               Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_)
+                       : load_id (load_id_)
+                       , uuid (uuid_)
+                       , data (file_)
+                       , file (file_)
+               {}
 
-               FileData (boost::shared_array<uint8_t> data_, boost::uintmax_t size_)
-                       : Data (data_, size_)
+               Font (std::string load_id_, std::string uuid_, Data data_)
+                       : load_id (load_id_)
+                       , uuid (uuid_)
+                       , data (data_)
                {}
 
-               /** .ttf file that this data was last written to */
+               std::string load_id;
+               std::string uuid;
+               Data data;
+               /** .ttf file that this data was last written to, if applicable */
                mutable boost::optional<boost::filesystem::path> file;
        };
 
-       /** Font data, keyed by a subclass-dependent identifier.
-        *  For Interop, the string is the font ID from the subtitle file.
-        *  For SMPTE, the string is the font's URN from the subtitle file.
-        */
-       std::map<std::string, FileData> _fonts;
+       std::list<Font> _fonts;
 
 private:
        /** @struct ParseState
@@ -120,17 +146,23 @@ private:
 
        void maybe_add_subtitle (std::string text, ParseState const & parse_state);
 
-       void examine_font_nodes (
+       void examine_nodes (
                boost::shared_ptr<const cxml::Node> xml,
                std::list<boost::shared_ptr<FontNode> > const & font_nodes,
                ParseState& parse_state
                );
 
-       void examine_text_nodes (
+       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
+               );
 };
 
 }