stash/vendor/github.com/asticode/go-astits/data_psi.go
cj c1a096a1a6
Caption support (#2462)
Co-authored-by: WithoutPants <53250216+WithoutPants@users.noreply.github.com>
2022-05-06 11:59:28 +10:00

608 lines
17 KiB
Go

package astits
import (
"fmt"
"github.com/asticode/go-astikit"
)
// PSI table IDs
const (
PSITableTypeBAT = "BAT"
PSITableTypeDIT = "DIT"
PSITableTypeEIT = "EIT"
PSITableTypeNIT = "NIT"
PSITableTypeNull = "Null"
PSITableTypePAT = "PAT"
PSITableTypePMT = "PMT"
PSITableTypeRST = "RST"
PSITableTypeSDT = "SDT"
PSITableTypeSIT = "SIT"
PSITableTypeST = "ST"
PSITableTypeTDT = "TDT"
PSITableTypeTOT = "TOT"
PSITableTypeUnknown = "Unknown"
)
type PSITableID uint16
const (
PSITableIDPAT PSITableID = 0x00
PSITableIDPMT PSITableID = 0x02
PSITableIDBAT PSITableID = 0x4a
PSITableIDDIT PSITableID = 0x7e
PSITableIDRST PSITableID = 0x71
PSITableIDSIT PSITableID = 0x7f
PSITableIDST PSITableID = 0x72
PSITableIDTDT PSITableID = 0x70
PSITableIDTOT PSITableID = 0x73
PSITableIDNull PSITableID = 0xff
PSITableIDEITStart PSITableID = 0x4e
PSITableIDEITEnd PSITableID = 0x6f
PSITableIDSDTVariant1 PSITableID = 0x42
PSITableIDSDTVariant2 PSITableID = 0x46
PSITableIDNITVariant1 PSITableID = 0x40
PSITableIDNITVariant2 PSITableID = 0x41
)
// PSIData represents a PSI data
// https://en.wikipedia.org/wiki/Program-specific_information
type PSIData struct {
PointerField int // Present at the start of the TS packet payload signaled by the payload_unit_start_indicator bit in the TS header. Used to set packet alignment bytes or content before the start of tabled payload data.
Sections []*PSISection
}
// PSISection represents a PSI section
type PSISection struct {
CRC32 uint32 // A checksum of the entire table excluding the pointer field, pointer filler bytes and the trailing CRC32.
Header *PSISectionHeader
Syntax *PSISectionSyntax
}
// PSISectionHeader represents a PSI section header
type PSISectionHeader struct {
PrivateBit bool // The PAT, PMT, and CAT all set this to 0. Other tables set this to 1.
SectionLength uint16 // The number of bytes that follow for the syntax section (with CRC value) and/or table data. These bytes must not exceed a value of 1021.
SectionSyntaxIndicator bool // A flag that indicates if the syntax section follows the section length. The PAT, PMT, and CAT all set this to 1.
TableID PSITableID // Table Identifier, that defines the structure of the syntax section and other contained data. As an exception, if this is the byte that immediately follow previous table section and is set to 0xFF, then it indicates that the repeat of table section end here and the rest of TS data payload shall be stuffed with 0xFF. Consequently the value 0xFF shall not be used for the Table Identifier.
TableType string
}
// PSISectionSyntax represents a PSI section syntax
type PSISectionSyntax struct {
Data *PSISectionSyntaxData
Header *PSISectionSyntaxHeader
}
// PSISectionSyntaxHeader represents a PSI section syntax header
type PSISectionSyntaxHeader struct {
CurrentNextIndicator bool // Indicates if data is current in effect or is for future use. If the bit is flagged on, then the data is to be used at the present moment.
LastSectionNumber uint8 // This indicates which table is the last table in the sequence of tables.
SectionNumber uint8 // This is an index indicating which table this is in a related sequence of tables. The first table starts from 0.
TableIDExtension uint16 // Informational only identifier. The PAT uses this for the transport stream identifier and the PMT uses this for the Program number.
VersionNumber uint8 // Syntax version number. Incremented when data is changed and wrapped around on overflow for values greater than 32.
}
// PSISectionSyntaxData represents a PSI section syntax data
type PSISectionSyntaxData struct {
EIT *EITData
NIT *NITData
PAT *PATData
PMT *PMTData
SDT *SDTData
TOT *TOTData
}
// parsePSIData parses a PSI data
func parsePSIData(i *astikit.BytesIterator) (d *PSIData, err error) {
// Init data
d = &PSIData{}
// Get next byte
var b byte
if b, err = i.NextByte(); err != nil {
err = fmt.Errorf("astits: fetching next byte failed: %w", err)
return
}
// Pointer field
d.PointerField = int(b)
// Pointer filler bytes
i.Skip(d.PointerField)
// Parse sections
var s *PSISection
var stop bool
for i.HasBytesLeft() && !stop {
if s, stop, err = parsePSISection(i); err != nil {
err = fmt.Errorf("astits: parsing PSI table failed: %w", err)
return
}
d.Sections = append(d.Sections, s)
}
return
}
// parsePSISection parses a PSI section
func parsePSISection(i *astikit.BytesIterator) (s *PSISection, stop bool, err error) {
// Init section
s = &PSISection{}
// Parse header
var offsetStart, offsetSectionsEnd, offsetEnd int
if s.Header, offsetStart, _, offsetSectionsEnd, offsetEnd, err = parsePSISectionHeader(i); err != nil {
err = fmt.Errorf("astits: parsing PSI section header failed: %w", err)
return
}
// Check whether we need to stop the parsing
if shouldStopPSIParsing(s.Header.TableID) {
stop = true
return
}
// Check whether there's a syntax section
if s.Header.SectionLength > 0 {
// Parse syntax
if s.Syntax, err = parsePSISectionSyntax(i, s.Header, offsetSectionsEnd); err != nil {
err = fmt.Errorf("astits: parsing PSI section syntax failed: %w", err)
return
}
// Process CRC32
if s.Header.TableID.hasCRC32() {
// Seek to the end of the sections
i.Seek(offsetSectionsEnd)
// Parse CRC32
if s.CRC32, err = parseCRC32(i); err != nil {
err = fmt.Errorf("astits: parsing CRC32 failed: %w", err)
return
}
// Get CRC32 data
i.Seek(offsetStart)
var crc32Data []byte
if crc32Data, err = i.NextBytesNoCopy(offsetSectionsEnd - offsetStart); err != nil {
err = fmt.Errorf("astits: fetching next bytes failed: %w", err)
return
}
// Compute CRC32
crc32 := computeCRC32(crc32Data)
// Check CRC32
if crc32 != s.CRC32 {
err = fmt.Errorf("astits: Table CRC32 %x != computed CRC32 %x", s.CRC32, crc32)
return
}
}
}
// Seek to the end of the section
i.Seek(offsetEnd)
return
}
// parseCRC32 parses a CRC32
func parseCRC32(i *astikit.BytesIterator) (c uint32, err error) {
var bs []byte
if bs, err = i.NextBytesNoCopy(4); err != nil {
err = fmt.Errorf("astits: fetching next bytes failed: %w", err)
return
}
c = uint32(bs[0])<<24 | uint32(bs[1])<<16 | uint32(bs[2])<<8 | uint32(bs[3])
return
}
// shouldStopPSIParsing checks whether the PSI parsing should be stopped
func shouldStopPSIParsing(tableID PSITableID) bool {
return tableID == PSITableIDNull ||
tableID.isUnknown()
}
// parsePSISectionHeader parses a PSI section header
func parsePSISectionHeader(i *astikit.BytesIterator) (h *PSISectionHeader, offsetStart, offsetSectionsStart, offsetSectionsEnd, offsetEnd int, err error) {
// Init
h = &PSISectionHeader{}
offsetStart = i.Offset()
// Get next byte
var b byte
if b, err = i.NextByte(); err != nil {
err = fmt.Errorf("astits: fetching next byte failed: %w", err)
return
}
// Table ID
h.TableID = PSITableID(b)
// Table type
h.TableType = h.TableID.Type()
// Check whether we need to stop the parsing
if shouldStopPSIParsing(h.TableID) {
return
}
// Get next bytes
var bs []byte
if bs, err = i.NextBytesNoCopy(2); err != nil {
err = fmt.Errorf("astits: fetching next bytes failed: %w", err)
return
}
// Section syntax indicator
h.SectionSyntaxIndicator = bs[0]&0x80 > 0
// Private bit
h.PrivateBit = bs[0]&0x40 > 0
// Section length
h.SectionLength = uint16(bs[0]&0xf)<<8 | uint16(bs[1])
// Offsets
offsetSectionsStart = i.Offset()
offsetEnd = offsetSectionsStart + int(h.SectionLength)
offsetSectionsEnd = offsetEnd
if h.TableID.hasCRC32() {
offsetSectionsEnd -= 4
}
return
}
// PSITableID.Type() returns the psi table type based on the table id
// Page: 28 | https://www.dvb.org/resources/public/standards/a38_dvb-si_specification.pdf
// (barbashov) the link above can be broken, alternative: https://dvb.org/wp-content/uploads/2019/12/a038_tm1217r37_en300468v1_17_1_-_rev-134_-_si_specification.pdf
func (t PSITableID) Type() string {
switch {
case t == PSITableIDBAT:
return PSITableTypeBAT
case t >= PSITableIDEITStart && t <= PSITableIDEITEnd:
return PSITableTypeEIT
case t == PSITableIDDIT:
return PSITableTypeDIT
case t == PSITableIDNITVariant1, t == PSITableIDNITVariant2:
return PSITableTypeNIT
case t == PSITableIDNull:
return PSITableTypeNull
case t == PSITableIDPAT:
return PSITableTypePAT
case t == PSITableIDPMT:
return PSITableTypePMT
case t == PSITableIDRST:
return PSITableTypeRST
case t == PSITableIDSDTVariant1, t == PSITableIDSDTVariant2:
return PSITableTypeSDT
case t == PSITableIDSIT:
return PSITableTypeSIT
case t == PSITableIDST:
return PSITableTypeST
case t == PSITableIDTDT:
return PSITableTypeTDT
case t == PSITableIDTOT:
return PSITableTypeTOT
default:
return PSITableTypeUnknown
}
}
// hasPSISyntaxHeader checks whether the section has a syntax header
func (t PSITableID) hasPSISyntaxHeader() bool {
return t == PSITableIDPAT ||
t == PSITableIDPMT ||
t == PSITableIDNITVariant1 || t == PSITableIDNITVariant2 ||
t == PSITableIDSDTVariant1 || t == PSITableIDSDTVariant2 ||
(t >= PSITableIDEITStart && t <= PSITableIDEITEnd)
}
// hasCRC32 checks whether the table has a CRC32
func (t PSITableID) hasCRC32() bool {
return t == PSITableIDPAT ||
t == PSITableIDPMT ||
t == PSITableIDTOT ||
t == PSITableIDNITVariant1 || t == PSITableIDNITVariant2 ||
t == PSITableIDSDTVariant1 || t == PSITableIDSDTVariant2 ||
(t >= PSITableIDEITStart && t <= PSITableIDEITEnd)
}
func (t PSITableID) isUnknown() bool {
switch t {
case PSITableIDBAT,
PSITableIDDIT,
PSITableIDNITVariant1, PSITableIDNITVariant2,
PSITableIDNull,
PSITableIDPAT,
PSITableIDPMT,
PSITableIDRST,
PSITableIDSDTVariant1, PSITableIDSDTVariant2,
PSITableIDSIT,
PSITableIDST,
PSITableIDTDT,
PSITableIDTOT:
return false
}
if t >= PSITableIDEITStart && t <= PSITableIDEITEnd {
return false
}
return true
}
// parsePSISectionSyntax parses a PSI section syntax
func parsePSISectionSyntax(i *astikit.BytesIterator, h *PSISectionHeader, offsetSectionsEnd int) (s *PSISectionSyntax, err error) {
// Init
s = &PSISectionSyntax{}
// Header
if h.TableID.hasPSISyntaxHeader() {
if s.Header, err = parsePSISectionSyntaxHeader(i); err != nil {
err = fmt.Errorf("astits: parsing PSI section syntax header failed: %w", err)
return
}
}
// Parse data
if s.Data, err = parsePSISectionSyntaxData(i, h, s.Header, offsetSectionsEnd); err != nil {
err = fmt.Errorf("astits: parsing PSI section syntax data failed: %w", err)
return
}
return
}
// parsePSISectionSyntaxHeader parses a PSI section syntax header
func parsePSISectionSyntaxHeader(i *astikit.BytesIterator) (h *PSISectionSyntaxHeader, err error) {
// Init
h = &PSISectionSyntaxHeader{}
// Get next 2 bytes
var bs []byte
if bs, err = i.NextBytesNoCopy(2); err != nil {
err = fmt.Errorf("astits: fetching next bytes failed: %w", err)
return
}
// Table ID extension
h.TableIDExtension = uint16(bs[0])<<8 | uint16(bs[1])
// Get next byte
var b byte
if b, err = i.NextByte(); err != nil {
err = fmt.Errorf("astits: fetching next byte failed: %w", err)
return
}
// Version number
h.VersionNumber = uint8(b&0x3f) >> 1
// Current/Next indicator
h.CurrentNextIndicator = b&0x1 > 0
// Get next byte
if b, err = i.NextByte(); err != nil {
err = fmt.Errorf("astits: fetching next byte failed: %w", err)
return
}
// Section number
h.SectionNumber = uint8(b)
// Get next byte
if b, err = i.NextByte(); err != nil {
err = fmt.Errorf("astits: fetching next byte failed: %w", err)
return
}
// Last section number
h.LastSectionNumber = uint8(b)
return
}
// parsePSISectionSyntaxData parses a PSI section data
func parsePSISectionSyntaxData(i *astikit.BytesIterator, h *PSISectionHeader, sh *PSISectionSyntaxHeader, offsetSectionsEnd int) (d *PSISectionSyntaxData, err error) {
// Init
d = &PSISectionSyntaxData{}
// Switch on table type
switch h.TableID {
case PSITableIDBAT:
// TODO Parse BAT
case PSITableIDDIT:
// TODO Parse DIT
case PSITableIDNITVariant1, PSITableIDNITVariant2:
if d.NIT, err = parseNITSection(i, sh.TableIDExtension); err != nil {
err = fmt.Errorf("astits: parsing NIT section failed: %w", err)
return
}
case PSITableIDPAT:
if d.PAT, err = parsePATSection(i, offsetSectionsEnd, sh.TableIDExtension); err != nil {
err = fmt.Errorf("astits: parsing PAT section failed: %w", err)
return
}
case PSITableIDPMT:
if d.PMT, err = parsePMTSection(i, offsetSectionsEnd, sh.TableIDExtension); err != nil {
err = fmt.Errorf("astits: parsing PMT section failed: %w", err)
return
}
case PSITableIDRST:
// TODO Parse RST
case PSITableIDSDTVariant1, PSITableIDSDTVariant2:
if d.SDT, err = parseSDTSection(i, offsetSectionsEnd, sh.TableIDExtension); err != nil {
err = fmt.Errorf("astits: parsing PMT section failed: %w", err)
return
}
case PSITableIDSIT:
// TODO Parse SIT
case PSITableIDST:
// TODO Parse ST
case PSITableIDTOT:
if d.TOT, err = parseTOTSection(i); err != nil {
err = fmt.Errorf("astits: parsing TOT section failed: %w", err)
return
}
case PSITableIDTDT:
// TODO Parse TDT
}
if h.TableID >= PSITableIDEITStart && h.TableID <= PSITableIDEITEnd {
if d.EIT, err = parseEITSection(i, offsetSectionsEnd, sh.TableIDExtension); err != nil {
err = fmt.Errorf("astits: parsing EIT section failed: %w", err)
return
}
}
return
}
// toData parses the PSI tables and returns a set of DemuxerData
func (d *PSIData) toData(firstPacket *Packet, pid uint16) (ds []*DemuxerData) {
// Loop through sections
for _, s := range d.Sections {
// Switch on table type
switch s.Header.TableID {
case PSITableIDNITVariant1, PSITableIDNITVariant2:
ds = append(ds, &DemuxerData{FirstPacket: firstPacket, NIT: s.Syntax.Data.NIT, PID: pid})
case PSITableIDPAT:
ds = append(ds, &DemuxerData{FirstPacket: firstPacket, PAT: s.Syntax.Data.PAT, PID: pid})
case PSITableIDPMT:
ds = append(ds, &DemuxerData{FirstPacket: firstPacket, PID: pid, PMT: s.Syntax.Data.PMT})
case PSITableIDSDTVariant1, PSITableIDSDTVariant2:
ds = append(ds, &DemuxerData{FirstPacket: firstPacket, PID: pid, SDT: s.Syntax.Data.SDT})
case PSITableIDTOT:
ds = append(ds, &DemuxerData{FirstPacket: firstPacket, PID: pid, TOT: s.Syntax.Data.TOT})
}
if s.Header.TableID >= PSITableIDEITStart && s.Header.TableID <= PSITableIDEITEnd {
ds = append(ds, &DemuxerData{EIT: s.Syntax.Data.EIT, FirstPacket: firstPacket, PID: pid})
}
}
return
}
func writePSIData(w *astikit.BitsWriter, d *PSIData) (int, error) {
b := astikit.NewBitsWriterBatch(w)
b.Write(uint8(d.PointerField))
for i := 0; i < d.PointerField; i++ {
b.Write(uint8(0x00))
}
bytesWritten := 1 + d.PointerField
if err := b.Err(); err != nil {
return 0, err
}
for _, s := range d.Sections {
n, err := writePSISection(w, s)
if err != nil {
return 0, err
}
bytesWritten += n
}
return bytesWritten, nil
}
func calcPSISectionLength(s *PSISection) uint16 {
ret := uint16(0)
if s.Header.TableID.hasPSISyntaxHeader() {
ret += 5 // PSI syntax header length
}
switch s.Header.TableID {
case PSITableIDPAT:
ret += calcPATSectionLength(s.Syntax.Data.PAT)
case PSITableIDPMT:
ret += calcPMTSectionLength(s.Syntax.Data.PMT)
}
if s.Header.TableID.hasCRC32() {
ret += 4
}
return ret
}
func writePSISection(w *astikit.BitsWriter, s *PSISection) (int, error) {
if s.Header.TableID != PSITableIDPAT && s.Header.TableID != PSITableIDPMT {
return 0, fmt.Errorf("writePSISection: table %s is not implemented", s.Header.TableID.Type())
}
b := astikit.NewBitsWriterBatch(w)
sectionLength := calcPSISectionLength(s)
sectionCRC32 := crc32Polynomial
if s.Header.TableID.hasCRC32() {
w.SetWriteCallback(func(bs []byte) {
sectionCRC32 = updateCRC32(sectionCRC32, bs)
})
defer w.SetWriteCallback(nil)
}
b.Write(uint8(s.Header.TableID))
b.Write(s.Header.SectionSyntaxIndicator)
b.Write(s.Header.PrivateBit)
b.WriteN(uint8(0xff), 2)
b.WriteN(sectionLength, 12)
bytesWritten := 3
if s.Header.SectionLength > 0 {
n, err := writePSISectionSyntax(w, s)
if err != nil {
return 0, err
}
bytesWritten += n
if s.Header.TableID.hasCRC32() {
b.Write(sectionCRC32)
bytesWritten += 4
}
}
return bytesWritten, b.Err()
}
func writePSISectionSyntax(w *astikit.BitsWriter, s *PSISection) (int, error) {
bytesWritten := 0
if s.Header.TableID.hasPSISyntaxHeader() {
n, err := writePSISectionSyntaxHeader(w, s.Syntax.Header)
if err != nil {
return 0, err
}
bytesWritten += n
}
n, err := writePSISectionSyntaxData(w, s.Syntax.Data, s.Header.TableID)
if err != nil {
return 0, err
}
bytesWritten += n
return bytesWritten, nil
}
func writePSISectionSyntaxHeader(w *astikit.BitsWriter, h *PSISectionSyntaxHeader) (int, error) {
b := astikit.NewBitsWriterBatch(w)
b.Write(h.TableIDExtension)
b.WriteN(uint8(0xff), 2)
b.WriteN(h.VersionNumber, 5)
b.Write(h.CurrentNextIndicator)
b.Write(h.SectionNumber)
b.Write(h.LastSectionNumber)
return 5, b.Err()
}
func writePSISectionSyntaxData(w *astikit.BitsWriter, d *PSISectionSyntaxData, tableID PSITableID) (int, error) {
switch tableID {
// TODO write other table types
case PSITableIDPAT:
return writePATSection(w, d.PAT)
case PSITableIDPMT:
return writePMTSection(w, d.PMT)
}
return 0, nil
}