av/codec/h264/h264dec/nalunit.go

/*
DESCRIPTION
  nalunit.go provides structures for a NAL unit as well as it's extensions.

AUTHORS
  Saxon Nelson-Milton <saxon@ausocean.org>, The Australian Ocean Laboratory (AusOcean)
  mrmod <mcmoranbjr@gmail.com>
*/

package h264dec

import (
	"io"

	"github.com/pkg/errors"

	"bitbucket.org/ausocean/av/codec/h264/h264dec/bits"
)

// MVCExtension describes a NAL unit header multiview video coding extension, as
// defined in section H.7.3.1.1 of the specifications.
// Semantics of fields are specified in section H.7.4.1.1.
type MVCExtension struct {
	// non_idr_flag, if true indicates that access unit is not IDR.
	NonIdrFlag bool

	// priority_id, indicates priority of NAL unit. A lower value => higher priority.
	PriorityID int

	// view_id, specifies a view identifier for the unit. Units with identical
	// view_id are in the same view.
	ViewID int

	// temporal_id, temporal identifier for the unit.
	TemporalID int

	// anchor_pic_flag, if true access unit is an anchor access unit.
	AnchorPicFlag bool

	// inter_view_flag, if false current view component not used for inter-view
	// prediction elsewhere in access unit.
	InterViewFlag bool

	// reserved_one_bit, always 1 (ignored by decoders)
	ReservedOneBit int
}

// NewMVCExtension parses a NAL unit header multiview video coding extension
// from br following the syntax structure specified in section H.7.3.1.1, and
// returns as a new MVCExtension.
func NewMVCExtension(br *bits.BitReader) (*MVCExtension, error) {
	e := &MVCExtension{}
	var err error

	e.NonIdrFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read NonIdrFlag")
	}

	e.PriorityID, err = br.ReadBitsInt(6)
	if err != nil {
		return nil, errors.Wrap(err, "could not read PriorityId")
	}

	e.ViewID, err = br.ReadBitsInt(10)
	if err != nil {
		return nil, errors.Wrap(err, "could not read ViewId")
	}

	e.TemporalID, err = br.ReadBitsInt(3)
	if err != nil {
		return nil, errors.Wrap(err, "could not read TemporalId")
	}

	e.AnchorPicFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read AnchorPicFlag")
	}

	e.InterViewFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read InterViewFlag")
	}

	e.ReservedOneBit, err = br.ReadBitsInt(1)
	if err != nil {
		return nil, errors.Wrap(err, "could not read ReservedOneBit")
	}

	return e, nil
}

// ThreeDAVCExtension describes a NAL unit header 3D advanced video coding
// extension, as defined in section J.7.3.1.1 of the specifications.
// For field semantics see section J.7.4.1.1.
type ThreeDAVCExtension struct {
	// view_idx, specifies the order index for the NAL i.e. view_id = view_id[view_idx].
	ViewIdx int

	// dpeth_flag, if true indicates NAL part of a depth view component, otherwise
	// a texture view component.
	DepthFlag bool

	// non_idr_flag, if true indicates that access unit is not IDR.
	NonIdrFlag bool

	// temporal_id, temporal identifier for the unit.
	TemporalID int

	// anchor_pic_flag, if true access unit is an anchor access unit.
	AnchorPicFlag bool

	// inter_view_flag, if false current view component not used for inter-view
	// prediction elsewhere in access unit.
	InterViewFlag bool
}

// NewThreeDAVCExtension parses a NAL unit header 3D advanced video coding
// extension from br following the syntax structure specified in section
// J.7.3.1.1, and returns as a new ThreeDAVCExtension.
func NewThreeDAVCExtension(br *bits.BitReader) (*ThreeDAVCExtension, error) {
	e := &ThreeDAVCExtension{}
	var err error

	e.ViewIdx, err = br.ReadBitsInt(8)
	if err != nil {
		return nil, errors.Wrap(err, "could not read ViewIdx")
	}

	e.DepthFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read DepthFlag")
	}

	e.NonIdrFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read NonIdrFlag")
	}

	e.TemporalID, err = br.ReadBitsInt(3)
	if err != nil {
		return nil, errors.Wrap(err, "could not read TemporalId")
	}

	e.AnchorPicFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read AnchorPicFlag")
	}

	e.InterViewFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read InterViewFlag")
	}

	return e, nil
}

// SVCExtension describes a NAL unit header scalable video coding extension, as
// defined in section G.7.3.1.1 of the specifications.
// For field semantics see section G.7.4.1.1.
type SVCExtension struct {
	// idr_flag, if true the current coded picture is an IDR picture when
	// dependency_id == max(dependency_id) in the coded picture.
	IdrFlag bool

	// priority_id, specifies priority identifier for unit.
	PriorityID int

	// no_inter_layer_pred_flag, if true inter-layer prediction can't be used for
	// decoding slice.
	NoInterLayerPredFlag bool

	// dependency_id, specifies a dependency identifier for the NAL.
	DependencyID int

	// quality_id, specifies a quality identifier for the NAL.
	QualityID int

	// temporal_id, specifiesa temporal identifier for the NAL.
	TemporalID int

	// use_ref_base_pic_flag, if true indicates reference base pictures and
	// decoded pictures are used as references for inter prediction.
	UseRefBasePicFlag bool

	// discardable_flag, if true, indicates current NAL is not used for decoding
	// dependency representations that are part of the current coded picture or
	// any subsequent coded picture in decoding order and have a greater
	// dependency_id value than current NAL.
	DiscardableFlag bool

	// output_flag, affects the decoded picture output and removal processes as
	// specified in Annex C.
	OutputFlag bool

	// reserved_three_2bits, equal to 3. Decoders ignore.
	ReservedThree2Bits int
}

// NewSVCExtension parses a NAL unit header scalable video coding extension from
// br following the syntax structure specified in section G.7.3.1.1, and returns
// as a new SVCExtension.
func NewSVCExtension(br *bits.BitReader) (*SVCExtension, error) {
	e := &SVCExtension{}
	var err error

	e.IdrFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read IdrFlag")
	}

	e.PriorityID, err = br.ReadBitsInt(6)
	if err != nil {
		return nil, errors.Wrap(err, "could not read PriorityId")
	}

	e.NoInterLayerPredFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read NoInterLayerPredFlag")
	}

	e.DependencyID, err = br.ReadBitsInt(3)
	if err != nil {
		return nil, errors.Wrap(err, "could not read DependencyId")
	}

	e.QualityID, err = br.ReadBitsInt(4)
	if err != nil {
		return nil, errors.Wrap(err, "could not read QualityId")
	}

	e.TemporalID, err = br.ReadBitsInt(3)
	if err != nil {
		return nil, errors.Wrap(err, "could not read TemporalId")
	}

	e.UseRefBasePicFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read UseRefBasePicFlag")
	}

	e.DiscardableFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read DiscardableFlag")
	}

	e.OutputFlag, err = br.ReadBool()
	if err != nil {
		return nil, errors.Wrap(err, "could not read OutputFlag")
	}

	e.ReservedThree2Bits, err = br.ReadBitsInt(2)
	if err != nil {
		return nil, errors.Wrap(err, "could not read ReservedThree2Bits")
	}

	return e, nil
}

// NALUnit describes a network abstraction layer unit, as defined in section
// 7.3.1 of the specifications.
// Field semantics are defined in section 7.4.1.
type NALUnit struct {
	// forbidden_zero_bit, always 0.
	ForbiddenZeroBit int

	// nal_ref_idc, if not 0 indicates content of NAL contains a sequence parameter
	// set, a sequence parameter set extension, a subset sequence parameter set,
	// a picture parameter set, a slice of a reference picture, a slice data
	// partition of a reference picture, or a prefix NAL preceding a slice of
	// a reference picture.
	RefIdc int

	// nal_unit_type, specifies the type of RBSP data contained in the NAL as
	// defined in Table 7-1.
	Type int

	// svc_extension_flag, indicates whether a nal_unit_header_svc_extension()
	// (G.7.3.1.1) or nal_unit_header_mvc_extension() (H.7.3.1.1) will follow next
	// in the syntax structure.
	SVCExtensionFlag bool

	// avc_3d_extension_flag, for nal_unit_type = 21, indicates that a
	// nal_unit_header_mvc_extension() (H.7.3.1.1) or
	// nal_unit_header_3davc_extension() (J.7.3.1.1) will follow next in syntax
	// structure.
	AVC3DExtensionFlag bool

	// nal_unit_header_svc_extension() as defined in section G.7.3.1.1.
	SVCExtension *SVCExtension

	// nal_unit_header_3davc_extension() as defined in section J.7.3.1.1
	ThreeDAVCExtension *ThreeDAVCExtension

	// nal_unit_header_mvc_extension() as defined in section H.7.3.1.1).
	MVCExtension *MVCExtension

	// emulation_prevention_three_byte, equal to 0x03 and is discarded by decoder.
	EmulationPreventionThreeByte byte

	// rbsp_byte, the raw byte sequence payload data for the NAL.
	RBSP []byte
}

// NewNALUnit parses a network abstraction layer unit from br following the
// syntax structure specified in section 7.3.1, and returns as a new NALUnit.
func NewNALUnit(br *bits.BitReader) (*NALUnit, error) {
	n := &NALUnit{}

	err := readFields(br, []field{
		{&n.ForbiddenZeroBit, "ForbiddenZeroBit", 1},
		{&n.RefIdc, "NalRefIdc", 2},
		{&n.Type, "NalUnitType", 5},
	})
	if err != nil {
		return nil, err
	}

	// TODO: use consts for the NAL types here
	if n.Type == 14 || n.Type == 20 || n.Type == 21 {
		if n.Type != 21 {
			n.SVCExtensionFlag, err = br.ReadBool()
			if err != nil {
				return nil, errors.Wrap(err, "could not read SVCExtensionFlag")
			}
		} else {
			n.AVC3DExtensionFlag, err = br.ReadBool()
			if err != nil {
				return nil, errors.Wrap(err, "could not read AVC3DExtensionFlag")
			}
		}
		if n.SVCExtensionFlag {
			n.SVCExtension, err = NewSVCExtension(br)
			if err != nil {
				return nil, errors.Wrap(err, "could not parse SVCExtension")
			}
		} else if n.AVC3DExtensionFlag {
			n.ThreeDAVCExtension, err = NewThreeDAVCExtension(br)
			if err != nil {
				return nil, errors.Wrap(err, "could not parse ThreeDAVCExtension")
			}
		} else {
			n.MVCExtension, err = NewMVCExtension(br)
			if err != nil {
				return nil, errors.Wrap(err, "could not parse MVCExtension")
			}
		}
	}

	for moreRBSPData(br) {
		next3Bytes, err := br.PeekBits(24)

		// If PeekBits cannot get 3 bytes, but there still might be 2 bytes left in
		// the source, we will get an io.EOF; we wish to ignore this and continue.
		// The call to moreRBSPData will determine when we have reached the end of
		// the NAL unit.
		if err != nil && errors.Cause(err) != io.EOF {
			return nil, errors.Wrap(err, "could not Peek next 3 bytes")
		}

		if next3Bytes == 0x000003 {
			for j := 0; j < 2; j++ {
				rbspByte, err := br.ReadBits(8)
				if err != nil {
					return nil, errors.Wrap(err, "could not read rbspByte")
				}
				n.RBSP = append(n.RBSP, byte(rbspByte))
			}

			// Read Emulation prevention three byte.
			eptByte, err := br.ReadBits(8)
			if err != nil {
				return nil, errors.Wrap(err, "could not read eptByte")
			}
			n.EmulationPreventionThreeByte = byte(eptByte)
		} else {
			b, err := br.ReadBits(8)
			if err != nil {
				return nil, errors.Wrap(err, "could not read RBSP byte")
			}
			n.RBSP = append(n.RBSP, byte(b))
		}
	}

	return n, nil
}