mp4

package
v0.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 4, 2021 License: MIT, MIT Imports: 15 Imported by: 0

README

Parsing and generation of MP4 (isobmff) boxes.

Background

The Box interfaces and some code in this directory is from the project https://github.com/jfbus/mp4. It has been vastly enhanced and the focus has changed from progressive mp4 files to segmented files.

Overall structure

Most boxes have their own file named after the box, but in some cases, there may be multiple boxes that have the same content, and the code is then having a generic name like visualsampleentry.go.

The Box interface is specified in box.go. It does not contain decode (parsing) methods which have distinct names for each box type and are dispatched in box.go.

Implement a new box

To implement a new box fooo, the following is needed.

Create a file fooo.go and create a struct type FoooBox.

FoooBox should then implement the Box interface methods:

     Type()
     Size()
     Encode()
     Info()

but also its own decode method DecodeFooo, and register that method in the decoders map in box.go. For a simple example, look at the prft box in prft.go.

A test file fooo_test.go should have a test using the method boxDiffAfterEncodeAndDecode to check that the box information is equal after encoding and decoding.

Container boxes like moof, have a list of all their children called Children, but also direct pointers to the children with appropriate names, like Mfhd and Traf. This makes it easy to chain box paths to reach an element like a TfhdBox as

    file.Moof.Traf.Tfhd

When there may be multiple children with the same name, there may be both a slice Trafs with all boxes and Traf that points to the first.

To handle media sample data there are two structures:

  1. Sample stores the sample information used in trun
  2. FullSample extends this with the sample binary data and absolute decode time

A MediaSegment can be fragmented into multiple fragments by the method

    func (s *MediaSegment) Fragmentify(timescale uint64, trex *TrexBox, duration uint32) ([]*Fragment, error)

License

See LICENSE.md

Documentation

Overview

Package mp4 - library for parsing and writing MP4/ISOBMFF files with a focus on fragmented files.

Most boxes have their own file named after the box four-letter name in the ISO/IEC 14996-12 standard, but in some cases, there may be multiple boxes that have the same content, and the code is then having a generic name like visualsampleentry.go.

The Box interface is specified in box.go. It decodes box size and type in the box header and dispatched decode for each individual box depending on its type.

Implement a new box

To implement a new box "fooo", the following is needed:

Create a file fooo.go and with struct type FoooBox.

FoooBox should then implement the Box interface methods:

Type()
Size()
Encode()
Info()

but also its own decode method `DecodeFooo`, and register that method in the `decoders` map in `box.go`. For a simple example, look at the `prft` box in `prft.go`.

Container Boxes

Container boxes like moof, have a list of all their children called Children, but also direct pointers to the children with appropriate names, like Mfhd and Traf. This makes it easy to chain box paths to reach an element like a TfhdBox as

file.Moof.Traf.Tfhd

When there may be multiple children with the same name, there may be both a pointer to a slice Trafs with all boxes and Traf that points to the first.

Media Sample Data Structures

To handle media sample data there are two structures:

1. `Sample` stores the sample information used in trun

2. `FullSample` also carries a slice with the samples binary data as well as decode time

Fragmenting segments

A MediaSegment can be fragmented into multiple fragments by the method

func (s *MediaSegment) Fragmentify(timescale uint64, trex *TrexBox, duration uint32) ([]*Fragment, error)

Index

Constants

View Source
const (
	EncModeSegment = EncFragFileMode(0) // Only encode boxes that are part of Init and MediaSegments
	EncModeBoxTree = EncFragFileMode(1) // Encode all boxes in file tree
)
View Source
const (
	OptimizeNone = EncOptimize(0)
	OptimizeTrun = EncOptimize(1 << 0)
)
View Source
const (
	UUID_PlayReady = "9a04f079-9840-4286-ab92-e65be0885f95"
	UUID_Widevine  = "edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"
	UUID_FairPlay  = "94CE86FB-07FF-4F43-ADB8-93D2FA968CA2"
	UUID_VCAS      = "9a27dd82-fde2-4725-8cbc-4234aa06ec09"
)
View Source
const DefaultTrakID = 1

DefaultTrakID - trakID used when generating new fragmented content

View Source
const NonSyncSampleFlags uint32 = 0x00010000

NonSyncSampleFlags - flags for non-sync sample

View Source
const SyncSampleFlags uint32 = 0x02000000

SyncSampleFlags - flags for I-frame or other sync sample

View Source
const UseSubSampleEncryption = 0x2

UseSubSampleEncryption - flag for subsample encryption

Variables

This section is empty.

Functions

func ContainerInfo added in v0.16.0

func ContainerInfo(c ContainerBox, w io.Writer, specificBoxLevels, indent, indentStep string) error

func EncodeContainer

func EncodeContainer(c ContainerBox, w io.Writer) error

EncodeContainer - marshal container c to w

func EncodeHeader

func EncodeHeader(b Box, w io.Writer) error

EncodeHeader - encode a box header to a writer

func EncodeHeaderWithSize added in v0.16.0

func EncodeHeaderWithSize(boxType string, boxSize uint64, largeSize bool, w io.Writer) error

EncodeHeaderWithSize - encode a box header to a writer and allow for largeSize

func GetVersion added in v0.21.0

func GetVersion() string

GetVersion - get version and also commitHash and commitDate if inserted via Makefile

func IsSyncSampleFlags

func IsSyncSampleFlags(flags uint32) bool

IsSyncSampleFlags - flags is set correctly for sync sample

func SetNonSyncSampleFlags

func SetNonSyncSampleFlags(flags uint32) uint32

SetNonSyncSampleFlags - return flags with nonsyncsample pattern

func SetSyncSampleFlags

func SetSyncSampleFlags(flags uint32) uint32

SetSyncSampleFlags - return flags with syncsample pattern

func WriteToFile added in v0.16.0

func WriteToFile(boxStructure BoxStructure, filePath string) error

WriteToFile - write a box structure to a file at filePath

Types

type AlstSampleGroupEntry added in v0.16.0

type AlstSampleGroupEntry struct {
	RollCount         uint16
	FirstOutputSample uint16
	SampleOffset      []uint32
	NumOutputSamples  []uint16
	NumTotalSamples   []uint16
}

AlstSampleGroupEntry - Alternative Startup Entry "alst"

ISO/IEC 14496-12 Ed. 6 2020 Section 10.3 - AlternativeStartupEntry

func (*AlstSampleGroupEntry) Encode added in v0.16.0

func (s *AlstSampleGroupEntry) Encode(sw *SliceWriter)

func (*AlstSampleGroupEntry) Info added in v0.16.0

func (s *AlstSampleGroupEntry) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*AlstSampleGroupEntry) Size added in v0.16.0

func (s *AlstSampleGroupEntry) Size() uint64

func (*AlstSampleGroupEntry) Type added in v0.16.0

func (s *AlstSampleGroupEntry) Type() string

type AudioSampleEntryBox

type AudioSampleEntryBox struct {
	DataReferenceIndex uint16
	ChannelCount       uint16
	SampleSize         uint16
	SampleRate         uint16 // Integer part
	Esds               *EsdsBox
	Children           []Box
	// contains filtered or unexported fields
}

AudioSampleEntryBox according to ISO/IEC 14496-12

func CreateAudioSampleEntryBox

func CreateAudioSampleEntryBox(name string, nrChannels, sampleSize, sampleRate uint16, child Box) *AudioSampleEntryBox

CreateAudioSampleEntryBox - Create new AudioSampleEntry such as mp4

func NewAudioSampleEntryBox

func NewAudioSampleEntryBox(name string) *AudioSampleEntryBox

NewAudioSampleEntryBox - Create new empty mp4a box

func (*AudioSampleEntryBox) AddChild

func (a *AudioSampleEntryBox) AddChild(b Box)

AddChild - add a child box (avcC normally, but clap and pasp could be part of visual entry)

func (*AudioSampleEntryBox) Encode

func (a *AudioSampleEntryBox) Encode(w io.Writer) error

Encode - write box to w

func (*AudioSampleEntryBox) Info added in v0.16.0

func (a *AudioSampleEntryBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*AudioSampleEntryBox) Size

func (a *AudioSampleEntryBox) Size() uint64

Size - return calculated size

func (*AudioSampleEntryBox) Type

func (a *AudioSampleEntryBox) Type() string

Type - return box type

type AvcCBox

type AvcCBox struct {
	avc.AVCDecConfRec
}

AvcCBox - AVCConfigurationBox (ISO/IEC 14496-15 5.4.2.1.2 and 5.3.3.1.2) Contains one AVCDecoderConfigurationRecord

func CreateAvcC

func CreateAvcC(spsNALUs [][]byte, ppsNALUs [][]byte) (*AvcCBox, error)

CreateAvcC - Create an avcC box based on SPS and PPS

func (*AvcCBox) Encode

func (a *AvcCBox) Encode(w io.Writer) error

Encode - write box to w

func (*AvcCBox) Info added in v0.16.0

func (a *AvcCBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*AvcCBox) Size

func (a *AvcCBox) Size() uint64

Size - return calculated size

func (*AvcCBox) Type

func (a *AvcCBox) Type() string

Type - return box type

type Box

type Box interface {
	// Type of box, normally 4 asccii characters, but is uint32 according to spec
	Type() string
	// Size of box including header and all children if any
	Size() uint64
	// Encode box to writer
	Encode(w io.Writer) error
	// Info - write box details
	//   spedificBoxLevels is a comma-separated list box:level or all:level where level >= 0.
	//   Higher levels give more details. 0 is default
	//   indent is indent at this box level.
	//   indentStep is how much to indent at each level
	Info(w io.Writer, specificBoxLevels, indent, indentStep string) error
}

Box is the general interface to any ISOBMFF box or similar

func DecodeAudioSampleEntry

func DecodeAudioSampleEntry(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeAudioSampleEntry - decode mp4a... box

func DecodeAvcC

func DecodeAvcC(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeAvcC - box-specific decode

func DecodeBox

func DecodeBox(startPos uint64, r io.Reader) (Box, error)

DecodeBox decodes a box

func DecodeBoxLazyMdat added in v0.24.0

func DecodeBoxLazyMdat(startPos uint64, r io.ReadSeeker) (Box, error)

DecodeBox decodes a box but don't read mdat into memory

func DecodeBtrt

func DecodeBtrt(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeBtrt - box-specific decode

func DecodeCToo added in v0.24.0

func DecodeCToo(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeCToo - box-specific decode

func DecodeCdat added in v0.17.0

func DecodeCdat(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeCdat - box-specific decode

func DecodeClap added in v0.17.0

func DecodeClap(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecideClap - box-specific decode

func DecodeCo64 added in v0.21.1

func DecodeCo64(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStco - box-specific decode

func DecodeContainerChildren

func DecodeContainerChildren(hdr *boxHeader, startPos, endPos uint64, r io.Reader) ([]Box, error)

DecodeContainerChildren decodes a container box

func DecodeCslg added in v0.24.0

func DecodeCslg(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeCslg - box-specific decode

func DecodeCtim

func DecodeCtim(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeCtim - box-specific decode

func DecodeCtts

func DecodeCtts(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeCtts - box-specific decode

func DecodeData added in v0.24.0

func DecodeData(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeData - decode Data (from mov_write_string_data_tag in movenc.c in ffmpeg)

func DecodeDinf

func DecodeDinf(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeDinf - box-specific decode

func DecodeDref

func DecodeDref(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeDref - box-specific decode

func DecodeEdts

func DecodeEdts(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeEdts - box-specific decode

func DecodeElng

func DecodeElng(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeElng - box-specific decode

func DecodeElst

func DecodeElst(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeElst - box-specific decode

func DecodeEmsg

func DecodeEmsg(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeEmsg - box-specific decode

func DecodeEsds

func DecodeEsds(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeEsds - box-specific decode

func DecodeFree

func DecodeFree(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeFree - box-specific decode

func DecodeFrma added in v0.16.0

func DecodeFrma(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSaio - box-specific decode

func DecodeFtyp

func DecodeFtyp(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeFtyp - box-specific decode

func DecodeHdlr

func DecodeHdlr(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeHdlr - box-specific decode

func DecodeHvcC added in v0.17.0

func DecodeHvcC(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeHvcC - box-specific decode

func DecodeIden

func DecodeIden(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeIden - box-specific decode

func DecodeIlst added in v0.19.0

func DecodeIlst(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeIlst - box-specific decode

func DecodeKind added in v0.19.0

func DecodeKind(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeKind - box-specific decode

func DecodeMdat

func DecodeMdat(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMdat - box-specific decode

func DecodeMdatLazily added in v0.24.0

func DecodeMdatLazily(hdr *boxHeader, startPos uint64) (Box, error)

DecodeMdatLazily - box-specific decode but Data is not in memory

func DecodeMdhd

func DecodeMdhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMdhd - Decode box

func DecodeMdia

func DecodeMdia(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMdia - box-specific decode

func DecodeMehd added in v0.16.0

func DecodeMehd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMehd - box-specific decode

func DecodeMeta added in v0.17.0

func DecodeMeta(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMinf - box-specific decode

func DecodeMfhd

func DecodeMfhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMfhd - box-specific decode

func DecodeMfra added in v0.19.0

func DecodeMfra(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMfra - box-specific decode

func DecodeMfro added in v0.19.0

func DecodeMfro(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMfro - box-specific decode

func DecodeMime added in v0.25.0

func DecodeMime(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMime - box-specific decode

func DecodeMinf

func DecodeMinf(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMinf - box-specific decode

func DecodeMoof

func DecodeMoof(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMoof - box-specific decode

func DecodeMoov

func DecodeMoov(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMoov - box-specific decode

func DecodeMvex

func DecodeMvex(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMvex - box-specific decode

func DecodeMvhd

func DecodeMvhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeMvhd - box-specific decode

func DecodeNmhd

func DecodeNmhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeNmhd - box-specific decode

func DecodePasp added in v0.17.0

func DecodePasp(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodePasp - box-specific decode

func DecodePayl

func DecodePayl(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodePayl - box-specific decode

func DecodePrft

func DecodePrft(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodePrft - box-specific decode

func DecodePssh added in v0.16.0

func DecodePssh(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodePssh - box-specific decode

func DecodeSaio added in v0.16.0

func DecodeSaio(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSaio - box-specific decode

func DecodeSaiz added in v0.16.0

func DecodeSaiz(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSaiz - box-specific decode

func DecodeSbgp added in v0.16.0

func DecodeSbgp(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSbgp - box-specific decode

func DecodeSchi added in v0.16.0

func DecodeSchi(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSchi - box-specific decode

func DecodeSchm added in v0.16.0

func DecodeSchm(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSchm - box-specific decode

func DecodeSdtp added in v0.16.0

func DecodeSdtp(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSdtp - box-specific decode

func DecodeSenc

func DecodeSenc(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSenc - box-specific decode

func DecodeSgpd added in v0.16.0

func DecodeSgpd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSgpd - box-specific decode

func DecodeSidx

func DecodeSidx(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSidx - box-specific decode

func DecodeSinf added in v0.16.0

func DecodeSinf(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSinf - box-specific decode

func DecodeSmhd

func DecodeSmhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSmhd - box-specific decode

func DecodeStbl

func DecodeStbl(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStbl - box-specific decode

func DecodeStco

func DecodeStco(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStco - box-specific decode

func DecodeSthd

func DecodeSthd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSthd - box-specific decode

func DecodeStpp

func DecodeStpp(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStpp - Decode XMLSubtitleSampleEntry (stpp)

func DecodeStsc

func DecodeStsc(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStsc - box-specific decode

func DecodeStsd

func DecodeStsd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStsd - box-specific decode

func DecodeStss

func DecodeStss(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStss - box-specific decode

func DecodeStsz

func DecodeStsz(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStsz - box-specific decode

func DecodeSttg

func DecodeSttg(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSttg - box-specific decode

func DecodeStts

func DecodeStts(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStts - box-specific decode

func DecodeStyp

func DecodeStyp(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeStyp - box-specific decode

func DecodeSubs

func DecodeSubs(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeSubs - box-specific decode

func DecodeTenc added in v0.16.0

func DecodeTenc(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTenc - box-specific decode

func DecodeTfdt

func DecodeTfdt(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTfdt - box-specific decode

func DecodeTfhd

func DecodeTfhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTfhd - box-specific decode

func DecodeTfra added in v0.19.0

func DecodeTfra(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTfra - box-specific decode

func DecodeTkhd

func DecodeTkhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTkhd - box-specific decode

func DecodeTraf

func DecodeTraf(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTraf - box-specific decode

func DecodeTrak

func DecodeTrak(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTrak - box-specific decode

func DecodeTref added in v0.25.0

func DecodeTref(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTref - box-specific decode

func DecodeTrefType added in v0.25.0

func DecodeTrefType(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeElng - box-specific decode

func DecodeTrep added in v0.19.0

func DecodeTrep(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTrep - box-specific decode

func DecodeTrex

func DecodeTrex(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTrex - box-specific decode

func DecodeTrun

func DecodeTrun(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeTrun - box-specific decode

func DecodeURLBox

func DecodeURLBox(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeURLBox - box-specific decode

func DecodeUUID

func DecodeUUID(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeUUIDBox - decode a UUID box including tfxd or tfrf

func DecodeUdta added in v0.17.0

func DecodeUdta(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeUdta - box-specific decode

func DecodeUnknown

func DecodeUnknown(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeUnknown - decode an unknown box

func DecodeVisualSampleEntry

func DecodeVisualSampleEntry(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVisualSampleEntry - decode avc1/avc3/... box

func DecodeVlab

func DecodeVlab(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVlab - box-specific decode

func DecodeVmhd

func DecodeVmhd(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVmhd - box-specific decode

func DecodeVsid

func DecodeVsid(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVsid - box-specific decode

func DecodeVttC

func DecodeVttC(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVttC - box-specific decode

func DecodeVtta

func DecodeVtta(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVtta - box-specific decode

func DecodeVttc

func DecodeVttc(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVttc - box-specific decode

func DecodeVtte

func DecodeVtte(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeVtte - box-specific decode

func DecodeWvtt

func DecodeWvtt(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

DecodeWvtt - Decoder wvtt Sample Entry (wvtt)

type BoxDecoder

type BoxDecoder func(hdr *boxHeader, startPos uint64, r io.Reader) (Box, error)

BoxDecoder is function signature of the Box Decode method

type BoxStructure added in v0.16.0

type BoxStructure interface {
	Encode(w io.Writer) error
}

BoxStructure represent a box or similar entity such as a Segment

type BtrtBox

type BtrtBox struct {
	BufferSizeDB uint32
	MaxBitrate   uint32
	AvgBitrate   uint32
}

BtrtBox - BitRateBox - ISO/IEC 14496-12 Section 8.5.2.2

func (*BtrtBox) Encode

func (b *BtrtBox) Encode(w io.Writer) error

Encode - write box to w

func (*BtrtBox) Info added in v0.16.0

func (b *BtrtBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*BtrtBox) Size

func (b *BtrtBox) Size() uint64

Size - return calculated size

func (*BtrtBox) Type

func (b *BtrtBox) Type() string

Type - return box type

type CTooBox added in v0.24.0

type CTooBox struct {
	Children []Box
}

CTooBox - ©too box defines the ffmpeg encoding tool information

func (*CTooBox) AddChild added in v0.24.0

func (b *CTooBox) AddChild(child Box)

AddChild - Add a child box and update SampleCount

func (*CTooBox) Encode added in v0.24.0

func (b *CTooBox) Encode(w io.Writer) error

Encode - box-specific encode of stsd - not a usual container

func (*CTooBox) GetChildren added in v0.24.0

func (b *CTooBox) GetChildren() []Box

GetChildren - list of child boxes

func (*CTooBox) Info added in v0.24.0

func (b *CTooBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - box-specific Info

func (*CTooBox) Size added in v0.24.0

func (b *CTooBox) Size() uint64

Size - calculated size of box

func (*CTooBox) Type added in v0.24.0

func (b *CTooBox) Type() string

Type - box type

type CdatBox added in v0.17.0

type CdatBox struct {
	Data []byte
}

CdatBox - Closed Captioning Sample Data according to QuickTime spec: https://developer.apple.com/library/archive/documentation/QuickTime/QTFF/QTFFChap3/qtff3.html#//apple_ref/doc/uid/TP40000939-CH205-SW87

func (*CdatBox) Encode added in v0.17.0

func (b *CdatBox) Encode(w io.Writer) error

Encode - write box to w

func (*CdatBox) Info added in v0.17.0

func (b *CdatBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*CdatBox) Size added in v0.17.0

func (b *CdatBox) Size() uint64

Size - calculated size of box

func (*CdatBox) Type added in v0.17.0

func (b *CdatBox) Type() string

Type - box type

type Chunk added in v0.24.0

type Chunk struct {
	ChunkNr       uint32
	StartSampleNr uint32
	NrSamples     uint32
}

Chunk defines a chunk with number, starting sampleNr and nrSamples

type ClapBox added in v0.17.0

type ClapBox struct {
	CleanApertureWidthN  uint32
	CleanApertureWidthD  uint32
	CleanApertureHeightN uint32
	CleanApertureHeightD uint32
	HorizOffN            uint32
	HorizOffD            uint32
	VertOffN             uint32
	VertOffD             uint32
}

ClapBox - Clean Aperture Box, ISO/IEC 14496-12 2020 Sec. 12.1.4

func (*ClapBox) Encode added in v0.17.0

func (b *ClapBox) Encode(w io.Writer) error

Encode - write box to w

func (*ClapBox) Info added in v0.17.0

func (b *ClapBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*ClapBox) Size added in v0.17.0

func (b *ClapBox) Size() uint64

Size - calculated size of box

func (*ClapBox) Type added in v0.17.0

func (b *ClapBox) Type() string

Type - box type

type Co64Box added in v0.21.1

type Co64Box struct {
	Version     byte
	Flags       uint32
	ChunkOffset []uint64
}

Co64Box - Chunk Large Offset Box

Contained in : Sample Table box (stbl)

64-bit version of StcoBox

func (*Co64Box) Encode added in v0.21.1

func (b *Co64Box) Encode(w io.Writer) error

Encode - box-specific encode

func (*Co64Box) GetOffset added in v0.24.0

func (b *Co64Box) GetOffset(chunkNr int) (uint64, error)

GetOffset - get offset for 1-based chunkNr.

func (*Co64Box) Info added in v0.21.1

func (b *Co64Box) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*Co64Box) Size added in v0.21.1

func (b *Co64Box) Size() uint64

Size - box-specific size

func (*Co64Box) Type added in v0.21.1

func (b *Co64Box) Type() string

Type - box-specific type

type ContainerBox

type ContainerBox interface {
	Type() string
	Size() uint64
	Encode(w io.Writer) error
	GetChildren() []Box
	Info(w io.Writer, specificBoxLevels, indent, indentStep string) error
}

ContainerBox is interface for ContainerBoxes

type CslgBox added in v0.24.0

type CslgBox struct {
	Version                      byte
	Flags                        uint32
	CompositionToDTSShift        int64
	LeastDecodeToDisplayDelta    int64
	GreatestDecodeToDisplayDelta int64
	CompositionStartTime         int64
	CompositionEndTime           int64
}

CslgBox - CompositionToDecodeBox -ISO/IEC 14496-12 2015 Sec. 8.6.1.4

Contained in: Sample Table Box (stbl) or Track Extension Properties Box (trep)

func (*CslgBox) Encode added in v0.24.0

func (b *CslgBox) Encode(w io.Writer) error

Encode - write box to w

func (*CslgBox) Info added in v0.24.0

func (b *CslgBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - get details with specificBoxLevels cslg:1 or higher

func (*CslgBox) Size added in v0.24.0

func (b *CslgBox) Size() uint64

Size - calculated size of box

func (*CslgBox) Type added in v0.24.0

func (b *CslgBox) Type() string

Type - box type

type CtimBox

type CtimBox struct {
	CueCurrentTime string
}

CtimBox - CueTimeBox (ctim) CueCurrentTime is current time indication (for split cues)

func (*CtimBox) Encode

func (c *CtimBox) Encode(w io.Writer) error

Encode - write box to w

func (*CtimBox) Info added in v0.16.0

func (c *CtimBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*CtimBox) Size

func (c *CtimBox) Size() uint64

Size - calculated size of box

func (*CtimBox) Type

func (c *CtimBox) Type() string

Type - box-specific type

type CttsBox

type CttsBox struct {
	Version      byte
	Flags        uint32
	SampleCount  []uint32
	SampleOffset []int32 // int32 to handle version 1
}

CttsBox - Composition Time to Sample Box (ctts - optional)

Contained in: Sample Table Box (stbl)

func (*CttsBox) Encode

func (b *CttsBox) Encode(w io.Writer) error

Encode - write box to w

func (*CttsBox) GetCompositionTimeOffset

func (b *CttsBox) GetCompositionTimeOffset(sampleNr uint32) int32

GetCompositionTimeOffset - composition time offset for (one-based) sampleNr in track timescale

func (*CttsBox) Info added in v0.16.0

func (b *CttsBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - get all info with specificBoxLevels ctts:1 or higher

func (*CttsBox) Size

func (b *CttsBox) Size() uint64

Size - calculated size of box

func (*CttsBox) Type

func (b *CttsBox) Type() string

Type - box type

type DataBox added in v0.24.0

type DataBox struct {
	Data []byte
}

DataBox - data box used by ffmpeg for providing information.

func (*DataBox) Encode added in v0.24.0

func (b *DataBox) Encode(w io.Writer) error

Encode - write box to w

func (*DataBox) Info added in v0.24.0

func (b *DataBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - box-specific Info

func (*DataBox) Size added in v0.24.0

func (b *DataBox) Size() uint64

Size - calculated size of box

func (*DataBox) Type added in v0.24.0

func (b *DataBox) Type() string

Type - box type

type DataRange added in v0.24.0

type DataRange struct {
	Offset uint64
	Size   uint64
}

DataRange is a range for sample data in a file relative to file start

type DecFileMode added in v0.24.0

type DecFileMode byte
const (
	// DecModeNormal reads Mdat data into memory during file decoding.
	DecModeNormal DecFileMode = iota
	// DecModeLazyMdat doesn't not read Mdat data into memory,
	// which means the decoding process requires less memory and faster.
	DecModeLazyMdat
)

type DinfBox

type DinfBox struct {
	Dref     *DrefBox
	Children []Box
}

DinfBox - Data Information Box (dinf - mandatory)

Contained in : Media Information Box (minf) or Meta Box (meta)

func (*DinfBox) AddChild

func (d *DinfBox) AddChild(box Box)

AddChild - Add a child box

func (*DinfBox) Encode

func (d *DinfBox) Encode(w io.Writer) error

Encode - write dinf container to w

func (*DinfBox) GetChildren

func (d *DinfBox) GetChildren() []Box

GetChildren - list of child boxes

func (*DinfBox) Info added in v0.16.0

func (d *DinfBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*DinfBox) Size

func (d *DinfBox) Size() uint64

Size - box-specific size

func (*DinfBox) Type

func (d *DinfBox) Type() string

Type - box-specific type

type DrefBox

type DrefBox struct {
	Version    byte
	Flags      uint32
	EntryCount int
	Children   []Box
}

DrefBox - Data Reference Box (dref - mandatory)

Contained id: Data Information Box (dinf)

Defines the location of the media data. If the data for the track is located in the same file it contains nothing useful.

func CreateDref

func CreateDref() *DrefBox

CreateDref - Create an DataReferenceBox for selfcontained content

func (*DrefBox) AddChild

func (d *DrefBox) AddChild(box Box)

AddChild - Add a child box and update EntryCount

func (*DrefBox) Encode

func (d *DrefBox) Encode(w io.Writer) error

Encode - write dref box to w including children

func (*DrefBox) Info added in v0.16.0

func (d *DrefBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*DrefBox) Size

func (d *DrefBox) Size() uint64

Size - calculated size of box

func (*DrefBox) Type

func (d *DrefBox) Type() string

Type - box type

type EdtsBox

type EdtsBox struct {
	Elst     []*ElstBox
	Children []Box
}

EdtsBox - Edit Box (edts - optional)

Contained in: Track Box ("trak")

The edit box maps the presentation timeline to the media-time line

func (*EdtsBox) Encode

func (b *EdtsBox) Encode(w io.Writer) error

Encode - write edts container to w

func (*EdtsBox) GetChildren

func (b *EdtsBox) GetChildren() []Box

GetChildren - list of child boxes

func (*EdtsBox) Info added in v0.16.0

func (b *EdtsBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*EdtsBox) Size

func (b *EdtsBox) Size() uint64

Size - calculated size of box

func (*EdtsBox) Type

func (b *EdtsBox) Type() string

Type - box type

type ElngBox

type ElngBox struct {
	Language string
}

ElngBox - Extended Language Box

func CreateElng

func CreateElng(language string) *ElngBox

CreateElng - Create an Extended Language Box

func (*ElngBox) Encode

func (b *ElngBox) Encode(w io.Writer) error

Encode - write box to w

func (*ElngBox) Info added in v0.16.0

func (b *ElngBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*ElngBox) Size

func (b *ElngBox) Size() uint64

Size - calculated size of box

func (*ElngBox) Type

func (b *ElngBox) Type() string

Type - box type

type ElstBox

type ElstBox struct {
	Version           byte
	Flags             uint32
	SegmentDuration   []uint64
	MediaTime         []int64
	MediaRateInteger  []int16
	MediaRateFraction []int16
}

ElstBox - Edit List Box (elst - optional)

Contained in : Edit Box (edts)

func (*ElstBox) Encode

func (b *ElstBox) Encode(w io.Writer) error

Encode - write box to w

func (*ElstBox) Info added in v0.16.0

func (b *ElstBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*ElstBox) Size

func (b *ElstBox) Size() uint64

Size - calculated size of box

func (*ElstBox) Type

func (b *ElstBox) Type() string

Type - box type

type EmsgBox

type EmsgBox struct {
	Version               byte
	Flags                 uint32
	TimeScale             uint32
	PresentationTimeDelta uint32
	PresentationTime      uint64
	EventDuration         uint32
	Id                    uint32
	SchemeIdURI           string
	Value                 string
}

EmsgBox - DASHEventMessageBox as defined in ISO/IEC 23009-1

func (*EmsgBox) Encode

func (b *EmsgBox) Encode(w io.Writer) error

Encode - write box to w

func (*EmsgBox) Info added in v0.16.0

func (b *EmsgBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*EmsgBox) Size

func (b *EmsgBox) Size() uint64

Size - calculated size of box

func (*EmsgBox) Type

func (b *EmsgBox) Type() string

Type - box type

type EncFragFileMode added in v0.23.0

type EncFragFileMode byte

type EncOptimize added in v0.23.0

type EncOptimize uint32

func (EncOptimize) String added in v0.23.0

func (eo EncOptimize) String() string

type EsdsBox

type EsdsBox struct {
	Version               byte
	Flags                 uint32
	EsDescrTag            byte
	EsID                  uint16
	FlagsAndPriority      byte
	DecoderConfigDescrTag byte
	ObjectType            byte
	StreamType            byte
	BufferSizeDB          uint32
	MaxBitrate            uint32
	AvgBitrate            uint32
	DecSpecificInfoTag    byte
	DecConfig             []byte
	SLConfigDescrTag      byte
	SLConfigValue         byte
	// contains filtered or unexported fields
}

EsdsBox as used for MPEG-audio, see ISO 14496-1 Section 7.2.6.6 for DecoderConfigDescriptor

func CreateEsdsBox

func CreateEsdsBox(decConfig []byte) *EsdsBox

CreateEsdsBox - Create an EsdsBox geiven decConfig

func (*EsdsBox) Encode

func (e *EsdsBox) Encode(w io.Writer) error

Encode - write box to w

func (*EsdsBox) Info added in v0.16.0

func (e *EsdsBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*EsdsBox) Size

func (e *EsdsBox) Size() uint64

Size - calculated size of box

func (*EsdsBox) Type

func (e *EsdsBox) Type() string

Type - box type

type File

type File struct {
	Ftyp        *FtypBox
	Moov        *MoovBox
	Mdat        *MdatBox        // Only used for non-fragmented files
	Init        *InitSegment    // Init data (ftyp + moov for fragmented file)
	Sidx        *SidxBox        // SidxBox for a DASH OnDemand file
	Segments    []*MediaSegment // Media segments
	Children    []Box           // All top-level boxes in order
	FragEncMode EncFragFileMode // Determine how fragmented files are encoded
	EncOptimize EncOptimize     // Bit field with optimizations being done at encoding
	// contains filtered or unexported fields
}

File - an MPEG-4 file asset

A progressive MPEG-4 file contains three main boxes:

ftyp : the file type box
moov : the movie box (meta-data)
mdat : the media data (chunks and samples). Only used for pror

where mdat may come before moov. If fragmented, there are many more boxes and they are collected in the InitSegment, Segment and Segments structures. The sample metadata in thefragments in the Segments will be optimized unless EncodeVerbatim is set. To Encode the same data as Decoded, this flag must therefore be set. In all cases, Children contain all top-level boxes

func DecodeFile

func DecodeFile(r io.Reader, options ...Option) (*File, error)

DecodeFile - parse and decode a file from reader r with optional file options. For example, the file options overwrite the default decode or encode mode.

func NewFile

func NewFile() *File

NewFile - create MP4 file

func ReadMP4File added in v0.16.0

func ReadMP4File(path string) (*File, error)

ReadMP4File - read an mp4 file from path

func (*File) AddChild

func (f *File) AddChild(box Box, boxStartPos uint64)

AddChild - add child with start position

func (*File) AddMediaSegment

func (f *File) AddMediaSegment(m *MediaSegment)

AddMediaSegment - add a mediasegment to file f

func (*File) ApplyOptions added in v0.24.0

func (f *File) ApplyOptions(opts ...Option)

ApplyOptions - applies options for decoding or encoding a file

func (*File) CopySampleData added in v0.25.0

func (f *File) CopySampleData(w io.Writer, rs io.ReadSeeker, trak *TrakBox, startSampleNr, endSampleNr uint32) error

CopySampleData - copy sample data from a track in a progressive mp4 file to w. Use rs if lazy read.

func (*File) DumpWithSampleData

func (f *File) DumpWithSampleData(w io.Writer, specificBoxLevels string) error

DumpWithSampleData - print information about file and its children boxes

func (*File) Encode

func (f *File) Encode(w io.Writer) error

Encode - encode a file to a Writer Fragmented files are encoded based on InitSegment and MediaSegments, unless EncodeVerbatim is set.

func (*File) Info added in v0.16.0

func (f *File) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - write box tree with indent for each level

func (*File) IsFragmented

func (f *File) IsFragmented() bool

IsFragmented - is file made of multiple segments (Mp4 fragments)

func (*File) LastSegment

func (f *File) LastSegment() *MediaSegment

LastSegment - Currently last segment

type Fixed16

type Fixed16 uint16

Fixed16 - An 8.8 fixed point number

func (Fixed16) String

func (f Fixed16) String() string

type Fixed32

type Fixed32 uint32

Fixed32 - A 16.16 fixed point number

func (Fixed32) String

func (f Fixed32) String() string

type Fragment

type Fragment struct {
	Prft     *PrftBox
	Moof     *MoofBox
	Mdat     *MdatBox
	Children []Box // All top-level boxes in order

	EncOptimize EncOptimize // Bit field with optimizations being done at encoding
	// contains filtered or unexported fields
}

Fragment - MP4 Fragment ([prft] + moof + mdat)

func CreateFragment

func CreateFragment(seqNumber uint32, trackID uint32) (*Fragment, error)

CreateFragment - create single track empty fragment

func CreateMultiTrackFragment added in v0.17.0

func CreateMultiTrackFragment(seqNumber uint32, trackIDs []uint32) (*Fragment, error)

CreateFragment - create multi-track empty fragment without trun

func NewFragment

func NewFragment() *Fragment

NewFragment - New emtpy one-track MP4 Fragment

func (*Fragment) AddChild

func (f *Fragment) AddChild(b Box)

AddChild - Add a top-level box to Fragment

func (*Fragment) AddFullSample

func (f *Fragment) AddFullSample(s FullSample)

AddFullSample - add a full sample to the first (and only) trun of a track AddFullSampleToTrack is the more general function

func (*Fragment) AddFullSampleToTrack added in v0.17.0

func (f *Fragment) AddFullSampleToTrack(s FullSample, trackID uint32) error

AddFullSampleToTrack - allows for adding samples to any track New trun boxes will be created if latest trun of fragment is not in this track

func (*Fragment) AddSample added in v0.24.0

func (f *Fragment) AddSample(s Sample, baseMediaDecodeTime uint64)

AddSample - add a sample to the first (and only) trun of a track AddSampleToTrack is the more general function

func (*Fragment) AddSampleInterval added in v0.25.0

func (f *Fragment) AddSampleInterval(sItvl SampleInterval) error

GetSampleInterval - get SampleInterval for a fragment with only one track

func (*Fragment) AddSampleToTrack added in v0.24.0

func (f *Fragment) AddSampleToTrack(s Sample, trackID uint32, baseMediaDecodeTime uint64) error

AddSampleToTrack - allows for adding samples to any track New trun boxes will be created if latest trun of fragment is not in this track baseMediaDecodeTime will be used only for first sample in a trun

func (*Fragment) AddSamples added in v0.25.0

func (f *Fragment) AddSamples(ss []Sample, baseMediaDecodeTime uint64)

AddSamples - add a slice of Sample to the first (and only) trun of a track

func (*Fragment) DumpSampleData

func (f *Fragment) DumpSampleData(w io.Writer, trex *TrexBox) error

DumpSampleData - Get Sample data and print out

func (*Fragment) Encode

func (f *Fragment) Encode(w io.Writer) error

Encode - write fragment via writer

func (*Fragment) GetChildren

func (f *Fragment) GetChildren() []Box

GetChildren - return children boxes

func (*Fragment) GetFullSamples

func (f *Fragment) GetFullSamples(trex *TrexBox) ([]FullSample, error)

GetFullSamples - Get full samples including media and accumulated time

func (*Fragment) GetSampleInterval added in v0.25.0

func (f *Fragment) GetSampleInterval(trex *TrexBox, startSampleNr, endSampleNr uint32) (SampleInterval, error)

GetSampleInterval - get SampleInterval for a fragment with only one track

func (*Fragment) GetSampleNrFromTime added in v0.25.0

func (f *Fragment) GetSampleNrFromTime(trex *TrexBox, sampleTime uint64) (uint32, error)

Look up sample number from a specifed time. Return error if no matching time

func (*Fragment) Info added in v0.16.0

func (f *Fragment) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*Fragment) SetTrunDataOffsets added in v0.17.0

func (f *Fragment) SetTrunDataOffsets()

SetTrunDataOffsets - set DataOffset in trun depending on size and writeOrder

func (*Fragment) Size added in v0.25.0

func (f *Fragment) Size() uint64

Size - return size of fragment including all boxes. Be aware that TrafBox.OptimizeTfhdTrun() can change size

type FreeBox

type FreeBox struct {
	Name string
	// contains filtered or unexported fields
}

FreeBox - Free Space Box (free or skip)

func (*FreeBox) Encode

func (b *FreeBox) Encode(w io.Writer) error

Encode - write box to w

func (*FreeBox) Info added in v0.16.0

func (b *FreeBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*FreeBox) Size

func (b *FreeBox) Size() uint64

Size - calculated size of box

func (*FreeBox) Type

func (b *FreeBox) Type() string

Type - box type

type FrmaBox added in v0.16.0

type FrmaBox struct {
	DataFormat string // uint32 - original box type
}

FrmaBox - Original Format Box

func (*FrmaBox) Encode added in v0.16.0

func (b *FrmaBox) Encode(w io.Writer) error

Encode - write box to w

func (*FrmaBox) Info added in v0.16.0

func (b *FrmaBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*FrmaBox) Size added in v0.16.0

func (b *FrmaBox) Size() uint64

Size - return calculated size

func (*FrmaBox) Type added in v0.16.0

func (b *FrmaBox) Type() string

Type - return box type

type FtypBox

type FtypBox struct {
	MajorBrand       string
	MinorVersion     uint32
	CompatibleBrands []string
}

FtypBox - File Type Box (ftyp - mandatory)

func CreateFtyp

func CreateFtyp() *FtypBox

CreateFtyp - Create an Ftyp box suitable for DASH/CMAF

func (*FtypBox) Encode

func (b *FtypBox) Encode(w io.Writer) error

Encode - write box to w

func (*FtypBox) Info added in v0.16.0

func (b *FtypBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*FtypBox) Size

func (b *FtypBox) Size() uint64

Size - return calculated size

func (*FtypBox) Type

func (b *FtypBox) Type() string

Type - return box type

type FullSample

type FullSample struct {
	Sample
	DecodeTime uint64 // Absolute decode time (offset + accumulated sample Dur)
	Data       []byte // Sample data
}

FullSample - include accumulated time and data. Times in mdhd timescale

func (*FullSample) PresentationTime

func (s *FullSample) PresentationTime() uint64

PresentationTime - DecodeTime displaced by composition time offset (possibly negative)

type HdlrBox

type HdlrBox struct {
	Version              byte
	Flags                uint32
	PreDefined           uint32
	HandlerType          string
	Name                 string // Null-terminated UTF-8 string according to ISO/IEC 14496-12 Sec. 8.4.3.3
	LacksNullTermination bool   // This should be true, but we allow false as well
}

HdlrBox - Handler Reference Box (hdlr - mandatory)

Contained in: Media Box (mdia) or Meta Box (meta)

This box describes the type of data contained in the trak. HandlerType can be : "vide" (video track), "soun" (audio track), "subt" (subtitle track) Other types are: "hint" (hint track), "meta" (timed Metadata track), "auxv" (auxiliary video track). clcp (Closed Captions (QuickTime))

func CreateHdlr

func CreateHdlr(mediaOrHdlrType string) (*HdlrBox, error)

CreateHdlr - create mediaType-specific hdlr box

func (*HdlrBox) Encode

func (b *HdlrBox) Encode(w io.Writer) error

Encode - write box to w

func (*HdlrBox) Info added in v0.16.0

func (b *HdlrBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*HdlrBox) Size

func (b *HdlrBox) Size() uint64

Size - calculated size of box

func (*HdlrBox) Type

func (b *HdlrBox) Type() string

Type - box type

type HvcCBox added in v0.17.0

type HvcCBox struct {
	hevc.HEVCDecConfRec
}

HvcCBox - HEVCConfigurationBox (ISO/IEC 14496-15 8.4.1.1.2) Contains one HEVCDecoderConfigurationRecord

func CreateHvcC added in v0.17.1

func CreateHvcC(vpsNalus, spsNalus, ppsNalus [][]byte, vpsComplete, spsComplete, ppsComplete bool) (*HvcCBox, error)

CreateHvcC- Create an hvcC box based on VPS, SPS and PPS and signal completeness

func (*HvcCBox) Encode added in v0.17.0

func (b *HvcCBox) Encode(w io.Writer) error

Encode - write box to w

func (*HvcCBox) Info added in v0.17.0

func (b *HvcCBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - box-specific Info

func (*HvcCBox) Size added in v0.17.0

func (b *HvcCBox) Size() uint64

Size - return calculated size

func (*HvcCBox) Type added in v0.17.0

func (b *HvcCBox) Type() string

Type - return box type

type IdenBox

type IdenBox struct {
	CueID string
}

IdenBox - CueIDBox (iden)

func (*IdenBox) Encode

func (i *IdenBox) Encode(w io.Writer) error

Encode - write box to w

func (*IdenBox) Info added in v0.16.0

func (i *IdenBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*IdenBox) Size

func (i *IdenBox) Size() uint64

Size - calculated size of box

func (*IdenBox) Type

func (i *IdenBox) Type() string

Type - box-specific type

type IlstBox added in v0.19.0

type IlstBox struct {
	Children []Box
}

IlstBox - iTunes Metadata Item List Atom (ilst) See https://developer.apple.com/library/archive/documentation/QuickTime/QTFF/Metadata/Metadata.html

func (*IlstBox) AddChild added in v0.19.0

func (s *IlstBox) AddChild(child Box)

AddChild - Add a child box and update SampleCount

func (*IlstBox) Encode added in v0.19.0

func (b *IlstBox) Encode(w io.Writer) error

Encode - box-specific encode of stsd - not a usual container

func (*IlstBox) GetChildren added in v0.19.0

func (b *IlstBox) GetChildren() []Box

GetChildren - list of child boxes

func (*IlstBox) Info added in v0.19.0

func (b *IlstBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*IlstBox) Size added in v0.19.0

func (b *IlstBox) Size() uint64

Size - box-specific type

func (*IlstBox) Type added in v0.19.0

func (s *IlstBox) Type() string

Type - box-specific type

type Informer added in v0.16.0

type Informer interface {
	// Info - write details via Info method
	//   spedificBoxLevels is a comma-separated list box:level or all:level where level >= 0.
	//   Higher levels give more details. 0 is default
	//   indent is indent at this box level.
	//   indentStep is how much to indent at each level
	Info(w io.Writer, specificBoxLevels, indent, indentStep string) error
}

Informer - write box, segment or file details

type InitSegment

type InitSegment struct {
	MediaType string
	Ftyp      *FtypBox
	Moov      *MoovBox
	Children  []Box // All top-level boxes in order
}

InitSegment - MP4/CMAF init segment

func CreateEmptyInit added in v0.17.0

func CreateEmptyInit() *InitSegment

CreateEmptyInit - create an init segment for fragmented files

func NewMP4Init

func NewMP4Init() *InitSegment

NewMP4Init - Create MP4Init

func (*InitSegment) AddChild

func (s *InitSegment) AddChild(b Box)

AddChild - Add a top-level box to InitSegment

func (*InitSegment) AddEmptyTrack added in v0.17.0

func (i *InitSegment) AddEmptyTrack(timeScale uint32, mediaType, language string)

AddEmptyTrack - add trak + trex box with appropriate trackID value

func (*InitSegment) Encode

func (s *InitSegment) Encode(w io.Writer) error

Encode - encode an initsegment to a Writer

func (*InitSegment) GetMediaType

func (s *InitSegment) GetMediaType() string

GetMediaType - should return video or audio (at present)

func (*InitSegment) Info added in v0.16.0

func (i *InitSegment) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - write box tree with indent for each level

func (*InitSegment) Size added in v0.25.0

func (s *InitSegment) Size() uint64

Size - size of init segment

type InitializationVector

type InitializationVector []byte

InitializationVector (8 or 16 bytes)

type KindBox added in v0.19.0

type KindBox struct {
	SchemeURI string
	Value     string
}

KindBox - Track Kind Box

func (*KindBox) Encode added in v0.19.0

func (b *KindBox) Encode(w io.Writer) error

Encode - write box to w

func (*KindBox) Info added in v0.19.0

func (b *KindBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*KindBox) Size added in v0.19.0

func (b *KindBox) Size() uint64

Size - calculated size of box

func (*KindBox) Type added in v0.19.0

func (b *KindBox) Type() string

Type - box type

type MdatBox

type MdatBox struct {
	StartPos uint64
	Data     []byte

	LargeSize bool
	// contains filtered or unexported fields
}

MdatBox - Media Data Box (mdat) The mdat box contains media chunks/samples.

func (*MdatBox) AddSampleData

func (m *MdatBox) AddSampleData(s []byte)

AddSampleData - a sample data to an mdat box

func (*MdatBox) CopyData added in v0.24.0

func (m *MdatBox) CopyData(start, size int64, rs io.ReadSeeker, w io.Writer) (nrWritten int64, err error)

CopyData - copy data range from mdat to w. The ReadSeeker is used for lazily loaded mdat case.

func (*MdatBox) Encode

func (m *MdatBox) Encode(w io.Writer) error

Encode - write box to w. If m.lazyDataSize > 0, the mdat data needs to be written separately

func (*MdatBox) GetLazyDataSize added in v0.24.0

func (m *MdatBox) GetLazyDataSize() uint64

func (*MdatBox) HeaderSize added in v0.16.0

func (m *MdatBox) HeaderSize() uint64

HeaderSize - 8 or 16 (bytes) depending o whether largeSize is used

func (*MdatBox) Info added in v0.16.0

func (m *MdatBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MdatBox) IsLazy added in v0.24.0

func (m *MdatBox) IsLazy() bool

IsLazy - is the mdat data handled lazily (with separate writer/reader).

func (*MdatBox) PayloadAbsoluteOffset added in v0.16.0

func (m *MdatBox) PayloadAbsoluteOffset() uint64

PayloadAbsoluteOffset - position of mdat payload start (works after header)

func (*MdatBox) ReadData added in v0.24.0

func (m *MdatBox) ReadData(start, size int64, rs io.ReadSeeker) ([]byte, error)

ReadData reads Mdat data specified by the start and size. Input argument start is the postion relative to the start of a file. The ReadSeeker is used for lazily loaded mdat case.

func (*MdatBox) SetData added in v0.24.0

func (m *MdatBox) SetData(data []byte)

SetData - set the mdat data to given slice. No copying is done

func (*MdatBox) SetLazyDataSize added in v0.24.0

func (m *MdatBox) SetLazyDataSize(newSize uint64)

SetLazyDataSize - set size of mdat lazy data, so that the data can be written separately Don't put any data in m.Data in this mode.

func (*MdatBox) Size

func (m *MdatBox) Size() uint64

Size - return calculated size, depending on largeSize set or not

func (*MdatBox) Type

func (m *MdatBox) Type() string

Type - return box type

type MdhdBox

type MdhdBox struct {
	Version          byte // Only version 0
	Flags            uint32
	CreationTime     uint64 // Typically not set
	ModificationTime uint64 // Typically not set
	Timescale        uint32 // Media timescale for this track
	Duration         uint64 // Trak duration, 0 for fragmented files
	Language         uint16 // Three-letter ISO-639-2/T language code
}

MdhdBox - Media Header Box (mdhd - mandatory)

Contained in : Media Box (mdia)

Timescale defines the timescale used for this track. Language is a ISO-639-2/T language code stored as 1bit padding + [3]int5

func (*MdhdBox) Encode

func (m *MdhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*MdhdBox) GetLanguage

func (m *MdhdBox) GetLanguage() string

GetLanguage - Get three-byte language string

func (*MdhdBox) Info added in v0.16.0

func (m *MdhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MdhdBox) SetLanguage

func (m *MdhdBox) SetLanguage(lang string)

SetLanguage - Set three-byte language string

func (*MdhdBox) Size

func (m *MdhdBox) Size() uint64

Size - calculated size of box

func (*MdhdBox) Type

func (m *MdhdBox) Type() string

Type - box type

type MdiaBox

type MdiaBox struct {
	Mdhd     *MdhdBox
	Hdlr     *HdlrBox
	Elng     *ElngBox
	Minf     *MinfBox
	Elst     *ElstBox
	Children []Box
}

MdiaBox - Media Box (mdia)

Contained in : Track Box (trak) Contains all information about the media data.

func NewMdiaBox

func NewMdiaBox() *MdiaBox

NewMdiaBox - Generate a new empty mdia box

func (*MdiaBox) AddChild

func (m *MdiaBox) AddChild(box Box)

AddChild - Add a child box

func (*MdiaBox) Encode

func (m *MdiaBox) Encode(w io.Writer) error

Encode - write mdia container to w

func (*MdiaBox) GetChildren

func (m *MdiaBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MdiaBox) Info added in v0.16.0

func (m *MdiaBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MdiaBox) Size

func (m *MdiaBox) Size() uint64

Size - return calculated size

func (*MdiaBox) Type

func (m *MdiaBox) Type() string

Type - return box type

type MediaSegment

type MediaSegment struct {
	Styp        *StypBox
	Sidx        *SidxBox // Sidx for a segment
	Fragments   []*Fragment
	EncOptimize EncOptimize
}

MediaSegment - MP4 Media Segment

func NewMediaSegment

func NewMediaSegment() *MediaSegment

NewMediaSegment - create empty MediaSegment with CMAF styp box

func NewMediaSegmentWithoutStyp added in v0.25.0

func NewMediaSegmentWithoutStyp() *MediaSegment

NewMediaSegmentWithoutStyp - create empty media segment with no styp box

func (*MediaSegment) AddFragment

func (s *MediaSegment) AddFragment(f *Fragment)

AddFragment - Add a fragment to a MediaSegment

func (*MediaSegment) Encode

func (s *MediaSegment) Encode(w io.Writer) error

Encode - Write MediaSegment via writer

func (*MediaSegment) Fragmentify

func (s *MediaSegment) Fragmentify(timescale uint64, trex *TrexBox, duration uint32) ([]*Fragment, error)

Fragmentify - Split into multiple fragments. Assume single mdat and trun for now

func (*MediaSegment) Info added in v0.16.0

func (m *MediaSegment) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - write box tree with indent for each level

func (*MediaSegment) LastFragment

func (s *MediaSegment) LastFragment() *Fragment

LastFragment - Currently last fragment

func (*MediaSegment) Size added in v0.25.0

func (s *MediaSegment) Size() uint64

Size - return size of media segment

type MehdBox added in v0.16.0

type MehdBox struct {
	Version          byte
	Flags            uint32
	FragmentDuration int64
}

MehdBox - Movie Extends Header Box Optional, provides overall duration of a fragmented movie

func (*MehdBox) Encode added in v0.16.0

func (b *MehdBox) Encode(w io.Writer) error

Encode - write box to w

func (*MehdBox) Info added in v0.16.0

func (b *MehdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Dump - write MehBox details.

func (*MehdBox) Size added in v0.16.0

func (b *MehdBox) Size() uint64

Size - return calculated size

func (*MehdBox) Type added in v0.16.0

func (b *MehdBox) Type() string

Type - return box type

type MetaBox added in v0.17.0

type MetaBox struct {
	Version  byte
	Flags    uint32
	Hdlr     *HdlrBox
	Children []Box
}

MetaBox - MetaBox meta ISO/IEC 14496-12 Ed. 6 2020 Section 8.11

func CreateMetaBox added in v0.17.0

func CreateMetaBox(version byte, hdlr *HdlrBox) *MetaBox

CreateMetaBox - Create a new MetaBox

func (*MetaBox) AddChild added in v0.17.0

func (b *MetaBox) AddChild(box Box)

AddChild - Add a child box

func (*MetaBox) Encode added in v0.17.0

func (b *MetaBox) Encode(w io.Writer) error

Encode - write minf container to w

func (*MetaBox) GetChildren added in v0.17.0

func (b *MetaBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MetaBox) Info added in v0.17.0

func (b *MetaBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MetaBox) Size added in v0.17.0

func (b *MetaBox) Size() uint64

Size - calculated size of box

func (*MetaBox) Type added in v0.17.0

func (b *MetaBox) Type() string

Type - box type

type MfhdBox

type MfhdBox struct {
	Version        byte
	Flags          uint32
	SequenceNumber uint32
}

MfhdBox - Media Fragment Header Box (mfhd)

Contained in : Movie Fragment box (moof))

func CreateMfhd

func CreateMfhd(sequenceNumber uint32) *MfhdBox

CreateMfhd - create an MfhdBox

func (*MfhdBox) Encode

func (m *MfhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*MfhdBox) Info added in v0.16.0

func (m *MfhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MfhdBox) Size

func (m *MfhdBox) Size() uint64

Size - calculated size of box

func (*MfhdBox) Type

func (m *MfhdBox) Type() string

Type - box type

type MfraBox added in v0.19.0

type MfraBox struct {
	Tfra     *TfraBox
	Tfras    []*TfraBox
	Mfro     *MfroBox
	Children []Box
	StartPos uint64
}

MfraBox - Movie Fragment Random Access Box (mfra) Container for TfraBox(es) that can be used to find sync samples

func (*MfraBox) AddChild added in v0.19.0

func (m *MfraBox) AddChild(child Box) error

AddChild - add child box

func (*MfraBox) Encode added in v0.19.0

func (m *MfraBox) Encode(w io.Writer) error

Encode - byte-specific encode

func (*MfraBox) GetChildren added in v0.19.0

func (m *MfraBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MfraBox) Info added in v0.19.0

func (m *MfraBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MfraBox) Size added in v0.19.0

func (m *MfraBox) Size() uint64

Size - returns calculated size

func (*MfraBox) Type added in v0.19.0

func (m *MfraBox) Type() string

Type - returns box type

type MfroBox added in v0.19.0

type MfroBox struct {
	Version    byte
	Flags      uint32
	ParentSize uint32
}

MfroBox - Movie Fragment Random Access Offset Box (mfro) Contained in : MfraBox (mfra)

func (*MfroBox) Encode added in v0.19.0

func (b *MfroBox) Encode(w io.Writer) error

Encode - write box to w

func (*MfroBox) Info added in v0.19.0

func (t *MfroBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MfroBox) Size added in v0.19.0

func (b *MfroBox) Size() uint64

Size - return calculated size

func (*MfroBox) Type added in v0.19.0

func (b *MfroBox) Type() string

Type - return box type

type MimeBox added in v0.25.0

type MimeBox struct {
	Version              byte
	Flags                uint32
	ContentType          string
	LacksZeroTermination bool // Handle non-compliant case as well
}

MimeBox - MIME Box as defined in ISO/IEC 14496-12 2020 Section 12.3.3.2

func (*MimeBox) Encode added in v0.25.0

func (b *MimeBox) Encode(w io.Writer) error

Encode - write box to w

func (*MimeBox) Info added in v0.25.0

func (b *MimeBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - specific box information

func (*MimeBox) Size added in v0.25.0

func (b *MimeBox) Size() uint64

Size - calculated size of box

func (*MimeBox) Type added in v0.25.0

func (b *MimeBox) Type() string

Type - box type

type MinfBox

type MinfBox struct {
	Vmhd     *VmhdBox
	Smhd     *SmhdBox
	Stbl     *StblBox
	Dinf     *DinfBox
	Hdlr     *HdlrBox
	Children []Box
}

MinfBox - Media Information Box (minf - mandatory)

Contained in : Media Box (mdia)

func NewMinfBox

func NewMinfBox() *MinfBox

NewMinfBox - Generate a new empty minf box

func (*MinfBox) AddChild

func (m *MinfBox) AddChild(box Box)

AddChild - Add a child box

func (*MinfBox) Encode

func (m *MinfBox) Encode(w io.Writer) error

Encode - write minf container to w

func (*MinfBox) GetChildren

func (m *MinfBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MinfBox) Info added in v0.16.0

func (m *MinfBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MinfBox) Size

func (m *MinfBox) Size() uint64

Size - calculated size of box

func (*MinfBox) Type

func (m *MinfBox) Type() string

Type - box type

type MoofBox

type MoofBox struct {
	Mfhd     *MfhdBox
	Traf     *TrafBox // The first traf child box
	Trafs    []*TrafBox
	Children []Box
	StartPos uint64
}

MoofBox - Movie Fragment Box (moof)

Contains all meta-data. To be able to stream a file, the moov box should be placed before the mdat box.

func (*MoofBox) AddChild

func (m *MoofBox) AddChild(b Box) error

AddChild - add child box

func (*MoofBox) Encode

func (m *MoofBox) Encode(w io.Writer) error

Encode - write moof after updating trun dataoffset

func (*MoofBox) GetChildren

func (m *MoofBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MoofBox) Info added in v0.16.0

func (m *MoofBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MoofBox) Size

func (m *MoofBox) Size() uint64

Size - returns calculated size

func (*MoofBox) Type

func (m *MoofBox) Type() string

Type - returns box type

type MoovBox

type MoovBox struct {
	Mvhd     *MvhdBox
	Trak     *TrakBox // The first trak box
	Traks    []*TrakBox
	Mvex     *MvexBox
	Children []Box
}

MoovBox - Movie Box (moov - mandatory)

Contains all meta-data. To be able to stream a file, the moov box should be placed before the mdat box.

func NewMoovBox

func NewMoovBox() *MoovBox

NewMoovBox - Generate a new empty moov box

func (*MoovBox) AddChild

func (m *MoovBox) AddChild(box Box)

AddChild - Add a child box

func (*MoovBox) Encode

func (m *MoovBox) Encode(w io.Writer) error

Encode - write moov container to w

func (*MoovBox) GetChildren

func (m *MoovBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MoovBox) Info added in v0.16.0

func (m *MoovBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MoovBox) Size

func (m *MoovBox) Size() uint64

Size - calculated size of box

func (*MoovBox) Type

func (m *MoovBox) Type() string

Type - box type

type MvexBox

type MvexBox struct {
	Mehd     *MehdBox
	Trex     *TrexBox
	Trexs    []*TrexBox
	Children []Box
}

MvexBox - MovieExtendsBox (mevx)

Contained in : Movie Box (moov)

Its presence signals a fragmented asset

func NewMvexBox

func NewMvexBox() *MvexBox

NewMvexBox - Generate a new empty mvex box

func (*MvexBox) AddChild

func (m *MvexBox) AddChild(box Box)

AddChild - Add a child box

func (*MvexBox) Encode

func (m *MvexBox) Encode(w io.Writer) error

Encode - write mvex container to w

func (*MvexBox) GetChildren

func (t *MvexBox) GetChildren() []Box

GetChildren - list of child boxes

func (*MvexBox) Info added in v0.16.0

func (m *MvexBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MvexBox) Size

func (m *MvexBox) Size() uint64

Size - return calculated size

func (*MvexBox) Type

func (m *MvexBox) Type() string

Type - return box type

type MvhdBox

type MvhdBox struct {
	Version          byte
	Flags            uint32
	CreationTime     uint64
	ModificationTime uint64
	Timescale        uint32
	Duration         uint64
	NextTrackID      uint32
	Rate             Fixed32
	Volume           Fixed16
}

MvhdBox - Movie Header Box (mvhd - mandatory)

Contained in : Movie Box (‘moov’)

Contains all media information (duration, ...).

Duration is measured in "time units", and timescale defines the number of time units per second.

func CreateMvhd

func CreateMvhd() *MvhdBox

CreateMvhd - create mvhd box with reasonable values

func (*MvhdBox) Encode

func (b *MvhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*MvhdBox) Info added in v0.16.0

func (b *MvhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*MvhdBox) Size

func (b *MvhdBox) Size() uint64

Size - return calculated size

func (*MvhdBox) Type

func (b *MvhdBox) Type() string

Type - return box type

type NmhdBox

type NmhdBox struct {
	Version byte
	Flags   uint32
}

NmhdBox - Null Media Header Box (nmhd - often used instead ofsthd for subtitle tracks)

func (*NmhdBox) Encode

func (b *NmhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*NmhdBox) Info added in v0.16.0

func (b *NmhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*NmhdBox) Size

func (b *NmhdBox) Size() uint64

Size - calculated size of box

func (*NmhdBox) Type

func (b *NmhdBox) Type() string

Type - box-specific type

type Option added in v0.24.0

type Option func(f *File)

Option is function signature of file options. The design follows functional options pattern.

func WithDecodeMode added in v0.24.0

func WithDecodeMode(mode DecFileMode) Option

WithDecodeMode sets up DecFileMode

func WithEncodeMode added in v0.24.0

func WithEncodeMode(mode EncFragFileMode) Option

WithEncodeMode sets up EncFragFileMode

type PaspBox added in v0.17.0

type PaspBox struct {
	HSpacing uint32
	VSpacing uint32
}

PaspBox - Pixel Aspect Ratio Box, ISO/IEC 14496-12 2020 Sec. 12.1.4

func (*PaspBox) Encode added in v0.17.0

func (b *PaspBox) Encode(w io.Writer) error

Encode - write box to w

func (*PaspBox) Info added in v0.17.0

func (b *PaspBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*PaspBox) Size added in v0.17.0

func (b *PaspBox) Size() uint64

Size - calculated size of box

func (*PaspBox) Type added in v0.17.0

func (b *PaspBox) Type() string

Type - box type

type PaylBox

type PaylBox struct {
	CueText string
}

PaylBox - CuePayloadBox (payl)

func (*PaylBox) Encode

func (p *PaylBox) Encode(w io.Writer) error

Encode - write box to w

func (*PaylBox) Info added in v0.16.0

func (p *PaylBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*PaylBox) Size

func (p *PaylBox) Size() uint64

Size - calculated size of box

func (*PaylBox) Type

func (p *PaylBox) Type() string

Type - box-specific type

type PrftBox

type PrftBox struct {
	Version      byte
	Flags        uint32
	NTPTimestamp uint64
	MediaTime    uint64
}

PrftBox - Producer Reference Box (prft)

Contained in File before moof box

func CreatePrftBox

func CreatePrftBox(version byte, ntp uint64, mediatime uint64) *PrftBox

CreatePrftBox - Create a new PrftBox

func (*PrftBox) Encode

func (p *PrftBox) Encode(w io.Writer) error

Encode - write box to w

func (*PrftBox) Info added in v0.16.0

func (p *PrftBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*PrftBox) Size

func (p *PrftBox) Size() uint64

Size - return calculated size

func (*PrftBox) Type

func (p *PrftBox) Type() string

Type - return box type

type PsshBox added in v0.16.0

type PsshBox struct {
	Version  byte
	Flags    uint32
	SystemID UUID
	KIDs     []UUID
	Data     []byte
}

PsshBox - Protection System Specific Header Box Defined in ISO/IEC 23001-7 Secion 8.1

func (*PsshBox) Encode added in v0.16.0

func (b *PsshBox) Encode(w io.Writer) error

Encode - write box to w

func (*PsshBox) Info added in v0.16.0

func (b *PsshBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*PsshBox) Size added in v0.16.0

func (b *PsshBox) Size() uint64

Size - return calculated size

func (*PsshBox) Type added in v0.16.0

func (b *PsshBox) Type() string

Type - return box type

type RapSampleGroupEntry added in v0.16.0

type RapSampleGroupEntry struct {
	NumLeadingSamplesKnown uint8
	NumLeadingSamples      uint8
}

RapSampleGroupEntry - Random Access Point "rap "

ISO/IEC 14496-12 Ed. 6 2020 Section 10.4 - VisualRandomAccessEntry

func (*RapSampleGroupEntry) Encode added in v0.16.0

func (s *RapSampleGroupEntry) Encode(sw *SliceWriter)

func (*RapSampleGroupEntry) Info added in v0.16.0

func (s *RapSampleGroupEntry) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*RapSampleGroupEntry) Size added in v0.16.0

func (s *RapSampleGroupEntry) Size() uint64

func (*RapSampleGroupEntry) Type added in v0.16.0

func (s *RapSampleGroupEntry) Type() string

type RollSampleGroupEntry added in v0.16.0

type RollSampleGroupEntry struct {
	RollDistance int16
}

RollSampleGroupEntry - Gradual Decoding Refresh "roll"

ISO/IEC 14496-12 Ed. 6 2020 Section 10.1

VisualRollRecoveryEntry / AudioRollRecoveryEntry / AudioPreRollEntry

func (*RollSampleGroupEntry) Encode added in v0.16.0

func (s *RollSampleGroupEntry) Encode(sw *SliceWriter)

func (*RollSampleGroupEntry) Info added in v0.16.0

func (s *RollSampleGroupEntry) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*RollSampleGroupEntry) Size added in v0.16.0

func (s *RollSampleGroupEntry) Size() uint64

func (*RollSampleGroupEntry) Type added in v0.16.0

func (s *RollSampleGroupEntry) Type() string

type SaioBox added in v0.16.0

type SaioBox struct {
	Version              byte
	Flags                uint32
	AuxInfoType          string // Used for Common Encryption Scheme (4-bytes uint32 according to spec)
	AuxInfoTypeParameter uint32
	Offset               []int64
}

SaioBox - Sample Auxiliary Information Offsets Box (saiz)

func (*SaioBox) Encode added in v0.16.0

func (b *SaioBox) Encode(w io.Writer) error

Encode - write box to w

func (*SaioBox) Info added in v0.16.0

func (b *SaioBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write SaioBox details. Get offset list with level >= 1

func (*SaioBox) Size added in v0.16.0

func (b *SaioBox) Size() uint64

Size - return calculated size

func (*SaioBox) Type added in v0.16.0

func (b *SaioBox) Type() string

Type - return box type

type SaizBox added in v0.16.0

type SaizBox struct {
	Version               byte
	Flags                 uint32
	AuxInfoType           string // Used for Common Encryption Scheme (4-bytes uint32 according to spec)
	AuxInfoTypeParameter  uint32
	SampleCount           uint32
	SampleInfo            []byte
	DefaultSampleInfoSize byte
}

SaizBox - Sample Auxiliary Information Sizes Box (saiz)

func (*SaizBox) Encode added in v0.16.0

func (b *SaizBox) Encode(w io.Writer) error

Encode - write box to w

func (*SaizBox) Info added in v0.16.0

func (b *SaizBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write SaizBox details. Get sampleInfo list with level >= 1

func (*SaizBox) Size added in v0.16.0

func (b *SaizBox) Size() uint64

Size - return calculated size

func (*SaizBox) Type added in v0.16.0

func (b *SaizBox) Type() string

Type - return box type

type Sample

type Sample struct {
	Flags                 uint32 // interpreted as SampleFlags
	Dur                   uint32 // Sample duration in mdhd timescale
	Size                  uint32 // Size of sample data
	CompositionTimeOffset int32  // Signed composition time offset
}

Sample - sample as used in trun box (mdhd timescale)

func NewSample

func NewSample(flags uint32, dur uint32, size uint32, compositionTimeOffset int32) Sample

NewSample - create Sample with trun data

func (*Sample) IsSync

func (s *Sample) IsSync() bool

IsSync - check sync by masking flags including dependsOn

type SampleFlags

type SampleFlags struct {
	IsLeading                 byte
	SampleDependsOn           byte
	SampleIsDependedOn        byte
	SampleHasRedundancy       byte
	SamplePaddingValue        byte
	SampleIsNonSync           bool
	SampleDegradationPriority uint16
}

SampleFlags according to 14496-12 Sec. 8.8.3.1

func DecodeSampleFlags

func DecodeSampleFlags(u uint32) SampleFlags

DecodeSampleFlags - decode a uint32 flags field

func (SampleFlags) Encode added in v0.16.0

func (sf SampleFlags) Encode() uint32

func (SampleFlags) String added in v0.16.0

func (sf SampleFlags) String() string

type SampleGroupEntry added in v0.16.0

type SampleGroupEntry interface {
	// GroupingType SampleGroupEntry (uint32 according to spec)
	Type() string // actually
	// Size of SampleGroup Entry
	Size() uint64
	// Encode SampleGroupEntry to SliceWriter
	Encode(sw *SliceWriter)
	// Info - description of content.
	Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)
}

SampleGroupEntry - like a box, but size and type are not in a header

func DecodeAlstSampleGroupEntry added in v0.16.0

func DecodeAlstSampleGroupEntry(name string, length uint32, sr *SliceReader) (SampleGroupEntry, error)

func DecodeRapSampleGroupEntry added in v0.16.0

func DecodeRapSampleGroupEntry(name string, length uint32, sr *SliceReader) (SampleGroupEntry, error)

func DecodeRollSampleGroupEntry added in v0.16.0

func DecodeRollSampleGroupEntry(name string, length uint32, sr *SliceReader) (SampleGroupEntry, error)

func DecodeSeigSampleGroupEntry added in v0.16.0

func DecodeSeigSampleGroupEntry(name string, length uint32, sr *SliceReader) (SampleGroupEntry, error)

DecodeSeigSampleGroupEntry - decode Commone Encryption Sample Group Entry

func DecodeUnknownSampleGroupEntry added in v0.16.0

func DecodeUnknownSampleGroupEntry(name string, length uint32, sr *SliceReader) (SampleGroupEntry, error)

type SampleGroupEntryDecoder added in v0.16.0

type SampleGroupEntryDecoder func(name string, length uint32, sr *SliceReader) (SampleGroupEntry, error)

SampleGroupEntryDecoder is function signature of the SampleGroupEntry Decode method

type SampleInterval added in v0.25.0

type SampleInterval struct {
	FirstDecodeTime uint64
	Samples         []Sample
	OffsetInMdat    uint32 // Offset relative start of mdat box
	Size            uint32 // total size of all samples in interval
	Data            []byte // If set, should be relevant mdat range
}

SampleInterval - an interval of samples including reference to or concatenated binary media data

type SbgpBox added in v0.16.0

type SbgpBox struct {
	Version                 byte
	Flags                   uint32
	GroupingType            string // uint32, but takes values such as seig
	GroupingTypeParameter   uint32
	SampleCounts            []uint32
	GroupDescriptionIndices []uint32
}

SbgpBox - Sample To Group Box, ISO/IEC 14496-12 6'th edition 2020 Section 8.9.2

func (*SbgpBox) Encode added in v0.16.0

func (b *SbgpBox) Encode(w io.Writer) error

Encode - write box to w

func (*SbgpBox) Info added in v0.16.0

func (b *SbgpBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*SbgpBox) Size added in v0.16.0

func (b *SbgpBox) Size() uint64

Size - return calculated size

func (*SbgpBox) Type added in v0.16.0

func (b *SbgpBox) Type() string

Type - return box type

type SchiBox added in v0.16.0

type SchiBox struct {
	Children []Box
}

SchiBox - Schema Information Box

func (*SchiBox) AddChild added in v0.16.0

func (b *SchiBox) AddChild(box Box)

AddChild - Add a child box

func (*SchiBox) Encode added in v0.16.0

func (b *SchiBox) Encode(w io.Writer) error

Encode - write minf container to w

func (*SchiBox) GetChildren added in v0.16.0

func (b *SchiBox) GetChildren() []Box

GetChildren - list of child boxes

func (*SchiBox) Info added in v0.16.0

func (b *SchiBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SchiBox) Size added in v0.16.0

func (b *SchiBox) Size() uint64

Size - calculated size of box

func (*SchiBox) Type added in v0.16.0

func (b *SchiBox) Type() string

Type - box type

type SchmBox added in v0.16.0

type SchmBox struct {
	Version       byte
	Flags         uint32
	SchemeType    string // 4CC represented as uint32
	SchemeVersion uint32
	SchemeUri     string // Absolute null-terminated URL
}

SchmBox - Scheme Type Box

func (*SchmBox) Encode added in v0.16.0

func (b *SchmBox) Encode(w io.Writer) error

Encode - write box to w

func (*SchmBox) Info added in v0.16.0

func (b *SchmBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*SchmBox) Size added in v0.16.0

func (b *SchmBox) Size() uint64

Size - return calculated size

func (*SchmBox) Type added in v0.16.0

func (b *SchmBox) Type() string

Type - return box type

type SdtpBox added in v0.16.0

type SdtpBox struct {
	Version byte
	Flags   uint32
	Entries []SdtpEntry
}

SdtpBox - Sample Dependency Box (sdtp - optional)

ISO/IEC 14496-12 Ed. 6 2020 Section 8.6.4 Contained in Sample Table Box (stbl)

Table to determine whether a sample depends or is depended on by other samples

func CreateSdtpBox added in v0.16.0

func CreateSdtpBox(entries []SdtpEntry) *SdtpBox

CreateSdtpBox - Create a new SdtpBox

func (*SdtpBox) Encode added in v0.16.0

func (b *SdtpBox) Encode(w io.Writer) error

Encode - write box to w

func (*SdtpBox) Info added in v0.16.0

func (b *SdtpBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SdtpBox) Size added in v0.16.0

func (b *SdtpBox) Size() uint64

Size - return calculated size

func (*SdtpBox) Type added in v0.16.0

func (b *SdtpBox) Type() string

Type - return box type

type SdtpEntry added in v0.16.0

type SdtpEntry uint8

SdtpEntry (uint8)

ISO/IEC 14496-12 Ed. 6 2020 Section 8.6.4.2

func NewSdtpEntry added in v0.16.0

func NewSdtpEntry(isLeading, sampleDependsOn, sampleDependedOn, hasRedundancy uint8) SdtpEntry

NewSdtpEntry - make new SdtpEntry from 2-bit parameters

func (SdtpEntry) IsLeading added in v0.16.0

func (entry SdtpEntry) IsLeading() uint8

IsLeading (bits 0-1) 0: Leading unknown 1: Has dependency before referenced I-picture (not decodable) 2: Not a leading sample 3: Has no dependency before referenced I-picture (decodable)

func (SdtpEntry) SampleDependsOn added in v0.16.0

func (entry SdtpEntry) SampleDependsOn() uint8

SampleDependsOn (bits 2-3) 0: Dependency is unknown 1: Depends on others (not an I-picture) 2: Does not depend on others (I-picture) 3: Reservced

func (SdtpEntry) SampleHasRedundancy added in v0.16.0

func (entry SdtpEntry) SampleHasRedundancy() uint8

SampleIsDependedOn (bits 6-7) 0: Redundant coding unknown 1: Redundant coding in this sample 2: No redundant coding in this sample 3: Reserved

func (SdtpEntry) SampleIsDependedOn added in v0.16.0

func (entry SdtpEntry) SampleIsDependedOn() uint8

SampleIsDependedOn (bits 4-5) 0: Dependency unknown 1: Other samples may depend on this (not disposable) 2: No other samples depend on this (disposable) 3: Reserved

type SeigSampleGroupEntry added in v0.16.0

type SeigSampleGroupEntry struct {
	CryptByteBlock  byte
	SkipByteBlock   byte
	IsProtected     byte
	PerSampleIVSize byte
	KID             UUID
	// ConstantIVSize byte given by len(ConstantIV)
	ConstantIV []byte
}

SeigSampleGroupEntry - CencSampleEncryptionInformationGroupEntry as defined in CEF ISO/IEC 23001-7 3rd edition 2016

func (*SeigSampleGroupEntry) Encode added in v0.16.0

func (s *SeigSampleGroupEntry) Encode(sw *SliceWriter)

func (*SeigSampleGroupEntry) Info added in v0.16.0

func (s *SeigSampleGroupEntry) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*SeigSampleGroupEntry) Size added in v0.16.0

func (s *SeigSampleGroupEntry) Size() uint64

func (*SeigSampleGroupEntry) Type added in v0.16.0

func (s *SeigSampleGroupEntry) Type() string

type SencBox

type SencBox struct {
	Version     byte
	Flags       uint32
	SampleCount uint32
	IVs         []InitializationVector // 8 or 16 bytes if present
	SubSamples  [][]SubSamplePattern
}

SencBox - Sample Encryption Box (senc) See ISO/IEC 23001-7 Section 7.2 Full Box + SampleCount

func CreateSencBox

func CreateSencBox() *SencBox

CreateSendBox - create an empty SencBox

func (*SencBox) AddSample

func (s *SencBox) AddSample(sample SencSample) error

AddSample - add a senc sample with possible IV and subsamples

func (*SencBox) Encode

func (s *SencBox) Encode(w io.Writer) error

Encode - box-specific encode

func (*SencBox) GetPerSampleIVSize

func (s *SencBox) GetPerSampleIVSize() int

func (*SencBox) Info added in v0.16.0

func (s *SencBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SencBox) Size

func (s *SencBox) Size() uint64

Size - box-specific type

func (*SencBox) Type

func (s *SencBox) Type() string

Type - box-specific type

type SencSample

type SencSample struct {
	IV         InitializationVector // 0,8,16 byte length
	SubSamples []SubSamplePattern
}

SencSample - sample in SencBox

type SgpdBox added in v0.16.0

type SgpdBox struct {
	Version                      byte
	Flags                        uint32
	GroupingType                 string // uint32, but takes values such as seig
	DefaultLength                uint32
	DefaultGroupDescriptionIndex uint32
	DescriptionLengths           []uint32
	SampleGroupEntries           []SampleGroupEntry
}

SgpdBox - Sample Group Description Box, ISO/IEC 14496-12 6'th edition 2020 Section 8.9.3 Version 0 is deprecated

func (*SgpdBox) Encode added in v0.16.0

func (b *SgpdBox) Encode(w io.Writer) error

Encode - write box to w

func (*SgpdBox) Info added in v0.16.0

func (b *SgpdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*SgpdBox) Size added in v0.16.0

func (b *SgpdBox) Size() uint64

Size - return calculated size

func (*SgpdBox) Type added in v0.16.0

func (b *SgpdBox) Type() string

Type - return box type

type SidxBox

type SidxBox struct {
	Version                  byte
	Flags                    uint32
	ReferenceID              uint32
	Timescale                uint32
	EarliestPresentationTime uint64
	FirstOffset              uint64
	SidxRefs                 []SidxRef
}

SidxBox - SegmentIndexBox

func CreateSidx

func CreateSidx(baseMediaDecodeTime uint64) *SidxBox

CreateSidx - Create a new TfdtBox with baseMediaDecodeTime

func (*SidxBox) Encode

func (b *SidxBox) Encode(w io.Writer) error

Encode - write box to w

func (*SidxBox) Info added in v0.16.0

func (b *SidxBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - more info for level 1

func (*SidxBox) Size

func (b *SidxBox) Size() uint64

Size - return calculated size

func (*SidxBox) Type

func (b *SidxBox) Type() string

Type - return box type

type SidxRef

type SidxRef struct {
	ReferencedSize     uint32
	SubSegmentDuration uint32
	SAPDeltaTime       uint32
	ReferenceType      uint8 // 1-bit
	StartsWithSAP      uint8 // 1-bit
	SAPType            uint8
}

SidxRef - reference as used inside SidxBox

type SinfBox added in v0.16.0

type SinfBox struct {
	Frma     *FrmaBox // Mandatory
	Schm     *SchmBox // Optional
	Schi     *SchiBox // Optional
	Children []Box
}

SchiBox - Protection Scheme Information Box

func (*SinfBox) AddChild added in v0.16.0

func (b *SinfBox) AddChild(box Box)

AddChild - Add a child box

func (*SinfBox) Encode added in v0.16.0

func (b *SinfBox) Encode(w io.Writer) error

Encode - write minf container to w

func (*SinfBox) GetChildren added in v0.16.0

func (b *SinfBox) GetChildren() []Box

GetChildren - list of child boxes

func (*SinfBox) Info added in v0.16.0

func (b *SinfBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SinfBox) Size added in v0.16.0

func (b *SinfBox) Size() uint64

Size - calculated size of box

func (*SinfBox) Type added in v0.16.0

func (b *SinfBox) Type() string

Type - box type

type SliceReader

type SliceReader struct {
	// contains filtered or unexported fields
}

SliceReader - read integers from a slice

func NewSliceReader

func NewSliceReader(data []byte) *SliceReader

NewSliceReader - create a new slice reader reading from data

func (*SliceReader) GetPos

func (s *SliceReader) GetPos() int

GetPos - get read position is slice

func (*SliceReader) Length

func (s *SliceReader) Length() int

Length - get length of slice

func (*SliceReader) NrRemainingBytes

func (s *SliceReader) NrRemainingBytes() int

NrRemaingingByts - return number of bytes remaining

func (*SliceReader) ReadBytes

func (s *SliceReader) ReadBytes(n int) []byte

ReadBytes - read a slice of bytes

func (*SliceReader) ReadFixedLengthString

func (s *SliceReader) ReadFixedLengthString(length int) string

ReadFixedLengthString - read string of specified length

func (*SliceReader) ReadInt16

func (s *SliceReader) ReadInt16() int16

ReadInt16 - read int16 from slice

func (*SliceReader) ReadInt32

func (s *SliceReader) ReadInt32() int32

ReadInt32 - read int32 from slice

func (*SliceReader) ReadInt64

func (s *SliceReader) ReadInt64() int64

ReadInt64 - read int64 from slice

func (*SliceReader) ReadUint16

func (s *SliceReader) ReadUint16() uint16

ReadUint16 - read uint16 from slice

func (*SliceReader) ReadUint24 added in v0.19.0

func (s *SliceReader) ReadUint24() uint32

ReadUint24 - read uint24 from slice

func (*SliceReader) ReadUint32

func (s *SliceReader) ReadUint32() uint32

ReadUint32 - read uint32 from slice

func (*SliceReader) ReadUint64

func (s *SliceReader) ReadUint64() uint64

ReadUint64 - read uint64 from slice

func (*SliceReader) ReadUint8

func (s *SliceReader) ReadUint8() byte

ReadUint8 - read uint8 from slice

func (*SliceReader) ReadZeroTerminatedString

func (s *SliceReader) ReadZeroTerminatedString() (string, error)

ReadZeroTerminatedString - read string until zero

func (*SliceReader) RemainingBytes

func (s *SliceReader) RemainingBytes() []byte

RemainingBytes - return remaining bytes of this slice

func (*SliceReader) SetPos

func (s *SliceReader) SetPos(pos int)

SetPos - set read position is slice

func (*SliceReader) SkipBytes

func (s *SliceReader) SkipBytes(n int)

SkipBytes - skip passed n bytes

type SliceWriter

type SliceWriter struct {
	// contains filtered or unexported fields
}

SliceWriter - write numbers to a []byte slice

func NewSliceWriter

func NewSliceWriter(data []byte) *SliceWriter

NewSliceWriter - create writer around slice

func (*SliceWriter) WriteBytes

func (b *SliceWriter) WriteBytes(byteSlice []byte)

WriteBytes - write []byte

func (*SliceWriter) WriteInt16

func (b *SliceWriter) WriteInt16(n int16)

WriteInt16 - write int16 to slice

func (*SliceWriter) WriteInt32

func (b *SliceWriter) WriteInt32(n int32)

WriteInt32 - write int32 to slice

func (*SliceWriter) WriteInt64

func (b *SliceWriter) WriteInt64(n int64)

WriteInt64 - write int64 to slice

func (*SliceWriter) WriteString

func (b *SliceWriter) WriteString(s string, addZeroEnd bool)

WriteString - write string to slice with or without zero end

func (*SliceWriter) WriteUint16

func (b *SliceWriter) WriteUint16(n uint16)

WriteUint16 - write uint16 to slice

func (*SliceWriter) WriteUint24 added in v0.19.0

func (b *SliceWriter) WriteUint24(n uint32)

WriteUint24 - write uint24 to slice

func (*SliceWriter) WriteUint32

func (b *SliceWriter) WriteUint32(n uint32)

WriteUint32 - write uint32 to slice

func (*SliceWriter) WriteUint64

func (b *SliceWriter) WriteUint64(n uint64)

WriteUint64 - write uint64 to slice

func (*SliceWriter) WriteUint8

func (b *SliceWriter) WriteUint8(n byte)

WriteUint8 - write byte to slice

func (*SliceWriter) WriteUnityMatrix

func (b *SliceWriter) WriteUnityMatrix()

WriteUnityMatrix - write a unity matrix for mvhd or tkhd

func (*SliceWriter) WriteZeroBytes

func (b *SliceWriter) WriteZeroBytes(n int)

WriteZeroBytes - write n byte of zeroes

type SmhdBox

type SmhdBox struct {
	Version byte
	Flags   uint32
	Balance uint16 // should be int16
}

SmhdBox - Sound Media Header Box (smhd - mandatory for sound tracks)

Contained in : Media Information Box (minf)

func CreateSmhd

func CreateSmhd() *SmhdBox

CreateSmhd - Create Sound Media Header Box (all is zero)

func (*SmhdBox) Encode

func (b *SmhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*SmhdBox) Info added in v0.16.0

func (b *SmhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SmhdBox) Size

func (b *SmhdBox) Size() uint64

Size - calculated size of box

func (*SmhdBox) Type

func (b *SmhdBox) Type() string

Type - box type

type StblBox

type StblBox struct {
	// Same order as in Table 1 in ISO/IEC 14496-12 Ed.6 2020
	Stsd  *StsdBox
	Stts  *SttsBox
	Ctts  *CttsBox
	Stsc  *StscBox
	Stsz  *StszBox
	Stss  *StssBox
	Stco  *StcoBox
	Co64  *Co64Box
	Sdtp  *SdtpBox
	Sbgp  *SbgpBox   // The first
	Sbgps []*SbgpBox // All
	Sgpd  *SgpdBox   // The first
	Sgpds []*SgpdBox // All
	Subs  *SubsBox
	Saiz  *SaizBox
	Saio  *SaioBox

	Children []Box
}

StblBox - Sample Table Box (stbl - mandatory)

Contained in : Media Information Box (minf)

The table contains all information relevant to data samples (times, chunks, sizes, ...)

func NewStblBox

func NewStblBox() *StblBox

NewStblBox - Generate a new empty stbl box

func (*StblBox) AddChild

func (s *StblBox) AddChild(box Box)

AddChild - Add a child box

func (*StblBox) Encode

func (s *StblBox) Encode(w io.Writer) error

Encode - write stbl container to w

func (*StblBox) GetChildren

func (s *StblBox) GetChildren() []Box

GetChildren - list of child boxes

func (*StblBox) Info added in v0.16.0

func (s *StblBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StblBox) Size

func (s *StblBox) Size() uint64

Size - box-specific size

func (*StblBox) Type

func (s *StblBox) Type() string

Type - box-specific type

type StcoBox

type StcoBox struct {
	Version     byte
	Flags       uint32
	ChunkOffset []uint32
}

StcoBox - Chunk Offset Box (stco - mandatory)

Contained in : Sample Table box (stbl)

The table contains the offsets (starting at the beginning of the file) for each chunk of data for the current track. A chunk contains samples, the table defining the allocation of samples to each chunk is stsc.

func (*StcoBox) Encode

func (b *StcoBox) Encode(w io.Writer) error

Encode - box-specific encode

func (*StcoBox) GetOffset added in v0.24.0

func (b *StcoBox) GetOffset(chunkNr int) (uint64, error)

GetOffset - get offset for 1-based chunkNr.

func (*StcoBox) Info added in v0.16.0

func (b *StcoBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StcoBox) Size

func (b *StcoBox) Size() uint64

Size - box-specific size

func (*StcoBox) Type

func (b *StcoBox) Type() string

Type - box-specific type

type SthdBox

type SthdBox struct {
	Version byte
	Flags   uint32
}

SthdBox - Subtitle Media Header Box (sthd - for subtitle tracks)

func (*SthdBox) Encode

func (b *SthdBox) Encode(w io.Writer) error

Encode - write box to w

func (*SthdBox) Info added in v0.16.0

func (b *SthdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SthdBox) Size

func (b *SthdBox) Size() uint64

Size - calculated size of box

func (*SthdBox) Type

func (b *SthdBox) Type() string

Type - box-specific type

type StppBox

type StppBox struct {
	Namespace          string   // Mandatory
	SchemaLocation     string   // Optional
	AuxiliaryMimeTypes string   // Required if auxiliary types present
	Btrt               *BtrtBox // Optional
	Children           []Box
	DataReferenceIndex uint16
}

StppBox - XMLSubtitleSampleEntryr Box (stpp)

Contained in : Media Information Box (minf)

func NewStppBox

func NewStppBox(namespace, schemaLocation, auxiliaryMimeTypes string) *StppBox

NewStppBox - Create new stpp box namespace, schemaLocation and auxiliaryMimeType are space-separated utf8-lists without zero-termination schemaLocation and auxiliaryMimeTypes are optional

func (*StppBox) AddChild

func (w *StppBox) AddChild(box Box)

AddChild - add a child box (avcC normally, but clap and pasp could be part of visual entry)

func (*StppBox) Encode

func (s *StppBox) Encode(w io.Writer) error

Encode - write box to w

func (*StppBox) Info added in v0.16.0

func (s *StppBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StppBox) Size

func (s *StppBox) Size() uint64

Size - return calculated size

func (*StppBox) Type

func (s *StppBox) Type() string

Type - return box type

type StscBox

type StscBox struct {
	Version byte
	Flags   uint32

	FirstChunk          []uint32
	SamplesPerChunk     []uint32
	SampleDescriptionID []uint32
	// contains filtered or unexported fields
}

StscBox - Sample To Chunk Box (stsc - mandatory)

A chunk contains samples. This table defines to which chunk a sample is associated. Each entry is defined by :

  • first chunk : all chunks starting at this index up to the next first chunk have the same sample count/description
  • samples per chunk : number of samples in the chunk
  • sample description id : description (see the sample description box - stsd) this value is most often the same for all samples, so it is stored as a single value if possible

func (*StscBox) ChunkNrFromSampleNr

func (b *StscBox) ChunkNrFromSampleNr(sampleNr int) (chunkNr, firstSampleInChunk int, err error)

ChunkNrFromSampleNr - get chunk number from sampleNr (one-based)

func (*StscBox) Encode

func (b *StscBox) Encode(w io.Writer) error

Encode - box-specific encode

func (*StscBox) GetChunk added in v0.24.0

func (b *StscBox) GetChunk(chunkNr uint32) Chunk

func (*StscBox) GetContainingChunks added in v0.24.0

func (b *StscBox) GetContainingChunks(startSampleNr, endSampleNr uint32) ([]Chunk, error)

GetContainingChunks - get chunks containing the sample interval

func (*StscBox) GetSampleDescriptionID added in v0.25.0

func (b *StscBox) GetSampleDescriptionID(sampleNr int) uint32

GetSampleDescription - get the sample description ID from common or individual values

func (*StscBox) Info added in v0.16.0

func (b *StscBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StscBox) SetSingleSampleDescriptionID added in v0.25.0

func (b *StscBox) SetSingleSampleDescriptionID(sampleDescriptionID uint32)

SetSingleSampleDescriptionID - use this for efficiency if all samples have same sample description

func (*StscBox) Size

func (b *StscBox) Size() uint64

Size - box-specfic size

func (*StscBox) Type

func (b *StscBox) Type() string

Type box-specific type

type StsdBox

type StsdBox struct {
	Version     byte
	Flags       uint32
	SampleCount uint32
	AvcX        *VisualSampleEntryBox
	HvcX        *VisualSampleEntryBox
	Mp4a        *AudioSampleEntryBox
	Wvtt        *WvttBox
	Children    []Box
}

StsdBox - Sample Description Box (stsd - manatory) See ISO/IEC 14496-12 Section 8.5.2.2 Full Box + SampleCount All Children are sampleEntries

func NewStsdBox

func NewStsdBox() *StsdBox

NewStsdBox - Generate a new empty stsd box

func (*StsdBox) AddChild

func (s *StsdBox) AddChild(box Box)

AddChild - Add a child box and update SampleCount

func (*StsdBox) Encode

func (s *StsdBox) Encode(w io.Writer) error

Encode - box-specific encode of stsd - not a usual container

func (*StsdBox) GetSampleDescription

func (s *StsdBox) GetSampleDescription(index int) (Box, error)

GetSampleDescription - get one of multiple descriptions

func (*StsdBox) Info added in v0.16.0

func (s *StsdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StsdBox) ReplaceChild

func (s *StsdBox) ReplaceChild(box Box)

AddChild - Replace a child box with one of the same type

func (*StsdBox) Size

func (s *StsdBox) Size() uint64

Size - box-specific type

func (*StsdBox) Type

func (s *StsdBox) Type() string

Type - box-specific type

type StssBox

type StssBox struct {
	Version      byte
	Flags        uint32
	SampleNumber []uint32
}

StssBox - Sync Sample Box (stss - optional)

Contained in : Sample Table box (stbl)

This lists all sync samples (key frames for video tracks) in the data. If absent, all samples are sync samples.

func (*StssBox) Encode

func (b *StssBox) Encode(w io.Writer) error

Encode - box-specific encode

func (*StssBox) EntryCount added in v0.24.0

func (b *StssBox) EntryCount() uint32

EntryCount - number of sync samples

func (*StssBox) Info added in v0.16.0

func (b *StssBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StssBox) IsSyncSample

func (b *StssBox) IsSyncSample(sampleNr uint32) (isSync bool)

IsSyncSample - check if sample (one-based) sampleNr is a sync sample

func (*StssBox) Size

func (b *StssBox) Size() uint64

Size - box-specfic size

func (*StssBox) Type

func (b *StssBox) Type() string

Type - box-specfic type

type StszBox

type StszBox struct {
	Version           byte
	Flags             uint32
	SampleUniformSize uint32
	SampleNumber      uint32
	SampleSize        []uint32
}

StszBox - Sample Size Box (stsz - mandatory)

Contained in : Sample Table box (stbl)

For each track, either stsz of the more compact stz2 must be present. stz2 variant is not supported.

This table lists the size of each sample. If all samples have the same size, it can be defined in the SampleUniformSize attribute.

func (*StszBox) Encode

func (b *StszBox) Encode(w io.Writer) error

Encode - write box to w

func (*StszBox) GetNrSamples added in v0.24.0

func (b *StszBox) GetNrSamples() uint32

GetNrSamples - get number of sampples

func (*StszBox) GetSampleSize

func (b *StszBox) GetSampleSize(i int) uint32

GetSampleSize returns the size (in bytes) of a sample

func (*StszBox) GetTotalSampleSize added in v0.24.0

func (b *StszBox) GetTotalSampleSize(startNr, endNr uint32) (uint64, error)

GetTotalSize - get total size of a range [startNr, endNr] of samples

func (*StszBox) Info added in v0.16.0

func (b *StszBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StszBox) Size

func (b *StszBox) Size() uint64

Size - box-specific size

func (*StszBox) Type

func (b *StszBox) Type() string

Type - box-specific type

type SttgBox

type SttgBox struct {
	Settings string
}

SttgBox - CueSettingsBox (sttg)

func (*SttgBox) Encode

func (s *SttgBox) Encode(w io.Writer) error

Encode - write box to w

func (*SttgBox) Info added in v0.16.0

func (s *SttgBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SttgBox) Size

func (s *SttgBox) Size() uint64

Size - calculated size of box

func (*SttgBox) Type

func (s *SttgBox) Type() string

Type - box-specific type

type SttsBox

type SttsBox struct {
	Version         byte
	Flags           uint32
	SampleCount     []uint32
	SampleTimeDelta []uint32
}

SttsBox - Decoding Time to Sample Box (stts - mandatory)

This table contains the duration in time units for each sample.

  • SampleCount : the number of consecutive samples having the same duration
  • SampleTimeDelta : duration in time units

func (*SttsBox) Encode

func (b *SttsBox) Encode(w io.Writer) error

Encode - write box to w

func (*SttsBox) GetDecodeTime

func (b *SttsBox) GetDecodeTime(sampleNr uint32) (decTime uint64, dur uint32)

GetDecodeTime - decode time and duration for (one-based) sampleNr in track timescale

func (*SttsBox) GetDur added in v0.24.0

func (b *SttsBox) GetDur(sampleNr uint32) (dur uint32)

GetDur - get dur for a specific sample

func (*SttsBox) GetSampleNrAtTime added in v0.24.0

func (b *SttsBox) GetSampleNrAtTime(sampleStartTime uint64) (sampleNr uint32, err error)

GetSampleNrAtTime - get sample number at or as soon as possible after time Time is calculated by summing up durations of previous samples

func (*SttsBox) GetTimeCode

func (b *SttsBox) GetTimeCode(sample, timescale uint32) time.Duration

GetTimeCode - return the timecode (duration since the beginning of the media) of the beginning of a sample

func (*SttsBox) Info added in v0.16.0

func (b *SttsBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*SttsBox) Size

func (b *SttsBox) Size() uint64

Size - return calculated size

func (*SttsBox) Type

func (b *SttsBox) Type() string

Type - return box type

type StypBox

type StypBox struct {
	MajorBrand       string
	MinorVersion     uint32
	CompatibleBrands []string
}

StypBox Segment Type Box (styp)

func CreateStyp added in v0.16.0

func CreateStyp() *StypBox

CreateStyp - Create an Styp box suitable for DASH/CMAF

func (*StypBox) Encode

func (b *StypBox) Encode(w io.Writer) error

Encode - write box to w

func (*StypBox) Info added in v0.16.0

func (b *StypBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*StypBox) Size

func (b *StypBox) Size() uint64

Size - return calculated size

func (*StypBox) Type

func (b *StypBox) Type() string

Type - return box type

type SubSamplePattern

type SubSamplePattern struct {
	BytesOfClearData     uint16
	BytesOfProtectedData uint32
}

SubSamplePattern - pattern of subsample encryption

type SubsBox

type SubsBox struct {
	Version byte
	Flags   uint32
	Entries []SubsEntry
}

SubsBox - SubSampleInformationBox

func (*SubsBox) Encode

func (b *SubsBox) Encode(w io.Writer) error

Encode - write box to w

func (*SubsBox) Info added in v0.16.0

func (b *SubsBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - specificBoxLevels dump:1 gives details

func (*SubsBox) Size

func (b *SubsBox) Size() uint64

Size - return calculated size

func (*SubsBox) Type

func (b *SubsBox) Type() string

Type - return box type

type SubsEntry

type SubsEntry struct {
	SampleDelta uint32
	SubSamples  []SubsSample
}

SubsEntry - entry in SubsBox

type SubsSample

type SubsSample struct {
	SubsampleSize           uint32
	CodecSpecificParameters uint32
	SubsamplePriority       uint8
	Discardable             uint8
}

SubsSample - sample in SubsEntry

type TencBox added in v0.16.0

type TencBox struct {
	Version                byte
	Flags                  uint32
	DefaultCryptByteBlock  byte
	DefaultSkipByteBlock   byte
	DefaultIsProtected     byte
	DefaultPerSampleIVSize byte
	DefaultKID             UUID
	// BDefaultConstantIVSize  byte given by len(DefaultContantIV)
	DefaultConstantIV []byte
}

TencBox - Track Encryption Box Defined in ISO/IEC 23001-7 Secion 8.2

func (*TencBox) Encode added in v0.16.0

func (b *TencBox) Encode(w io.Writer) error

Encode - write box to w

func (*TencBox) Info added in v0.16.0

func (b *TencBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*TencBox) Size added in v0.16.0

func (b *TencBox) Size() uint64

Size - return calculated size

func (*TencBox) Type added in v0.16.0

func (b *TencBox) Type() string

Type - return box type

type TfdtBox

type TfdtBox struct {
	Version             byte
	Flags               uint32
	BaseMediaDecodeTime uint64
}

TfdtBox - Track Fragment Decode Time (tfdt)

Contained in : Track Fragment box (traf)

func CreateTfdt

func CreateTfdt(baseMediaDecodeTime uint64) *TfdtBox

CreateTfdt - Create a new TfdtBox with baseMediaDecodeTime

func (*TfdtBox) Encode

func (t *TfdtBox) Encode(w io.Writer) error

Encode - write box to w

func (*TfdtBox) Info added in v0.16.0

func (t *TfdtBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

func (*TfdtBox) SetBaseMediaDecodeTime

func (t *TfdtBox) SetBaseMediaDecodeTime(bTime uint64)

SetBaseMediaDecodeTime - Set time of TfdtBox

func (*TfdtBox) Size

func (t *TfdtBox) Size() uint64

Size - return calculated size

func (*TfdtBox) Type

func (t *TfdtBox) Type() string

Type - return box type

type TfhdBox

type TfhdBox struct {
	Version                byte
	Flags                  uint32
	TrackID                uint32
	BaseDataOffset         uint64
	SampleDescriptionIndex uint32
	DefaultSampleDuration  uint32
	DefaultSampleSize      uint32
	DefaultSampleFlags     uint32
}

TfhdBox - Track Fragment Header Box (tfhd)

Contained in : Track Fragment box (traf))

func CreateTfhd

func CreateTfhd(trackID uint32) *TfhdBox

CreateTfhd - Create a new TfdtBox with baseMediaDecodeTime

func (*TfhdBox) DefaultBaseIfMoof

func (t *TfhdBox) DefaultBaseIfMoof() bool

DefaultBaseIfMoof - interpreted flags value

func (*TfhdBox) DurationIsEmpty

func (t *TfhdBox) DurationIsEmpty() bool

DurationIsEmpty - interpreted flags value

func (*TfhdBox) Encode

func (t *TfhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*TfhdBox) HasBaseDataOffset

func (t *TfhdBox) HasBaseDataOffset() bool

HasBaseDataOffset - interpreted flags value

func (*TfhdBox) HasDefaultSampleDuration

func (t *TfhdBox) HasDefaultSampleDuration() bool

HasDefaultSampleDuration - interpreted flags value

func (*TfhdBox) HasDefaultSampleFlags

func (t *TfhdBox) HasDefaultSampleFlags() bool

HasDefaultSampleFlags - interpreted flags value

func (*TfhdBox) HasDefaultSampleSize

func (t *TfhdBox) HasDefaultSampleSize() bool

HasDefaultSampleSize - interpreted flags value

func (*TfhdBox) HasSampleDescriptionIndex

func (t *TfhdBox) HasSampleDescriptionIndex() bool

HasSampleDescriptionIndex - interpreted flags value

func (*TfhdBox) Info added in v0.16.0

func (t *TfhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TfhdBox) Size

func (t *TfhdBox) Size() uint64

Size - returns calculated size

func (*TfhdBox) Type

func (t *TfhdBox) Type() string

Type - returns box type

type TfraBox added in v0.19.0

type TfraBox struct {
	Version               byte
	Flags                 uint32
	TrackID               uint32
	LengthSizeOfTrafNum   byte
	LengthSizeOfTrunNum   byte
	LengthSizeOfSampleNum byte
	Entries               []TrafEntry
}

TfraBox - Track Fragment Random Access Box (tfra) Contained it MfraBox (mfra)

func (*TfraBox) Encode added in v0.19.0

func (b *TfraBox) Encode(w io.Writer) error

Encode - write box to w

func (*TfraBox) Info added in v0.19.0

func (b *TfraBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - more info for level 1

func (*TfraBox) Size added in v0.19.0

func (b *TfraBox) Size() uint64

Size - return calculated size

func (*TfraBox) Type added in v0.19.0

func (b *TfraBox) Type() string

Type - return box type

type TfrfData

type TfrfData struct {
	Version                   byte
	Flags                     uint32
	FragmentCount             byte
	FragmentAbsoluteTimes     []uint64
	FragmentAbsoluteDurations []uint64
}

TfrfData - MSS TfrfBox data after UUID part Defined in MSS-SSTR v20180912 section 2.2.4.5

type TfxdData

type TfxdData struct {
	Version                  byte
	Flags                    uint32
	FragmentAbsoluteTime     uint64
	FragmentAbsoluteDuration uint64
}

TfxdData - MSS TfxdBox data after UUID part Defined in MSS-SSTR v20180912 section 2.2.4.4

type TkhdBox

type TkhdBox struct {
	Version          byte
	Flags            uint32
	CreationTime     uint64
	ModificationTime uint64
	TrackID          uint32
	Duration         uint64
	Layer            int16
	AlternateGroup   int16 // should be int16
	Volume           Fixed16
	Width, Height    Fixed32
}

TkhdBox - Track Header Box (tkhd - mandatory)

This box describes the track. Duration is measured in time units (according to the time scale defined in the movie header box). Duration is 0 for fragmented files.

Volume (relevant for audio tracks) is a fixed point number (8 bits + 8 bits). Full volume is 1.0. Width and Height (relevant for video tracks) are fixed point numbers (16 bits + 16 bits). Video pixels are not necessarily square.

func CreateTkhd

func CreateTkhd() *TkhdBox

CreateTkhd - create tkhd box with common settings

func (*TkhdBox) Encode

func (b *TkhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*TkhdBox) Info added in v0.16.0

func (b *TkhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TkhdBox) Size

func (b *TkhdBox) Size() uint64

Size - calculated size of box

func (*TkhdBox) Type

func (b *TkhdBox) Type() string

Type - box type

type TrafBox

type TrafBox struct {
	Tfhd     *TfhdBox
	Tfdt     *TfdtBox
	Trun     *TrunBox // The first TrunBox
	Truns    []*TrunBox
	Children []Box
}

TrafBox - Track Fragment Box (traf)

Contained in : Movie Fragment Box (moof)

func (*TrafBox) AddChild

func (t *TrafBox) AddChild(b Box) error

AddChild - add child box

func (*TrafBox) Encode

func (t *TrafBox) Encode(w io.Writer) error

Encode - write box to w

func (*TrafBox) GetChildren

func (t *TrafBox) GetChildren() []Box

GetChildren - list of child boxes

func (*TrafBox) Info added in v0.16.0

func (t *TrafBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TrafBox) OptimizeTfhdTrun

func (t *TrafBox) OptimizeTfhdTrun() error

OptimizeTfhdTrun - optimize trun by default values in tfhd box Only look at first trun, even if there is more than one Don't optimize again, if already done so that no data is present

func (*TrafBox) Size

func (t *TrafBox) Size() uint64

Size - return calculated size

func (*TrafBox) Type

func (t *TrafBox) Type() string

Type - return box type

type TrafEntry added in v0.19.0

type TrafEntry struct {
	Time        int64
	MoofOffset  int64
	TrafNumber  uint32
	TrunNumber  uint32
	SampleDelta uint32
}

Tfrabox - reference as used inside SidxBox

type TrakBox

type TrakBox struct {
	Tkhd     *TkhdBox
	Mdia     *MdiaBox
	Edts     *EdtsBox
	Children []Box
}

TrakBox - Track Box (tkhd - mandatory)

Contained in : Movie Box (moov)

A media file can contain one or more tracks.

func CreateEmptyTrak added in v0.17.0

func CreateEmptyTrak(trackID, timeScale uint32, mediaType, language string) *TrakBox

Create a full Trak tree for an empty (fragmented) track with no samples or stsd content

func NewTrakBox

func NewTrakBox() *TrakBox

NewTrakBox - Make a new empty TrakBox

func (*TrakBox) AddChild

func (t *TrakBox) AddChild(box Box)

AddChild - Add a child box

func (*TrakBox) Encode

func (t *TrakBox) Encode(w io.Writer) error

Encode - write trak container to w

func (*TrakBox) GetChildren

func (t *TrakBox) GetChildren() []Box

GetChildren - list of child boxes

func (*TrakBox) GetNrSamples added in v0.24.0

func (t *TrakBox) GetNrSamples() uint32

GetNrSamples - get number of samples for this track defined in the parent moov box.

func (*TrakBox) GetRangesForSampleInterval added in v0.24.0

func (t *TrakBox) GetRangesForSampleInterval(startSampleNr, endSampleNr uint32) ([]DataRange, error)

GetRangesForSampleInterval - get ranges inside file for sample range [startSampleNr, endSampleNr]

func (*TrakBox) GetSampleData added in v0.24.0

func (t *TrakBox) GetSampleData(startSampleNr, endSampleNr uint32) ([]Sample, error)

GetSampleData - get sample metadata for a specific interval of samples defined in moov. If going outside the range of available samples, an error is returned.

func (*TrakBox) Info added in v0.16.0

func (t *TrakBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TrakBox) SetAACDescriptor

func (t *TrakBox) SetAACDescriptor(objType byte, samplingFrequency int) error

SetAACDescriptor - Modify a TrakBox by adding AAC SampleDescriptor objType is one of AAClc, HEAACv1, HEAACv2 For HEAAC, the samplingFrequency is the base frequency (normally 24000)

func (*TrakBox) SetAVCDescriptor

func (t *TrakBox) SetAVCDescriptor(sampleDescriptorType string, spsNALUs, ppsNALUs [][]byte) error

SetAVCDescriptor - Set AVC SampleDescriptor based on SPS and PPS

func (*TrakBox) SetHEVCDescriptor added in v0.18.0

func (t *TrakBox) SetHEVCDescriptor(sampleDescriptorType string, vpsNALUs, spsNALUs, ppsNALUs [][]byte) error

SetHEVCDescriptor - Set HEVC SampleDescriptor based on VPS, SPS, and PPS

func (*TrakBox) SetStppDescriptor added in v0.25.0

func (t *TrakBox) SetStppDescriptor(namespace, schemaLocation, auxiliaryMimeTypes string) error

SetStppDescriptor - add stpp box with utf8-lists namespace, schemaLocation and auxiliaryMimeType The utf8-lists have space-separated items, but no zero-termination

func (*TrakBox) SetWvttDescriptor added in v0.25.0

func (t *TrakBox) SetWvttDescriptor(config string) error

SetWvttDescriptor - Set wvtt descriptor with a vttC box. config should start with WEBVTT or be empty.

func (*TrakBox) Size

func (t *TrakBox) Size() uint64

Size - calculated size of box

func (*TrakBox) Type

func (t *TrakBox) Type() string

Type - box type

type TrefBox added in v0.25.0

type TrefBox struct {
	Children []Box
}

TrefBox - // TrackReferenceBox - ISO/IEC 14496-12 Ed. 9 Sec. 8.3

func (*TrefBox) AddChild added in v0.25.0

func (b *TrefBox) AddChild(box Box)

AddChild - Add a child box

func (*TrefBox) Encode added in v0.25.0

func (b *TrefBox) Encode(w io.Writer) error

Encode - write minf container to w

func (*TrefBox) GetChildren added in v0.25.0

func (b *TrefBox) GetChildren() []Box

GetChildren - list of child boxes

func (*TrefBox) Info added in v0.25.0

func (b *TrefBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TrefBox) Size added in v0.25.0

func (b *TrefBox) Size() uint64

Size - calculated size of box

func (*TrefBox) Type added in v0.25.0

func (b *TrefBox) Type() string

Type - box type

type TrefTypeBox added in v0.25.0

type TrefTypeBox struct {
	Name     string
	TrackIDs []uint32
}

TrefTypeBox - TrackReferenceTypeBox - ISO/IEC 14496-12 Ed. 9 Sec. 8.3 Name can be one of hint, cdsc, font, hind, vdep, vplx, subt (ISO/IEC 14496-12) dpnd, ipir, mpod, sync (ISO/IEC 14496-14)

func (*TrefTypeBox) Encode added in v0.25.0

func (b *TrefTypeBox) Encode(w io.Writer) error

Encode - write box to w

func (*TrefTypeBox) Info added in v0.25.0

func (b *TrefTypeBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TrefTypeBox) Size added in v0.25.0

func (b *TrefTypeBox) Size() uint64

Size - calculated size of box

func (*TrefTypeBox) Type added in v0.25.0

func (b *TrefTypeBox) Type() string

Type - box type

type TrepBox added in v0.19.0

type TrepBox struct {
	Version  byte
	Flags    uint32
	TrackID  uint32
	Children []Box
}

TrepBox - Track Extension Properties Box (trep) Contained in mvex

func (*TrepBox) AddChild added in v0.19.0

func (s *TrepBox) AddChild(child Box)

AddChild - Add a child box and update SampleCount

func (*TrepBox) Encode added in v0.19.0

func (b *TrepBox) Encode(w io.Writer) error

Encode - box-specific encode of stsd - not a usual container

func (*TrepBox) Info added in v0.19.0

func (b *TrepBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TrepBox) Size added in v0.19.0

func (b *TrepBox) Size() uint64

Size - box-specific type

func (*TrepBox) Type added in v0.19.0

func (s *TrepBox) Type() string

Type - box-specific type

type TrexBox

type TrexBox struct {
	Version                       byte
	Flags                         uint32
	TrackID                       uint32
	DefaultSampleDescriptionIndex uint32
	DefaultSampleDuration         uint32
	DefaultSampleSize             uint32
	DefaultSampleFlags            uint32
}

TrexBox - Track Extends Box

Contained in : Mvex Box (mvex)

func CreateTrex

func CreateTrex(trackID uint32) *TrexBox

CreateTrex - create trex box with trackID

func (*TrexBox) Encode

func (t *TrexBox) Encode(w io.Writer) error

Encode - write box to w

func (*TrexBox) Info added in v0.16.0

func (t *TrexBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*TrexBox) Size

func (t *TrexBox) Size() uint64

Size - return calculated size

func (*TrexBox) Type

func (t *TrexBox) Type() string

Type - return box type

type TrunBox

type TrunBox struct {
	Version byte

	DataOffset int32

	Samples []Sample
	// contains filtered or unexported fields
}

TrunBox - Track Fragment Run Box (trun)

Contained in : Track Fragmnet Box (traf)

func CreateTrun

func CreateTrun(writeOrderNr uint32) *TrunBox

CreateTrun - create a TrunBox for filling up with samples

func (*TrunBox) AddFullSample

func (t *TrunBox) AddFullSample(s *FullSample)

AddFullSample - add Sample part of FullSample

func (*TrunBox) AddSample

func (t *TrunBox) AddSample(s Sample)

AddSample - add a Sample

func (*TrunBox) AddSampleDefaultValues

func (t *TrunBox) AddSampleDefaultValues(tfhd *TfhdBox, trex *TrexBox) (totalDur uint64)

AddSampleDefaultValues - add values from tfhd and trex boxes if needed Return total duration

func (*TrunBox) AddSamples added in v0.25.0

func (t *TrunBox) AddSamples(s []Sample)

AddSamples - add a a slice of Sample

func (*TrunBox) Duration

func (t *TrunBox) Duration(defaultSampleDuration uint32) uint64

Duration - calculate total duration of all samples given defaultSampleDuration

func (*TrunBox) Encode

func (t *TrunBox) Encode(w io.Writer) error

Encode - write box to w

func (*TrunBox) FirstSampleFlags added in v0.25.0

func (t *TrunBox) FirstSampleFlags() (flags uint32, present bool)

FirstSampleFlags - return firstSampleFlags and indicator if present

func (*TrunBox) GetFullSamples

func (t *TrunBox) GetFullSamples(offsetInMdat uint32, baseDecodeTime uint64, mdat *MdatBox) []FullSample

GetFullSamples - get all sample data including accumulated time and binary media data offsetInMdat is offset in mdat data (data normally starts 8 or 16 bytes after start of mdat box) baseDecodeTime is decodeTime in tfdt in track timescale (timescale in mfhd) To fill missing individual values from tfhd and trex defaults, call trun.AddSampleDefaultValues() before this call

func (*TrunBox) GetSampleInterval added in v0.25.0

func (t *TrunBox) GetSampleInterval(startSampleNr, endSampleNr uint32, baseDecodeTime uint64, mdat *MdatBox, offsetInMdat uint32) (SampleInterval, error)

GetSampleInterval - get sample interval [startSampleNr, endSampleNr] (1-based and inclusive) This includes mdat data (if not lazy), in which case only offsetInMdat is given. baseDecodeTime is decodeTime in tfdt in track timescale (timescale from mfhd). To fill missing individual values from tfhd and trex defaults, call AddSampleDefaultValues() before this call.

func (*TrunBox) GetSampleNrForRelativeTime added in v0.25.0

func (t *TrunBox) GetSampleNrForRelativeTime(deltaTime uint64, defaultSampleDuration uint32) (uint32, error)

GetSampleNrForRelativeTime - get sample number for exact relative time (calculated from summing durations)

func (*TrunBox) GetSampleRange added in v0.25.0

func (t *TrunBox) GetSampleRange(startSampleNr, endSampleNr uint32) []Sample

GetSampleRange - get a one-based range of samples To fill missing individual values from tfhd and trex defaults, call AddSampleDefaultValues() before this call

func (*TrunBox) GetSamples

func (t *TrunBox) GetSamples() []Sample

GetSamples - get all trun sample data To fill missing individual values from tfhd and trex defaults, call AddSampleDefaultValues() before this call

func (*TrunBox) HasDataOffset

func (t *TrunBox) HasDataOffset() bool

HasDataOffset - interpreted dataOffsetPresent flag

func (*TrunBox) HasFirstSampleFlags

func (t *TrunBox) HasFirstSampleFlags() bool

HasFirstSampleFlags - interpreted firstSampleFlagsPresent flag

func (*TrunBox) HasSampleCompositionTimeOffset added in v0.25.0

func (t *TrunBox) HasSampleCompositionTimeOffset() bool

HasSampleCompositionTimeOffset - interpreted sampleCompositionTimeOffset flag

func (*TrunBox) HasSampleDuration

func (t *TrunBox) HasSampleDuration() bool

HasSampleDuration - interpreted sampleDurationPresent flag

func (*TrunBox) HasSampleFlags

func (t *TrunBox) HasSampleFlags() bool

HasSampleFlags - interpreted sampleFlagsPresent flag

func (*TrunBox) HasSampleSize

func (t *TrunBox) HasSampleSize() bool

HasSampleSize - interpreted sampleSizePresent flag

func (*TrunBox) Info added in v0.16.0

func (t *TrunBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

Info - specificBoxLevels trun:1 gives details

func (*TrunBox) RemoveFirstSampleFlags added in v0.25.0

func (t *TrunBox) RemoveFirstSampleFlags()

RemoveFirstSampleFlags - remove firstSampleFlags and its indicator

func (*TrunBox) SampleCount

func (t *TrunBox) SampleCount() uint32

SampleCount - return how many samples are defined

func (*TrunBox) SetFirstSampleFlags added in v0.25.0

func (t *TrunBox) SetFirstSampleFlags(flags uint32)

SetFirstSampleFlags - set firstSampleFlags and bit indicating its presence

func (*TrunBox) Size

func (t *TrunBox) Size() uint64

Size - return calculated size

func (*TrunBox) SizeOfData added in v0.17.0

func (t *TrunBox) SizeOfData() (totalSize uint64)

SizeOfData - size of mediasamples in bytes

func (*TrunBox) Type

func (t *TrunBox) Type() string

Type - return box type

type URLBox

type URLBox struct {
	Version  byte
	Flags    uint32
	Location string // Zero-terminated string
}

URLBox - DataEntryUrlBox ('url ')

Contained in : DrefBox (dref

func CreateURLBox

func CreateURLBox() *URLBox

CreateURLBox - Create a self-referencing URL box

func (*URLBox) Encode

func (u *URLBox) Encode(w io.Writer) error

Encode - write box to w

func (*URLBox) Info added in v0.16.0

func (u *URLBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*URLBox) Size

func (u *URLBox) Size() uint64

Size - return calculated size

func (*URLBox) Type

func (u *URLBox) Type() string

Type - return box type

type UUID added in v0.16.0

type UUID []byte

UUID - 16-byte KeyID or SystemID

func (UUID) String added in v0.16.0

func (u UUID) String() string

type UUIDBox

type UUIDBox struct {
	UUID    string // 16 bytes
	SubType string
	Tfxd    *TfxdData
	Tfrf    *TfrfData
}

UUIDBox - Used as container for MSS boxes tfxd and tfrf

func (*UUIDBox) Encode

func (u *UUIDBox) Encode(w io.Writer) error

Encode - write UUIDBox including tfxd or tfrf to w

func (*UUIDBox) Info added in v0.16.0

func (u *UUIDBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*UUIDBox) Size

func (u *UUIDBox) Size() uint64

Size - return calculated size including tfxd/tfrf

func (*UUIDBox) Type

func (u *UUIDBox) Type() string

Type - return box type

type UdtaBox added in v0.17.0

type UdtaBox struct {
	Children []Box
}

User Data Box - container for User Data

Contained in : moov, trak, moof, or traf

func (*UdtaBox) AddChild added in v0.17.0

func (b *UdtaBox) AddChild(box Box)

AddChild - Add a child box

func (*UdtaBox) Encode added in v0.17.0

func (b *UdtaBox) Encode(w io.Writer) error

Encode - write udta container to w

func (*UdtaBox) GetChildren added in v0.17.0

func (b *UdtaBox) GetChildren() []Box

GetChildren - list of child boxes

func (*UdtaBox) Info added in v0.17.0

func (b *UdtaBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*UdtaBox) Size added in v0.17.0

func (b *UdtaBox) Size() uint64

Size - calculated size of box

func (*UdtaBox) Type added in v0.17.0

func (b *UdtaBox) Type() string

Type - box type

type UnknownBox

type UnknownBox struct {
	// contains filtered or unexported fields
}

UnknownBox - box that we don't know how to parse

func (*UnknownBox) Encode

func (b *UnknownBox) Encode(w io.Writer) error

Encode - write box to w

func (*UnknownBox) Info added in v0.16.0

func (b *UnknownBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*UnknownBox) Size

func (b *UnknownBox) Size() uint64

Size - return calculated size

func (*UnknownBox) Type

func (b *UnknownBox) Type() string

Type - return box type

type UnknownSampleGroupEntry added in v0.16.0

type UnknownSampleGroupEntry struct {
	Name   string
	Length uint32
	Data   []byte
}

Unknown or not implemented SampleGroupEntry

func (*UnknownSampleGroupEntry) Encode added in v0.16.0

func (s *UnknownSampleGroupEntry) Encode(sw *SliceWriter)

func (*UnknownSampleGroupEntry) Info added in v0.16.0

func (s *UnknownSampleGroupEntry) Info(w io.Writer, specificBoxLevels, indent, indentStep string) (err error)

Info - write box info to w

func (*UnknownSampleGroupEntry) Size added in v0.16.0

func (s *UnknownSampleGroupEntry) Size() uint64

func (*UnknownSampleGroupEntry) Type added in v0.16.0

func (s *UnknownSampleGroupEntry) Type() string

type VisualSampleEntryBox

type VisualSampleEntryBox struct {
	DataReferenceIndex uint16
	Width              uint16
	Height             uint16
	Horizresolution    uint32
	Vertresolution     uint32
	FrameCount         uint16
	CompressorName     string
	AvcC               *AvcCBox
	HvcC               *HvcCBox
	Btrt               *BtrtBox
	Clap               *ClapBox
	Pasp               *PaspBox
	Children           []Box
	// contains filtered or unexported fields
}

VisualSampleEntryBox - Video Sample Description box (avc1/avc3)

func CreateVisualSampleEntryBox

func CreateVisualSampleEntryBox(name string, width, height uint16, sampleEntry Box) *VisualSampleEntryBox

CreateVisualSampleEntryBox - Create new VisualSampleEntry such as avc1, avc3, hev1, hvc1

func NewVisualSampleEntryBox

func NewVisualSampleEntryBox(name string) *VisualSampleEntryBox

NewVisualSampleEntryBox - Create new empty avc1 or avc3 box

func (*VisualSampleEntryBox) AddChild

func (b *VisualSampleEntryBox) AddChild(child Box)

AddChild - add a child box (avcC normally, but clap and pasp could be part of visual entry)

func (*VisualSampleEntryBox) Encode

func (b *VisualSampleEntryBox) Encode(w io.Writer) error

Encode - write box to w

func (*VisualSampleEntryBox) Info added in v0.16.0

func (b *VisualSampleEntryBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VisualSampleEntryBox) Size

func (b *VisualSampleEntryBox) Size() uint64

Size - return calculated size

func (*VisualSampleEntryBox) Type

func (b *VisualSampleEntryBox) Type() string

Type - return box type

type VlabBox

type VlabBox struct {
	SourceLabel string
}

VlabBox - WebVTTSourceLabelBox (vlab)

func (*VlabBox) Encode

func (v *VlabBox) Encode(w io.Writer) error

Encode - write box to w

func (*VlabBox) Info added in v0.16.0

func (v *VlabBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VlabBox) Size

func (v *VlabBox) Size() uint64

Size - calculated size of box

func (*VlabBox) Type

func (v *VlabBox) Type() string

Type - box-specific type

type VmhdBox

type VmhdBox struct {
	Version      byte
	Flags        uint32
	GraphicsMode uint16
	OpColor      [3]uint16
}

VmhdBox - Video Media Header Box (vhmd - mandatory for video tracks)

Contained in : Media Information Box (minf)

func CreateVmhd

func CreateVmhd() *VmhdBox

CreateVmhd - Create Video Media Header Box

func (*VmhdBox) Encode

func (b *VmhdBox) Encode(w io.Writer) error

Encode - write box to w

func (*VmhdBox) Info added in v0.16.0

func (b *VmhdBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VmhdBox) Size

func (b *VmhdBox) Size() uint64

Size - calculated size of box

func (*VmhdBox) Type

func (b *VmhdBox) Type() string

Type - box-specific type

type VsidBox

type VsidBox struct {
	SourceID uint32
}

VsidBox - CueSourceIDBox (vsid)

func (*VsidBox) Encode

func (v *VsidBox) Encode(w io.Writer) error

Encode - write box to w

func (*VsidBox) Info added in v0.16.0

func (v *VsidBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VsidBox) Size

func (v *VsidBox) Size() uint64

Size - calculated size of box

func (*VsidBox) Type

func (v *VsidBox) Type() string

Type - box-specific type

type VttCBox

type VttCBox struct {
	Config string
}

VttCBox - WebVTTConfigurationBox (vttC)

func (*VttCBox) Encode

func (v *VttCBox) Encode(w io.Writer) error

Encode - write box to w

func (*VttCBox) Info added in v0.16.0

func (v *VttCBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VttCBox) Size

func (v *VttCBox) Size() uint64

Size - calculated size of box

func (*VttCBox) Type

func (v *VttCBox) Type() string

Type - box-specific type

type VttaBox

type VttaBox struct {
	CueAdditionalText string
}

VttaBox - VTTAdditionalTextBox (vtta) (corresponds to NOTE in WebVTT)

func (*VttaBox) Encode

func (v *VttaBox) Encode(w io.Writer) error

Encode - write box to w

func (*VttaBox) Info added in v0.16.0

func (v *VttaBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VttaBox) Size

func (v *VttaBox) Size() uint64

Size - calculated size of box

func (*VttaBox) Type

func (v *VttaBox) Type() string

Type - box-specific type

type VttcBox

type VttcBox struct {
	Vsid     *VsidBox
	Iden     *IdenBox
	Ctim     *CtimBox
	Sttg     *SttgBox
	Payl     *PaylBox
	Children []Box
}

VttcBox - VTTCueBox (vttc)

func (*VttcBox) AddChild

func (v *VttcBox) AddChild(box Box)

AddChild - Add a child box

func (*VttcBox) Encode

func (v *VttcBox) Encode(w io.Writer) error

Encode - write mvex container to w

func (*VttcBox) GetChildren

func (v *VttcBox) GetChildren() []Box

GetChildren - list of child boxes

func (*VttcBox) Info added in v0.16.0

func (v *VttcBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VttcBox) Size

func (v *VttcBox) Size() uint64

Size - return calculated size

func (*VttcBox) Type

func (v *VttcBox) Type() string

Type - return box type

type VtteBox

type VtteBox struct {
}

VtteBox - VTTEmptyBox (vtte)

func (*VtteBox) Encode

func (v *VtteBox) Encode(w io.Writer) error

Encode - write box to w

func (*VtteBox) Info added in v0.16.0

func (v *VtteBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*VtteBox) Size

func (v *VtteBox) Size() uint64

Size - calculated size of box

func (*VtteBox) Type

func (v *VtteBox) Type() string

Type - box-specific type

type WvttBox

type WvttBox struct {
	VttC               *VttCBox
	Vlab               *VlabBox
	Btrt               *BtrtBox
	Children           []Box
	DataReferenceIndex uint16
}

WvttBox - WVTTSampleEntry (wvtt) Extends PlainTextSampleEntry which extends SampleEntry

func NewWvttBox

func NewWvttBox() *WvttBox

NewAudioSampleEntryBox - Create new empty mp4a box

func (*WvttBox) AddChild

func (w *WvttBox) AddChild(box Box)

AddChild - add a child box (avcC normally, but clap and pasp could be part of visual entry)

func (*WvttBox) Encode

func (a *WvttBox) Encode(w io.Writer) error

Encode - write box to w

func (*WvttBox) Info added in v0.16.0

func (a *WvttBox) Info(w io.Writer, specificBoxLevels, indent, indentStep string) error

func (*WvttBox) Size

func (a *WvttBox) Size() uint64

Size - return calculated size

func (*WvttBox) Type

func (a *WvttBox) Type() string

Type - return box type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL