Android: Hold the locked buffer in AndroidImpl until it is presented via BufferImpl

Author: MarijnS95

src/backends/android.rs

@@ -17,11 +17,16 @@ use crate::{BufferInterface, Pixel, Rect, SoftBufferError, SurfaceInterface};
 /// The handle to a window for software buffering.
 #[derive(Debug)]
 pub struct AndroidImpl<D, W> {
+    // Must be first in the struct to guarantee being dropped and unlocked before the `NativeWindow` reference
+    in_progress_buffer: Option<NativeWindowBufferLockGuard<'static>>,
     native_window: NativeWindow,
     window: W,
     _display: PhantomData<D>,
 }
 
+// TODO: Move to NativeWindowBufferLockGuard?
+unsafe impl<D, W> Send for AndroidImpl<D, W> {}
+
 impl<D: HasDisplayHandle, W: HasWindowHandle> SurfaceInterface<D, W> for AndroidImpl<D, W> {
     type Context = D;
     type Buffer<'surface>
@@ -41,6 +46,7 @@ impl<D: HasDisplayHandle, W: HasWindowHandle> SurfaceInterface<D, W> for Android
         let native_window = unsafe { NativeWindow::clone_from_ptr(a.a_native_window.cast()) };
 
         Ok(Self {
+            in_progress_buffer: None,
             native_window,
             _display: PhantomData,
             window,
@@ -77,6 +83,12 @@ impl<D: HasDisplayHandle, W: HasWindowHandle> SurfaceInterface<D, W> for Android
     }
 
     fn buffer_mut(&mut self) -> Result<BufferImpl<'_>, SoftBufferError> {
+        if self.in_progress_buffer.is_some() {
+            return Ok(BufferImpl {
+                native_window_buffer: &mut self.in_progress_buffer,
+            });
+        }
+
         let native_window_buffer = self.native_window.lock(None).map_err(|err| {
             SoftBufferError::PlatformError(
                 Some("Failed to lock ANativeWindow".to_owned()),
@@ -99,8 +111,19 @@ impl<D: HasDisplayHandle, W: HasWindowHandle> SurfaceInterface<D, W> for Android
             ));
         }
 
+        // SAFETY: We guarantee that the guard isn't actually held longer than this owned handle of
+        // the `NativeWindow` (which is trivially cloneable), by means of having BufferImpl take a
+        // mutable borrow on AndroidImpl which owns the NativeWindow and LockGuard.
+        let native_window_buffer = unsafe {
+            std::mem::transmute::<
+                NativeWindowBufferLockGuard<'_>,
+                NativeWindowBufferLockGuard<'static>,
+            >(native_window_buffer)
+        };
+        self.in_progress_buffer = Some(native_window_buffer);
+
         Ok(BufferImpl {
-            native_window_buffer,
+            native_window_buffer: &mut self.in_progress_buffer,
         })
     }
 
@@ -112,28 +135,29 @@ impl<D: HasDisplayHandle, W: HasWindowHandle> SurfaceInterface<D, W> for Android
 
 #[derive(Debug)]
 pub struct BufferImpl<'surface> {
-    native_window_buffer: NativeWindowBufferLockGuard<'surface>,
+    // This Option will always be Some until present_with_damage() is called
+    native_window_buffer: &'surface mut Option<NativeWindowBufferLockGuard<'static>>,
 }
 
 // TODO: Move to NativeWindowBufferLockGuard?
 unsafe impl Send for BufferImpl<'_> {}
 
 impl BufferInterface for BufferImpl<'_> {
     fn byte_stride(&self) -> NonZeroU32 {
-        NonZeroU32::new(self.native_window_buffer.stride() as u32 * 4).unwrap()
+        NonZeroU32::new(self.native_window_buffer.as_ref().unwrap().stride() as u32 * 4).unwrap()
     }
 
     fn width(&self) -> NonZeroU32 {
-        NonZeroU32::new(self.native_window_buffer.width() as u32).unwrap()
+        NonZeroU32::new(self.native_window_buffer.as_ref().unwrap().width() as u32).unwrap()
     }
 
     fn height(&self) -> NonZeroU32 {
-        NonZeroU32::new(self.native_window_buffer.height() as u32).unwrap()
+        NonZeroU32::new(self.native_window_buffer.as_ref().unwrap().height() as u32).unwrap()
     }
 
     #[inline]
     fn pixels_mut(&mut self) -> &mut [Pixel] {
-        let native_buffer = self.native_window_buffer.bytes().unwrap();
+        let native_buffer = self.native_window_buffer.as_mut().unwrap().bytes().unwrap();
         // assert_eq!(
         //     native_buffer.len(),
         //     self.native_window_buffer.stride() * self.native_window_buffer.height()
@@ -168,6 +192,7 @@ impl BufferInterface for BufferImpl<'_> {
 
         // The surface will be presented when it is unlocked, which happens when the owned guard
         // is dropped.
+        self.native_window_buffer.take();
 
         Ok(())
     }