src/interop_subtitle_asset.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/interop_subtitle_asset.h
  36  *  @brief InteropSubtitleAsset class
  37  */
  38
  39
  40 #ifndef DCP_INTEROP_SUBTITLE_ASSET_H
  41 #define DCP_INTEROP_SUBTITLE_ASSET_H
  42
  43
  44 #include "subtitle_asset.h"
  45 #include <boost/filesystem.hpp>
  46
  47
  48 namespace dcp {
  49
  50
  51 class InteropLoadFontNode;
  52
  53
  54 /** @class InteropSubtitleAsset
  55  *  @brief A set of subtitles to be read and/or written in the Inter-Op format
  56  *
  57  *  Inter-Op subtitles are sometimes known as CineCanvas.
  58  */
  59 class InteropSubtitleAsset : public SubtitleAsset
  60 {
  61 public:
  62         InteropSubtitleAsset ();
  63         explicit InteropSubtitleAsset (boost::filesystem::path file);
  64
  65         bool equals (
  66                 std::shared_ptr<const Asset>,
  67                 EqualityOptions,
  68                 NoteHandler note
  69                 ) const;
  70
  71         void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
  72         void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
  73
  74         std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
  75
  76         void add_font (std::string load_id, dcp::ArrayData data);
  77
  78         std::string xml_as_string () const;
  79
  80         /** Write this content to an XML file with its fonts alongside */
  81         void write (boost::filesystem::path path) const;
  82
  83         void resolve_fonts (std::vector<std::shared_ptr<Asset>> assets);
  84         void add_font_assets (std::vector<std::shared_ptr<Asset>>& assets);
  85         void set_font_file (std::string load_id, boost::filesystem::path file);
  86
  87         /** Set the reel number or sub-element identifier
  88          *  of these subtitles.
  89          *  @param n New reel number.
  90          */
  91         void set_reel_number (std::string n) {
  92                 _reel_number = n;
  93         }
  94
  95         /** Set the language tag of these subtitles.
  96          *  @param l New language.
  97          */
  98         void set_language (std::string l) {
  99                 _language = l;
 100         }
 101
 102         /** @return title of the movie that the subtitles are for */
 103         void set_movie_title (std::string m) {
 104                 _movie_title = m;
 105         }
 106
 107         /** @return reel number or sub-element of a programme that
 108          *  these subtitles refer to.
 109          */
 110         std::string reel_number () const {
 111                 return _reel_number;
 112         }
 113
 114         /** @return language used in the subtitles */
 115         std::string language () const {
 116                 return _language;
 117         }
 118
 119         /** @return movie title that these subtitles are for */
 120         std::string movie_title () const {
 121                 return _movie_title;
 122         }
 123
 124         int time_code_rate () const {
 125                 /* Interop can use either; just pick one */
 126                 return 1000;
 127         }
 128
 129         static std::string static_pkl_type (Standard) {
 130                 return "text/xml;asdcpKind=Subtitle";
 131         }
 132
 133 protected:
 134
 135         std::string pkl_type (Standard s) const {
 136                 return static_pkl_type (s);
 137         }
 138
 139 private:
 140         std::string _reel_number;
 141         std::string _language;
 142         std::string _movie_title;
 143         std::vector<std::shared_ptr<InteropLoadFontNode>> _load_font_nodes;
 144 };
 145
 146
 147 }
 148
 149
 150 #endif
 151