chiaki-lib
Low-level pybind11 bindings around
chiaki-ng, the PS4/PS5 Remote Play client library:
discover consoles (DiscoveryManager), register with one (Backend), connect and stream one
(ChiakiPySession), pull its decoded frames (CpuFrameHandler, CudaFrameHandler,
VulkanFrameHandler), play its audio (AudioOutput) and draw it with Vulkan (VulkanRenderer).
Most users want chiaki-py, the Pythonic client built on top of this package, instead of using it directly.
chiaki-ng's log messages go to the chiaki_lib logger, libplacebo's to chiaki_lib.placebo and
FFmpeg's to chiaki_lib.ffmpeg.
Examples
examples/ walks through a whole session using only chiaki_lib. Run the scripts from the
repository root, in order: each step saves what the next one needs under ./cache/.
| Script | What it does |
|---|---|
1.1_login.py |
Signs in to your PSN account in the terminal (open the printed URL, paste back the one you land on) and saves it to cache/psn_account.json |
1.2_discover_hosts.py [--timeout SECONDS] |
Lists the PS4/PS5 consoles on the local network; needs no login |
1.3_register_console.py <host> <pin> [--ps4] [--console-pin PIN] |
Pairs with a console using the 8-digit code from its Link Device screen and saves cache/host_registration.json |
1.4.1_stream_cpu.py |
Streams the registered console into an OpenCV window, frames decoded to system memory (CpuFrameHandler) |
1.4.2_stream_cuda.py |
Streams into a GLFW window, frames converted and drawn on an NVIDIA GPU through CUDA-OpenGL interop (CudaFrameHandler) |
1.4.3_stream_vulkan.py |
Streams into a GLFW window, frames decoded and drawn on the GPU with Vulkan and never copied (VulkanFrameHandler, VulkanRenderer) |
python examples/1.1_login.py
python examples/1.2_discover_hosts.py
python examples/1.3_register_console.py 192.168.1.50 12345678
python examples/1.4.1_stream_cpu.py
The streaming examples wake the console up if it is in standby, play its audio, and forward a
DualSense controller's input if dualsense-py is
installed and one is plugged in. In the window, F shows the frame rate and Q or Esc quits.
helpers.py, fps_overlay.py, glfw_video.py and cuda_gl.py hold the code they share.
Besides chiaki_lib, the examples need:
| Script | Packages |
|---|---|
1.1_login.py |
requests |
1.4.1_stream_cpu.py |
opencv-python |
1.4.2_stream_cuda.py |
cupy-cuda12x cuda-python PyOpenGL glfw opencv-python, and an NVIDIA GPU that also drives the display |
1.4.3_stream_vulkan.py |
glfw opencv-python, and a GPU and driver with Vulkan video decoding |
Layout
| Path | What |
|---|---|
pybind/include, pybind/src |
The C++ wrapper around chiaki-ng |
pybind/bindings |
The pybind11 bindings; most pydef_*.cpp are generated, see below |
chiaki_lib/ |
The Python package: the compiled _native module lands here, next to its stubs in _native/ |
cmake/ |
Builds libplacebo on Windows |
examples/ |
Login, discovery, pairing and streaming scripts, see Examples |
Building
The extension module is built with CMake first; python -m build then only packages what CMake
put into chiaki_lib/. CMake fetches chiaki-ng (CHIAKI_NG_VERSION, into libs/chiaki-ng) and
pybind11 itself; on Windows it also downloads FFmpeg and builds libplacebo into deps/. The
native dependencies each platform needs are listed in the workflows under .github/workflows/.
Windows, from a Visual Studio x64 dev shell, with vcpkg and pip install meson:
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release `
-DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake" `
-DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl
cmake --build build --target chiaki-lib-py
python -m build --wheel
Linux / macOS:
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build build --target chiaki-lib-py
python -m build --wheel
For development, pip install -e . --config-settings editable_mode=compat after the CMake build
makes import chiaki_lib use the module built in place. compat puts this folder on sys.path
through a plain .pth entry, which Pylance/pyright can follow; the default editable mode uses an
import hook they can't see through.
Regenerating the bindings
After changing a bound header in pybind/include, regenerate the pydef_*.cpp files and the
stubs in chiaki_lib/_native/__init__.pyi, and commit the result:
pip install -e .[dev] --config-settings editable_mode=compat
python pybind/bindings/generate_bindings.py # or: cmake --build build --target chiaki-lib-generate-bindings
License
AGPL-3.0-only, like chiaki-ng. See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for chiaki-lib 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| chiaki_lib-0.1.0.tar.gz | 50.8 MB | Details |
Built distributions (wheels)
Total release size: 652.3 MB
Release files / chiaki_lib-0.1.0.tar.gz
| Download URL | chiaki_lib-0.1.0.tar.gz |
|---|---|
| Size | 50.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2e8222914e7fe9382fa37053806961be22b7eea8791228354750754a1b2b0787
|
|
BLAKE2b-256 checksum How to use checksums |
291b0757db6a842ccb8927e1bf179395213c182a6cbc2cd8a58e2e11028a7e7a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp314-cp314-win_amd64.whl
| Download URL | chiaki_lib-0.1.0-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 52.2 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
71bd40ce2adbd22a5e5ba965284a92f5424c0385536bd3e61e66700adf335733
|
|
BLAKE2b-256 checksum How to use checksums |
fd8793aad9587e5d6777c83bbfe91f724b5276cfa3184597f0825f4dd6c4eada
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp314-cp314-manylinux_2_39_x86_64.whl
| Download URL | chiaki_lib-0.1.0-cp314-cp314-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 67.2 MB |
| Tags | CPython 3.14 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
f9b3e4dfb726725275e6271f5278540b7c559cc73f07debc8d6a82b6d6ae1f52
|
|
BLAKE2b-256 checksum How to use checksums |
aa7b04ac8e9f3db82460b7d4f0ce922a1514f67939f78c915c5c3c8462388b2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp314-cp314-manylinux_2_36_aarch64.whl
| Download URL | chiaki_lib-0.1.0-cp314-cp314-manylinux_2_36_aarch64.whl |
|---|---|
| Size | 11.6 MB |
| Tags | CPython 3.14 Linux glibc 2.36+ ARM64 |
|
SHA-256 checksum How to use checksums |
b80112c769dbd4d2fa6e2d2172fbda2b99abcb3c731a2542b582c6736ef13a29
|
|
BLAKE2b-256 checksum How to use checksums |
9dd960668d440c9d696ccb3dfaab0bf459d8dda4a8f8127c196a5259ccc8dd8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp314-cp314-macosx_15_0_arm64.whl
| Download URL | chiaki_lib-0.1.0-cp314-cp314-macosx_15_0_arm64.whl |
|---|---|
| Size | 20.4 MB |
| Tags | CPython 3.14 macOS 15.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
45add4a63574d4883c55b2ee6aac2f0d772a8dae89038d8c6f997636b28e4b5b
|
|
BLAKE2b-256 checksum How to use checksums |
6eea6178ee1a983c03cc01da3f4092ef9aed2f85d50c9e1844af640d8f8984d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp313-cp313-win_amd64.whl
| Download URL | chiaki_lib-0.1.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 50.9 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d51017f670a8b3fd1ca3706a6d87614ab52dba329cdf8c871304cd2c3faee80e
|
|
BLAKE2b-256 checksum How to use checksums |
3e68d220359d4d0eb315c1cca60f8a3699d7c472a97844a88222f458bedc59d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp313-cp313-manylinux_2_39_x86_64.whl
| Download URL | chiaki_lib-0.1.0-cp313-cp313-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 67.2 MB |
| Tags | CPython 3.13 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
bd34482366130703fc29f625c5760046b8caefdf2c3751137d36666121df3625
|
|
BLAKE2b-256 checksum How to use checksums |
7f8bb33382dc76088d630f9072388655771db20c4f0ebdcf19edb4c23f046279
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp313-cp313-manylinux_2_36_aarch64.whl
| Download URL | chiaki_lib-0.1.0-cp313-cp313-manylinux_2_36_aarch64.whl |
|---|---|
| Size | 11.6 MB |
| Tags | CPython 3.13 Linux glibc 2.36+ ARM64 |
|
SHA-256 checksum How to use checksums |
679c72eefe160ac4c30faf4a95b4babf5255b252290a3fbb586761401d5827b5
|
|
BLAKE2b-256 checksum How to use checksums |
6b442bcaf73143a51f503bf21d08b55dc825c69b3b060e325a394aef22a3d05b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp313-cp313-macosx_15_0_arm64.whl
| Download URL | chiaki_lib-0.1.0-cp313-cp313-macosx_15_0_arm64.whl |
|---|---|
| Size | 20.4 MB |
| Tags | CPython 3.13 macOS 15.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
c6efce13ef75b493adc85417ac500e4df6f7f2a02df2b53774164f9b6e5f4778
|
|
BLAKE2b-256 checksum How to use checksums |
6a0d2b7a31f821abe2aaf64a55404c7f1da81c82f92ea45854d7d32c14d138fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp312-cp312-win_amd64.whl
| Download URL | chiaki_lib-0.1.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 50.9 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
b0a1d0ed8b6c9530f54f8fd6aa0b8ce1c07fd1829105bd07486fa09948dcfe43
|
|
BLAKE2b-256 checksum How to use checksums |
899dced771e6ba5a8746e3781c2116b8fe13b4b842a3d0de1e71a2e1741f25cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp312-cp312-manylinux_2_39_x86_64.whl
| Download URL | chiaki_lib-0.1.0-cp312-cp312-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 67.2 MB |
| Tags | CPython 3.12 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
339b445be5568db74f70dbb2458fbf518f9adda8929812ffbae71163d5f62118
|
|
BLAKE2b-256 checksum How to use checksums |
a9cabd4a7fff109b119844770dd9262fee0fc58ea995d45fb74ccf387c04e777
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp312-cp312-manylinux_2_36_aarch64.whl
| Download URL | chiaki_lib-0.1.0-cp312-cp312-manylinux_2_36_aarch64.whl |
|---|---|
| Size | 11.6 MB |
| Tags | CPython 3.12 Linux glibc 2.36+ ARM64 |
|
SHA-256 checksum How to use checksums |
c02462dd536fec0633a7cd7b0f6025a5f7fbfb43f6106fadead5c21881abec1b
|
|
BLAKE2b-256 checksum How to use checksums |
050ccb25f838701e4ddb768593be645c09e65b3d5e91601b2df20da1ed4aab0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp312-cp312-macosx_15_0_arm64.whl
| Download URL | chiaki_lib-0.1.0-cp312-cp312-macosx_15_0_arm64.whl |
|---|---|
| Size | 20.4 MB |
| Tags | CPython 3.12 macOS 15.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
836067e1e42aed3509a5bf750caf518f3e497f66f69d43affeadf988a1cddc01
|
|
BLAKE2b-256 checksum How to use checksums |
b7ca0086585b1e042bfa74b12e57055896582bd8aef958e3c36beb6d55451aef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp311-cp311-win_amd64.whl
| Download URL | chiaki_lib-0.1.0-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 50.9 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
831954e9f206cd339d6f9897da9dd290e3db7362fca663aebea6ea3fc64b35fd
|
|
BLAKE2b-256 checksum How to use checksums |
04329e96c3129c4f8956e6aaade0bac1b373bf7cabebdc0309fb80bdcd38d488
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp311-cp311-manylinux_2_39_x86_64.whl
| Download URL | chiaki_lib-0.1.0-cp311-cp311-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 67.2 MB |
| Tags | CPython 3.11 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
063e1f28ace26d7e82ba9432dcb56cda68e2f75f35660caedb4122ebb1dcf636
|
|
BLAKE2b-256 checksum How to use checksums |
10e1eb6ccdb179aa7325ee500f5d80c36249f3d6a98b8b183a32b4a98ac451ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp311-cp311-manylinux_2_36_aarch64.whl
| Download URL | chiaki_lib-0.1.0-cp311-cp311-manylinux_2_36_aarch64.whl |
|---|---|
| Size | 11.6 MB |
| Tags | CPython 3.11 Linux glibc 2.36+ ARM64 |
|
SHA-256 checksum How to use checksums |
31a7c8e9ab633596d9335738e61e05202f1b757d132bfaf3ec38d973f6ccaa70
|
|
BLAKE2b-256 checksum How to use checksums |
91b832ab44228e9716c2ee9bbe8e95533e777430d06916c79cd5761d18442a2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / chiaki_lib-0.1.0-cp311-cp311-macosx_15_0_arm64.whl
| Download URL | chiaki_lib-0.1.0-cp311-cp311-macosx_15_0_arm64.whl |
|---|---|
| Size | 20.4 MB |
| Tags | CPython 3.11 macOS 15.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
bc94b75b35ba959e9b684698c9c9415ca5711ad97975989b5eb4e473a417eb16
|
|
BLAKE2b-256 checksum How to use checksums |
e378a649e2abb6f0c19c47a31298b4a41e106298c8147b06525ed5cc1ec04767
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency log
