pixelflux 1.5.3__cp38-cp38-manylinux_2_34_x86_64.whl

pixelflux/__init__.py

@@ -0,0 +1,221 @@
+import ctypes
+import os
+import threading
+import sys
+
+class CaptureSettings(ctypes.Structure):
+    _fields_ = [
+        ("capture_width", ctypes.c_int),
+        ("capture_height", ctypes.c_int),
+        ("scale", ctypes.c_double),
+        ("capture_x", ctypes.c_int),
+        ("capture_y", ctypes.c_int),
+        ("target_fps", ctypes.c_double),
+        ("jpeg_quality", ctypes.c_int),
+        ("paint_over_jpeg_quality", ctypes.c_int),
+        ("use_paint_over_quality", ctypes.c_bool),
+        ("paint_over_trigger_frames", ctypes.c_int),
+        ("damage_block_threshold", ctypes.c_int),
+        ("damage_block_duration", ctypes.c_int),
+        ("output_mode", ctypes.c_int),
+        ("h264_crf", ctypes.c_int),
+        ("h264_paintover_crf", ctypes.c_int),
+        ("h264_paintover_burst_frames", ctypes.c_int),
+        ("h264_fullcolor", ctypes.c_bool),
+        ("h264_fullframe", ctypes.c_bool),
+        ("h264_streaming_mode", ctypes.c_bool),
+        ("capture_cursor", ctypes.c_bool),
+        ("watermark_path", ctypes.c_char_p),
+        ("watermark_location_enum", ctypes.c_int),
+        ("vaapi_render_node_index", ctypes.c_int),
+        ("use_cpu", ctypes.c_bool),
+        ("debug_logging", ctypes.c_bool),
+    ]
+
+class StripeEncodeResult(ctypes.Structure):
+    _fields_ = [
+        ("type", ctypes.c_int),
+        ("stripe_y_start", ctypes.c_int),
+        ("stripe_height", ctypes.c_int),
+        ("size", ctypes.c_int),
+        ("data", ctypes.POINTER(ctypes.c_ubyte)),
+        ("frame_id", ctypes.c_int),
+    ]
+
+StripeCallback = ctypes.CFUNCTYPE(
+    None, ctypes.POINTER(StripeEncodeResult), ctypes.c_void_p
+)
+
+lib_dir = os.path.dirname(__file__)
+lib_path = os.path.join(lib_dir, 'screen_capture_module.so')
+
+_legacy_lib = None
+try:
+    if os.path.exists(lib_path):
+        _legacy_lib = ctypes.CDLL(lib_path)
+    else:
+        _legacy_lib = ctypes.CDLL('screen_capture_module.so')
+except OSError:
+    pass
+
+if _legacy_lib:
+    create_module = _legacy_lib.create_screen_capture_module
+    create_module.restype = ctypes.c_void_p
+    destroy_module = _legacy_lib.destroy_screen_capture_module
+    destroy_module.argtypes = [ctypes.c_void_p]
+    start_capture_c = _legacy_lib.start_screen_capture
+    start_capture_c.argtypes = [ctypes.c_void_p, CaptureSettings, StripeCallback, ctypes.c_void_p]
+    stop_capture_c = _legacy_lib.stop_screen_capture
+    stop_capture_c.argtypes = [ctypes.c_void_p]
+    free_stripe_encode_result_data = _legacy_lib.free_stripe_encode_result_data
+    free_stripe_encode_result_data.argtypes = [ctypes.POINTER(StripeEncodeResult)]
+
+_GLOBAL_WAYLAND_BACKEND = None
+if os.environ.get("PIXELFLUX_WAYLAND") == "true":
+    try:
+        from . import pixelflux_wayland
+        _GLOBAL_WAYLAND_BACKEND = pixelflux_wayland.WaylandBackend()
+        print(">> [PixelFlux] Rust Wayland Backend Initialized Globally.")
+    except ImportError as e:
+        print(f">> [PixelFlux] Failed to load Wayland backend: {e}")
+        pass
+
+class ScreenCapture:
+    """Python wrapper for screen capture module using ctypes."""
+
+    def __init__(self):
+        if _legacy_lib:
+            self._module = create_module()
+        else:
+            self._module = None
+        
+        self._is_capturing = False
+        self._python_stripe_callback = None
+        self._c_callback = None
+
+    def __del__(self):
+        if hasattr(self, '_module') and self._module:
+            try:
+                self.stop_capture()
+                destroy_module(self._module)
+            except:
+                pass
+            self._module = None
+
+    def start_capture(self, settings: CaptureSettings, stripe_callback):
+        if self._is_capturing:
+            raise ValueError("Capture already started.")
+
+        self._python_stripe_callback = stripe_callback
+        mode = getattr(settings, 'mode', 'x11')
+
+    def start_capture(self, settings: CaptureSettings, stripe_callback):
+        if self._is_capturing:
+            raise ValueError("Capture already started.")
+
+        self._python_stripe_callback = stripe_callback
+        
+        if _GLOBAL_WAYLAND_BACKEND:
+            if settings.scale < 0.1:
+                if settings.debug_logging:
+                    print(f">> [PixelFlux] Warning: Scale {settings.scale} is invalid. Defaulting to 1.0")
+                settings.scale = 1.0
+
+            if settings.debug_logging:
+                print(f">> [PixelFlux] Connecting to Rust Wayland Backend (Scale: {settings.scale})...")
+            
+            is_h264 = (settings.output_mode == 1)
+
+            def rust_bridge_callback(data_bytes): 
+                if not self._python_stripe_callback:
+                    return
+                size = len(data_bytes)
+                c_buffer = (ctypes.c_ubyte * size).from_buffer_copy(data_bytes)
+                result_struct = StripeEncodeResult()
+                result_struct.size = size
+                result_struct.data = ctypes.cast(c_buffer, ctypes.POINTER(ctypes.c_ubyte))
+                if is_h264:
+                    result_struct.type = 0
+                    if size >= 4:
+                        result_struct.frame_id = int.from_bytes(data_bytes[2:4], 'big')
+                    else:
+                        result_struct.frame_id = 0
+                    if size >= 6:
+                         result_struct.stripe_y_start = int.from_bytes(data_bytes[4:6], 'big')
+                    else:
+                         result_struct.stripe_y_start = 0
+                    result_struct.stripe_height = settings.capture_height
+                else:
+                    result_struct.type = 1
+                    if size >= 2:
+                        result_struct.frame_id = int.from_bytes(data_bytes[0:2], 'big')
+                    else:
+                        result_struct.frame_id = 0
+                    if size >= 4:
+                        result_struct.stripe_y_start = int.from_bytes(data_bytes[2:4], 'big')
+                    else:
+                        result_struct.stripe_y_start = 0
+                    result_struct.stripe_height = 0
+                self._python_stripe_callback(ctypes.byref(result_struct), None)
+            _GLOBAL_WAYLAND_BACKEND.start_capture(rust_bridge_callback, settings)
+            self._is_capturing = True
+            return 
+
+        if not self._module:
+             raise OSError("Legacy screen_capture_module.so not found.")
+
+        if not callable(stripe_callback):
+            raise TypeError("stripe_callback must be callable.")
+        
+        self._c_callback = StripeCallback(self._internal_c_callback)
+        start_capture_c(self._module, settings, self._c_callback, None)
+        self._is_capturing = True
+
+    def stop_capture(self):
+        if not self._is_capturing:
+            return
+        
+        if self._module and self._c_callback:
+            stop_capture_c(self._module)
+            self._c_callback = None
+        
+        if _GLOBAL_WAYLAND_BACKEND:
+             _GLOBAL_WAYLAND_BACKEND.stop_capture()
+            
+        self._is_capturing = False
+        self._python_stripe_callback = None
+
+    def _internal_c_callback(self, result_ptr, user_data):
+        if self._is_capturing and self._python_stripe_callback:
+            try:
+                self._python_stripe_callback(result_ptr, user_data)
+            finally:
+                free_stripe_encode_result_data(result_ptr)
+
+    def inject_key(self, scancode, state):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.inject_key(scancode, state)
+
+    def inject_mouse_move(self, x, y):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.inject_mouse_move(float(x), float(y))
+
+    def inject_relative_mouse_move(self, dx, dy):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.inject_relative_mouse_move(float(dx), float(dy))
+
+    def inject_mouse_button(self, btn, state):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.inject_mouse_button(btn, state)
+
+    def inject_mouse_scroll(self, x, y):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.inject_mouse_scroll(float(x), float(y))
+
+    def set_cursor_rendering(self, enabled):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.set_cursor_rendering(bool(enabled))
+
+    def set_cursor_callback(self, callback):
+        if _GLOBAL_WAYLAND_BACKEND:
+            _GLOBAL_WAYLAND_BACKEND.set_cursor_callback(callback)

pixelflux-1.5.3.dist-info/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  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 http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

pixelflux-1.5.3.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.1
+Name: pixelflux
+Version: 1.5.3
+Summary: A performant web native pixel delivery pipeline for diverse sources, blending VNC-inspired parallel processing of pixel buffers with flexible modern encoding formats.
+Home-page: https://github.com/linuxserver/pixelflux
+Author: Linuxserver.io
+Author-email: pypi@linuxserver.io
+License: MPL-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nvidia-cuda-nvrtc
+
+# pixelflux
+
+[![PyPI version](https://badge.fury.io/py/pixelflux.svg)](https://badge.fury.io/py/pixelflux)
+[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
+
+**A performant web native pixel delivery pipeline for diverse sources, blending parallel processing of pixel buffers with flexible modern encoding formats.**
+
+This module provides a Python interface to a high-performance capture library supporting both **X11** and **Wayland** environments. It captures pixel data, detects changes, and encodes modified stripes into JPEG or H.264.
+
+It supports CPU-based encoding (libx264, libjpeg-turbo) as well as hardware-accelerated H.264 encoding via NVIDIA's NVENC and VA-API for Intel/AMD GPUs. The Wayland backend features a **zero-copy pipeline**, passing GPU buffers directly to the encoder to minimize latency and CPU usage.
+
+## Installation
+
+This module relies on native C++ (X11) and Rust (Wayland) extensions that are compiled during installation.
+
+### 1. Prerequisites
+
+Ensure you have a C++ compiler (`g++`), the Rust toolchain (`cargo`), and development files for Python and the underlying graphics libraries.
+
+**Base Dependencies (Debian/Ubuntu):**
+```bash
+sudo apt-get update && \
+sudo apt-get install -y \
+  g++ \
+  git \
+  curl \
+  python3-dev \
+  libavcodec-dev \
+  libavutil-dev \
+  libjpeg-turbo8-dev \
+  libx264-dev \
+  libyuv-dev
+```
+
+**X11 Backend Dependencies:**
+```bash
+sudo apt-get install -y \
+  libx11-dev \
+  libxext-dev \
+  libxfixes-dev
+```
+
+**Wayland Backend Dependencies:**
+To build the Rust-based Wayland backend, you need the Rust toolchain and Wayland/DRM libraries:
+
+```bash
+# Install Rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+
+# Install Libraries
+sudo apt-get install -y \
+  libgbm-dev \
+  libdrm-dev \
+  libwayland-dev \
+  libinput-dev \
+  libxkbcommon-dev \
+  libva-dev \
+  libclang-dev
+```
+
+### 2. Hardware Acceleration (Optional but Recommended)
+*   **NVIDIA (NVENC):** The library detects the NVIDIA driver at runtime. No extra compile-time packages are needed.
+*   **Intel/AMD (VA-API):** Ensure `libva-dev` and `libdrm-dev` are installed. You must also have the correct drivers (e.g., `intel-media-va-driver-non-free` or `mesa-va-drivers`).
+
+### 3. Install the Package
+
+**Option A: Install from PyPI**
+```bash
+pip install pixelflux
+```
+
+**Option B: Install from local source**
+```bash
+# From the root of the project repository
+pip install .
+```
+
+## Usage
+
+### Backend Selection
+
+By default, `pixelflux` loads the legacy X11 backend. To enable the **Wayland** backend (built on [Smithay](https://github.com/Smithay/smithay)), set the following environment variable before importing the module:
+
+```bash
+export PIXELFLUX_WAYLAND=true
+```
+
+To test launching programs into this backend simply add `WAYLAND_DISPLAY=wayland-1` before launching them: 
+
+```bash
+WAYLAND_DISPLAY=wayland-1 glmark2-es2-wayland -s 1920x1080
+```
+
+### Capture Settings
+
+The `CaptureSettings` class configures both backends.
+
+```python
+from pixelflux import CaptureSettings, ScreenCapture
+
+settings = CaptureSettings()
+
+# --- Core Capture ---
+settings.capture_width = 1920
+settings.capture_height = 1080
+settings.capture_x = 0
+settings.capture_y = 0
+settings.capture_cursor = True
+settings.target_fps = 60.0
+settings.scale = 1.0  # Fractional scaling (Wayland only)
+
+# --- Encoding Mode ---
+# 0 for JPEG, 1 for H.264
+settings.output_mode = 1
+# Force CPU encoding and ignore hardware encoders
+capture_settings.use_cpu = False
+
+# --- Debugging ---
+settings.debug_logging = False # Enable/disable the continuous FPS and settings log to the console.
+
+# --- JPEG Settings ---
+settings.jpeg_quality = 75              # Quality for changed stripes (0-100)
+settings.paint_over_jpeg_quality = 90   # Quality for static "paint-over" stripes (0-100)
+
+# --- H.264 Settings ---
+settings.h264_crf = 25                   # CRF value (0-51, lower is better quality/higher bitrate)
+settings.h264_paintover_crf = 18         # CRF for H.264 paintover on static content. Must be lower than h264_crf to activate.
+settings.h264_paintover_burst_frames = 5 # Number of high-quality frames to send in a burst when a paintover is triggered.
+settings.h264_fullcolor = False          # Use I444 (full color) instead of I420 for software encoding
+settings.h264_fullframe = True           # Encode full frames (required for HW accel) instead of just changed stripes
+settings.h264_streaming_mode = False     # Bypass all VNC logic and work like a normal video encoder, higher constant CPU usage for fullscreen gaming/videos
+
+# --- Hardware Acceleration ---
+# >= 0: Enable GPU Encoding on /dev/dri/renderD(128 + index)
+# -1: Disable GPU Encoding (System will try NVENC if available when using the x11 backend, Wayland needs this set to a render node)
+settings.vaapi_render_node_index = -1
+
+# --- Change Detection & Optimization ---
+settings.use_paint_over_quality = True  # Enable paint-over/IDR requests for static regions
+settings.paint_over_trigger_frames = 15 # Frames of no motion to trigger paint-over
+settings.damage_block_threshold = 10    # Consecutive changes to trigger "damaged" state
+settings.damage_block_duration = 30     # Frames a stripe stays "damaged"
+
+# --- Watermarking ---
+# Must be a bytes object. The path to your PNG image.
+settings.watermark_path = b"/path/to/your/watermark.png" 
+# 0:None, 1:TopLeft, 2:TopRight, 3:BottomLeft, 4:BottomRight, 5:Middle, 6:Animated
+settings.watermark_location_enum = 4 
+```
+
+### Input Injection (Wayland Only)
+
+In Wayland mode, `pixelflux` acts as the compositor. You cannot use external tools like `xdotool`. Instead, use the input injection methods provided by the `ScreenCapture` instance:
+
+```python
+capture = ScreenCapture()
+capture.start_capture(settings, my_callback)
+
+# Inject Mouse Motion (Absolute coordinates)
+capture.inject_mouse_move(x=500.0, y=300.0)
+
+# Inject Mouse Button (1=Left, 2=Middle, 3=Right, etc.)
+# State: 1 = Pressed, 0 = Released
+capture.inject_mouse_button(btn=1, state=1) 
+
+# Inject Scroll (Vertical/Horizontal)
+capture.inject_mouse_scroll(x=0.0, y=10.0)
+
+# Inject Keyboard Key
+# scancode: Linux raw keycode (e.g., 17 for 'w')
+# state: 1 = Pressed, 0 = Released
+capture.inject_key(scancode=17, state=1)
+```
+
+### Stripe Callback
+
+Your callback receives a `ctypes.POINTER(StripeEncodeResult)`.
+
+```python
+def my_callback(result_ptr, user_data):
+    result = result_ptr.contents
+    
+    # Access data
+    # result.type (0=H264, 1=JPEG)
+    # result.frame_id
+    # result.stripe_y_start
+    
+    # Copy data to Python bytes
+    encoded_data = ctypes.string_at(result.data, result.size)
+    
+    # Send encoded_data to client...
+```
+
+## Zero-Copy Pipeline (Wayland)
+
+The Wayland backend implements a **Zero-Copy** architecture for hardware encoding.
+
+1.  **Rendering:** The compositor renders the desktop to a GPU buffer (GBM).
+2.  **Export:** This buffer is exported as a `Dmabuf` (file descriptor).
+3.  **Encoding:** The `Dmabuf` is imported directly into the encoder context (NVENC or VA-API) without ever copying pixel data to system RAM (CPU).
+
+**Performance Note:** Enabling **watermarking** or utilizing a render node different from the encoding node will force a "Readback" fallback, copying pixels to the CPU and breaking the zero-copy chain. This increases latency and CPU load.
+
+## Features
+
+*   **Hybrid Backend:**
+    *   **X11 (C++):** Legacy support using XShm.
+    *   **Wayland (Rust):** Modern, secure, headless compositor based on [Smithay](https://github.com/Smithay/smithay).
+*   **Flexible Encoding:**
+    *   **Software:** libx264 (H.264) and libjpeg-turbo (JPEG) with multi-threaded striping.
+    *   **Hardware:** NVIDIA NVENC and VA-API (Intel/AMD) with Zero-Copy support.
+*   **Smart Bandwidth Management:**
+    *   **Change Detection:** Encodes only changed stripes (Software/JPEG mode).
+    *   **Paint-Over:** Automatically improves quality for static regions.
+    *   **Damage Throttling:** Limits processing during high-motion scenes.
+*   **Input Handling:** Built-in input injection for mouse and keyboard (Wayland).
+*   **Cursor Compositing:** Hardware cursor planes or software rendering options.
+*   **Dynamic Watermarking:** Overlay PNGs with static positioning or DVD-screensaver style animation.
+
+## License
+
+This project is licensed under the **Mozilla Public License Version 2.0**.
+A copy of the MPL 2.0 can be found at https://mozilla.org/MPL/2.0/.

pixelflux-1.5.3.dist-info/RECORD

@@ -0,0 +1,17 @@
+pixelflux/__init__.py,sha256=VcelO_5diZWiSQuyEUj6fjRZ9kdRG1Hmc5kdGnL2zsk,8416
+pixelflux/pixelflux_wayland.cpython-38-x86_64-linux-gnu.so,sha256=-Cr9AqUOHRbXpyK-_zWJ3iDYAFvYtN5YC725lsiKDLI,4979113
+pixelflux/screen_capture_module.so,sha256=1riEG7xoOrKk0vKp23EpZ-PbMXab0Ht3n9DPqnOYFLY,471057
+pixelflux.libs/libavcodec-cbf5326f.so.62.11.100,sha256=EFNq_xTR33pew8GSUvoX62opVusYKCsEGezi75mOANg,18856945
+pixelflux.libs/libavfilter-ccfe8cc4.so.11.4.100,sha256=iGng9QfxkEHYap4HOZmlrFBuccBEOM7xdWUsC5f-xu0,5964105
+pixelflux.libs/libavformat-51c9d82e.so.62.3.100,sha256=N2SY6gtZLGJ9Pm6xvNEXzdn9TsLlJtckRWkkl7UM1FI,2887105
+pixelflux.libs/libavutil-a197a99a.so.60.8.100,sha256=NFc4QLPhDRi5lkD6LIquH0SNF6U5kE5oFTx9BeO5X5U,1100617
+pixelflux.libs/libjpeg-4c250c2c.so.62.4.0,sha256=nQbnap2EzLMsVJQBPtLHFCo9TvfsfHj8ky4BtmUPrvo,930481
+pixelflux.libs/libswresample-f497f412.so.6.1.100,sha256=EbfbeeZ83ds_kp_XYhsdfZ8ouXrcs-1EjHae0rtuoAk,148753
+pixelflux.libs/libswscale-fb732e58.so.9.1.100,sha256=lQ8vgpcOrCZDnYrV1dLJltSD4sV7kURtka9qdlX5-Qo,1714017
+pixelflux.libs/libx264-d4c7cdf1.so.165,sha256=4SlUu8nrElt9cSnWFHH2S1e6NhAnQlnZAFzLcvtUnVs,2448073
+pixelflux.libs/libyuv-a98a8cc0.so,sha256=kQLAEKxXnwY7yj0I7rilB6INRapmOQFftG5w7dfKBq0,1087969
+pixelflux-1.5.3.dist-info/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+pixelflux-1.5.3.dist-info/METADATA,sha256=Gsmk-TUhYZBWJIkG4nbiewJu5vVVUcihLskUSJh2mW4,9023
+pixelflux-1.5.3.dist-info/WHEEL,sha256=L3HW8fVbXzdi0Qbq6Dl6IkkMSshhqlUpffoAzAKCWvI,111
+pixelflux-1.5.3.dist-info/top_level.txt,sha256=qFojlw7Q8mxa-8CJ_NqmgfQtjUaYLVMI9RUuAPoX8Yg,10
+pixelflux-1.5.3.dist-info/RECORD,,

pixelflux-1.5.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.3.2)
+Root-Is-Purelib: false
+Tag: cp38-cp38-manylinux_2_34_x86_64
+

pixelflux-1.5.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+pixelflux