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 dcp {
  30
  31 class SMPTELoadFontNode;
  32
  33 /** @class SMPTESubtitleAsset
  34  *  @brief A set of subtitles to be read and/or written in the SMPTE format.
  35  */
  36 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
  37 {
  38 public:
  39         /** @param file File name
  40          *  @param mxf true if `file' is a MXF, or false if it is an XML file.
  41          */
  42         SMPTESubtitleAsset (boost::filesystem::path file, bool mxf = true);
  43
  44         bool equals (
  45                 boost::shared_ptr<const Asset>,
  46                 EqualityOptions,
  47                 NoteHandler note
  48                 ) const;
  49
  50         std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
  51
  52         Glib::ustring xml_as_string () const;
  53         void write (boost::filesystem::path path) const;
  54
  55         /** @return title of the film that these subtitles are for,
  56          *  to be presented to the user.
  57          */
  58         std::string content_title_text () const {
  59                 return _content_title_text;
  60         }
  61
  62         /** @return language as a xs:language, if one was specified */
  63         boost::optional<std::string> language () const {
  64                 return _language;
  65         }
  66
  67         /** @return annotation text, to be presented to the user */
  68         boost::optional<std::string> annotation_text () const {
  69                 return _annotation_text;
  70         }
  71
  72         /** @return file creation time and date */
  73         LocalTime issue_date () const {
  74                 return _issue_date;
  75         }
  76
  77         boost::optional<int> reel_number () const {
  78                 return _reel_number;
  79         }
  80
  81         Fraction edit_rate () const {
  82                 return _edit_rate;
  83         }
  84
  85         /** @return subdivision of 1 second that is used for subtitle times;
  86          *  e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
  87          *  represents 4ms.
  88          */
  89         int time_code_rate () const {
  90                 return _time_code_rate;
  91         }
  92
  93         boost::optional<Time> start_time () const {
  94                 return _start_time;
  95         }
  96
  97         static bool valid_mxf (boost::filesystem::path);
  98
  99 protected:
 100
 101         std::string pkl_type (Standard) const {
 102                 return "application/mxf";
 103         }
 104
 105 private:
 106         std::string _content_title_text;
 107         boost::optional<std::string> _language;
 108         boost::optional<std::string> _annotation_text;
 109         LocalTime _issue_date;
 110         boost::optional<int> _reel_number;
 111         Fraction _edit_rate;
 112         int _time_code_rate;
 113         boost::optional<Time> _start_time;
 114
 115         std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
 116 };
 117
 118 }