Tidying.

[libdcp.git] / src / interop_subtitle_asset.h

diff --git a/src/interop_subtitle_asset.h b/src/interop_subtitle_asset.h
index 8690d11c3b82205b41e83291c3327012e32d1d9b..07bfeadfafff99ffa9a3a73014f93c9ac4008b6e 100644 (file)
--- a/src/interop_subtitle_asset.h
+++ b/src/interop_subtitle_asset.h
@@ -1,35 +1,54 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 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.
 */
 
+
 /** @file  src/interop_subtitle_asset.h
- *  @brief InteropSubtitleAsset class.
+ *  @brief InteropSubtitleAsset class
  */
 
+
 #include "subtitle_asset.h"
 #include <boost/filesystem.hpp>
 
+
 namespace dcp {
 
+
 class InteropLoadFontNode;
 
+
 /** @class InteropSubtitleAsset
- *  @brief A set of subtitles to be read and/or written in the Inter-Op format.
+ *  @brief A set of subtitles to be read and/or written in the Inter-Op format
  *
  *  Inter-Op subtitles are sometimes known as CineCanvas.
  */
@@ -37,22 +56,29 @@ class InteropSubtitleAsset : public SubtitleAsset
 {
 public:
        InteropSubtitleAsset ();
-       InteropSubtitleAsset (boost::filesystem::path file);
+       explicit InteropSubtitleAsset (boost::filesystem::path file);
 
        bool equals (
-               boost::shared_ptr<const Asset>,
+               std::shared_ptr<const Asset>,
                EqualityOptions,
                NoteHandler note
                ) const;
 
-       std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
+       void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
+       void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
 
-       void add_font (std::string load_id, boost::filesystem::path file);
+       std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
 
-       Glib::ustring xml_as_string () const;
+       void add_font (std::string load_id, dcp::ArrayData data);
+
+       std::string xml_as_string () const;
+
+       /** Write this content to an XML file with its fonts alongside */
        void write (boost::filesystem::path path) const;
-       void resolve_fonts (std::list<boost::shared_ptr<Object> > objects);
-       void add_font_assets (std::list<boost::shared_ptr<Asset> >& assets);
+
+       void resolve_fonts (std::vector<std::shared_ptr<Asset>> assets);
+       void add_font_assets (std::vector<std::shared_ptr<Asset>>& assets);
+       void set_font_file (std::string load_id, boost::filesystem::path file);
 
        /** Set the reel number or sub-element identifier
         *  of these subtitles.
@@ -91,17 +117,26 @@ public:
                return _movie_title;
        }
 
+       int time_code_rate () const {
+               /* Interop can use either; just pick one */
+               return 1000;
+       }
+
+       static std::string static_pkl_type (Standard) {
+               return "text/xml;asdcpKind=Subtitle";
+       }
+
 protected:
 
-       std::string pkl_type (Standard) const {
-               return "text/xml";
+       std::string pkl_type (Standard s) const {
+               return static_pkl_type (s);
        }
 
 private:
        std::string _reel_number;
        std::string _language;
        std::string _movie_title;
-       std::list<boost::shared_ptr<InteropLoadFontNode> > _load_font_nodes;
+       std::vector<std::shared_ptr<InteropLoadFontNode>> _load_font_nodes;
 };
 
 }