summaryrefslogtreecommitdiff
path: root/src/lib/types.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2018-07-23 15:10:11 +0100
committerCarl Hetherington <cth@carlh.net>2018-07-23 15:10:11 +0100
commita5c629cb9b638b67a0e4c2d26fe9ab2e124bf0eb (patch)
tree6cd463704f413259516e2888704272a371a108a6 /src/lib/types.h
parentdf17bbd25da69fc38eb2dcd8b4a2531cf0bab0bc (diff)
Tidy up after mass rename.
Diffstat (limited to 'src/lib/types.h')
-rw-r--r--src/lib/types.h27
1 files changed, 15 insertions, 12 deletions
diff --git a/src/lib/types.h b/src/lib/types.h
index 6e3732d31..02d71e297 100644
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -130,25 +130,28 @@ enum ReelType
};
/** Type of captions.
- * For better or worse DoM has uses two names for text that appears
- * with the DCP:
*
- * open captions: text that is shown to everybody on-screen (aka subtitles).
- * closed captions: text that is shown to some viewers using some other method.
+ * 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
*
- * There is also still use of the word `subtitle' in the code; these are the
- * same as open captions in DoM.
+ * 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
{
- CAPTION_OPEN,
- CAPTION_CLOSED,
- CAPTION_COUNT
+ TEXT_OPEN_SUBTITLE,
+ TEXT_CLOSED_CAPTION,
+ TEXT_COUNT
};
-extern std::string caption_type_to_string (TextType t);
-extern std::string caption_type_to_name (TextType t);
-extern TextType string_to_caption_type (std::string s);
+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.