av/generator/mpegts_generator.go

/*
NAME
  mpegts_generator.go

DESCRIPTION
  See Readme.md

AUTHOR
  Dan Kortschak <dan@ausocean.org>
  Saxon Nelson-Milton <saxon@ausocean.org>

LICENSE
  mpegts_generator.go is Copyright (C) 2017-2018 the Australian Ocean Lab (AusOcean)

  It is free software: you can redistribute it and/or modify them
  under the terms of the GNU General Public License as published by the
  Free Software Foundation, either version 3 of the License, or (at your
  option) any later version.

  It is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 for more details.

  You should have received a copy of the GNU General Public License
  along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
*/

package generator

import (
	"encoding/binary"
	"hash/crc32"
	"math/bits"
	"time"

	"bitbucket.org/ausocean/av/mpegts"
	"bitbucket.org/ausocean/av/pes"
)

const psiPacketSize = 184

// TODO: really need to finish the at and pmt stuff - this is too hacky
var (
	patTable = []byte{
		0x00, // pointer

		// ---- section included in data sent to CRC32 during check
		// table header
		0x00, // table id
		0xb0, // section syntax indicator:1|private bit:1|reserved:2|section length:2|more bytes...:2
		0x0d, // more bytes...

		// syntax section
		0x00, 0x01, // table id extension
		0xc1, // reserved bits:3|version:5|use now:1
		0x00, // section number
		0x00, // last section number
		// table data
		0x00, 0x01, // Program number
		0xf0, 0x00, // reserved:3|program map PID:13

		// 0x2a, 0xb1, 0x04, 0xb2, // CRC
		// ----
	}
	pmtTable = []byte{
		0x00, // pointer

		// ---- section included in data sent to CRC32 during check
		// table header
		0x02, // table id
		0xb0, // section syntax indicator:1|private bit:1|reserved:2|section length:2|more bytes...:2
		0x12, // more bytes...

		// syntax section
		0x00, 0x01, // table id extension
		0xc1, // reserved bits:3|version:5|use now:1
		0x00, // section number
		0x00, // last section number
		// table data
		0xe1, 0x00, // reserved:3|PCR PID:13
		0xf0, 0x00, // reserved:4|unused:2|program info length:10
		// No program descriptors since program info length is 0.
		// elementary stream info data
		0x1b,       // stream type
		0xe1, 0x00, // reserved:3|elementary PID:13
		0xf0, 0x00, // reserved:4|unused:2|ES info length:10
		// No elementary stream descriptors since ES info length is 0.

		// 0x15, 0xbd, 0x4d, 0x56, // CRC
		// ----
	}
)

func init() {
	// Generate IEEE polynomial table
	// for the big-endian algorithm.
	crcTable := crc32_MakeTable(bits.Reverse32(crc32.IEEE))

	patTable = completePSI(patTable, crcTable)
	pmtTable = completePSI(pmtTable, crcTable)
}

func completePSI(psi []byte, tab *crc32.Table) []byte {
	var buf [4]byte
	crc := crc32_Update(0xffffffff, tab, psi[1:])
	binary.BigEndian.PutUint32(buf[:], crc)
	dst := make([]byte, len(psi), psiPacketSize)
	copy(dst, psi)
	dst = append(dst, buf[:]...)
	for len(dst) < cap(dst) {
		dst = append(dst, 0xff)
	}
	return dst
}

func crc32_MakeTable(poly uint32) *crc32.Table {
	var t crc32.Table
	for i := range t {
		crc := uint32(i) << 24
		for j := 0; j < 8; j++ {
			if crc&0x80000000 != 0 {
				crc = (crc << 1) ^ poly
			} else {
				crc <<= 1
			}
		}
		t[i] = crc
	}
	return &t
}

func crc32_Update(crc uint32, tab *crc32.Table, p []byte) uint32 {
	for _, v := range p {
		crc = tab[byte(crc>>24)^v] ^ (crc << 8)
	}
	return crc
}

const (
	sdtPid   = 17
	patPid   = 0
	pmtPid   = 4096
	videoPid = 256
	streamID = 0xe0 // First video stream ID.
)

// Time related constants.
const (
	// ptsOffset is the offset added to the clock to determine
	// the current presentation timestamp,
	ptsOffset = 700 * time.Millisecond

	// pcrFreq is the base Program Clock Reference frequency.
	pcrFreq = 90000 // Hz
)

// tsGenerator encapsulates properties of an mpegts generator.
type tsGenerator struct {
	outputChan   chan []byte
	nalInputChan chan []byte

	clock         time.Duration
	frameInterval time.Duration
	ptsOffset     time.Duration

	continuity map[int]byte
}

// NewTsGenerator returns an instance of the tsGenerator struct
func NewTsGenerator(fps float64) (g *tsGenerator) {
	return &tsGenerator{
		outputChan:   make(chan []byte, 1),
		nalInputChan: make(chan []byte, 1),

		frameInterval: time.Duration(float64(time.Second) / fps),
		ptsOffset:     ptsOffset,

		continuity: map[int]byte{
			patPid:   0,
			pmtPid:   0,
			videoPid: 0,
		},
	}
}

// Start is called when we would like generation to begin, i.e. we would like
// the generator to start taking input data and creating mpegts packets
func (g *tsGenerator) Start() {
	go g.generate()
}

func (g *tsGenerator) Stop() {}

// InputChan returns a handle to the nalInputChan (inputChan) so that nal units
// can be passed to the generator and processed
func (g *tsGenerator) InputChan() chan []byte {
	return g.nalInputChan
}

// OutputChan returns a handle to the generator output chan where the mpegts
// packets will show up once ready to go
func (g *tsGenerator) OutputChan() <-chan []byte {
	return g.outputChan
}

const (
	hasPayload         = 0x1
	hasAdaptationField = 0x2
)

const (
	hasDTS = 0x1
	hasPTS = 0x2
)

// generate handles the incoming data and generates equivalent mpegts packets -
// sending them to the output channel
func (g *tsGenerator) generate() {
	for {
		nalu := <-g.nalInputChan

		// Write PAT
		patPkt := mpegts.Packet{
			PUSI:    true,
			PID:     patPid,
			CC:      g.ccFor(patPid),
			AFC:     hasPayload,
			Payload: patTable,
		}
		g.outputChan <- patPkt.Bytes()

		// Write PMT.
		pmtPkt := mpegts.Packet{
			PUSI:    true,
			PID:     pmtPid,
			CC:      g.ccFor(pmtPid),
			AFC:     hasPayload,
			Payload: pmtTable,
		}
		g.outputChan <- pmtPkt.Bytes()

		// Prepare PES data.
		pesPkt := pes.Packet{
			StreamID:     streamID,
			PDI:          hasPTS,
			PTS:          g.pts(),
			Data:         nalu,
			HeaderLength: 5,
		}
		buf := pesPkt.Bytes()

		pusi := true
		for len(buf) != 0 {
			pkt := mpegts.Packet{
				PUSI: pusi,
				PID:  videoPid,
				RAI:  pusi,
				CC:   g.ccFor(videoPid),
				AFC:  hasAdaptationField | hasPayload,
				PCRF: pusi,
			}
			n := pkt.FillPayload(buf)
			buf = buf[n:]

			if pusi {
				// If the packet has a Payload Unit Start Indicator
				// flag set then we need to write a PCR.
				pkt.PCR = g.pcr()
				pusi = false
			}

			g.outputChan <- pkt.Bytes()
		}

		g.tick()
	}
}

// tick advances the clock one frame interval.
func (g *tsGenerator) tick() {
	g.clock += g.frameInterval
}

// pts retuns the current presentation timestamp.
func (g *tsGenerator) pts() uint64 {
	return uint64((g.clock + g.ptsOffset).Seconds() * pcrFreq)
}

// pcr returns the current program clock reference.
func (g *tsGenerator) pcr() uint64 {
	return uint64(g.clock.Seconds() * pcrFreq)
}

// ccFor returns the next continuity counter for pid.
func (g *tsGenerator) ccFor(pid int) byte {
	cc := g.continuity[pid]
	const continuityCounterMask = 0xf
	g.continuity[pid] = (cc + 1) & continuityCounterMask
	return cc
}