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 #include "subtitle_asset.h"
  41 #include <boost/filesystem.hpp>
  42
  43
  44 namespace dcp {
  45
  46
  47 class InteropLoadFontNode;
  48
  49
  50 /** @class InteropSubtitleAsset
  51  *  @brief A set of subtitles to be read and/or written in the Inter-Op format
  52  *
  53  *  Inter-Op subtitles are sometimes known as CineCanvas.
  54  */
  55 class InteropSubtitleAsset : public SubtitleAsset
  56 {
  57 public:
  58         InteropSubtitleAsset ();
  59         explicit InteropSubtitleAsset (boost::filesystem::path file);
  60
  61         bool equals (
  62                 std::shared_ptr<const Asset>,
  63                 EqualityOptions,
  64                 NoteHandler note
  65                 ) const;
  66
  67         void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
  68         void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
  69
  70         std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
  71
  72         void add_font (std::string load_id, dcp::ArrayData data);
  73
  74         std::string xml_as_string () const;
  75
  76         /** Write this content to an XML file with its fonts alongside */
  77         void write (boost::filesystem::path path) const;
  78
  79         void resolve_fonts (std::vector<std::shared_ptr<Asset>> assets);
  80         void add_font_assets (std::vector<std::shared_ptr<Asset>>& assets);
  81         void set_font_file (std::string load_id, boost::filesystem::path file);
  82
  83         /** Set the reel number or sub-element identifier
  84          *  of these subtitles.
  85          *  @param n New reel number.
  86          */
  87         void set_reel_number (std::string n) {
  88                 _reel_number = n;
  89         }
  90
  91         /** Set the language tag of these subtitles.
  92          *  @param l New language.
  93          */
  94         void set_language (std::string l) {
  95                 _language = l;
  96         }
  97
  98         /** @return title of the movie that the subtitles are for */
  99         void set_movie_title (std::string m) {
 100                 _movie_title = m;
 101         }
 102
 103         /** @return reel number or sub-element of a programme that
 104          *  these subtitles refer to.
 105          */
 106         std::string reel_number () const {
 107                 return _reel_number;
 108         }
 109
 110         /** @return language used in the subtitles */
 111         std::string language () const {
 112                 return _language;
 113         }
 114
 115         /** @return movie title that these subtitles are for */
 116         std::string movie_title () const {
 117                 return _movie_title;
 118         }
 119
 120         int time_code_rate () const {
 121                 /* Interop can use either; just pick one */
 122                 return 1000;
 123         }
 124
 125         static std::string static_pkl_type (Standard) {
 126                 return "text/xml;asdcpKind=Subtitle";
 127         }
 128
 129 protected:
 130
 131         std::string pkl_type (Standard s) const {
 132                 return static_pkl_type (s);
 133         }
 134
 135 private:
 136         std::string _reel_number;
 137         std::string _language;
 138         std::string _movie_title;
 139         std::vector<std::shared_ptr<InteropLoadFontNode>> _load_font_nodes;
 140 };
 141
 142 }