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