objc2_vision/generated/

VNRequestHandler.rs

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-core-graphics")]
use objc2_core_graphics::*;
#[cfg(feature = "objc2-core-image")]
use objc2_core_image::*;
#[cfg(feature = "objc2-core-media")]
use objc2_core_media::*;
#[cfg(feature = "objc2-core-video")]
use objc2_core_video::*;
use objc2_foundation::*;

use crate::*;

/// Options keys passed into the VNImageRequestHandler creations or requests that take an auxiliary image. These are options that either describe specific properties of an image like the VNImageOptionCameraIntrinsics or how an image needs to be handled like the VNImageOptionCIContext.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnimageoption?language=objc)
// NS_TYPED_ENUM
pub type VNImageOption = NSString;

extern "C" {
    /// VNImageOptionProperties is the dictionary from CGImageSourceCopyPropertiesAtIndex. This contains metadata that can be used by some algorithms like horizon detection.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnimageoptionproperties?language=objc)
    pub static VNImageOptionProperties: &'static VNImageOption;
}

extern "C" {
    /// VNImageOptionCameraIntrinsics  Specifies the camera intrinsics as an NSData or CFData representing a matrix_float3x3. See kCMSampleBufferAttachmentKey_CameraIntrinsicMatrix for details
    ///
    /// Camera intrinsic matrix is a CFData containing a matrix_float3x3, which is column-major. It has the following contents:
    /// fx    0    ox
    /// 0    fy    oy
    /// 0    0    1
    /// fx and fy are the focal length in pixels. For square pixels, they will have the same value.
    /// ox and oy are the coordinates of the principal point. The origin is the upper left of the frame.
    ///
    /// Note: When using a CMSampleBuffer as an input and that sample buffer has camera intrinsics attached to it, Vision will use the camera intrinsic from there unless overwritten by passing in as an explicit option which will take precedence.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnimageoptioncameraintrinsics?language=objc)
    pub static VNImageOptionCameraIntrinsics: &'static VNImageOption;
}

extern "C" {
    /// VNImageOptionCIContext  Specifies the CIContext to be used in Core Image operations of request handler. If this is not specified, Vision will create its own CIContext. This option is helpful when the passed in CIImage is the result of a CIFilter chain that has been executed on a CIContext or uses outputs of a CIImage on a given CIContext as they don't have to transfer to other contexts.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnimageoptioncicontext?language=objc)
    pub static VNImageOptionCIContext: &'static VNImageOption;
}

extern_class!(
    /// Performs requests on a single image.
    ///
    /// The VNImageRequestHandler is created with an image that is used to be used for the requests a client might want to schedule. The VNImageRequestHandler retains, but never modifies, the image source for its entire lifetime. The client also must not modify the content of the image source once the VNImageRequestHandler is created otherwise the results are undefined.
    /// The VNImageRequestHandler can choose to also cache intermediate representation of the image or other request-specific information for the purposes of runtime performance.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnimagerequesthandler?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct VNImageRequestHandler;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for VNImageRequestHandler {}
);

impl VNImageRequestHandler {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[cfg(feature = "objc2-core-video")]
        /// initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.
        ///
        ///
        /// Parameter `pixelBuffer`: A CVPixelBuffer containing the image to be used for performing the requests. The content of the buffer cannot be modified for the lifetime of the VNImageRequestHandler.
        ///
        /// Parameter `options`: A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics
        #[unsafe(method(initWithCVPixelBuffer:options:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCVPixelBuffer_options(
            this: Allocated<Self>,
            pixel_buffer: &CVPixelBuffer,
            options: &NSDictionary<VNImageOption, AnyObject>,
        ) -> Retained<Self>;

        #[cfg(feature = "objc2-core-graphics")]
        /// initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.
        ///
        ///
        /// Parameter `image`: A CGImageRef containing the image to be used for performing the requests. The content of the image cannot be modified.
        ///
        /// Parameter `options`: A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics
        #[unsafe(method(initWithCGImage:options:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCGImage_options(
            this: Allocated<Self>,
            image: &CGImage,
            options: &NSDictionary<VNImageOption, AnyObject>,
        ) -> Retained<Self>;

        #[cfg(feature = "objc2-core-image")]
        /// initWithCIImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage.
        ///
        ///
        /// Parameter `image`: A CIImage containing the image to be used for performing the requests. The content of the image cannot be modified.
        ///
        /// Parameter `options`: A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics
        ///
        ///
        /// Note: :  Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator. The orientation of the original image should be applied for instance by using imageByApplyingOrientation or use the initWithCIImage:options:orientation API.
        #[unsafe(method(initWithCIImage:options:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCIImage_options(
            this: Allocated<Self>,
            image: &CIImage,
            options: &NSDictionary<VNImageOption, AnyObject>,
        ) -> Retained<Self>;

        /// initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL
        ///
        ///
        /// Parameter `imageURL`: A URL pointing at an image to be used for performing the requests. The image has to be in a format that is supported by ImageIO. The content of the image cannot be modified.
        ///
        /// Parameter `options`: A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics
        ///
        ///
        /// Note: :  Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        #[unsafe(method(initWithURL:options:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithURL_options(
            this: Allocated<Self>,
            image_url: &NSURL,
            options: &NSDictionary<VNImageOption, AnyObject>,
        ) -> Retained<Self>;

        /// initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object.
        ///
        ///
        /// Parameter `imageData`: An NSData object containing the content of the image to be used for performing the requests. See CIImage imageWithData for supported format. The content of the image cannot be modified.
        ///
        /// Parameter `options`: A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics
        ///
        ///
        /// Note: :  Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        #[unsafe(method(initWithData:options:))]
        #[unsafe(method_family = init)]
        pub fn initWithData_options(
            this: Allocated<Self>,
            image_data: &NSData,
            options: &NSDictionary<VNImageOption, AnyObject>,
        ) -> Retained<Self>;

        #[cfg(feature = "objc2-core-media")]
        /// Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef
        ///
        ///
        /// Parameter `sampleBuffer`: A CMSampleBuffer containing the imageBuffer that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.
        ///
        /// Parameter `options`: A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics
        ///
        /// Note: CMSampleBuffers can contain metadata like camera intrinsics that will be used by algorithms supporting it unless overwritten by the options.
        #[unsafe(method(initWithCMSampleBuffer:options:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCMSampleBuffer_options(
            this: Allocated<Self>,
            sample_buffer: &CMSampleBuffer,
            options: &NSDictionary<VNImageOption, AnyObject>,
        ) -> Retained<Self>;

        #[cfg(feature = "VNRequest")]
        /// performRequests schedules one or more VNRequests to be performed. The function returns once all requests have been finished.
        ///
        ///
        /// The results of the VNRequests as well any possible errors of the individual requests are reported in the VNRequests results and error properties.
        ///
        ///
        /// Parameter `requests`: An NSArray of VNRequests that are to be performed.
        ///
        /// Parameter `error`: Returns an error that happened during scheduling of the requests. Check individual requests results and errors for their respective success and failures. This parameter is optional.
        ///
        /// Returns: Returns true if all requests were scheduled and performed. Check individual requests results and errors for their respective success and failures.
        #[unsafe(method(performRequests:error:_))]
        #[unsafe(method_family = none)]
        pub fn performRequests_error(
            &self,
            requests: &NSArray<VNRequest>,
        ) -> Result<(), Retained<NSError>>;
    );
}

/// Methods declared on superclass `NSObject`.
impl VNImageRequestHandler {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

extern_class!(
    /// Performs requests on a sequence of images.
    ///
    /// The VNSequenceRequestHandler is created without any specific image source.  The -performRequests:on
    /// <ImageSource
    /// >:error: methods will retain the image source for no longer than the lifetime of the call.
    /// The VNSequenceRequestHandler can choose to also cache state information related to the previously-processed image sources.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnsequencerequesthandler?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct VNSequenceRequestHandler;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for VNSequenceRequestHandler {}
);

impl VNSequenceRequestHandler {
    extern_methods!(
        /// Creates a new object.
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[cfg(all(feature = "VNRequest", feature = "objc2-core-video"))]
        /// Perform requests on an image in a CVPixelBuffer.
        ///
        ///
        /// Parameter `requests`: The VNRequests to be performed on the image.
        ///
        ///
        /// Parameter `pixelBuffer`: The CVPixelBuffer containing the image to be processed.
        ///
        ///
        /// Parameter `error`: On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify NULL for this parameter if you do not want the error information.
        #[unsafe(method(performRequests:onCVPixelBuffer:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn performRequests_onCVPixelBuffer_error(
            &self,
            requests: &NSArray<VNRequest>,
            pixel_buffer: &CVPixelBuffer,
        ) -> Result<(), Retained<NSError>>;

        #[cfg(all(feature = "VNRequest", feature = "objc2-core-graphics"))]
        /// Perform requests on an image in a CGImageRef.
        ///
        ///
        /// Parameter `requests`: The VNRequests to be performed on the image.
        ///
        ///
        /// Parameter `image`: The CGImageRef containing the image to be processed.
        ///
        ///
        /// Parameter `error`: On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify NULL for this parameter if you do not want the error information.
        #[unsafe(method(performRequests:onCGImage:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn performRequests_onCGImage_error(
            &self,
            requests: &NSArray<VNRequest>,
            image: &CGImage,
        ) -> Result<(), Retained<NSError>>;

        #[cfg(all(feature = "VNRequest", feature = "objc2-core-image"))]
        /// Perform requests on an image in a CIImage.
        ///
        ///
        /// Parameter `requests`: The VNRequests to be performed on the image.
        ///
        ///
        /// Parameter `image`: The CIImage containing the image to be processed.
        ///
        ///
        /// Parameter `error`: On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify NULL for this parameter if you do not want the error information.
        #[unsafe(method(performRequests:onCIImage:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn performRequests_onCIImage_error(
            &self,
            requests: &NSArray<VNRequest>,
            image: &CIImage,
        ) -> Result<(), Retained<NSError>>;

        #[cfg(feature = "VNRequest")]
        /// Perform requests on an image referenced by an URL.
        ///
        ///
        /// Parameter `requests`: The VNRequests to be performed on the image.
        ///
        ///
        /// Parameter `imageURL`: The URL of the image to be processed.  If this is not a file-based URL, the method will fail.
        ///
        ///
        /// Parameter `error`: On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify NULL for this parameter if you do not want the error information.
        #[unsafe(method(performRequests:onImageURL:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn performRequests_onImageURL_error(
            &self,
            requests: &NSArray<VNRequest>,
            image_url: &NSURL,
        ) -> Result<(), Retained<NSError>>;

        #[cfg(feature = "VNRequest")]
        /// Perform requests on an image with its source format in memory.
        ///
        ///
        /// Parameter `requests`: The VNRequests to be performed on the image.
        ///
        ///
        /// Parameter `imageData`: The data representing the source format of the image to be processed.
        ///
        ///
        /// Parameter `error`: On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify NULL for this parameter if you do not want the error information.
        #[unsafe(method(performRequests:onImageData:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn performRequests_onImageData_error(
            &self,
            requests: &NSArray<VNRequest>,
            image_data: &NSData,
        ) -> Result<(), Retained<NSError>>;

        #[cfg(all(feature = "VNRequest", feature = "objc2-core-media"))]
        /// Perform requests on the image buffer contained in the CMSampleBufferRef.
        ///
        ///
        /// Parameter `requests`: The VNRequests to be performed on the image.
        ///
        ///
        /// Parameter `sampleBuffer`: A CMSampleBuffer containing an image that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.
        ///
        ///
        /// Parameter `error`: On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify NULL for this parameter if you do not want the error information.
        #[unsafe(method(performRequests:onCMSampleBuffer:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn performRequests_onCMSampleBuffer_error(
            &self,
            requests: &NSArray<VNRequest>,
            sample_buffer: &CMSampleBuffer,
        ) -> Result<(), Retained<NSError>>;
    );
}

/// Methods declared on superclass `NSObject`.
impl VNSequenceRequestHandler {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}