turbopipe 1.0.5__cp38-cp38-win_amd64.whl → 1.2.0__cp38-cp38-win_amd64.whl

turbopipe/__init__.py

@@ -1,14 +1,14 @@
-from io import IOBase
+from typing import Optional, Union
 
 from moderngl import Buffer
 
 from turbopipe import _turbopipe
 
 
-def pipe(buffer: Buffer, file: IOBase) -> None:
+def pipe(buffer: Union[Buffer, memoryview], fileno: int) -> None:
     """
-    Pipe the content of a moderngl.Buffer to a file descriptor,
-    Fast, threaded and non-blocking. Call `sync()` when done!
+    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
@@ -24,11 +24,17 @@ def pipe(buffer: Buffer, file: IOBase) -> None:
         turbopipe.pipe(buffer, child.stdin.fileno())
         ```
     """
-    _turbopipe.pipe(buffer.mglo, file)
-
-def sync() -> None:
-    """Waits for all jobs to finish"""
-    _turbopipe.sync()
+    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"""
+    if isinstance(buffer, Buffer):
+        buffer = memoryview(buffer.mglo)
+    _turbopipe.sync(buffer)
+    del buffer
 
 def close() -> None:
     """Syncs and deletes objects"""

{turbopipe-1.0.5.dist-info → turbopipe-1.2.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: turbopipe
-Version: 1.0.5
-Summary: 🌀 Faster ModernGL Buffer inter process data transfers
+Version: 1.2.0
+Summary: 🌀 Faster MemoryView inter-process data transfers for subprocesses
 Home-page: https://brokensrc.dev
 Author-Email: Tremeschin <29046864+Tremeschin@users.noreply.github.com>
 License: MIT License
@@ -35,12 +35,18 @@ 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>
+  Faster <a href="https://github.com/moderngl/moderngl"><b>ModernGL Buffers</b></a> inter-process data transfers for subprocesses
+  <br>
   <br>
-  Faster <a href="https://github.com/moderngl/moderngl"><b>ModernGL</b></a> inter-process data transfers
+  <a href="https://pypi.org/project/turbopipe/"><img src="https://img.shields.io/pypi/v/turbopipe?label=PyPI&color=blue"></a>
+  <a href="https://pypi.org/project/turbopipe/"><img src="https://img.shields.io/pypi/dw/turbopipe?label=Installs&color=blue"></a>
+  <a href="https://github.com/BrokenSource/TurboPipe"><img src="https://img.shields.io/github/v/tag/BrokenSource/TurboPipe?label=GitHub&color=orange"></a>
+  <a href="https://github.com/BrokenSource/TurboPipe/stargazers"><img src="https://img.shields.io/github/stars/BrokenSource/TurboPipe?label=Stars&style=flat&color=orange"></a>
+  <a href="https://discord.gg/KjqvcYwRHm"><img src="https://img.shields.io/discord/1184696441298485370?label=Discord&style=flat&color=purple"></a>
 </div>
 
 <br>
@@ -53,7 +59,7 @@ The **optimizations** involved are:
 
 - **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
+- **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
@@ -68,7 +74,7 @@ It couldn't be easier! Just install the [**`turbopipe`**](https://pypi.org/proje
 
 ```bash
 # With pip (https://pip.pypa.io/)
-python -m pip install turbopipe
+pip install turbopipe
 
 # With Poetry (https://python-poetry.org/)
 poetry add turbopipe
@@ -84,7 +90,7 @@ rye add turbopipe
 
 # 🚀 Usage
 
-See also the [**Examples**](https://github.com/BrokenSource/TurboPipe/tree/main/examples) folder for more controlled usage, 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/Scene.py) usage of it!
 
 ```python
 import subprocess
@@ -106,7 +112,7 @@ ffmpeg = subprocess.Popen(
 for _ in range(60 * 60):
     turbopipe.pipe(buffer, ffmpeg.stdin.fileno())
 
-# Finalize writing
+# Finalize writing, encoding
 turbopipe.sync()
 ffmpeg.stdin.close()
 ffmpeg.wait()
@@ -148,9 +154,9 @@ ffmpeg.wait()
 | 🐢   | Null      |         1 |   882 fps | 2.44 GB/s   |          |
 | 🚀   | Null      |         1 |   793 fps | 2.19 GB/s   | -10.04%  |
 | 🌀   | Null      |         1 |  1911 fps | 5.28 GB/s   | 116.70%  |
-| 🐢   | Null      |         4 |   880 fps | 2.43 GB/s   |          |
-| 🚀   | Null      |         4 |   924 fps | 2.56 GB/s   | 5.05%    |
-| 🌀   | Null      |         4 |  2037 fps | 5.63 GB/s   | 131.59%  |
+| 🐢   | Null      |         4 |   857 fps | 2.37 GB/s   |          |
+| 🚀   | Null      |         4 |   891 fps | 2.47 GB/s   | 4.05%    |
+| 🌀   | Null      |         4 |  2309 fps | 6.38 GB/s   | 169.45%  |
 | 🐢   | ultrafast |         4 |   714 fps | 1.98 GB/s   |          |
 | 🚀   | ultrafast |         4 |   670 fps | 1.85 GB/s   | -6.10%   |
 | 🌀   | ultrafast |         4 |  1093 fps | 3.02 GB/s   | 53.13%   |
@@ -166,9 +172,9 @@ ffmpeg.wait()
 | 🐢    | Null      |         4 |   390 fps | 2.43 GB/s   |         |
 | 🚀    | Null      |         4 |   391 fps | 2.43 GB/s   | 0.26%   |
 | 🌀    | Null      |         4 |   756 fps | 4.71 GB/s   | 94.01%  |
-| 🐢    | ultrafast |         4 |   277 fps | 1.73 GB/s   |         |
-| 🚀    | ultrafast |         4 |   270 fps | 1.68 GB/s   | -2.40%  |
-| 🌀    | ultrafast |         4 |   402 fps | 2.50 GB/s   | 45.32%  |
+| 🐢    | ultrafast |         4 |   269 fps | 1.68 GB/s   |         |
+| 🚀    | ultrafast |         4 |   272 fps | 1.70 GB/s   | 1.48%   |
+| 🌀    | ultrafast |         4 |   409 fps | 2.55 GB/s   | 52.29%  |
 | 🐢    | slow      |         4 |   115 fps | 0.72 GB/s   |         |
 | 🚀    | slow      |         4 |   118 fps | 0.74 GB/s   | 3.40%   |
 | 🌀    | slow      |         4 |   119 fps | 0.75 GB/s   | 4.34%   |
@@ -178,9 +184,9 @@ ffmpeg.wait()
 | 🐢    | Null      |         1 |   210 fps | 2.33 GB/s   |          |
 | 🚀    | Null      |         1 |   239 fps | 2.64 GB/s   | 13.84%   |
 | 🌀    | Null      |         1 |   534 fps | 5.91 GB/s   | 154.32%  |
-| 🐢    | Null      |         4 |   233 fps | 2.58 GB/s   |          |
-| 🚀    | Null      |         4 |   232 fps | 2.57 GB/s   | -0.08%   |
-| 🌀    | Null      |         4 |   495 fps | 5.48 GB/s   | 112.64%  |
+| 🐢    | Null      |         4 |   219 fps | 2.43 GB/s   |          |
+| 🚀    | Null      |         4 |   231 fps | 2.56 GB/s   | 5.64%    |
+| 🌀    | Null      |         4 |   503 fps | 5.56 GB/s   | 129.75%  |
 | 🐢    | ultrafast |         4 |   141 fps | 1.56 GB/s   |          |
 | 🚀    | ultrafast |         4 |   150 fps | 1.67 GB/s   | 6.92%    |
 | 🌀    | ultrafast |         4 |   226 fps | 2.50 GB/s   | 60.37%   |
@@ -360,9 +366,7 @@ On realistically loads, like [**ShaderFlow**](https://github.com/BrokenSource/Sh
 
 # 📚 Future work
 
-- Add support for NumPy arrays, memoryviews, and byte-like objects
 - Disable/investigate performance degradation on Windows iGPUs
 - Improve the thread synchronization and/or use a ThreadPool
-- Stabler way for finding mglo struct offsets (moderngl.h?)
 - Maybe use `mmap` instead of chunks writing on Linux
-- Test on MacOS 🙈
+- Test on macOS 🙈

turbopipe-1.2.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+turbopipe-1.2.0.dist-info/METADATA,sha256=GshXnXUHFzM7sZFhvu3nDaTtgbgWA6PpjWNw6lyQ_78,21721
+turbopipe-1.2.0.dist-info/WHEEL,sha256=vIXzP6jLUy4sdmrQppnovVBqmdfNCkEM0I7EHxeJ-zs,83
+turbopipe-1.2.0.dist-info/License.md,sha256=s3HF089BzBa_7DenpGj5kPHBu-XhGLP6gRzhhhLXLls,1096
+turbopipe/_turbopipe.cp38-win_amd64.pyd,sha256=NcVE1U5a6KLzv1Sth63QL-O6TGxRJ7nXk9SAL43vXqg,35840
+turbopipe/_turbopipe.cp38-win_amd64.lib,sha256=PMdYfGloeL0aoriS0sJJug1lOBmSSwxODwh1h0BQspM,2052
+turbopipe/__init__.py,sha256=D0FP-CR87qJeLGv_VYCGRcwdONFhBYt02D2bm4Xdax4,1346
+turbopipe-1.2.0.dist-info/RECORD,,

turbopipe-1.0.5.dist-info/RECORD

@@ -1,7 +0,0 @@
-turbopipe-1.0.5.dist-info/METADATA,sha256=tHesZ-pctUtrb6nqF-kdjzAnR4f_UYBUbqV4JtaLY5A,21059
-turbopipe-1.0.5.dist-info/WHEEL,sha256=vIXzP6jLUy4sdmrQppnovVBqmdfNCkEM0I7EHxeJ-zs,83
-turbopipe-1.0.5.dist-info/License.md,sha256=s3HF089BzBa_7DenpGj5kPHBu-XhGLP6gRzhhhLXLls,1096
-turbopipe/_turbopipe.cp38-win_amd64.pyd,sha256=MWC-1Vwe_dPVT9WYpO_LxHHfx2BsrLwrV14AUkqpAAI,35840
-turbopipe/_turbopipe.cp38-win_amd64.lib,sha256=PMdYfGloeL0aoriS0sJJug1lOBmSSwxODwh1h0BQspM,2052
-turbopipe/__init__.py,sha256=8aMUtfquTKmZl_D9liQ2gqGyHD_-z76oDzwIcZRWzu8,961
-turbopipe-1.0.5.dist-info/RECORD,,