Skip to main content

CarrierResampler

Struct CarrierResampler 

Source
pub struct CarrierResampler<C: FfmpegCarrier> { /* private fields */ }
Available on crate feature resample only.
Expand description

mediadecode::resampler::AudioResampler impl wrapping swresample.

Construction is Self::new, off the trait, taking both specs — see the trait’s own documentation for why the target can never be a constant.

Implementations§

Source§

impl CarrierResampler<View>

Source

pub fn new( source: ResampleSpec, target: ResampleSpec, limits: FrameLimits, ) -> Result<Self, ResampleError>

Opens a resampler between two explicit specs. See CarrierResampler::new_impl for the full contract.

Source

pub const fn source(&self) -> &ResampleSpec

The spec frames must arrive in.

Source

pub const fn target(&self) -> &ResampleSpec

The spec frames leave in.

Source

pub const fn inner(&self) -> &Context

The wrapped swr context.

Source

pub fn delay(&self) -> i64

Samples still inside the delay line, counted at the output rate.

Source§

impl CarrierResampler<Owned>

Source

pub fn new( source: ResampleSpec, target: ResampleSpec, limits: FrameLimits, ) -> Result<Self, ResampleError>

Opens a resampler between two explicit specs. See CarrierResampler::new_impl for the full contract.

Source

pub const fn source(&self) -> &ResampleSpec

The spec frames must arrive in.

Source

pub const fn target(&self) -> &ResampleSpec

The spec frames leave in.

Source

pub const fn inner(&self) -> &Context

The wrapped swr context.

Source

pub fn delay(&self) -> i64

Samples still inside the delay line, counted at the output rate.

Trait Implementations§

Source§

impl AudioResampler for CarrierResampler<View>

Source§

type Adapter = Ffmpeg

Backend vocabulary. The source and target specs are both expressed in it.
Source§

type Buffer = <View as FfmpegCarrier>::Buffer

Buffer type held by the frames this resampler accepts and produces.
Source§

type Error = ResampleError

Resampler-specific error type — faults only. The rhythm’s own states leave through Sent and Received; what travels here is the mid-stream-change refusal out of send_frame and whatever else genuinely went wrong.
Source§

fn send_frame( &mut self, frame: &AudioFrame<SampleFormat, ChannelLayoutDescription, AudioFrameExtra, <View as FfmpegCarrier>::Buffer>, ) -> Result<Sent, ResampleError>

Submits one decoded frame. Read more
Source§

fn receive_frame( &mut self, dst: &mut AudioFrame<SampleFormat, ChannelLayoutDescription, AudioFrameExtra, <View as FfmpegCarrier>::Buffer>, ) -> Result<Received, ResampleError>

Drains one converted frame into dst, answering the same Received that AudioStreamDecoder::receive_frame answers.
Source§

fn send_eof(&mut self) -> Result<Sent, ResampleError>

Signals end of stream. The conversion tail becomes drainable through receive_frame.
Source§

fn flush(&mut self) -> Result<(), ResampleError>

Flushes internal state — buffered input, the undrained tail, and the output timestamp anchor — leaving the resampler ready for a fresh stream on the same two specs.
Source§

impl AudioResampler for CarrierResampler<Owned>

Source§

type Adapter = Ffmpeg

Backend vocabulary. The source and target specs are both expressed in it.
Source§

type Buffer = <Owned as FfmpegCarrier>::Buffer

Buffer type held by the frames this resampler accepts and produces.
Source§

type Error = ResampleError

Resampler-specific error type — faults only. The rhythm’s own states leave through Sent and Received; what travels here is the mid-stream-change refusal out of send_frame and whatever else genuinely went wrong.
Source§

fn send_frame( &mut self, frame: &AudioFrame<SampleFormat, ChannelLayoutDescription, AudioFrameExtra, <Owned as FfmpegCarrier>::Buffer>, ) -> Result<Sent, ResampleError>

Submits one decoded frame. Read more
Source§

fn receive_frame( &mut self, dst: &mut AudioFrame<SampleFormat, ChannelLayoutDescription, AudioFrameExtra, <Owned as FfmpegCarrier>::Buffer>, ) -> Result<Received, ResampleError>

Drains one converted frame into dst, answering the same Received that AudioStreamDecoder::receive_frame answers.
Source§

fn send_eof(&mut self) -> Result<Sent, ResampleError>

Signals end of stream. The conversion tail becomes drainable through receive_frame.
Source§

fn flush(&mut self) -> Result<(), ResampleError>

Flushes internal state — buffered input, the undrained tail, and the output timestamp anchor — leaving the resampler ready for a fresh stream on the same two specs.
Source§

impl<C: FfmpegCarrier> Send for CarrierResampler<C>

Send, and deliberately not Sync.

§Safety

The SwrContext behind ctx is owned by this value: it is allocated in [open_context], never shared, never cloned, and dropped with the resampler. Every operation that touches it goes through &mut selfswr_convert_frame, swr_get_delay, swr_init on the rebuild — so no two threads can be inside libswresample for this context at once, which is the whole of what that library requires: it keeps no thread-local or process-global state of its own, and a context is a plain heap allocation whose address is meaningful on any thread.

The other fields are ordinary owned values. The two ffmpeg_next::ChannelLayouts and the two ResampleSpecs wrap an AVChannelLayout, which holds a pointer only for AV_CHANNEL_ORDER_CUSTOM — and [preflight_layout] refuses that order at the one construction choke point, so every layout a live resampler holds is the u.mask arm: a uint64_t, a plain value. The staged layouts come from [initialized_layout], which produces av_channel_layout_default’s mask-only answer. ready holds Frame<C> values, whose carriers are Send by the carrier contract.

Not Sync, and that is not an oversight. &self would let two threads hold the context at once, and nothing in this type serialises that; the &mut receiver is the serialisation. Moving the whole resampler to another thread is sound; sharing it is not offered.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more