Skip to main content

Module probe

Module probe 

Source
Expand description

File-summary helpers built on the extraction and box layers. File-summary helpers built on the extraction and box layers, with byte-slice convenience entry points for in-memory probe flows.

Structs§

AacProfileInfo
AAC profile details derived from an esds descriptor stream.
Ac3CodecDetails
Parsed AC-3 decoder configuration details.
Av1CodecDetails
Parsed AV1 decoder configuration details.
AvcCodecDetails
Parsed AVC decoder configuration details.
AvcDecoderConfigInfo
Summary of AVC decoder configuration attached to a video track.
ChunkInfo
Expanded chunk placement information.
CleanApertureInfo
Clean-aperture values parsed from clap.
CodecDetailedProbeInfo
Additive detailed probe summary that extends DetailedProbeInfo with codec-specific configuration details.
CodecDetailedTrackInfo
Additive per-track summary that extends DetailedTrackInfo with parsed codec-specific configuration.
ColorInfo
Declared color information parsed from colr.
ContentLightLevelInfo
Content-light-level metadata parsed from CoLL.
DeclaredBitrateInfo
Declared buffering and bitrate values parsed from btrt.
DetailedProbeInfo
Additive detailed probe summary that extends ProbeInfo without changing its public shape.
DetailedTrackInfo
Additive per-track summary that extends TrackInfo with richer sample-entry details.
EditListEntry
One edit-list entry from elst.
ExtendedMediaCharacteristicsProbeInfo
Additive detailed probe summary that extends MediaCharacteristicsProbeInfo with extra typed visual sample-entry metadata.
ExtendedMediaCharacteristicsTrackInfo
Additive per-track summary that extends MediaCharacteristicsTrackInfo with extra typed visual sample-entry metadata.
FieldOrderInfo
Declared field-order hint parsed from fiel.
HevcCodecDetails
Parsed HEVC decoder configuration details.
MasteringDisplayInfo
Mastering-display metadata parsed from SmDm.
MediaCharacteristicsProbeInfo
Additive detailed probe summary that extends CodecDetailedProbeInfo with media characteristics already parsed by the crate.
MediaCharacteristicsTrackInfo
Additive per-track summary that extends DetailedTrackInfo with parsed codec and media characteristics.
Mp4AudioCodecDetails
Parsed MPEG-4 audio decoder configuration details.
Mp4aInfo
Summary of MP4A decoder configuration attached to an audio track.
OpusCodecDetails
Parsed Opus decoder configuration details.
PcmCodecDetails
Parsed PCM configuration details.
PixelAspectRatioInfo
Declared pixel aspect ratio parsed from pasp.
ProbeInfo
High-level summary of one MP4 file.
ProbeOptions
Additive controls for eager probe expansion.
ProtectionSchemeInfo
Protection-scheme summary derived from schm.
SampleInfo
Expanded sample timing and size information.
SegmentInfo
Summary of one fragmented-media segment.
TextSubtitleCodecDetails
Parsed text subtitle sample-entry details.
TrackInfo
Summary of one logical media track.
TrackMediaCharacteristics
Media characteristics derived from stable sample-entry side boxes such as btrt, colr, pasp, and fiel.
TrackVisualMetadata
Additional typed visual sample-entry metadata parsed from boxes that were added after the original TrackMediaCharacteristics shape was stabilized.
VpCodecDetails
Parsed VP8 or VP9 decoder configuration details.
WebVttCodecDetails
Parsed WebVTT sample-entry details.
XmlSubtitleCodecDetails
Parsed XML subtitle sample-entry details.

Enums§

ProbeError
Errors raised while probing files or derived codec summaries.
TrackCodec
Coarse codec classification used by the probe surface.
TrackCodecDetails
Parsed codec-specific configuration for one recognized track family.
TrackCodecFamily
Normalized codec family derived from the sample entry or protected original format.

Functions§

average_sample_bitrate
Returns the average bitrate implied by samples in the supplied timescale.
average_segment_bitrate
Returns the average bitrate implied by segments for track_id.
detect_aac_effective_sample_rate
Detects the effective AAC sample rate signaled by one esds descriptor stream.
detect_aac_profile
Detects the AAC object profile exposed by an esds descriptor stream.
find_idr_frames
Finds sample indices whose AVC payload contains an IDR NAL unit.
find_idr_frames_asyncasync
Finds sample indices whose AVC payload contains an IDR NAL unit through the additive Tokio- based async surface.
max_sample_bitrate
Returns the maximum rolling-window bitrate implied by samples.
max_segment_bitrate
Returns the maximum per-segment bitrate implied by segments for track_id.
normalized_codec_family_name
Returns the additive codec-family label used by detailed reporting.
probe
Probes a file and returns the backwards-compatible coarse movie, track, and fragment summary.
probe_asyncasync
Probes a file through the additive Tokio-based async surface and returns the backwards-compatible coarse movie, track, and fragment summary.
probe_bytes
Probes an in-memory MP4 byte slice and returns the coarse movie, track, and fragment summary.
probe_bytes_with_options
Probes an in-memory MP4 byte slice with additive expansion controls and returns the coarse movie, track, and fragment summary.
probe_codec_detailed
Probes a file and returns an additive detailed summary with parsed codec-specific configuration when it is available.
probe_codec_detailed_asyncasync
Probes a file through the additive Tokio-based async surface and returns an additive detailed summary with parsed codec-specific configuration when it is available.
probe_codec_detailed_bytes
Probes an in-memory MP4 byte slice and returns the additive codec-detailed summary.
probe_codec_detailed_bytes_with_options
Probes an in-memory MP4 byte slice with additive expansion controls and returns the codec-detailed summary.
probe_codec_detailed_with_options
Probes a file with additive expansion controls and returns the codec-detailed summary.
probe_codec_detailed_with_options_asyncasync
Probes a file through the additive Tokio-based async surface with expansion controls and returns the codec-detailed summary.
probe_detailed
Probes a file and returns an additive detailed movie, track, and fragment summary.
probe_detailed_asyncasync
Probes a file through the additive Tokio-based async surface and returns an additive detailed movie, track, and fragment summary.
probe_detailed_bytes
Probes an in-memory MP4 byte slice and returns the additive detailed summary.
probe_detailed_bytes_with_options
Probes an in-memory MP4 byte slice with additive expansion controls and returns the detailed summary.
probe_detailed_with_options
Probes a file with additive expansion controls and returns the detailed movie, track, and fragment summary.
probe_detailed_with_options_asyncasync
Probes a file through the additive Tokio-based async surface with expansion controls and returns the detailed movie, track, and fragment summary.
probe_extended_media_characteristics
Probes a file and returns an additive summary with parsed codec, media characteristics, and extra typed visual sample-entry metadata.
probe_extended_media_characteristics_asyncasync
Probes a file through the additive Tokio-based async surface and returns an additive summary with parsed codec, media characteristics, and extra typed visual sample-entry metadata.
probe_extended_media_characteristics_bytes
Probes an in-memory MP4 byte slice and returns the extended media-characteristics summary.
probe_extended_media_characteristics_bytes_with_options
Probes an in-memory MP4 byte slice with additive expansion controls and returns the extended media-characteristics summary.
probe_extended_media_characteristics_with_options
Probes a file with additive expansion controls and returns the extended media-characteristics summary.
probe_extended_media_characteristics_with_options_asyncasync
Probes a file through the additive Tokio-based async surface with expansion controls and returns the extended media-characteristics summary.
probe_fra
Legacy fragmented-file probe entry point that currently aliases probe.
probe_fra_asyncasync
Legacy fragmented-file probe entry point through the additive Tokio-based async surface.
probe_fra_bytes
Legacy fragmented-file probe entry point for in-memory MP4 bytes.
probe_fra_codec_detailed
Legacy fragmented-file codec-detailed probe entry point that currently aliases probe_codec_detailed.
probe_fra_codec_detailed_asyncasync
Legacy fragmented-file codec-detailed probe entry point through the additive Tokio-based async surface.
probe_fra_codec_detailed_bytes
Legacy fragmented-file codec-detailed probe entry point for in-memory MP4 bytes.
probe_fra_detailed
Legacy fragmented-file detailed probe entry point that currently aliases probe_detailed.
probe_fra_detailed_asyncasync
Legacy fragmented-file detailed probe entry point through the additive Tokio-based async surface.
probe_fra_detailed_bytes
Legacy fragmented-file detailed probe entry point for in-memory MP4 bytes.
probe_fra_media_characteristics
Legacy fragmented-file media-characteristics probe entry point that currently aliases probe_media_characteristics.
probe_fra_media_characteristics_asyncasync
Legacy fragmented-file media-characteristics probe entry point through the additive Tokio-based async surface.
probe_fra_media_characteristics_bytes
This currently aliases probe_media_characteristics_bytes for callers that already use the fragmented-file helper naming.
probe_media_characteristics
Probes a file and returns an additive summary with parsed codec and media characteristics.
probe_media_characteristics_asyncasync
Probes a file through the additive Tokio-based async surface and returns an additive summary with parsed codec and media characteristics.
probe_media_characteristics_bytes
Probes an in-memory MP4 byte slice and returns the additive media-characteristics summary.
probe_media_characteristics_bytes_with_options
Probes an in-memory MP4 byte slice with additive expansion controls and returns the media-characteristics summary.
probe_media_characteristics_with_options
Probes a file with additive expansion controls and returns the media-characteristics summary.
probe_media_characteristics_with_options_asyncasync
Probes a file through the additive Tokio-based async surface with expansion controls and returns the media-characteristics summary.
probe_with_options
Probes a file with additive expansion controls and returns the backwards-compatible coarse movie, track, and fragment summary.
probe_with_options_asyncasync
Probes a file through the additive Tokio-based async surface with expansion controls and returns the backwards-compatible coarse movie, track, and fragment summary.