src/subtitle_content.h

   1 /*
   2     Copyright (C) 2012-2014 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 #ifndef LIBDCP_SUBTITLE_CONTENT_H
  21 #define LIBDCP_SUBTITLE_CONTENT_H
  22
  23 #include "content.h"
  24 #include "dcp_time.h"
  25 #include <libcxml/cxml.h>
  26
  27 namespace dcp
  28 {
  29
  30 class SubtitleString;
  31 class Font;
  32 class Text;
  33 class Subtitle;
  34 class LoadFont;
  35
  36 /** @class SubtitleContent
  37  *  @brief A representation of an XML or MXF file containing subtitles.
  38  *
  39  *  XXX: perhaps this should inhert from MXF, or there should be different
  40  *  classes for XML and MXF subs.
  41  */
  42 class SubtitleContent : public Content
  43 {
  44 public:
  45         /** Construct a SubtitleContent.
  46          *  @param file Filename.
  47          *  @param mxf true if the file is an MXF file, false for XML.
  48          */
  49         SubtitleContent (boost::filesystem::path file, bool mxf);
  50         SubtitleContent (Fraction edit_rate, std::string movie_title, std::string language);
  51
  52         bool equals (
  53                 boost::shared_ptr<const Content>,
  54                 EqualityOptions,
  55                 boost::function<void (NoteType, std::string)> note
  56                 ) const {
  57                 /* XXX */
  58                 note (ERROR, "subtitle content not compared yet");
  59                 return true;
  60         }
  61
  62         std::string language () const {
  63                 return _language;
  64         }
  65
  66         std::list<boost::shared_ptr<SubtitleString> > subtitles_at (Time t) const;
  67         std::list<boost::shared_ptr<SubtitleString> > const & subtitles () const {
  68                 return _subtitles;
  69         }
  70
  71         void add (boost::shared_ptr<SubtitleString>);
  72
  73         void write_xml () const;
  74         Glib::ustring xml_as_string () const;
  75
  76 protected:
  77         std::string pkl_type (Standard) const {
  78                 return "text/xml";
  79         }
  80
  81         std::string asdcp_kind () const {
  82                 return "Subtitle";
  83         }
  84
  85 private:
  86         std::string font_id_to_name (std::string id) const;
  87
  88         struct ParseState {
  89                 std::list<boost::shared_ptr<Font> > font_nodes;
  90                 std::list<boost::shared_ptr<Text> > text_nodes;
  91                 std::list<boost::shared_ptr<Subtitle> > subtitle_nodes;
  92         };
  93
  94         void maybe_add_subtitle (std::string text, ParseState const & parse_state);
  95
  96         void examine_font_nodes (
  97                 boost::shared_ptr<const cxml::Node> xml,
  98                 std::list<boost::shared_ptr<Font> > const & font_nodes,
  99                 ParseState& parse_state
 100                 );
 101
 102         void examine_text_nodes (
 103                 boost::shared_ptr<const cxml::Node> xml,
 104                 std::list<boost::shared_ptr<Text> > const & text_nodes,
 105                 ParseState& parse_state
 106                 );
 107
 108         boost::optional<std::string> _movie_title;
 109         /* strangely, this is sometimes a string */
 110         std::string _reel_number;
 111         std::string _language;
 112         std::list<boost::shared_ptr<LoadFont> > _load_font_nodes;
 113
 114         std::list<boost::shared_ptr<SubtitleString> > _subtitles;
 115         bool _need_sort;
 116 };
 117
 118 }
 119
 120 #endif