src/smpte_subtitle_asset.h

   1 /*
   2     Copyright (C) 2012-2020 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 /** @file  src/smpte_subtitle_asset.h
  35  *  @brief SMPTESubtitleAsset class.
  36  */
  37
  38 #include "subtitle_asset.h"
  39 #include "language_tag.h"
  40 #include "local_time.h"
  41 #include "mxf.h"
  42 #include "crypto_context.h"
  43 #include <boost/filesystem.hpp>
  44
  45 namespace ASDCP {
  46         namespace TimedText {
  47                 class MXFReader;
  48         }
  49 }
  50
  51 struct verify_invalid_language1;
  52 struct verify_invalid_language2;
  53
  54 namespace dcp {
  55
  56 class SMPTELoadFontNode;
  57
  58 /** @class SMPTESubtitleAsset
  59  *  @brief A set of subtitles to be read and/or written in the SMPTE format.
  60  */
  61 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
  62 {
  63 public:
  64         SMPTESubtitleAsset ();
  65
  66         /** @param file File name
  67          */
  68         explicit SMPTESubtitleAsset (boost::filesystem::path file);
  69
  70         bool equals (
  71                 std::shared_ptr<const Asset>,
  72                 EqualityOptions,
  73                 NoteHandler note
  74                 ) const;
  75
  76         std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
  77
  78         std::string xml_as_string () const;
  79         void write (boost::filesystem::path path) const;
  80         void add (std::shared_ptr<Subtitle>);
  81         void add_font (std::string id, dcp::ArrayData data);
  82         void set_key (Key key);
  83
  84         void set_content_title_text (std::string t) {
  85                 _content_title_text = t;
  86         }
  87
  88         void set_language (dcp::LanguageTag l) {
  89                 _language = l.to_string();
  90         }
  91
  92         void set_issue_date (LocalTime t) {
  93                 _issue_date = t;
  94         }
  95
  96         void set_reel_number (int r) {
  97                 _reel_number = r;
  98         }
  99
 100         void set_edit_rate (Fraction e) {
 101                 _edit_rate = e;
 102         }
 103
 104         void set_time_code_rate (int t) {
 105                 _time_code_rate = t;
 106         }
 107
 108         void set_start_time (Time t) {
 109                 _start_time = t;
 110         }
 111
 112         void set_intrinsic_duration (int64_t d) {
 113                 _intrinsic_duration = d;
 114         }
 115
 116         /** @return title of the film that these subtitles are for,
 117          *  to be presented to the user.
 118          */
 119         std::string content_title_text () const {
 120                 return _content_title_text;
 121         }
 122
 123         /** @return Language, if one was set.  This should be a xs:language, but
 124          *  it might not be if a non-compliant DCP was read in.
 125          */
 126         boost::optional<std::string> language () const {
 127                 return _language;
 128         }
 129
 130         /** @return annotation text, to be presented to the user */
 131         boost::optional<std::string> annotation_text () const {
 132                 return _annotation_text;
 133         }
 134
 135         /** @return file creation time and date */
 136         LocalTime issue_date () const {
 137                 return _issue_date;
 138         }
 139
 140         boost::optional<int> reel_number () const {
 141                 return _reel_number;
 142         }
 143
 144         Fraction edit_rate () const {
 145                 return _edit_rate;
 146         }
 147
 148         /** @return subdivision of 1 second that is used for subtitle times;
 149          *  e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
 150          *  represents 4ms.
 151          */
 152         int time_code_rate () const {
 153                 return _time_code_rate;
 154         }
 155
 156         boost::optional<Time> start_time () const {
 157                 return _start_time;
 158         }
 159
 160         std::string xml_id () const {
 161                 return _xml_id;
 162         }
 163
 164         static bool valid_mxf (boost::filesystem::path);
 165         static std::string static_pkl_type (Standard) {
 166                 return "application/mxf";
 167         }
 168
 169 protected:
 170
 171         std::string pkl_type (Standard s) const {
 172                 return static_pkl_type (s);
 173         }
 174
 175 private:
 176         friend struct ::write_smpte_subtitle_test;
 177         friend struct ::write_smpte_subtitle_test2;
 178         friend struct ::verify_invalid_language1;
 179         friend struct ::verify_invalid_language2;
 180
 181         void read_fonts (std::shared_ptr<ASDCP::TimedText::MXFReader>);
 182         void parse_xml (std::shared_ptr<cxml::Document> xml);
 183         void read_mxf_descriptor (std::shared_ptr<ASDCP::TimedText::MXFReader> reader, std::shared_ptr<DecryptionContext> dec);
 184
 185         /** The total length of this content in video frames.  The amount of
 186          *  content presented may be less than this.
 187          */
 188         int64_t _intrinsic_duration;
 189         /** <ContentTitleText> from the asset */
 190         std::string _content_title_text;
 191         /** This is stored and returned as a string so that we can tolerate non-RFC-5646 strings,
 192          *  but must be set as a dcp::LanguageTag to try to ensure that we create compliant output.
 193          */
 194         boost::optional<std::string> _language;
 195         boost::optional<std::string> _annotation_text;
 196         LocalTime _issue_date;
 197         boost::optional<int> _reel_number;
 198         Fraction _edit_rate;
 199         int _time_code_rate;
 200         boost::optional<Time> _start_time;
 201
 202         std::vector<std::shared_ptr<SMPTELoadFontNode>> _load_font_nodes;
 203         /** UUID for the XML inside the MXF, which should be different to the ID of the MXF according to
 204          *  Doremi's 2.8.18 release notes.
 205          */
 206         std::string _xml_id;
 207 };
 208
 209 }