src/smpte_subtitle_asset.h

   1 /*
   2     Copyright (C) 2012-2015 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 "local_time.h"
  40 #include "mxf.h"
  41 #include <boost/filesystem.hpp>
  42
  43 namespace ASDCP {
  44         namespace TimedText {
  45                 class MXFReader;
  46         }
  47 }
  48
  49 namespace dcp {
  50
  51 class SMPTELoadFontNode;
  52 class DecryptionContext;
  53
  54 /** @class SMPTESubtitleAsset
  55  *  @brief A set of subtitles to be read and/or written in the SMPTE format.
  56  */
  57 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
  58 {
  59 public:
  60         SMPTESubtitleAsset ();
  61
  62         /** @param file File name
  63          */
  64         explicit SMPTESubtitleAsset (boost::filesystem::path file);
  65
  66         bool equals (
  67                 boost::shared_ptr<const Asset>,
  68                 EqualityOptions,
  69                 NoteHandler note
  70                 ) const;
  71
  72         std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
  73
  74         std::string xml_as_string () const;
  75         void write (boost::filesystem::path path) const;
  76         void add (SubtitleString);
  77         void add_font (std::string id, boost::filesystem::path file);
  78         void set_key (Key key);
  79
  80         void set_content_title_text (std::string t) {
  81                 _content_title_text = t;
  82         }
  83
  84         void set_language (std::string l) {
  85                 _language = l;
  86         }
  87
  88         void set_issue_date (LocalTime t) {
  89                 _issue_date = t;
  90         }
  91
  92         void set_reel_number (int r) {
  93                 _reel_number = r;
  94         }
  95
  96         void set_edit_rate (Fraction e) {
  97                 _edit_rate = e;
  98         }
  99
 100         void set_time_code_rate (int t) {
 101                 _time_code_rate = t;
 102         }
 103
 104         void set_start_time (Time t) {
 105                 _start_time = t;
 106         }
 107
 108         void set_intrinsic_duration (int64_t d) {
 109                 _intrinsic_duration = d;
 110         }
 111
 112         /** @return title of the film that these subtitles are for,
 113          *  to be presented to the user.
 114          */
 115         std::string content_title_text () const {
 116                 return _content_title_text;
 117         }
 118
 119         /** @return language as a xs:language, if one was specified */
 120         boost::optional<std::string> language () const {
 121                 return _language;
 122         }
 123
 124         /** @return annotation text, to be presented to the user */
 125         boost::optional<std::string> annotation_text () const {
 126                 return _annotation_text;
 127         }
 128
 129         /** @return file creation time and date */
 130         LocalTime issue_date () const {
 131                 return _issue_date;
 132         }
 133
 134         boost::optional<int> reel_number () const {
 135                 return _reel_number;
 136         }
 137
 138         Fraction edit_rate () const {
 139                 return _edit_rate;
 140         }
 141
 142         /** @return subdivision of 1 second that is used for subtitle times;
 143          *  e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
 144          *  represents 4ms.
 145          */
 146         int time_code_rate () const {
 147                 return _time_code_rate;
 148         }
 149
 150         boost::optional<Time> start_time () const {
 151                 return _start_time;
 152         }
 153
 154         static bool valid_mxf (boost::filesystem::path);
 155
 156 protected:
 157
 158         std::string pkl_type (Standard) const {
 159                 return "application/mxf";
 160         }
 161
 162 private:
 163         void read_fonts (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
 164         void parse_xml (boost::shared_ptr<cxml::Document> xml);
 165         void read_mxf_descriptor (boost::shared_ptr<ASDCP::TimedText::MXFReader> reader, boost::shared_ptr<DecryptionContext> dec);
 166
 167         /** The total length of this content in video frames.  The amount of
 168          *  content presented may be less than this.
 169          */
 170         int64_t _intrinsic_duration;
 171         /** <ContentTitleText> from the asset */
 172         std::string _content_title_text;
 173         boost::optional<std::string> _language;
 174         boost::optional<std::string> _annotation_text;
 175         LocalTime _issue_date;
 176         boost::optional<int> _reel_number;
 177         Fraction _edit_rate;
 178         int _time_code_rate;
 179         boost::optional<Time> _start_time;
 180
 181         std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
 182 };
 183
 184 }