videotoolbox 0.16.0

Safe Rust bindings for Apple's VideoToolbox framework — hardware H.264/HEVC/ProRes encode and decode on macOS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

#![doc = include_str!("../README.md")]
//!
//! ---
//!
//! # API Documentation
//!
//! Safe, **zero-runtime-dependency** Rust bindings for Apple's
//! [VideoToolbox](https://developer.apple.com/documentation/videotoolbox)
//! framework — hardware-accelerated H.264, HEVC, and `ProRes` codecs on macOS.
//!
//! Most of the crate uses direct `extern "C"` bindings against the system
//! framework. Objective-C-only / async APIs (notably `VTFrameProcessor`,
//! `VTMotionEstimationSession`, and `VTRAWProcessingSession`) use a small Swift
//! bridge behind the `frame_processor` feature.
//!
//! # Quick start
//!
//! ```rust,no_run
//! use videotoolbox::prelude::*;
//! use apple_cf::iosurface::IOSurface;
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let surface = IOSurface::create(1920, 1080, u32::from_be_bytes(*b"BGRA"), 4)
//!     .ok_or("failed to allocate IOSurface")?;
//!
//! let encoder = CompressionSession::builder(1920, 1080, Codec::H264)
//!     .with_real_time(true)
//!     .with_average_bit_rate(8_000_000)
//!     .with_expected_frame_rate(60.0)
//!     .build()?;
//!
//! let encoded = encoder.encode(&surface, (0, 60))?;
//! println!("Got {} bytes of H.264", encoded.data.len());
//! # Ok(())
//! # }
//! ```

#![cfg_attr(docsrs, feature(doc_cfg))]

pub mod error;
pub mod ffi;
pub mod session;
pub mod tagged_buffer_group;

#[cfg(feature = "compression")]
#[cfg_attr(docsrs, doc(cfg(feature = "compression")))]
pub mod compression;
pub mod decompression;
pub mod encoder_list;
pub mod hdr_metadata;
pub mod multipass;
pub mod transfer;
pub mod utilities;

#[cfg(feature = "frame_processor")]
#[cfg_attr(docsrs, doc(cfg(feature = "frame_processor")))]
pub mod frame_processor;
#[cfg(feature = "frame_processor")]
#[cfg_attr(docsrs, doc(cfg(feature = "frame_processor")))]
pub mod motion_estimation;
#[cfg(feature = "frame_processor")]
#[cfg_attr(docsrs, doc(cfg(feature = "frame_processor")))]
pub mod raw_processing;

pub use decompression::{DecodedFrame, DecodedMultiImageFrame, DecompressionSession};
pub use encoder_list::{
    available_video_encoder_details, available_video_encoder_details_with_options,
    available_video_encoders, supported_property_dictionary_for_encoder,
    EncoderSupportedProperties, VideoEncoder, VideoEncoderDetails, VideoEncoderListOptions,
};
pub use error::VTError;
pub use hdr_metadata::{HdrMetadataFormat, HdrMetadataSession};
pub use multipass::{FrameSilo, MultiPassStorage};
pub use session::Codec;
pub use tagged_buffer_group::TaggedBufferGroup;
pub use transfer::{
    DownsamplingMode, PixelRotationSession, PixelTransferSession, Rotation, ScalingMode,
};
pub use utilities::{
    copy_raw_processor_extension_properties, copy_video_decoder_extension_properties,
    create_cg_image_from_pixel_buffer, is_hardware_decode_supported,
    register_professional_workflow_decoders, register_professional_workflow_encoders,
    register_supplemental_video_decoder_if_available,
};

#[cfg(feature = "frame_processor")]
pub use frame_processor::{
    download_super_resolution_model, download_super_resolution_model_for_configuration,
    frame_processor_capabilities, low_latency_super_resolution_supported_scale_factors,
    super_resolution_model_percentage_available,
    super_resolution_model_percentage_available_for_configuration, super_resolution_model_status,
    super_resolution_model_status_for_configuration, super_resolution_supported_scale_factors,
    FrameProcessor, FrameProcessorCapabilities, FrameProcessorFrame, FrameProcessorOpticalFlow,
    FrameProcessorSubmissionMode, FrameRateConversionConfiguration,
    FrameRateConversionSubmissionMode, MotionBlurConfiguration, OpticalFlowConfiguration,
    SuperResolutionConfiguration, SuperResolutionModelStatus,
    VTFrameRateConversionConfigurationQualityPrioritization,
    VTFrameRateConversionConfigurationRevision, VTMotionBlurConfigurationQualityPrioritization,
    VTMotionBlurConfigurationRevision, VTOpticalFlowConfigurationQualityPrioritization,
    VTOpticalFlowConfigurationRevision, VTSuperResolutionScalerConfigurationInputType,
    VTSuperResolutionScalerConfigurationQualityPrioritization,
    VTSuperResolutionScalerConfigurationRevision,
};
#[cfg(feature = "frame_processor")]
pub use motion_estimation::{
    MotionEstimationResult, MotionEstimationSession, MotionEstimationSessionOptions,
};
#[cfg(feature = "frame_processor")]
pub use raw_processing::{RawProcessingParameter, RawProcessingSession};

#[cfg(feature = "compression")]
pub use compression::{CompressionSession, CompressionSessionBuilder, EncodedFrame, ProfileLevel};

/// Common imports for users of this crate.
pub mod prelude {
    pub use crate::error::VTError;
    pub use crate::session::Codec;
    pub use crate::transfer::{PixelRotationSession, PixelTransferSession, Rotation};

    #[cfg(feature = "compression")]
    pub use crate::compression::{CompressionSession, CompressionSessionBuilder, EncodedFrame};
}