package obu

Import Path
	github.com/pion/rtp/codecs/av1/obu (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 2 packages

Involved Source Files

	    errors.go
	  d leb128.go
		Package obu implements tools for working with the Open Bitstream Unit.

	    obu.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type ExtensionHeader (struct)
		ExtensionHeader represents an OBU extension header obu_extension_header().
		5.3.3 https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40

		Fields (total 3)
			Reserved3Bits uint8
			SpatialID uint8
			TemporalID uint8
		Methods (only one)
			(*ExtensionHeader) Marshal() byte
				Marshal serializes the OBU extension header to a byte slice.
				5.3.3 https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40
				
					obu_extension_header() { Type
						temporal_id                      f(3)
						spatial_id                       f(2)
						extension_header_reserved_3bits  f(3)
					}

		As Outputs Of (at least one exported)
			func ParseOBUExtensionHeader(headerData byte) ExtensionHeader

	 type Header (struct)
		Header represents the header of an OBU obu_header().
		5.3.2: https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40

		Fields (total 4)
			ExtensionHeader *ExtensionHeader
			HasSizeField bool
			Reserved1Bit bool
			Type Type
		Methods (total 2)
			(*Header) Marshal() []byte
				Marshal serializes the OBU header to a byte slice.
				If the OBU has an extension header, the extension header is serialized as well.
				5.3.2: https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40
				
					obu_header() { Type
						obu_forbidden_bit     f(1)
						obu_type              f(4)
						obu_extension_flag    f(1)
						obu_has_size_field    f(1)
						obu_reserved_1bit     f(1)
						if ( obu_extension_flag == 1 )
							obu_extension_header()
						}
					}

			(*Header) Size() int
				Size returns the size of the OBU header in bytes.

		Implements (at least one exported)
			*Header : github.com/gogo/protobuf/proto.Sizer
		As Outputs Of (at least one exported)
			func ParseOBUHeader(data []byte) (*Header, error)

	 type OBU (struct)
		OBU represents an AV1 OBU.
		5.1 https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=39

		Fields (total 2)
			Header Header
			Payload []byte
		Methods (only one)
			(*OBU) Marshal() []byte
				Marshal serializes the OBU to low-overhead bitstream format.
				5.2 https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40


	 type Type uint8 (basic type)
		Type represents the type of an AV1 OBU.

		Methods (only one)
			( Type) String() string
		Implements (at least 2)
			 Type : expvar.Var
			 Type : fmt.Stringer
		As Types Of (total 9)
			const OBUFrame
			const OBUFrameHeader
			const OBUMetadata
			const OBUPadding
			const OBURedundantFrameHeader
			const OBUSequenceHeader
			const OBUTemporalDelimiter
			const OBUTileGroup
			const OBUTileList


Package-Level Functions (total 5)

	 func EncodeLEB128(in uint) (out uint)
		EncodeLEB128 encodes a uint as LEB128.

	 func ParseOBUExtensionHeader(headerData byte) ExtensionHeader
		ParseOBUExtensionHeader parses an OBU extension header from the given data.
		5.3.3 https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40
		
			obu_extension_header() { Type
				temporal_id                      f(3)
				spatial_id                       f(2)
				extension_header_reserved_3bits  f(3)
			}

	 func ParseOBUHeader(data []byte) (*Header, error)
		ParseOBUHeader parses an OBU header from the given data.
		5.3.2: https://aomediacodec.github.io/av1-spec/av1-spec.pdf#page=40
		
			obu_header() { Type
				obu_forbidden_bit     f(1)
				obu_type              f(4)
				obu_extension_flag    f(1)
				obu_has_size_field    f(1)
				obu_reserved_1bit     f(1)
				if ( obu_extension_flag == 1 )
					obu_extension_header()
				}
			}

	 func ReadLeb128(in []byte) (uint, uint, error)
		ReadLeb128 scans an buffer and decodes a Leb128 value.
		If the end of the buffer is reached and all MSB are set
		an error is returned.

	 func WriteToLeb128(in uint) []byte
		WriteToLeb128 writes a uint to a LEB128 encoded byte slice.


Package-Level Variables (total 3)

	  var ErrFailedToReadLEB128 error
		ErrFailedToReadLEB128 indicates that a buffer ended before a LEB128 value could be successfully read.

	  var ErrInvalidOBUHeader error
		ErrInvalidOBUHeader is returned when an OBU header has forbidden bits set.

	  var ErrShortHeader error
		ErrShortHeader is returned when an OBU header is not large enough.
		This can happen when an extension header is expected but not present.


Package-Level Constants (total 9)

	const OBUFrame Type = 6
		OBUFrame av1 frame_obu.

	const OBUFrameHeader Type = 3
		OBUFrameHeader av1 frame_header_obu.

	const OBUMetadata Type = 5
		OBUMetadata av1 metadata_obu.

	const OBUPadding Type = 15
		OBUPadding av1 padding_obu.

	const OBURedundantFrameHeader Type = 7
		OBURedundantFrameHeader av1 redundant_frame_header_obu.

	const OBUSequenceHeader Type = 1
		OBUSequenceHeader av1 sequence_header_obu.

	const OBUTemporalDelimiter Type = 2
		OBUTemporalDelimiter av1 temporal_delimiter_obu.

	const OBUTileGroup Type = 4
		OBUTileGroup av1 tile_group_obu.

	const OBUTileList Type = 8
		OBUTileList av1 tile_list_obu.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.