Skip to main content

VTKStreaming

This module provides classes to encode and stream frames from a VTK OpenGL render window using video codecs. It supports video encoding with VP9 (through libvpx) and H.264/H.265 (through NVENC).

Installation

VTKStreaming is available on PyPi on the following platforms:

  • Linux x86_64 for python 3.10 to 3.13 included.
  • Windows x86_64 for python 3.10 to 3.13 included.
  • MacOSX arm64 for python 3.10 to 3.13 included.

It is currently based on VTK 9.6.0.

pip install vtk-streaming

Building from source

Build for quick development

Requirements:

  • Linux: A C++ compiler (GCC 11.4+ or any other compiler supported by VTK.)
  • Windows: MSVC (Visual Studio Build Tools). (ensure visual studio environment is initialized)
  • macOS: Xcode command line tools. (xcode-select --install should have completed successfully)

Linux/macOS

python3 -m venv .venv
. .venv/bin/activate
pip install -e . --extra-index-url https://vtk.org/files/wheel-sdks

Windows

Open a powershell with MSVC initialized (ex: Visual Studio Developer Powershell)

python3 -m venv .venv
.venv/bin/activate.ps1
pip install -e . --extra-index-url https://vtk.org/files/wheel-sdks

Reproduce CI artifacts

Wheels are built with cibuildwheel.

Requirements:

  • Linux: Docker (the build runs in a manylinux container).
  • Windows: MSVC (Visual Studio Build Tools). (ensure visual studio environment is initialized)
  • macOS: Xcode command line tools. (xcode-select --install should have completed successfully)

Build a wheel for one Python/platform target:

# Linux
uvx cibuildwheel --only cp310-manylinux_x86_64

# Windows
uvx cibuildwheel --only cp310-win_amd64

# macOS
uvx cibuildwheel --only cp310-macosx_arm64

uvx comes with uv; alternatively pipx run cibuildwheel or if you use pip:

pip install cibuildwheel

# Linux
cibuildwheel --only cp310-manylinux_x86_64

# Windows
cibuildwheel --only cp310-win_amd64

# macOS
cibuildwheel --only cp310-macosx_arm64

Substitute cp310/cp311/cp312/cp313 to target other Python versions. The wheel is written to wheelhouse/ and can be installed directly:

pip install wheelhouse/vtk_streaming-*.whl

Examples

  1. examples/simple_encoder_decoder.py - Live VP9 encode/decode round-trip with two render windows side by side.
  2. examples/resize_encoder_decoder.py - VP9 encode/decode round-trip that survives window resizes.
  3. examples/simple_nvenc_record.py - Record a render window for later playback using NVENC. This needs ffplay to playback the .h264 file.

Getting help

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

vtk_streaming-0.3.3-cp313-cp313-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.13Windows x86-64

vtk_streaming-0.3.3-cp313-cp313-manylinux_2_28_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.28+ x86-64

vtk_streaming-0.3.3-cp313-cp313-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

vtk_streaming-0.3.3-cp312-cp312-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.12Windows x86-64

vtk_streaming-0.3.3-cp312-cp312-manylinux_2_28_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.28+ x86-64

vtk_streaming-0.3.3-cp312-cp312-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

vtk_streaming-0.3.3-cp311-cp311-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.11Windows x86-64

vtk_streaming-0.3.3-cp311-cp311-manylinux_2_28_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64

vtk_streaming-0.3.3-cp311-cp311-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

vtk_streaming-0.3.3-cp310-cp310-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.10Windows x86-64

vtk_streaming-0.3.3-cp310-cp310-manylinux_2_28_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64

vtk_streaming-0.3.3-cp310-cp310-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

File details

Details for the file vtk_streaming-0.3.3-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 cb51281065f6d97c9f95c6faff5cd364ed0db799228052de96ab4748bc4cdd49
MD5 3d3184bf9d5039b9c1217f0a6764428f
BLAKE2b-256 6dea42b482a92050507e66a1c0f5f54469e9b6b70256af486129f2f97ae4efa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp313-cp313-win_amd64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp313-cp313-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 bfbcf666b633e6c7dfb8cdba1ca3c3795bcd1e00befe02fa6ae26601a8743860
MD5 40e3550704a8a73c89b2a254f619ae40
BLAKE2b-256 0e754114634e8100e6e1248efbbae21a923025ea6703a26ebbfad7df64658af6

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp313-cp313-manylinux_2_28_x86_64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a6bb25eb9b66e449b9ec84a23e83bdb0afa1ecce18f4ce90f25eeb684812a38c
MD5 ac68e48eedcb74dfdd956ce52063d08a
BLAKE2b-256 9295ec715bab56805335878bce1f1d62c1bade71aca2ee1e737e42e36ac625ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp313-cp313-macosx_11_0_arm64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 5d8b4b88e1b9afa695f06bf1f2e1b4e6f746692d960d8436f3821c76850b8835
MD5 58777b0216a3ab9dad356856ee5212e2
BLAKE2b-256 d4de1d18bd17f615b9df95495d954485ce2bf1de229a1333fd9ce619f732a0cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp312-cp312-win_amd64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp312-cp312-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 83aeb42dde8c6a3671c776cab5bcfda6c9665ae753925ce071bf0176b39fcdfe
MD5 d250ee0f254109136cd409155d77a37e
BLAKE2b-256 372e7c728ded0748fc64fee91721c9d703367c3cb0d365b5c798c086b43070d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp312-cp312-manylinux_2_28_x86_64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ea2d2444110d4bf20da80eb4062a4a6bf32c03b87c96ca550a1f02a20ea452b5
MD5 63d2308242d597557f341f408c753103
BLAKE2b-256 e5245fe0c511960efbfb091f576a83022b5c9cc875a5d63c33558c7f7a648a4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp312-cp312-macosx_11_0_arm64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 675598368b6eb7c3d387283bd4f3712a70cfa16511ea4683e9076094d2685530
MD5 353da3a723661f026afd299d2da806ed
BLAKE2b-256 bb2ef85b2df5c2d1d0488fd5a9d7d095467477222e806cd63e16270b4e6887d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp311-cp311-win_amd64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp311-cp311-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e306f63aa0d07de4921fc184f1d4bc9321faa80baab520c4edd71f3ab62b5f84
MD5 0c260705c1bf66b0316648b20143e705
BLAKE2b-256 bb0b97136d1a3551531829f29561885f3f4e6e9cf7f48b9969f378caba83f082

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp311-cp311-manylinux_2_28_x86_64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 553522ba0ce7f21c3294202199b6ddcf7641b1e515c0659f349ed2e4978fec8a
MD5 50c95e5de57fed4915a77f626fd28566
BLAKE2b-256 539bd94b4d86d6d4ab3b17875a31376f626117d0a6b504d3330043857c0ccac7

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp311-cp311-macosx_11_0_arm64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 c77cea663399100874979354960b9a57c06dcd4a1bc3c22d7928943caaa4447d
MD5 98bac55b4a50676b01393f8b48fe6e4a
BLAKE2b-256 28fb2a784bf00fa890ad7a50c58d6d81af2778e935d55ac5678196083ba93d98

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp310-cp310-win_amd64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp310-cp310-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1c9e78dbcca9582c461dc6dba9df59a2514a617310c12a3b7e0bdbd8bf72969d
MD5 d60b85989b60b017ae8f3c6d0aa56c79
BLAKE2b-256 e4c8c7d4b2e4182f84927c70b51531fcfc660ec08e120eee88b659f38650afb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp310-cp310-manylinux_2_28_x86_64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vtk_streaming-0.3.3-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vtk_streaming-0.3.3-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8670a2f85133e97b102279fa688d7677fbfb9c0acf97bd9d6b9d9c69ac146411
MD5 c9d71765d7baa7517dc8491ed3ac5fb9
BLAKE2b-256 1737748c5ec8b64b43ce38f1538b2a4943b8b5283daed7228d61e2c9f63e97a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for vtk_streaming-0.3.3-cp310-cp310-macosx_11_0_arm64.whl:

Publisher: release.yml on Kitware/VTKStreaming

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page