.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "VBI 3pm"
.TH VBI 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Video::Capture::VBI \- Functions to manipulate vbi fields & lines.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&   use Video::Capture::VBI;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.IP new 4
.IX Item "new"
Create a new VBI decoder object. VBI decoding often requires state, which
this object represents
.IP "reset (NYI)" 4
.IX Item "reset (NYI)"
Reset the state (e.g. after switching a channel).
.SH "CONSTANTS / MASK OPERATORS"
.IX Header "CONSTANTS / MASK OPERATORS"
The following constants are available (see ETS 300 706 for a more thorough
definition).
.PP
.Vb 1
\&   VTX_SUB 0x003f7f # S1..S4 field mask
\&
\&   VTX_C4  0x000080 # erase page
\&   VTX_C5  0x004000 # newsflash
\&   VTX_C6  0x008000 # subtitle
\&   VTX_C7  0x010000 # suppress header
\&   VTX_C8  0x020000 # update indicator
\&   VTX_C9  0x040000 # interrupted sequence
\&   VTX_C10 0x080000 # inhibit display
\&   VTX_C11 0x100000 # magazine serial
\&
\&   VTX_C12 0x200000 # ... option ...
\&   VTX_C13 0x400000 # ... character ...
\&   VTX_C14 0x800000 # ... set
.Ve
.PP
The following mask functions all take a single "CTRL" bitfield and return
the corresponding subfield:
.PP
.Vb 5
\&   VTX_S1  (shift    )&15 } # S1
\&   VTX_S2  (shift>> 4)& 7 } # S2
\&   VTX_S3  (shift>> 8)&15 } # S3
\&   VTX_S4  (shift>>12)& 3 } # S4
\&   VTX_NOC (shift>>21)& 7 } # national character set...
.Ve