rtsp-backchannel 0.1.0__tar.gz

rtsp_backchannel-0.1.0/LICENSE

@@ -0,0 +1,6 @@
+ONVIF Backchannel is dual-licensed under the Apache License, Version 2.0,
+or the MIT License, at your option.
+
+See LICENSE-APACHE and LICENSE-MIT for the full license texts.
+
+SPDX-License-Identifier: MIT OR Apache-2.0

rtsp_backchannel-0.1.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rtsp_backchannel-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GagaKor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rtsp_backchannel-0.1.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: rtsp-backchannel
+Version: 0.1.0
+Summary: Discover ONVIF cameras, resolve RTSP streams, and play backchannel audio without GStreamer
+Author: GagaKor
+License-Expression: MIT OR Apache-2.0
+Project-URL: Homepage, https://github.com/GagaKor/rtsp-backchannel
+Project-URL: Repository, https://github.com/GagaKor/rtsp-backchannel.git
+Project-URL: Issues, https://github.com/GagaKor/rtsp-backchannel/issues
+Keywords: onvif,rtsp,audio,rtp,backchannel
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-MIT
+License-File: LICENSE-APACHE
+License-File: THIRD_PARTY_NOTICES.md
+Dynamic: license-file
+
+# RTSP Backchannel for Python
+
+[English](https://github.com/GagaKor/rtsp-backchannel/blob/master/python/README.md) |
+[한국어](https://github.com/GagaKor/rtsp-backchannel/blob/master/python/README.ko.md)
+
+Python library and CLI for discovering ONVIF cameras, resolving profile RTSP
+URIs, and playing one audio file through an ONVIF RTSP backchannel. GStreamer
+is not required.
+
+Other implementations:
+
+- [TypeScript](https://github.com/GagaKor/rtsp-backchannel/blob/master/README.md)
+- [Rust](https://github.com/GagaKor/rtsp-backchannel/blob/master/rust/README.md)
+
+The package starts a backchannel session, sends the complete file at real-time
+speed, and closes the session. It calls a separately installed `ffmpeg`
+executable to decode input audio. PCMA encoding and RTP/RTSP transport are
+implemented in Python. FFmpeg is not bundled or installed by this package.
+
+## Requirements
+
+- Python 3.11 or later
+- `ffmpeg` on `PATH` for file playback
+- A camera that exposes an ONVIF `sendonly` PCMA audio backchannel
+
+Discovery and stream URI lookup do not require FFmpeg.
+
+## Installation
+
+Install a released version from PyPI:
+
+```bash
+python3 -m pip install rtsp-backchannel
+```
+
+To install the current `master` source instead of a registry release:
+
+```bash
+python3 -m pip install \
+  "git+https://github.com/GagaKor/rtsp-backchannel.git#subdirectory=python"
+```
+
+Install FFmpeg separately when playback is required:
+
+```bash
+# macOS
+brew install ffmpeg
+
+# Ubuntu or Debian
+sudo apt-get update
+sudo apt-get install ffmpeg
+```
+
+On Windows, install a build from the
+[FFmpeg download page](https://ffmpeg.org/download.html) and add the directory
+containing `ffmpeg.exe` to `PATH`.
+
+## Quick Playback
+
+```python
+import os
+
+from rtsp_backchannel import play_file
+
+result = play_file(
+    host="camera.local",
+    user="admin",
+    password=os.environ["ONVIF_PASSWORD"],
+    file="/absolute/path/to/event.mp3",
+    volume=0.05,
+)
+
+print(result.packets_sent, result.duration_seconds)
+```
+
+`volume` must be between `0.0` and `1.0`. The tested default is `0.05`.
+
+## Complete Workflow
+
+Discovery is optional when the camera address is already known. Stream lookup
+is useful for inspecting ONVIF Media Profiles, but `play_file` currently opens
+the first profile independently and does not accept a `StreamUri` selected by
+the caller.
+
+```python
+import os
+
+from rtsp_backchannel import (
+    discover_devices,
+    get_stream_uris,
+    play_file,
+)
+
+password = os.environ["ONVIF_PASSWORD"]
+
+devices = discover_devices(timeout=3.0)
+if not devices:
+    raise RuntimeError("no ONVIF device found")
+camera = devices[0]
+
+streams = get_stream_uris(
+    host=camera.ip,
+    user="admin",
+    password=password,
+    device_urls=camera.xaddrs,
+    timeout=8.0,
+)
+
+for stream in streams:
+    print(stream.profile_token, stream.profile_name, stream.uri)
+
+result = play_file(
+    host=camera.ip,
+    user="admin",
+    password=password,
+    file="/absolute/path/to/event.mp3",
+    volume=0.05,
+)
+
+print(result.codec, result.packets_sent, result.duration_seconds)
+```
+
+## Public API
+
+### `discover_devices`
+
+```python
+discover_devices(
+    *,
+    timeout: float = 3.0,
+    interfaces: list[str] | None = None,
+) -> list[DiscoveredDevice]
+```
+
+Searches selected local IPv4 interfaces with WS-Discovery. Omitting
+`interfaces` uses addresses detected from hostname resolution and the default
+route. Pass every local IPv4 address explicitly when multiple NICs or VLANs
+must be covered. Each result contains `ip`, `xaddrs`, `scopes`, and optional
+`name`, `hardware`, and `endpoint_reference` fields.
+
+WS-Discovery multicast is normally not routed, so discovery must run from the
+same subnet or VLAN as the camera.
+
+### `get_stream_uris`
+
+```python
+get_stream_uris(
+    *,
+    host: str,
+    user: str,
+    password: str,
+    device_urls: list[str] | None = None,
+    timeout: float = 8.0,
+) -> list[StreamUri]
+```
+
+Authenticates with the ONVIF Device and Media services and returns every Media
+Profile's `profile_token`, optional `profile_name`, and `uri`. Credentials are
+not inserted into returned RTSP URIs.
+
+### `play_file`
+
+```python
+play_file(
+    *,
+    host: str,
+    user: str,
+    password: str,
+    file: str,
+    volume: float = 0.05,
+) -> PlaybackResult
+```
+
+`PlaybackResult` contains `codec`, `sample_rate`, `payload_type`, `rtp_channel`,
+`encoded_bytes`, `packets_sent`, and `duration_seconds`. Invalid arguments,
+authentication failures, network failures, and unsupported camera SDP are
+reported as exceptions.
+
+## CLI
+
+Read the password without echoing it or placing it in shell history:
+
+```bash
+printf 'Camera password: '
+read -rs ONVIF_PASSWORD
+printf '\n'
+export ONVIF_PASSWORD
+```
+
+Then use the installed command:
+
+```bash
+# Discover cameras. Output is one JSON object per line.
+rtsp-backchannel discover --timeout-ms 3000
+
+# Search explicit interfaces on a multi-NIC or multi-VLAN host.
+rtsp-backchannel discover \
+  --interface 192.0.2.20 \
+  --interface 198.51.100.20
+
+# Resolve RTSP URIs for all ONVIF Media Profiles.
+rtsp-backchannel streams \
+  --host camera.local \
+  --user admin
+
+# Play one file and close the RTSP session.
+rtsp-backchannel play \
+  --host camera.local \
+  --user admin \
+  --file '/absolute/path/to/event.mp3' \
+  --volume 0.05
+```
+
+The `play` word is optional for backward compatibility. `--pass` is available
+for manual use, but `ONVIF_PASSWORD` avoids exposing the password in the
+process argument list.
+
+## Playback Behavior
+
+- PCMA (G.711 A-law) at 8 kHz mono
+- TCP interleaved RTP
+- 40 ms audio packets with real-time pacing
+- RTSP keepalive during long files
+- RTSP teardown after success or failure
+
+The first ONVIF Media Profile must expose a `sendonly` PCMA audio track. Audio
+output and decoder configuration are camera-specific; a successful RTSP
+session does not override disabled or misrouted camera audio output settings.
+
+## Development
+
+From the repository root:
+
+```bash
+PYTHONPATH=python:. python3 -m unittest discover -s python -p 'test_*.py'
+python3 -m build python
+python3 -m twine check python/dist/*
+```
+
+Release preparation and registry publishing are documented in
+[RELEASING.md](https://github.com/GagaKor/rtsp-backchannel/blob/master/RELEASING.md).
+
+## License
+
+Licensed under either
+[MIT](https://github.com/GagaKor/rtsp-backchannel/blob/master/python/LICENSE-MIT)
+or
+[Apache-2.0](https://github.com/GagaKor/rtsp-backchannel/blob/master/python/LICENSE-APACHE),
+at your option.
+
+This package does not include or link FFmpeg. If an application bundles or
+redistributes FFmpeg, review the license terms of that FFmpeg build separately.
+See [FFmpeg Legal](https://ffmpeg.org/legal.html) and
+[THIRD_PARTY_NOTICES.md](https://github.com/GagaKor/rtsp-backchannel/blob/master/python/THIRD_PARTY_NOTICES.md).
+
+ONVIF is a trademark of ONVIF, Inc. This independent project is not affiliated
+with or endorsed by ONVIF, Inc. and does not claim ONVIF Profile conformance.