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 "subtitle_string.h"
  26 #include <libcxml/cxml.h>
  27
  28 namespace dcp
  29 {
  30
  31 class SubtitleString;
  32 class Font;
  33 class Text;
  34 class Subtitle;
  35
  36 /** @class SubtitleContent
  37  *  @brief A parent for classes representing a file containing subtitles.
  38  */
  39 class SubtitleContent : public Content
  40 {
  41 public:
  42         SubtitleContent ();
  43         SubtitleContent (boost::filesystem::path file);
  44
  45         bool equals (
  46                 boost::shared_ptr<const Asset>,
  47                 EqualityOptions,
  48                 boost::function<void (NoteType, std::string)> note
  49                 ) const;
  50
  51         std::string language () const {
  52                 return _language;
  53         }
  54
  55         std::list<SubtitleString> subtitles_at (Time t) const;
  56         std::list<SubtitleString> const & subtitles () const {
  57                 return _subtitles;
  58         }
  59
  60         void add (SubtitleString);
  61
  62         void write_xml (boost::filesystem::path) const;
  63         virtual Glib::ustring xml_as_string () const {
  64                 /* XXX: this should be pure virtual when SMPTE writing is implemented */
  65                 return "";
  66         }
  67
  68         Time latest_subtitle_out () const;
  69
  70 protected:
  71         void parse_common (boost::shared_ptr<cxml::Document> xml, std::list<boost::shared_ptr<dcp::Font> > font_nodes);
  72
  73         std::string pkl_type (Standard) const {
  74                 return "text/xml";
  75         }
  76
  77         std::string asdcp_kind () const {
  78                 return "Subtitle";
  79         }
  80
  81         /* strangely, this is sometimes a string */
  82         std::string _reel_number;
  83         std::string _language;
  84
  85         std::list<SubtitleString> _subtitles;
  86
  87 private:
  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
 109 }
 110
 111 #endif