turbopipe 1.2.2__cp39-cp39-win_amd64.whl → 1.2.3__cp39-cp39-win_amd64.whl

turbopipe/__init__.py

@@ -4,33 +4,21 @@ from moderngl import Buffer
 
 from turbopipe import _turbopipe
 
+__all__ = [
+    "pipe",
+    "sync",
+    "close"
+]
 
 def pipe(buffer: Union[Buffer, memoryview], fileno: int) -> None:
-    """
-    Pipe the content of a moderngl.Buffer or memoryview to a file descriptor, fast, threaded and
-    blocking when needed. Call `sync(buffer)` before this, and `sync()` when done for
-
-    Usage:
-        ```python
-        # Assuming `buffer = ctx.buffer(...)`
-        # Note: Use as `fbo.read_into(buffer)`
-
-        # As a open() file
-        with open("file.bin", "wb") as file:
-            turbopipe.pipe(buffer, file)
-
-        # As a subprocess
-        child = subprocess.Popen(..., stdin=subprocess.PIPE)
-        turbopipe.pipe(buffer, child.stdin.fileno())
-        ```
-    """
+    """Pipe a buffer contents to a file descriptor, fast and threaded"""
     if isinstance(buffer, Buffer):
         buffer = memoryview(buffer.mglo)
     _turbopipe.pipe(buffer, fileno)
     del buffer
 
 def sync(buffer: Optional[Union[Buffer, memoryview]]=None) -> None:
-    """Waits for any pending write operation on a buffer, or 'all buffers' if None, to finish"""
+    """Wait for pending operations on a buffer to finish"""
     if isinstance(buffer, Buffer):
         buffer = memoryview(buffer.mglo)
     _turbopipe.sync(buffer)
@@ -39,9 +27,3 @@ def sync(buffer: Optional[Union[Buffer, memoryview]]=None) -> None:
 def close() -> None:
     """Syncs and deletes objects"""
     _turbopipe.close()
-
-__all__ = [
-    "pipe",
-    "sync",
-    "close"
-]

{turbopipe-1.2.2.dist-info → turbopipe-1.2.3.dist-info}/METADATA

@@ -1,41 +1,18 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: turbopipe
-Version: 1.2.2
+Version: 1.2.3
 Summary: 🌀 Faster ModernGL Buffers inter-process data transfers for subprocesses
 Author-Email: Tremeschin <29046864+Tremeschin@users.noreply.github.com>
-License: MIT License
-         
-         Copyright (c) 2024 Gabriel Tremeschin
-         
-         Permission is hereby granted, free of charge, to any person obtaining a copy
-         of this software and associated documentation files (the "Software"), to deal
-         in the Software without restriction, including without limitation the rights
-         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-         copies of the Software, and to permit persons to whom the Software is
-         furnished to do so, subject to the following conditions:
-         
-         The above copyright notice and this permission notice shall be included in all
-         copies or substantial portions of the Software.
-         
-         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-         SOFTWARE.
-         
-Project-URL: issues, https://github.com/BrokenSource/TurboPipe/issues
-Project-URL: repository, https://github.com/BrokenSource/TurboPipe
-Project-URL: documentation, https://github.com/BrokenSource/TurboPipe
-Project-URL: homepage, https://brokensrc.dev
+License-Expression: MIT
+Project-URL: GitHub, https://github.com/BrokenSource/TurboPipe
+Project-URL: Changelog, https://brokensrc.dev/about/changelog
+Project-URL: Funding, https://brokensrc.dev/about/sponsors
+Project-URL: Contact, https://brokensrc.dev/about/contact
+Project-URL: Homepage, https://brokensrc.dev
 Requires-Python: >=3.7
 Requires-Dist: moderngl
 Description-Content-Type: text/markdown
 
-> [!IMPORTANT]
-> <sub>Also check out [**ShaderFlow**](https://github.com/BrokenSource/ShaderFlow), where **TurboPipe** shines! 😉</sub>
-<!-- PyPI -->
 <div align="center">
   <a href="https://brokensrc.dev/"><img src="https://raw.githubusercontent.com/BrokenSource/TurboPipe/main/turbopipe/resources/images/turbopipe.png" width="200"></a>
   <h1>TurboPipe</h1>
@@ -57,15 +34,17 @@ Description-Content-Type: text/markdown
 
 The **optimizations** involved are:
 
-- **Zero-copy**: Avoid unnecessary memory copies or allocation (intermediate `buffer.read()`)
+- **Zero-copy**: Avoid unnecessary memory copies or allocation (intermediate `buffer.read`)
 - **C++**: The core of TurboPipe is written in C++ for speed, efficiency and low-level control
-- **Chunks**: Write in chunks of 4096 bytes (RAM page size), so the hardware is happy (Unix)
 - **Threaded**:
     - Doesn't block Python code execution, allows to render next frame
     - Decouples the main thread from the I/O thread for performance
+- **Chunks**: Write in chunks of 4096 bytes (RAM page size), so the hardware is happy (Unix)
 
 ✅ Don't worry, there's proper **safety** in place. TurboPipe will block Python if a memory address is already queued for writing, and guarantees order of writes per file-descriptor. Just call `.sync()` when done 😉
 
+<sub>Also check out [**ShaderFlow**](https://github.com/BrokenSource/ShaderFlow), where **TurboPipe** shines! 😉</sub>
+
 <br>
 
 # 📦 Installation
@@ -90,7 +69,7 @@ rye add turbopipe
 
 # 🚀 Usage
 
-See also the [**Examples**](https://github.com/BrokenSource/TurboPipe/tree/main/examples) folder for comparisons, and [**ShaderFlow**](https://github.com/BrokenSource/ShaderFlow/blob/main/ShaderFlow/Scene.py) usage of it!
+See also the [**Examples**](https://github.com/BrokenSource/TurboPipe/tree/main/examples) folder for comparisons, and [**ShaderFlow**](https://github.com/BrokenSource/ShaderFlow/blob/main/ShaderFlow/Exporting.py)'s usage of it!
 
 ```python
 import subprocess
@@ -98,27 +77,53 @@ import subprocess
 import moderngl
 import turbopipe
 
-# Create ModernGL objects
+# Create ModernGL objects and proxy buffers
 ctx = moderngl.create_standalone_context()
-buffers = [ctx.buffer(reserve=1920*1080*3) for _ in range(2)]
+width, height, duration, fps = (1920, 1080, 10, 60)
+buffers = [
+    ctx.buffer(reserve=(width*height*3))
+    for _ in range(nbuffers := 2)
+]
+
+# Create your FBO, Textures, Shaders, etc.
 
 # Make sure resolution, pixel format matches!
-ffmpeg = subprocess.Popen(
-    'ffmpeg -f rawvideo -pix_fmt rgb24 -r 60 -s 1920x1080 -i - -f null -'.split(),
-    stdin=subprocess.PIPE
-)
-
-# Rendering loop of yours (eg. 1m footage)
-for frame in range(60 * 60):
-    buffer = buffers[frame % len(buffer)]
+ffmpeg = subprocess.Popen((
+    "ffmpeg",
+    "-f", "rawvideo",
+    "-pix_fmt", "rgb24",
+    "-r", str(fps),
+    "-s", f"{width}x{height}",
+    "-i", "-",
+    "-f", "null",
+    "output.mp4"
+), stdin=subprocess.PIPE)
+
+# Rendering loop of yours
+for frame in range(duration*fps):
+    buffer = buffers[frame % nbuffers]
+
+    # Wait queued writes before copying
     turbopipe.sync(buffer)
     fbo.read_into(buffer)
+
+    # Doesn't lock the GIL, writes in parallel
     turbopipe.pipe(buffer, ffmpeg.stdin.fileno())
 
-# Finalize writing, encoding
+# Wait for queued writes, clean memory
+for buffer in buffers:
+    turbopipe.sync(buffer)
+    buffer.release()
+
+# Signal stdin stream is done
 ffmpeg.stdin.close()
-turbopipe.close()
+
+# wait for encoding to finish
 ffmpeg.wait()
+
+# Warn: Albeit rare, only call close when no other data
+# write is pending, as it might skip a frame or halt
+turbopipe.close()
 ```
 
 <br>
@@ -370,5 +375,5 @@ On realistically loads, like [**ShaderFlow**](https://github.com/BrokenSource/Sh
 # 📚 Future work
 
 - Disable/investigate performance degradation on Windows iGPUs
-- Improve the thread synchronization and/or use a ThreadPool
 - Maybe use `mmap` instead of chunks writing on Linux
+- Split the code into a libturbopipe? Not sure where it would be useful 😅

turbopipe-1.2.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+turbopipe-1.2.3.dist-info/METADATA,sha256=MdldXjJ_g4d1H7thMGPxOrXbTYj3LiWFE3KaMJTACUw,21140
+turbopipe-1.2.3.dist-info/WHEEL,sha256=8AdrFzOtKQ6LLJ-VyqCU3y1iN8N--fMXYqrdkeTKDn0,83
+turbopipe/_turbopipe.cp39-win_amd64.pyd,sha256=rbkw-oQErmmzkev2gb64I56Ihym8jFSgNvqISr_0gVI,35328
+turbopipe/_turbopipe.cp39-win_amd64.lib,sha256=IlfSQHen9PesR7TShHNTpDYm0JdiZkUKEvBG5n6r9wA,2052
+turbopipe/__init__.py,sha256=-dDOggd5gJ67k7Mv_GowhRegxEZFV4qzTvEPJOCTE-A,774
+turbopipe-1.2.3.dist-info/RECORD,,

turbopipe-1.2.2.dist-info/License.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Gabriel Tremeschin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

turbopipe-1.2.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-turbopipe-1.2.2.dist-info/METADATA,sha256=wOFE8tKTn_jt4GJJVbWkrIGfJZSQbGUuq-vyMA4z2_E,21819
-turbopipe-1.2.2.dist-info/WHEEL,sha256=8AdrFzOtKQ6LLJ-VyqCU3y1iN8N--fMXYqrdkeTKDn0,83
-turbopipe-1.2.2.dist-info/License.md,sha256=s3HF089BzBa_7DenpGj5kPHBu-XhGLP6gRzhhhLXLls,1096
-turbopipe/_turbopipe.cp39-win_amd64.pyd,sha256=4FdM75NT5jscGGeW64X306klC4lygiv8PIXHbyjKgvw,35840
-turbopipe/_turbopipe.cp39-win_amd64.lib,sha256=q3cpTY96pvOAJVAaG6LWkTBdOvMBFSp2G0QyqCE5jIc,2052
-turbopipe/__init__.py,sha256=D0FP-CR87qJeLGv_VYCGRcwdONFhBYt02D2bm4Xdax4,1346
-turbopipe-1.2.2.dist-info/RECORD,,