version 0.5.0

Author: shssoichiro

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 0.5.0
+
+- [Breaking] Change the `copy_from_u8_slice_with_stride` to take stride in bytes instead of in pixels.
+  This seems to be the more common case from other APIs, and it also addresses a theoretical edge case
+  where stride may not be a multiple of byte depth.
+
 ## Version 0.4.2
 
 - Improve performance of `rows` iterators

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "v_frame"
-version = "0.4.2"
+version = "0.5.0"
 rust-version = "1.85.0"
 description = "Video Frame data structures, originally part of rav1e"
 license = "BSD-2-Clause"

src/plane.rs

@@ -280,12 +280,16 @@ where
     ///   this plane's `width * height * bytes_per_pixel`
     #[inline]
     pub fn copy_from_u8_slice(&mut self, src: &[u8]) -> Result<(), Error> {
-        self.copy_from_u8_slice_with_stride(src, self.width())
+        self.copy_from_u8_slice_with_stride(
+            src,
+            self.width()
+                .saturating_mul(NonZeroUsize::new(size_of::<T>()).expect("size can't be zero")),
+        )
     }
 
     /// Copies the data from `src` into this plane's visible pixels.
     /// This version accepts inputs where the row stride is longer than the visible data width.
-    /// The `input_stride` must be in pixels.
+    /// The `input_stride` must be in bytes.
     ///
     /// # Errors
     /// - Returns `Error::Datalength` if the length of `src` does not match
@@ -310,7 +314,7 @@ where
             });
         }
 
-        let byte_count = input_stride.get() * self.height().get() * byte_width;
+        let byte_count = input_stride.get() * self.height().get();
         if byte_count != src.len() {
             return Err(Error::DataLength {
                 expected: byte_count,
@@ -334,7 +338,7 @@ where
             // u16 pixels - need to convert from little-endian bytes
             let row_byte_width = width * byte_width;
             for (row_idx, dest_row) in self.rows_mut().enumerate() {
-                let src_offset = row_idx * stride * byte_width;
+                let src_offset = row_idx * stride;
                 let src_row = &src[src_offset..src_offset + row_byte_width];
 
                 for (dest_pixel, src_chunk) in dest_row.iter_mut().zip(src_row.chunks_exact(2)) {

src/plane/tests.rs

@@ -440,7 +440,7 @@ fn copy_from_u8_slice_with_stride_u16() {
         0x02, 0x01, 0x04, 0x03, 0xFF, 0xFF,  // Row 0
         0x06, 0x05, 0x08, 0x07, 0xFF, 0xFF,  // Row 1
     ];
-    let stride = NonZeroUsize::new(3).unwrap();
+    let stride = NonZeroUsize::new(6).unwrap();
 
     plane.copy_from_u8_slice_with_stride(&data, stride).unwrap();
 
@@ -497,7 +497,7 @@ fn copy_from_u8_slice_with_stride_wrong_length() {
 
     // Should need 3 * 2 * 2 = 12 bytes
     let data = vec![1, 2, 3, 4, 5, 6]; // Only 6 bytes
-    let stride = NonZeroUsize::new(3).unwrap();
+    let stride = NonZeroUsize::new(6).unwrap();
 
     let result = plane.copy_from_u8_slice_with_stride(&data, stride);
     assert!(matches!(result, Err(Error::DataLength { .. })));