src/smpte_subtitle_asset.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/smpte_subtitle_asset.h
  21  *  @brief SMPTESubtitleAsset class.
  22  */
  23
  24 #include "subtitle_asset.h"
  25 #include "local_time.h"
  26 #include "mxf.h"
  27 #include <boost/filesystem.hpp>
  28
  29 namespace ASDCP {
  30         namespace TimedText {
  31                 class MXFReader;
  32         }
  33 }
  34
  35 namespace dcp {
  36
  37 class SMPTELoadFontNode;
  38
  39 /** @class SMPTESubtitleAsset
  40  *  @brief A set of subtitles to be read and/or written in the SMPTE format.
  41  */
  42 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
  43 {
  44 public:
  45         SMPTESubtitleAsset ();
  46
  47         /** @param file File name
  48          */
  49         SMPTESubtitleAsset (boost::filesystem::path file);
  50
  51         bool equals (
  52                 boost::shared_ptr<const Asset>,
  53                 EqualityOptions,
  54                 NoteHandler note
  55                 ) const;
  56
  57         std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
  58
  59         Glib::ustring xml_as_string () const;
  60         void write (boost::filesystem::path path) const;
  61         void add_font (std::string id, boost::filesystem::path file);
  62
  63         void set_content_title_text (std::string t) {
  64                 _content_title_text = t;
  65         }
  66
  67         void set_language (std::string l) {
  68                 _language = l;
  69         }
  70
  71         void set_reel_number (int r) {
  72                 _reel_number = r;
  73         }
  74
  75         void set_edit_rate (Fraction e) {
  76                 _edit_rate = e;
  77         }
  78
  79         void set_time_code_rate (int t) {
  80                 _time_code_rate = t;
  81         }
  82
  83         void set_start_time (Time t) {
  84                 _start_time = t;
  85         }
  86
  87         /** @return title of the film that these subtitles are for,
  88          *  to be presented to the user.
  89          */
  90         std::string content_title_text () const {
  91                 return _content_title_text;
  92         }
  93
  94         /** @return language as a xs:language, if one was specified */
  95         boost::optional<std::string> language () const {
  96                 return _language;
  97         }
  98
  99         /** @return annotation text, to be presented to the user */
 100         boost::optional<std::string> annotation_text () const {
 101                 return _annotation_text;
 102         }
 103
 104         /** @return file creation time and date */
 105         LocalTime issue_date () const {
 106                 return _issue_date;
 107         }
 108
 109         boost::optional<int> reel_number () const {
 110                 return _reel_number;
 111         }
 112
 113         Fraction edit_rate () const {
 114                 return _edit_rate;
 115         }
 116
 117         /** @return subdivision of 1 second that is used for subtitle times;
 118          *  e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
 119          *  represents 4ms.
 120          */
 121         int time_code_rate () const {
 122                 return _time_code_rate;
 123         }
 124
 125         boost::optional<Time> start_time () const {
 126                 return _start_time;
 127         }
 128
 129         static bool valid_mxf (boost::filesystem::path);
 130
 131 protected:
 132
 133         std::string pkl_type (Standard) const {
 134                 return "application/mxf";
 135         }
 136
 137 private:
 138         void read_fonts (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
 139
 140         std::string _content_title_text;
 141         boost::optional<std::string> _language;
 142         boost::optional<std::string> _annotation_text;
 143         LocalTime _issue_date;
 144         boost::optional<int> _reel_number;
 145         Fraction _edit_rate;
 146         int _time_code_rate;
 147         boost::optional<Time> _start_time;
 148
 149         std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
 150 };
 151
 152 }