Struct VTLowLatencyFrameInterpolationConfiguration 

pub struct VTLowLatencyFrameInterpolationConfiguration { /* private fields */ }

Available on crate features VTFrameProcessor_LowLatencyFrameInterpolation and objc2 only.

Configuration that you use to program Video Toolbox frame processor for low-latency frame interpolation.

This configuration can do either purely temporal interpolation (frame-rate conversion) or temporal and spatial interpolation (scaling and frame-rate conversion). This processor requires a source frame and a previous frame. It does temporal scaling, which interpolates frames between the previous frame and the source frame. When performing both temporal and spatial interpolation, the processor can only perform 2x upscaling, and a single frame of temporal interpolation. When performing spatial scaling, the processor produces upscaled intermediate frames and an upscaled sourceFrame, but it does not upscale the previous reference frame you provided.

Important: When calling VTFrameProcessor/startSessionWithConfiguration:error: to create a VTLowLatencyFrameInterpolation session, ML model loading may take longer than a frame time. Avoid blocking the UI thread or stalling frame rendering pipelines during this call.

See also Apple’s documentation

Implementations

impl VTLowLatencyFrameInterpolationConfiguration

pub unsafe fn initWithFrameWidth_frameHeight_numberOfInterpolatedFrames( this: Allocated<Self>, frame_width: NSInteger, frame_height: NSInteger, number_of_interpolated_frames: NSInteger, ) -> Option<Retained<Self>>

Creates a new low-latency frame interpolation configuration for frame-rate conversion.

The available interpolation points are the equal to the value of (2^x - 1), where x is equal to numberOfInterpolatedFrames. For example,

• If you request 1 interpolated frame, 1 interpolation point at 0.5 is available.

• If you request 2 interpolated frames, 3 interpolation points at 0.25, 0.5 and 0.75 are available. You don’t need to use all available interpolation points. Setting a higher numberOfInterpolatedFrames increases the resolution of interpolation in some cases, but also increases latency.

• Parameters:

• frameWidth: Width of source frame in pixels.

• frameHeight: Height of source frame in pixels.

• numberOfInterpolatedFrames: The number of uniformly spaced frames that you want to be used for interpolation.

pub unsafe fn initWithFrameWidth_frameHeight_spatialScaleFactor( this: Allocated<Self>, frame_width: NSInteger, frame_height: NSInteger, spatial_scale_factor: NSInteger, ) -> Option<Retained<Self>>

Creates a new low-latency frame interpolation configuration for spatial scaling and temporal scaling.

When you configure the processor for spatial scaling, the low-latency frame interpolation processor only supports 2x spatial upscaling and a single frame of temporal interpolation at a 0.5 interpolation phase.

• Parameters:
• frameWidth: Width of source frame in pixels.
• frameHeight: Height of source frame in pixels.
• spatialScaleFactor: The requested spatial scale factor as an integer. Currently, the processor supports only 2x spatial scaling.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

pub unsafe fn frameWidth(&self) -> NSInteger

Width of source frames in pixels.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn frameHeight(&self) -> NSInteger

Height of source frames in pixels.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn spatialScaleFactor(&self) -> NSInteger

Configured spatial scale factor as an integer.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn numberOfInterpolatedFrames(&self) -> NSInteger

Number of uniformly spaced frames for which you configured the processor.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn frameSupportedPixelFormats(&self) -> Retained<NSArray<NSNumber>>

Available on crate feature objc2-foundation only.

Available supported pixel formats for current configuration.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn sourcePixelBufferAttributes( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

Available on crate feature objc2-foundation only.

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent source frames and reference frames.

Use CVPixelBufferCreateResolvedAttributesDictionary to combine this dictionary with your pixel buffer attributes dictionary.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn destinationPixelBufferAttributes( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

Available on crate feature objc2-foundation only.

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent destination frames.

Use CVPixelBufferCreateResolvedAttributesDictionary to combine this dictionary with your pixel buffer attributes dictionary.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn isSupported() -> bool

Reports whether the system supports this processor.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for VTLowLatencyFrameInterpolationConfiguration

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for VTLowLatencyFrameInterpolationConfiguration

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<VTLowLatencyFrameInterpolationConfiguration> for VTLowLatencyFrameInterpolationConfiguration

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for VTLowLatencyFrameInterpolationConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for VTLowLatencyFrameInterpolationConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for VTLowLatencyFrameInterpolationConfiguration

const NAME: &'static str = "VTLowLatencyFrameInterpolationConfiguration"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<VTLowLatencyFrameInterpolationConfiguration as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for VTLowLatencyFrameInterpolationConfiguration

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

Formats the value using the given formatter.

impl Deref for VTLowLatencyFrameInterpolationConfiguration

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for VTLowLatencyFrameInterpolationConfiguration

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for VTLowLatencyFrameInterpolationConfiguration

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for VTLowLatencyFrameInterpolationConfiguration

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for VTLowLatencyFrameInterpolationConfiguration

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for VTLowLatencyFrameInterpolationConfiguration

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl VTFrameProcessorConfiguration for VTLowLatencyFrameInterpolationConfiguration

unsafe fn isSupported() -> bool

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

Returns a Boolean indicating whether the system supports this processor on the current configuration.

unsafe fn frameSupportedPixelFormats(&self) -> Retained<NSArray<NSNumber>>

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-foundation only.

List of supported pixel formats for source frames for the current configuration.

unsafe fn sourcePixelBufferAttributes( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-foundation only.

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent source frames and reference frames.

unsafe fn destinationPixelBufferAttributes( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-foundation only.

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent destination frames.

unsafe fn nextFrameCount(&self) -> NSInteger

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

Returns the number of “next” frames that this processor requires for processing.

unsafe fn previousFrameCount(&self) -> NSInteger

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

Returns the number of “previous” frames that this processor requires for processing.

unsafe fn maximumDimensions() -> CMVideoDimensions

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-core-media only.

Returns the maximum dimensions for a sourceFrame for the processor.

unsafe fn minimumDimensions() -> CMVideoDimensions

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-core-media only.

Returns the minimum dimensions for a sourceFrame for the processor.

impl DowncastTarget for VTLowLatencyFrameInterpolationConfiguration

impl Eq for VTLowLatencyFrameInterpolationConfiguration

impl Send for VTLowLatencyFrameInterpolationConfiguration

impl Sync for VTLowLatencyFrameInterpolationConfiguration