Skip to main content

MediaCodecFrame

Struct MediaCodecFrame 

Source
pub struct MediaCodecFrame { /* private fields */ }
Available on Android only.
Expand description

MediaCodec decoder output frame in SurfaceTexture-backed mode.

Implementations§

Source§

impl MediaCodecFrame

Source

pub unsafe fn try_from_raw( buffer: *mut c_void, surface_texture: *mut c_void, format: PixelFormat, width: u32, height: u32, serial: u64, keep_alive: Option<KeepAlive>, ) -> Result<Self, InvalidHandleError>

Wrap a MediaCodec output buffer together with the SurfaceTexture it will be rendered into. Borrowing: the handle is stored non-owningly, this type has no Drop, and every obligation below extends to each Clone.

§Safety
  • buffer must point to a live, not yet released MediaCodec output buffer — an AVMediaCodecBuffer* from FFmpeg’s mediacodec hwaccel, or the AMediaCodecBufferInfo* of an NDK-dequeued output index. The import path hands it to av_mediacodec_release_buffer / AMediaCodec_releaseOutputBuffer with render = true to push the frame onto the surface, so a buffer that was already released is a double release. Null is rejected as InvalidHandleError::NullPointer and is not a caller obligation.
  • Each buffer may be wrapped once. Rendering is a one-shot consuming act on the codec’s side; because this newtype is Clone and takes no ownership, two live carriers naming the same buffer will each try to release it.
  • surface_texture must be a JNI global reference (not a local ref, which is invalid outside the JNI frame that made it) to the android.graphics.SurfaceTexture that backs the Surface this codec was configured with. It is not null-checked here.
  • width, height and format must describe the frame the codec will render; the importer sizes its destination texture from them.
  • Thread affinity — the sharp edge. MediaCodecFrame is Send + Sync, but SurfaceTexture.updateTexImage() is only legal on a thread with the OES texture’s GL context current, and only one updateTexImage may be in flight per texture. The caller asserts the consumer will be driven from such a thread, and that serial is monotonically increasing so the importer can detect out-of-order or repeated presentation.
  • Lifetime: nothing is retained and there is no Drop. The codec, its output surface and the SurfaceTexture global ref must all outlive this value and every Clone of it — keep_alive exists to anchor them.
Source

pub fn buffer(&self) -> *mut c_void

Source

pub fn surface_texture(&self) -> *mut c_void

Source

pub fn format(&self) -> PixelFormat

Source

pub fn width(&self) -> u32

Source

pub fn height(&self) -> u32

Source

pub fn serial(&self) -> u64

Source

pub fn keep_alive(&self) -> Option<&KeepAlive>

Trait Implementations§

Source§

impl Clone for MediaCodecFrame

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MediaCodecFrame

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Send for MediaCodecFrame

Source§

impl Sync for MediaCodecFrame

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

Source§

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,