#include <caption-closed.h>
Data Structures | |
| struct | APS |
Data Fields | |
| CC_Format_t | format |
| CC_CharacterSize_t | char_size |
| CC_Dimension_t | SDF |
| CC_Dimension_t | SDP |
| CC_Dimension_t | SSM |
| CC_Rcs_t | RCS |
| CC_Color_t | foreground |
| CC_Color_t | background |
| CC_Color_t | half_foreground |
| CC_Color_t | half_background |
| struct CaptionClosed_t::APS | APS |
| bool | need_clear |
| uint8_t | char_size_custom |
| uint8_t | char_number_in_oneline |
| uint8_t | char_line_number |
| uint16_t | SHS |
| uint16_t | SVS |
| const PES_pts_t * | pts |
| void * | userdata |
Detailed Description
Caption state, updated by the control commands during caption_closed_run().
Keep the same struct between the PES of the same PID: some commands (colors, size, format) hold until they are changed again. Initialize it with zeros.
Definition at line 114 of file caption-closed.h.
Field Documentation
◆ format
| CC_Format_t CaptionClosed_t::format |
Display format (CSI SWF).
Definition at line 115 of file caption-closed.h.
◆ char_size
| CC_CharacterSize_t CaptionClosed_t::char_size |
Character size (SSZ, MSZ, NSZ, SZX).
Definition at line 116 of file caption-closed.h.
◆ SDF
| CC_Dimension_t CaptionClosed_t::SDF |
Size of the display area (CSI SDF, Set Display Format).
Definition at line 117 of file caption-closed.h.
◆ SDP
| CC_Dimension_t CaptionClosed_t::SDP |
Position of the display area (CSI SDP, Set Display Position).
Definition at line 118 of file caption-closed.h.
◆ SSM
| CC_Dimension_t CaptionClosed_t::SSM |
Character size in points (CSI SSM).
Definition at line 119 of file caption-closed.h.
◆ RCS
| CC_Rcs_t CaptionClosed_t::RCS |
Raster color (CSI RCS).
Definition at line 120 of file caption-closed.h.
◆ foreground
| CC_Color_t CaptionClosed_t::foreground |
Text color (BKF ~ WHF, COL).
Definition at line 121 of file caption-closed.h.
◆ background
| CC_Color_t CaptionClosed_t::background |
Background color (COL).
Definition at line 122 of file caption-closed.h.
◆ half_foreground
| CC_Color_t CaptionClosed_t::half_foreground |
Text color, half intensity (COL).
Definition at line 123 of file caption-closed.h.
◆ half_background
| CC_Color_t CaptionClosed_t::half_background |
Background color, half intensity (COL).
Definition at line 124 of file caption-closed.h.
◆ APS
Cursor position (APS).
◆ need_clear
| bool CaptionClosed_t::need_clear |
TRUE when the CS command (clear screen) was received.
Definition at line 132 of file caption-closed.h.
◆ char_size_custom
| uint8_t CaptionClosed_t::char_size_custom |
SZX parameter, when char_size is CC_CharacterSize_Custom.
Definition at line 133 of file caption-closed.h.
◆ char_number_in_oneline
| uint8_t CaptionClosed_t::char_number_in_oneline |
Characters per line (CSI SWF).
Definition at line 134 of file caption-closed.h.
◆ char_line_number
| uint8_t CaptionClosed_t::char_line_number |
Number of lines (CSI SWF).
Definition at line 135 of file caption-closed.h.
◆ SHS
| uint16_t CaptionClosed_t::SHS |
Horizontal spacing (CSI SHS, Set Horizontal Spacing).
Definition at line 136 of file caption-closed.h.
◆ SVS
| uint16_t CaptionClosed_t::SVS |
Vertical spacing (CSI SVS, Set Vertical Spacing).
Definition at line 137 of file caption-closed.h.
◆ pts
| const PES_pts_t* CaptionClosed_t::pts |
PTS of the PES being processed; only valid during caption_closed_run().
Definition at line 139 of file caption-closed.h.
◆ userdata
| void* CaptionClosed_t::userdata |
Free for the user; handy to get the context back inside the hooks.
Definition at line 141 of file caption-closed.h.
The documentation for this struct was generated from the following file:
- include/closedcaption/caption-closed.h
