Crate pixelflow 

Public facade for PixelFlow embedding APIs.

Structs

AllocatorConfig

Runtime allocator configuration for frame plane buffers.

Clip

Immutable script-facing clip handle.

ClipMedia

Declared media properties for one clip.

Core

Per-instance PixelFlow host state.

CoreConfig

Configuration used when creating a Core.

ErrorCode

Stable machine-readable error code within an ErrorCategory.

FilterChangeSet

Filter output axes that may differ from the first input clip.

FilterDescriptor

Declares one registered filter capability.

FilterPlan

Planned graph-node metadata for one filter call.

FilterPlanRequest

Borrowed inputs for planning one filter node.

FilterRegistry

Per-core registry for filters and metadata extension keys.

FilterTiming

Aggregate timing for one graph node.

FormatDescriptor

Stable descriptor for a concrete planar format.

Frame

Immutable ref-counted frame handle.

FrameBuilder

Builder used for explicit output allocation and writes.

FrameRequest

Request object passed to a frame executor.

Graph

Immutable graph ready for validation and future rendering.

GraphBuilder

Mutable construction API. build freezes nodes into immutable graph.

GraphNode

One immutable graph node.

LoadedPlugin

Describes one loaded plugin.

LogRecord

Immutable log event delivered to a LogSink.

Logger

Cloneable logger handle used by core and downstream crates.

Metadata

Typed metadata map validated against a MetadataSchema.

MetadataSchema

Metadata schema for core keys and plugin extension keys.

NodeId

Stable graph node identifier.

NoopLogSink

Log sink that discards all records.

OrderedRender

Blocking ordered render iterator.

PixelFlowError

Structured error value used by public PixelFlow APIs.

Plane

Typed immutable plane view.

PlaneDescriptor

Descriptor for one plane in a format.

PlaneMut

Typed mutable plane view available while building outputs.

PlaneRows

Iterator over immutable typed plane rows.

Rational

Rational metadata value.

RawPlane

Raw immutable plane view used by expert Rust and C ABI adapters.

RawPlaneMut

Raw mutable plane view used by expert builders and C ABI adapters.

RenderEngine

Render engine configured with one per-core worker-pool setting.

RenderExecutorMap

Public map from graph node IDs to concrete render executors.

RenderOptions

User-selected render frame range.

RenderRange

Validated render frame range.

SourceCapabilities

Source node scheduling capabilities.

SourceRequest

Lazy source request captured during graph construction.

TimingReport

Snapshot of aggregate node timings.

ValidatedGraph

Validated graph plus reachability plan, ready for later render scheduling.

ValidationPlan

Reachability result used to index only reachable sources before render validation.

WorkerPoolConfig

Per-core worker pool configuration.

Y4mWriter

Streaming Y4M writer for one fixed output clip.

Enums

ChromaSiting

Official chroma-siting metadata values.

ChromaSubsampling

Chroma subsampling for YUV formats.

ClipFormat

Format state known for graph clip.

ClipResolution

Resolution state known for graph clip.

ColorMatrix

Official matrix coefficient metadata values.

ColorPrimaries

Official color-primaries metadata values.

ColorRange

Official color range metadata values.

ColorTransfer

Official transfer-function metadata values.

ConcurrencyClass

Declares how scheduler may run node callbacks across frames.

DependencyPattern

Declares which upstream frames a node may request while producing one output frame.

DynamicDependencyBounds

Runtime bounds for frame-map and dynamic dependencies.

ErrorCategory

Stable high-level category for routing errors across APIs and plugins.

FilterCompatibility

Filter media compatibility policy used during validation.

FilterOptionValue

Generic script-provided option value for filter planning.

FormatFamily

High-level pixel family.

FrameCount

Frame-count state known for graph clip.

FrameRate

Frame-rate state known for graph clip.

LogLevel

Severity for records emitted through PixelFlow logging hooks.

MetadataKind

Declared metadata type for schema entries.

MetadataValue

Typed metadata value.

NodeKind

Stored graph node kind.

PlaneRole

Semantic role of one plane.

SampleType

Stored scalar type for plane samples.

SourceOptionValue

Script-provided scalar option for a source request.

Constants

PIXELFLOW_ABI_VERSION

Current plugin ABI version.

Traits

FrameExecutor

Executor that produces frames for one graph node.

LogSink

Destination for PixelFlow log records.

Sample

Sample marker trait for supported plane sample types.

Functions

format_with_bit_depth

Derives same-family format at different logical bit depth.

is_y4m_compatible_format

Returns true when final clip format can be written as Phase 1 Y4M.

load_plugins_from_directories

Loads all plugins from configured directories, warning and skipping failures.

platform_plugin_directories

Returns conventional platform plugin directories.

resolve_format_alias

Resolves a user-facing alias to stable format descriptor.

version

Returns the pixelflow-core crate version.

y4m_chroma_tag

Returns Y4M chroma tag for one Phase 1 compatible format.

Type Aliases

FilterOptions

Deterministically sorted filter option map.

Result

Convenient result alias for PixelFlow operations.