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