setup.py

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at https://mozilla.org/MPL/2.0/.

import os
import re
import sys

from setuptools import setup
from setuptools_rust import Binding, RustExtension, Strip

with open("README.md", "r", encoding="utf-8") as fh:
    long_description = fh.read()

def crate_version() -> str:
    """The crate's version as pip spells it: a `2.1.0-rc.1` in Cargo.toml is `2.1.0rc1` here."""
    manifest = os.path.join(os.path.dirname(os.path.abspath(__file__)), "pixelflux", "Cargo.toml")
    with open(manifest, encoding="utf-8") as fh:
        semver = re.search(r'^version = "([^"]+)"', fh.read(), re.M).group(1)
    spelled = {"alpha": "a", "beta": "b", "rc": "rc", "dev": ".dev", "post": ".post"}
    return re.sub(r"-(alpha|beta|rc|dev|post)\.(\d+)$", lambda m: spelled[m.group(1)] + m.group(2), semver)


# The software H.264 and H.265 encoders are chosen at build time. The default build enables
# the GPL components (GPL-2.0+ libx264 and x265 encode every software H.264 and H.265
# session). Set PIXELFLUX_ENABLE_GPL=0 (or "false"/"no") to build without them: the
# BSD-licensed OpenH264 and kvazaar then encode those sessions, with no other difference
# in the API (pixelflux.SOFTWARE_ENCODERS reports which encoder a build carries per codec).
_enable_gpl = os.environ.get("PIXELFLUX_ENABLE_GPL", "1").strip().lower() not in (
    "0",
    "false",
    "no",
    "off",
)
if _enable_gpl:
    print(
        "NOTICE: pixelflux is being built WITH GPL-licensed components "
        "(GPL-2.0+ libx264 and x265 as the software H.264 and H.265 encoders), which is the "
        "default. Set PIXELFLUX_ENABLE_GPL=0 to exclude every GPL-licensed component.",
        file=sys.stderr,
    )
else:
    print(
        "NOTICE: pixelflux is being built WITHOUT GPL-licensed components "
        "(PIXELFLUX_ENABLE_GPL=0): libx264 and x265 are excluded, and OpenH264 and kvazaar "
        "(BSD) are the software H.264 and H.265 encoders.",
        file=sys.stderr,
    )

setup(
    name="pixelflux",
    version=crate_version(),
    author="Selkies Project",
    author_email="pypi@linuxserver.io",
    description="A performant web native pixel delivery pipeline for diverse sources, blending VNC-inspired parallel processing of pixel buffers with flexible modern encoding formats.",
    long_description=long_description,
    long_description_content_type="text/markdown",
    license="MPL-2.0",
    url="https://github.com/selkies-project/pixelflux",

    # Single self-contained Rust extension: the top-level `pixelflux` module does X11 (XShm)
    # and Wayland capture plus all encoding/conversion. No C/C++ sources, no Python package
    # layer -- `import pixelflux` resolves directly to pixelflux.cpython-*.so.
    packages=[],
    rust_extensions=[
        RustExtension(
            "pixelflux",
            "pixelflux/Cargo.toml",
            binding=Binding.PyO3,
            debug=False,
            strip=Strip.All,
            # `--locked`: a wheel carries the crate versions Cargo.lock names, and a
            # manifest that has outrun the lock fails the build rather than silently
            # resolving past it.
            args=["--locked", *([] if _enable_gpl else ["--no-default-features", "--features", "openh264"])],
        )
    ],

    classifiers=[
        "Programming Language :: Python :: 3",
        "Operating System :: POSIX :: Linux",
    ],
    python_requires=">=3.9",
    zip_safe=False,
)