framefinery-api 0.0.3

Shared media pipeline APIs for FrameFinery.
Documentation
//! Shared media pipeline APIs for FrameFinery.
//!
//! This crate is intentionally small at project bootstrap. It holds the stable
//! concepts that codec crates and tools can share without forcing AV2, VVC, or
//! future codecs into one internal design.
//!
//! ```
//! use framefinery_api::{Frame, FrameInfo, PixelFormat};
//!
//! let info = FrameInfo::new(16, 16, PixelFormat::Yuv420p8)?;
//! let frame = Frame::blank(info);
//! assert_eq!(frame.as_frame_ref().data().len(), info.expected_len());
//! # Ok::<(), framefinery_api::MediaError>(())
//! ```

mod dpb;
mod error;
mod filters;
mod frame;
mod packet;
mod pipeline;
mod settings;
mod video;

pub use dpb::{DecodedPictureBuffer, DpbEntry, PictureId};
pub use error::{MediaError, Result};
#[cfg(feature = "filter-crop")]
pub use filters::CropFilter;
#[cfg(feature = "filter-identity")]
pub use filters::IdentityFilter;
#[cfg(feature = "filter-scale")]
pub use filters::ScaleFilter;
pub use filters::{
    build_filter_transform, build_raw_video_source_filter, build_source_filter,
    filter_pipeline_output_info, filter_spec_manifest, filter_spec_name,
    generate_source_filter_stream, parse_filter_pipeline_specs, FilterPipelineBuilder,
    FilterPipelineSpec, FilterSpecExample, FilterSpecForm, FilterSpecManifest, FilterSpecParameter,
    FilterSpecValue, FilterStageSpec, CROP_FILTER_SPEC, IDENTITY_FILTER_SPEC, PATTERN_FILTER_SPEC,
    PATTERN_SOURCE_NAMES, SCALE_FILTER_SPEC,
};
pub use filters::{filter_manifest, FilterManifest, FilterStageKind, FilterStatus, FILTERS};
#[cfg(feature = "filter-pattern")]
pub use filters::{generate_pattern_stream, pattern_frame_data, PatternKind, PatternSource};
pub use frame::{
    convert_frame_format, convert_planar_frame_bit_depth, frame_psnr, planar_sample_sse,
    read_planar_sample, scale_sample_bit_depth, write_planar_sample, ChromaSampling, Frame,
    FrameInfo, FramePsnr, FrameRef, PixelFormat, SampleBitDepth,
};
pub use packet::{Packet, StreamId, Timestamp};
pub use pipeline::{
    run_frame_encode_pipeline, run_frame_filter_pipeline, EncodePipelineStats, Encoder, Filter,
    FilterPipelineStats, FilteredRawVideoFrameSource, FrameSourceRawVideoAdapter, Sink, Source,
};
pub use settings::{
    boolean_setting_enabled, i32_setting, setting_name, setting_value, setting_values_label,
    u8_setting, SettingManifest, SettingSpecExample, SettingSpecForm, SettingSpecManifest,
    SettingValue, GLOBAL_SETTINGS, LOSSLESS_SETTING, LOSSLESS_SETTING_SPEC,
};
pub use video::{
    CodecId, EncodedVideoChunk, FrameEncodeMetrics, FrameRate, RawVideoFrameReadSource,
    RawVideoFrameSource, RawVideoFrameSourceReadAdapter, ReconstructionMode, VideoChunkKind,
    VideoEncodeFrameMetrics, VideoEncodeFrameMetricsCallback, VideoEncodeOutput,
    VideoEncoderConfig, VideoEncoderManifest, VideoEncoderSession, VideoEncoderSetting,
    VideoRateControl, VideoSettingValue,
};
#[doc(hidden)]
pub use video::{
    VideoEncodeSourceFn, VideoEncodeSourceRequest, VideoEncoderManifestHooks,
    VideoEncoderSessionFactory,
};

/// Version of the `framefinery-api` crate compiled into this build.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");