Add safety documentation for pointer methods in audio, video, and frame modules

Author: animafps

rustsynth/src/format/audio.rs

@@ -73,6 +73,8 @@ pub struct AudioFormat {
 }
 
 impl AudioInfo {
+    /// # Safety
+    /// The pointer must be valid and point to a [ffi::VSAudioInfo]
     pub unsafe fn from_ptr(from: *const ffi::VSAudioInfo) -> Self {
         let from = &*from;
         Self {
@@ -94,6 +96,8 @@ impl AudioInfo {
 }
 
 impl AudioFormat {
+    /// # Safety
+    /// The pointer must be valid and point to a [ffi::VSAudioFormat]
     pub unsafe fn from_ptr(from: *const ffi::VSAudioFormat) -> Self {
         let from = &*from;
         let sample_type = if from.sampleType == 0 {

rustsynth/src/format/video.rs

@@ -5,6 +5,8 @@ use crate::{
 use rustsynth_sys as ffi;
 
 impl VideoFormat {
+    /// # Safety
+    /// The pointer must be valid and point to a [ffi::VSVideoFormat]
     pub unsafe fn from_ptr(from: *const ffi::VSVideoFormat) -> Self {
         let info = &*from;
 
@@ -149,6 +151,8 @@ impl VideoFormat {
 }
 
 impl VideoInfo {
+    /// # Safety
+    /// The pointer must be valid and point to a [ffi::VSVideoInfo]
     pub unsafe fn from_ptr(from: *const ffi::VSVideoInfo) -> Self {
         let from = &*from;
 

rustsynth/src/frame/mod.rs

@@ -40,7 +40,7 @@ impl FrameContext {
     /// Creates a FrameContext from a raw pointer.
     ///
     /// # Safety
-    /// The pointer must be valid and point to a `VSFrameContext`.
+    /// The pointer must be valid and point to a [ffi::VSFrameContext].
     #[inline]
     pub unsafe fn from_ptr(ptr: *mut ffi::VSFrameContext) -> Self {
         Self {
@@ -65,6 +65,8 @@ impl FrameContext {
 }
 
 impl<'core> Frame<'core> {
+    /// # Safety
+    /// The pointer must be valid and point to a [ffi::VSFrame]
     #[inline]
     pub unsafe fn from_ptr(ptr: *const ffi::VSFrame) -> Self {
         Self {
@@ -217,13 +219,13 @@ impl<'core> Frame<'core> {
     }
 
     /// Get read-only access to plane data
-    #[inline]
+    #[inline(always)]
     pub fn get_read_ptr(&self, plane: i32) -> *const u8 {
         unsafe { API::get_cached().get_frame_read_ptr(self.handle.as_ref(), plane) }
     }
 
     /// Get mutable access to plane data (only for owned frames)
-    #[inline]
+    #[inline(always)]
     pub fn get_write_ptr(&mut self, plane: i32) -> *mut u8 {
         unsafe { API::get_cached().get_frame_write_ptr(self.handle.as_ptr(), plane) }
     }

rustsynth/src/map/mod.rs

@@ -162,8 +162,8 @@ impl<'elem> OwnedMap<'elem> {
         }
     }
 
-    pub fn as_ptr(&self) -> *mut ffi::VSMap {
-        self.handle.as_ptr()
+    pub const fn as_ptr(&self) -> *mut ffi::VSMap {
+        self.map.as_ptr()
     }
 }
 
@@ -231,6 +231,10 @@ impl<'elem> Default for OwnedMap<'elem> {
 }
 
 impl<'elem> Map<'elem> {
+    pub const fn as_ptr(&self) -> *mut ffi::VSMap {
+        self.handle.as_ptr()
+    }
+
     /// Wraps pointer into `Map`.
     ///
     /// # Safety