A variety of changes to improve (but not entirely fix) behaviour

[dcpomatic.git] / src / lib / types.h

diff --git a/src/lib/types.h b/src/lib/types.h
index dfce6aec54be448c4c3e87658576783ca5ebba77..42e2e3eecd2c8d6801e3b6563ecdcf53a5b116d4 100644 (file)
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -31,7 +31,7 @@
 class Content;
 class VideoContent;
 class AudioContent;
-class SubtitleContent;
+class TextContent;
 class FFmpegContent;
 
 namespace cxml {
@@ -129,6 +129,31 @@ enum ReelType
        REELTYPE_BY_LENGTH
 };
 
+/** Type of captions.
+ *
+ *  The generally accepted definitions seem to be:
+ *  - subtitles: text for an audience who doesn't speak the film's language
+ *  - captions:  text for a hearing-impaired audience
+ *  - open:      on-screen
+ *  - closed:    only visible by some audience members
+ *
+ *  At the moment DoM supports open subtitles and closed captions.
+ *
+ *  There is some use of the word `subtitle' in the code which may mean
+ *  caption in some contexts.
+ */
+enum TextType
+{
+       TEXT_UNKNOWN,
+       TEXT_OPEN_SUBTITLE,
+       TEXT_CLOSED_CAPTION,
+       TEXT_COUNT
+};
+
+extern std::string text_type_to_string (TextType t);
+extern std::string text_type_to_name (TextType t);
+extern TextType string_to_text_type (std::string s);
+
 /** @struct Crop
  *  @brief A description of the crop of an image or video.
  */