Basics of multiple captions per content so that DCPContent can

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

diff --git a/src/lib/types.h b/src/lib/types.h
index 3337087ebfb71e630f30fd0d723629d857548fb8..b2bff78fa67f23a6e4c70e05ffe6315cacb02321 100644 (file)
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -129,6 +129,16 @@ enum ReelType
        REELTYPE_BY_LENGTH
 };
 
+/** 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.
+ *
+ *  There is also still use of the word `subtitle' in the code; these are the
+ *  same as open captions in DoM.
+ */
 enum CaptionType
 {
        CAPTION_OPEN,