routing

Documentation

Index

• Constants
• type AuxInputSpec
• type ConversionSpec
• type FilterSpec
• type Negotiator
  • func NewNegotiator(muxer resolver.MuxerResolver, demuxer resolver.DemuxerResolver, ...) *Negotiator
  • func (n *Negotiator) NegotiateConversion(ctx context.Context, spec ConversionSpec) (result *pipeline.Geometry, resultErr error)
• type PortRef

Constants

const MainInputAlias = "@in"

MainInputAlias is the reserved source alias for the main input's decoded stream. It cannot be used as an auxiliary input name or a filter alias.

Types

type AuxInputSpec

type AuxInputSpec struct {
	Source io.ReadSeeker

	DemuxManifest registry.DemuxerManifest
	DemuxConfig   registry.Configuration

	DecoderManifest registry.DecoderManifest
	DecodeConfig    registry.Configuration
}

AuxInputSpec is a named additional source, demuxed and decoded exactly like the main input. Filters read it by wiring a port to PortRef{Alias: name}; it has no filter chain of its own — any processing on the way to a consumer is just an ordinary FilterSpec wired from this alias, unified with the rest of the graph.

type ConversionSpec

type ConversionSpec struct {
	Input  io.ReadSeeker
	Output io.Writer

	DemuxManifest     registry.DemuxerManifest
	DemuxConfig       registry.Configuration
	SelectInputStream func(streams []media.StreamInfo) (media.StreamInfo, error)

	DecoderManifest registry.DecoderManifest
	DecodeConfig    registry.Configuration
	Filters         []FilterSpec
	AuxInputs       map[string]AuxInputSpec

	// Sink names the port that feeds the encoder. Nil resolves to the
	// default: the last filter's "out" port, or (with no filters) the main
	// input directly.
	Sink *PortRef

	EncoderManifest registry.EncoderManifest
	TargetCodec     media.CodecID
	EncodeConfig    registry.Configuration

	MuxManifest         registry.MuxerManifest
	MuxConfig           registry.Configuration
	PrepareOutputStream func(inStream media.StreamInfo) media.StreamInfo

	// Resources sets the total execution budget. Parallelism == 0 uses
	// runtime.GOMAXPROCS(0).
	Resources registry.ResourceBudget
}

type FilterSpec

type FilterSpec struct {
	Alias  string
	Config registry.Configuration
	Inputs map[string]PortRef
	// Manifest is the filter's already-resolved manifest, when the caller
	// has one (as pkg/conversion does, since it must resolve a
	// parameterized filter's manifest from its Parameters before Config
	// even makes sense). A parameterized filter's concrete manifest exists
	// only for this one invocation, so it cannot be found again by
	// Negotiator's config-keyed filter resolver the way an ordinary
	// filter's can — leave this zero to fall back to that resolver.
	Manifest registry.FilterManifest
}

FilterSpec describes one filter node in the conversion graph. Inputs maps each port this filter's manifest requires to where it reads from. A port left out of Inputs falls back to a default only when it is literally named "in": the first filter in declaration order reads MainInputAlias, and every later one reads the "out" port of the filter declared immediately before it. Every other port (multi-port filters have no "in" at all) must be wired explicitly.

type Negotiator

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

func NewNegotiator

func NewNegotiator(
	muxer resolver.MuxerResolver,
	demuxer resolver.DemuxerResolver,
	encoder resolver.EncoderResolver,
	decoder resolver.DecoderResolver,
	filter resolver.FilterResolver,
	bridge resolver.BridgeResolver,
) *Negotiator

func (*Negotiator) NegotiateConversion

func (n *Negotiator) NegotiateConversion(ctx context.Context, spec ConversionSpec) (result *pipeline.Geometry, resultErr error)

type PortRef

type PortRef struct {
	Alias string
	Port  string
}

PortRef names one port of one graph node: a filter alias, an auxiliary input name, or MainInputAlias. An empty Port defaults to "out".