vsaiortc 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. vsaiortc-0.0.1/CODE_OF_CONDUCT.md +46 -0
  2. vsaiortc-0.0.1/LICENSE +25 -0
  3. vsaiortc-0.0.1/MANIFEST.in +10 -0
  4. vsaiortc-0.0.1/PKG-INFO +165 -0
  5. vsaiortc-0.0.1/README.rst +127 -0
  6. vsaiortc-0.0.1/docs/Makefile +20 -0
  7. vsaiortc-0.0.1/docs/_static/vsaiortc.svg +156 -0
  8. vsaiortc-0.0.1/docs/api.rst +126 -0
  9. vsaiortc-0.0.1/docs/changelog.rst +763 -0
  10. vsaiortc-0.0.1/docs/conf.py +79 -0
  11. vsaiortc-0.0.1/docs/contributing.rst +44 -0
  12. vsaiortc-0.0.1/docs/examples.rst +9 -0
  13. vsaiortc-0.0.1/docs/helpers.rst +28 -0
  14. vsaiortc-0.0.1/docs/index.rst +64 -0
  15. vsaiortc-0.0.1/docs/license.rst +4 -0
  16. vsaiortc-0.0.1/examples/datachannel-cli/README.rst +27 -0
  17. vsaiortc-0.0.1/examples/datachannel-cli/cli.py +124 -0
  18. vsaiortc-0.0.1/examples/datachannel-filexfer/README.rst +33 -0
  19. vsaiortc-0.0.1/examples/datachannel-filexfer/filexfer.py +121 -0
  20. vsaiortc-0.0.1/examples/datachannel-vpn/README.rst +60 -0
  21. vsaiortc-0.0.1/examples/datachannel-vpn/tuntap.py +96 -0
  22. vsaiortc-0.0.1/examples/datachannel-vpn/vpn.py +109 -0
  23. vsaiortc-0.0.1/examples/janus/README.rst +48 -0
  24. vsaiortc-0.0.1/examples/janus/janus.py +267 -0
  25. vsaiortc-0.0.1/examples/server/README.rst +52 -0
  26. vsaiortc-0.0.1/examples/server/client.js +319 -0
  27. vsaiortc-0.0.1/examples/server/demo-instruct.wav +0 -0
  28. vsaiortc-0.0.1/examples/server/index.html +119 -0
  29. vsaiortc-0.0.1/examples/server/server.py +214 -0
  30. vsaiortc-0.0.1/examples/videostream-cli/README.rst +55 -0
  31. vsaiortc-0.0.1/examples/videostream-cli/cli.py +169 -0
  32. vsaiortc-0.0.1/examples/webcam/README.rst +96 -0
  33. vsaiortc-0.0.1/examples/webcam/client.js +76 -0
  34. vsaiortc-0.0.1/examples/webcam/index.html +43 -0
  35. vsaiortc-0.0.1/examples/webcam/webcam.py +164 -0
  36. vsaiortc-0.0.1/pyproject.toml +82 -0
  37. vsaiortc-0.0.1/requirements/doc.txt +2 -0
  38. vsaiortc-0.0.1/scripts/fetch-vendor.json +5 -0
  39. vsaiortc-0.0.1/scripts/fetch-vendor.py +64 -0
  40. vsaiortc-0.0.1/setup.cfg +4 -0
  41. vsaiortc-0.0.1/setup.py +21 -0
  42. vsaiortc-0.0.1/src/_cffi_src/build_opus.py +56 -0
  43. vsaiortc-0.0.1/src/_cffi_src/build_vpx.py +256 -0
  44. vsaiortc-0.0.1/src/vsaiortc/__init__.py +56 -0
  45. vsaiortc-0.0.1/src/vsaiortc/clock.py +29 -0
  46. vsaiortc-0.0.1/src/vsaiortc/codecs/__init__.py +183 -0
  47. vsaiortc-0.0.1/src/vsaiortc/codecs/_opus.pyi +4 -0
  48. vsaiortc-0.0.1/src/vsaiortc/codecs/_vpx.pyi +4 -0
  49. vsaiortc-0.0.1/src/vsaiortc/codecs/base.py +25 -0
  50. vsaiortc-0.0.1/src/vsaiortc/codecs/g711.py +91 -0
  51. vsaiortc-0.0.1/src/vsaiortc/codecs/h264.py +349 -0
  52. vsaiortc-0.0.1/src/vsaiortc/codecs/opus.py +113 -0
  53. vsaiortc-0.0.1/src/vsaiortc/codecs/vpx.py +400 -0
  54. vsaiortc-0.0.1/src/vsaiortc/contrib/__init__.py +0 -0
  55. vsaiortc-0.0.1/src/vsaiortc/contrib/media.py +609 -0
  56. vsaiortc-0.0.1/src/vsaiortc/contrib/signaling.py +218 -0
  57. vsaiortc-0.0.1/src/vsaiortc/events.py +20 -0
  58. vsaiortc-0.0.1/src/vsaiortc/exceptions.py +14 -0
  59. vsaiortc-0.0.1/src/vsaiortc/jitterbuffer.py +123 -0
  60. vsaiortc-0.0.1/src/vsaiortc/mediastreams.py +149 -0
  61. vsaiortc-0.0.1/src/vsaiortc/py.typed +1 -0
  62. vsaiortc-0.0.1/src/vsaiortc/rate.py +579 -0
  63. vsaiortc-0.0.1/src/vsaiortc/rtcconfiguration.py +33 -0
  64. vsaiortc-0.0.1/src/vsaiortc/rtcdatachannel.py +216 -0
  65. vsaiortc-0.0.1/src/vsaiortc/rtcdtlstransport.py +699 -0
  66. vsaiortc-0.0.1/src/vsaiortc/rtcicetransport.py +365 -0
  67. vsaiortc-0.0.1/src/vsaiortc/rtcpeerconnection.py +1307 -0
  68. vsaiortc-0.0.1/src/vsaiortc/rtcrtpparameters.py +170 -0
  69. vsaiortc-0.0.1/src/vsaiortc/rtcrtpreceiver.py +618 -0
  70. vsaiortc-0.0.1/src/vsaiortc/rtcrtpsender.py +463 -0
  71. vsaiortc-0.0.1/src/vsaiortc/rtcrtptransceiver.py +156 -0
  72. vsaiortc-0.0.1/src/vsaiortc/rtcsctptransport.py +1818 -0
  73. vsaiortc-0.0.1/src/vsaiortc/rtcsessiondescription.py +19 -0
  74. vsaiortc-0.0.1/src/vsaiortc/rtp.py +785 -0
  75. vsaiortc-0.0.1/src/vsaiortc/sdp.py +582 -0
  76. vsaiortc-0.0.1/src/vsaiortc/stats.py +114 -0
  77. vsaiortc-0.0.1/src/vsaiortc/utils.py +54 -0
  78. vsaiortc-0.0.1/src/vsaiortc.egg-info/PKG-INFO +165 -0
  79. vsaiortc-0.0.1/src/vsaiortc.egg-info/SOURCES.txt +150 -0
  80. vsaiortc-0.0.1/src/vsaiortc.egg-info/dependency_links.txt +1 -0
  81. vsaiortc-0.0.1/src/vsaiortc.egg-info/requires.txt +16 -0
  82. vsaiortc-0.0.1/src/vsaiortc.egg-info/top_level.txt +1 -0
  83. vsaiortc-0.0.1/stubs/av/__init__.pyi +84 -0
  84. vsaiortc-0.0.1/stubs/av/frame.pyi +5 -0
  85. vsaiortc-0.0.1/stubs/crc32c.pyi +1 -0
  86. vsaiortc-0.0.1/stubs/google_crc32c.pyi +1 -0
  87. vsaiortc-0.0.1/stubs/pyee.pyi +6 -0
  88. vsaiortc-0.0.1/tests/__init__.py +0 -0
  89. vsaiortc-0.0.1/tests/codecs.py +144 -0
  90. vsaiortc-0.0.1/tests/h264_0000.bin +0 -0
  91. vsaiortc-0.0.1/tests/h264_0001.bin +0 -0
  92. vsaiortc-0.0.1/tests/h264_0002.bin +1 -0
  93. vsaiortc-0.0.1/tests/h264_0003.bin +0 -0
  94. vsaiortc-0.0.1/tests/rtcp_bye.bin +0 -0
  95. vsaiortc-0.0.1/tests/rtcp_bye_invalid.bin +0 -0
  96. vsaiortc-0.0.1/tests/rtcp_bye_no_sources.bin +0 -0
  97. vsaiortc-0.0.1/tests/rtcp_bye_padding.bin +0 -0
  98. vsaiortc-0.0.1/tests/rtcp_psfb_invalid.bin +0 -0
  99. vsaiortc-0.0.1/tests/rtcp_psfb_pli.bin +0 -0
  100. vsaiortc-0.0.1/tests/rtcp_rr.bin +0 -0
  101. vsaiortc-0.0.1/tests/rtcp_rr_invalid.bin +0 -0
  102. vsaiortc-0.0.1/tests/rtcp_rtpfb.bin +0 -0
  103. vsaiortc-0.0.1/tests/rtcp_rtpfb_invalid.bin +0 -0
  104. vsaiortc-0.0.1/tests/rtcp_sdes.bin +0 -0
  105. vsaiortc-0.0.1/tests/rtcp_sdes_item_truncated.bin +0 -0
  106. vsaiortc-0.0.1/tests/rtcp_sdes_source_truncated.bin +0 -0
  107. vsaiortc-0.0.1/tests/rtcp_sr.bin +0 -0
  108. vsaiortc-0.0.1/tests/rtcp_sr_invalid.bin +0 -0
  109. vsaiortc-0.0.1/tests/rtp.bin +0 -0
  110. vsaiortc-0.0.1/tests/rtp_dtmf.bin +1 -0
  111. vsaiortc-0.0.1/tests/rtp_only_padding.bin +0 -0
  112. vsaiortc-0.0.1/tests/rtp_only_padding_with_header_extensions.bin +0 -0
  113. vsaiortc-0.0.1/tests/rtp_with_csrc.bin +0 -0
  114. vsaiortc-0.0.1/tests/rtp_with_sdes_mid.bin +0 -0
  115. vsaiortc-0.0.1/tests/sctp_abort.bin +0 -0
  116. vsaiortc-0.0.1/tests/sctp_cookie_echo.bin +0 -0
  117. vsaiortc-0.0.1/tests/sctp_data.bin +0 -0
  118. vsaiortc-0.0.1/tests/sctp_data_padding.bin +0 -0
  119. vsaiortc-0.0.1/tests/sctp_error.bin +0 -0
  120. vsaiortc-0.0.1/tests/sctp_forward_tsn.bin +0 -0
  121. vsaiortc-0.0.1/tests/sctp_heartbeat.bin +0 -0
  122. vsaiortc-0.0.1/tests/sctp_init.bin +0 -0
  123. vsaiortc-0.0.1/tests/sctp_init_bad_verification.bin +0 -0
  124. vsaiortc-0.0.1/tests/sctp_reconfig_add_out.bin +0 -0
  125. vsaiortc-0.0.1/tests/sctp_reconfig_reset_out.bin +0 -0
  126. vsaiortc-0.0.1/tests/sctp_reconfig_response.bin +0 -0
  127. vsaiortc-0.0.1/tests/sctp_sack.bin +0 -0
  128. vsaiortc-0.0.1/tests/sctp_shutdown.bin +0 -0
  129. vsaiortc-0.0.1/tests/test_clock.py +31 -0
  130. vsaiortc-0.0.1/tests/test_codecs.py +18 -0
  131. vsaiortc-0.0.1/tests/test_contrib_media.py +737 -0
  132. vsaiortc-0.0.1/tests/test_contrib_signaling.py +210 -0
  133. vsaiortc-0.0.1/tests/test_g711.py +170 -0
  134. vsaiortc-0.0.1/tests/test_h264.py +303 -0
  135. vsaiortc-0.0.1/tests/test_jitterbuffer.py +318 -0
  136. vsaiortc-0.0.1/tests/test_mediastreams.py +68 -0
  137. vsaiortc-0.0.1/tests/test_opus.py +110 -0
  138. vsaiortc-0.0.1/tests/test_ortc.py +76 -0
  139. vsaiortc-0.0.1/tests/test_rate.py +976 -0
  140. vsaiortc-0.0.1/tests/test_rtcdtlstransport.py +587 -0
  141. vsaiortc-0.0.1/tests/test_rtcicetransport.py +436 -0
  142. vsaiortc-0.0.1/tests/test_rtcpeerconnection.py +5144 -0
  143. vsaiortc-0.0.1/tests/test_rtcrtpreceiver.py +574 -0
  144. vsaiortc-0.0.1/tests/test_rtcrtpsender.py +455 -0
  145. vsaiortc-0.0.1/tests/test_rtcrtptransceiver.py +50 -0
  146. vsaiortc-0.0.1/tests/test_rtcsctptransport.py +2344 -0
  147. vsaiortc-0.0.1/tests/test_rtcsessiondescription.py +19 -0
  148. vsaiortc-0.0.1/tests/test_rtp.py +702 -0
  149. vsaiortc-0.0.1/tests/test_sdp.py +2037 -0
  150. vsaiortc-0.0.1/tests/test_utils.py +60 -0
  151. vsaiortc-0.0.1/tests/test_vpx.py +272 -0
  152. vsaiortc-0.0.1/tests/utils.py +117 -0
@@ -0,0 +1,46 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ ## Our Standards
8
+
9
+ Examples of behavior that contributes to creating a positive environment include:
10
+
11
+ * Using welcoming and inclusive language
12
+ * Being respectful of differing viewpoints and experiences
13
+ * Gracefully accepting constructive criticism
14
+ * Focusing on what is best for the community
15
+ * Showing empathy towards other community members
16
+
17
+ Examples of unacceptable behavior by participants include:
18
+
19
+ * The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+ * Trolling, insulting/derogatory comments, and personal or political attacks
21
+ * Public or private harassment
22
+ * Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+ ## Our Responsibilities
26
+
27
+ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ ## Scope
32
+
33
+ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+ ## Enforcement
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jeremy.laine@m4x.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+ Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+ ## Attribution
42
+
43
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44
+
45
+ [homepage]: http://contributor-covenant.org
46
+ [version]: http://contributor-covenant.org/version/1/4/
vsaiortc-0.0.1/LICENSE ADDED
@@ -0,0 +1,25 @@
1
+ Copyright (c) Jeremy Lainé.
2
+ All rights reserved.
3
+
4
+ Redistribution and use in source and binary forms, with or without
5
+ modification, are permitted provided that the following conditions are met:
6
+
7
+ * Redistributions of source code must retain the above copyright notice,
8
+ this list of conditions and the following disclaimer.
9
+ * Redistributions in binary form must reproduce the above copyright notice,
10
+ this list of conditions and the following disclaimer in the documentation
11
+ and/or other materials provided with the distribution.
12
+ * Neither the name of aiortc nor the names of its contributors may
13
+ be used to endorse or promote products derived from this software without
14
+ specific prior written permission.
15
+
16
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,10 @@
1
+ exclude .readthedocs.yaml
2
+ include CODE_OF_CONDUCT.md
3
+ include LICENSE
4
+ recursive-include docs *.py *.rst *.svg Makefile
5
+ recursive-include examples *.html *.js *.py *.rst *.wav
6
+ recursive-include requirements *.txt
7
+ recursive-include scripts *.json *.py
8
+ recursive-include src/_cffi_src *.py
9
+ recursive-include stubs *.pyi
10
+ recursive-include tests *.bin *.py
@@ -0,0 +1,165 @@
1
+ Metadata-Version: 2.1
2
+ Name: vsaiortc
3
+ Version: 0.0.1
4
+ Summary: An implementation of WebRTC and ORTC
5
+ Author-email: Yash Chudasama <yash@videosdk.live>, Ankit Chotaliya <ankit@videosdk.live>
6
+ License: BSD-3-Clause
7
+ Project-URL: homepage, https://github.com/zujonow/vs-aiortc
8
+ Project-URL: issues, https://github.com/zujonow/vs-aiortc/issues
9
+ Project-URL: documentation, https://docs.videosdk.live
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Environment :: Web Environment
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: BSD License
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Requires-Python: >=3.8
23
+ Description-Content-Type: text/x-rst
24
+ License-File: LICENSE
25
+ Requires-Dist: aioice<1.0.0,>=0.9.0
26
+ Requires-Dist: av<13.0.0,>=9.0.0
27
+ Requires-Dist: cffi>=1.0.0
28
+ Requires-Dist: cryptography>=42.0.0
29
+ Requires-Dist: dataclasses; python_version < "3.7"
30
+ Requires-Dist: google-crc32c>=1.1
31
+ Requires-Dist: pyee>=9.0.0
32
+ Requires-Dist: pylibsrtp>=0.10.0
33
+ Requires-Dist: pyopenssl>=24.0.0
34
+ Provides-Extra: dev
35
+ Requires-Dist: aiohttp>=3.7.0; extra == "dev"
36
+ Requires-Dist: coverage[toml]>=7.2.2; extra == "dev"
37
+ Requires-Dist: numpy>=1.19.0; extra == "dev"
38
+
39
+ .. image:: docs/_static/aiortc.svg
40
+ :width: 120px
41
+ :alt: aiortc
42
+
43
+ .. image:: https://img.shields.io/pypi/l/aiortc.svg
44
+ :target: https://pypi.python.org/pypi/aiortc
45
+ :alt: License
46
+
47
+ .. image:: https://img.shields.io/pypi/v/aiortc.svg
48
+ :target: https://pypi.python.org/pypi/aiortc
49
+ :alt: Version
50
+
51
+ .. image:: https://img.shields.io/pypi/pyversions/aiortc.svg
52
+ :target: https://pypi.python.org/pypi/aiortc
53
+ :alt: Python versions
54
+
55
+ .. image:: https://github.com/zujonow/vs-aiortc/workflows/tests/badge.svg
56
+ :target: https://github.com/zujonow/vs-aiortc/actions
57
+ :alt: Tests
58
+
59
+ .. image:: https://img.shields.io/codecov/c/github/aiortc/aiortc.svg
60
+ :target: https://codecov.io/gh/aiortc/aiortc
61
+ :alt: Coverage
62
+
63
+ .. image:: https://readthedocs.org/projects/aiortc/badge/?version=latest
64
+ :target: https://aiortc.readthedocs.io/
65
+ :alt: Documentation
66
+
67
+ What is ``vsaiortc``?
68
+ ----------------------
69
+
70
+ ``vsaiortc`` is a library for `Web Real-Time Communication (WebRTC)`_ and
71
+ `Object Real-Time Communication (ORTC)`_ in Python. It is built on top of
72
+ ``asyncio``, Python's standard asynchronous I/O framework.
73
+
74
+ The API closely follows its Javascript counterpart while using pythonic
75
+ constructs:
76
+
77
+ - promises are replaced by coroutines
78
+ - events are emitted using ``pyee.EventEmitter``
79
+
80
+ To learn more about ``vsaiortc`` please `read the documentation`_.
81
+
82
+ .. _Web Real-Time Communication (WebRTC): https://webrtc.org/
83
+ .. _Object Real-Time Communication (ORTC): https://ortc.org/
84
+ .. _read the documentation: https://aiortc.readthedocs.io/en/latest/
85
+
86
+ Why should I use ``vsaiortc``?
87
+ -------------------------------
88
+
89
+ The main WebRTC and ORTC implementations are either built into web browsers,
90
+ or come in the form of native code. While they are extensively battle tested,
91
+ their internals are complex and they do not provide Python bindings.
92
+ Furthermore they are tightly coupled to a media stack, making it hard to plug
93
+ in audio or video processing algorithms.
94
+
95
+ In contrast, the ``vsaiortc`` implementation is fairly simple and readable. As
96
+ such it is a good starting point for programmers wishing to understand how
97
+ WebRTC works or tinker with its internals. It is also easy to create innovative
98
+ products by leveraging the extensive modules available in the Python ecosystem.
99
+ For instance you can build a full server handling both signaling and data
100
+ channels or apply computer vision algorithms to video frames using OpenCV.
101
+
102
+ Furthermore, a lot of effort has gone into writing an extensive test suite for
103
+ the ``vsaiortc`` code to ensure best-in-class code quality.
104
+
105
+ Implementation status
106
+ ---------------------
107
+
108
+ ``vsaiortc`` allows you to exchange audio, video and data channels and
109
+ interoperability is regularly tested against both Chrome and Firefox. Here are
110
+ some of its features:
111
+
112
+ - SDP generation / parsing
113
+ - Interactive Connectivity Establishment, with half-trickle and mDNS support
114
+ - DTLS key and certificate generation
115
+ - DTLS handshake, encryption / decryption (for SCTP)
116
+ - SRTP keying, encryption and decryption for RTP and RTCP
117
+ - Pure Python SCTP implementation
118
+ - Data Channels
119
+ - Sending and receiving audio (Opus / PCMU / PCMA)
120
+ - Sending and receiving video (VP8 / H.264)
121
+ - Bundling audio / video / data channels
122
+ - RTCP reports, including NACK / PLI to recover from packet loss
123
+
124
+ Installing
125
+ ----------
126
+
127
+ The easiest way to install ``vsaiortc`` is to run:
128
+
129
+ .. code:: bash
130
+
131
+ pip install vsaiortc
132
+
133
+ Building from source
134
+ --------------------
135
+
136
+ If there are no wheels for your system or if you wish to build aiortc from
137
+ source you will need a couple of libraries installed on your system:
138
+
139
+ - Opus for audio encoding / decoding
140
+ - LibVPX for video encoding / decoding
141
+
142
+ Linux
143
+ .....
144
+
145
+ On Debian/Ubuntu run:
146
+
147
+ .. code:: bash
148
+
149
+ apt install libopus-dev libvpx-dev
150
+
151
+ OS X
152
+ ....
153
+
154
+ On OS X run:
155
+
156
+ .. code:: bash
157
+
158
+ brew install opus libvpx
159
+
160
+ License
161
+ -------
162
+
163
+ ``vsaiortc`` is released under the `BSD license`_.
164
+
165
+ .. _BSD license: https://aiortc.readthedocs.io/en/latest/license.html
@@ -0,0 +1,127 @@
1
+ .. image:: docs/_static/aiortc.svg
2
+ :width: 120px
3
+ :alt: aiortc
4
+
5
+ .. image:: https://img.shields.io/pypi/l/aiortc.svg
6
+ :target: https://pypi.python.org/pypi/aiortc
7
+ :alt: License
8
+
9
+ .. image:: https://img.shields.io/pypi/v/aiortc.svg
10
+ :target: https://pypi.python.org/pypi/aiortc
11
+ :alt: Version
12
+
13
+ .. image:: https://img.shields.io/pypi/pyversions/aiortc.svg
14
+ :target: https://pypi.python.org/pypi/aiortc
15
+ :alt: Python versions
16
+
17
+ .. image:: https://github.com/zujonow/vs-aiortc/workflows/tests/badge.svg
18
+ :target: https://github.com/zujonow/vs-aiortc/actions
19
+ :alt: Tests
20
+
21
+ .. image:: https://img.shields.io/codecov/c/github/aiortc/aiortc.svg
22
+ :target: https://codecov.io/gh/aiortc/aiortc
23
+ :alt: Coverage
24
+
25
+ .. image:: https://readthedocs.org/projects/aiortc/badge/?version=latest
26
+ :target: https://aiortc.readthedocs.io/
27
+ :alt: Documentation
28
+
29
+ What is ``vsaiortc``?
30
+ ----------------------
31
+
32
+ ``vsaiortc`` is a library for `Web Real-Time Communication (WebRTC)`_ and
33
+ `Object Real-Time Communication (ORTC)`_ in Python. It is built on top of
34
+ ``asyncio``, Python's standard asynchronous I/O framework.
35
+
36
+ The API closely follows its Javascript counterpart while using pythonic
37
+ constructs:
38
+
39
+ - promises are replaced by coroutines
40
+ - events are emitted using ``pyee.EventEmitter``
41
+
42
+ To learn more about ``vsaiortc`` please `read the documentation`_.
43
+
44
+ .. _Web Real-Time Communication (WebRTC): https://webrtc.org/
45
+ .. _Object Real-Time Communication (ORTC): https://ortc.org/
46
+ .. _read the documentation: https://aiortc.readthedocs.io/en/latest/
47
+
48
+ Why should I use ``vsaiortc``?
49
+ -------------------------------
50
+
51
+ The main WebRTC and ORTC implementations are either built into web browsers,
52
+ or come in the form of native code. While they are extensively battle tested,
53
+ their internals are complex and they do not provide Python bindings.
54
+ Furthermore they are tightly coupled to a media stack, making it hard to plug
55
+ in audio or video processing algorithms.
56
+
57
+ In contrast, the ``vsaiortc`` implementation is fairly simple and readable. As
58
+ such it is a good starting point for programmers wishing to understand how
59
+ WebRTC works or tinker with its internals. It is also easy to create innovative
60
+ products by leveraging the extensive modules available in the Python ecosystem.
61
+ For instance you can build a full server handling both signaling and data
62
+ channels or apply computer vision algorithms to video frames using OpenCV.
63
+
64
+ Furthermore, a lot of effort has gone into writing an extensive test suite for
65
+ the ``vsaiortc`` code to ensure best-in-class code quality.
66
+
67
+ Implementation status
68
+ ---------------------
69
+
70
+ ``vsaiortc`` allows you to exchange audio, video and data channels and
71
+ interoperability is regularly tested against both Chrome and Firefox. Here are
72
+ some of its features:
73
+
74
+ - SDP generation / parsing
75
+ - Interactive Connectivity Establishment, with half-trickle and mDNS support
76
+ - DTLS key and certificate generation
77
+ - DTLS handshake, encryption / decryption (for SCTP)
78
+ - SRTP keying, encryption and decryption for RTP and RTCP
79
+ - Pure Python SCTP implementation
80
+ - Data Channels
81
+ - Sending and receiving audio (Opus / PCMU / PCMA)
82
+ - Sending and receiving video (VP8 / H.264)
83
+ - Bundling audio / video / data channels
84
+ - RTCP reports, including NACK / PLI to recover from packet loss
85
+
86
+ Installing
87
+ ----------
88
+
89
+ The easiest way to install ``vsaiortc`` is to run:
90
+
91
+ .. code:: bash
92
+
93
+ pip install vsaiortc
94
+
95
+ Building from source
96
+ --------------------
97
+
98
+ If there are no wheels for your system or if you wish to build aiortc from
99
+ source you will need a couple of libraries installed on your system:
100
+
101
+ - Opus for audio encoding / decoding
102
+ - LibVPX for video encoding / decoding
103
+
104
+ Linux
105
+ .....
106
+
107
+ On Debian/Ubuntu run:
108
+
109
+ .. code:: bash
110
+
111
+ apt install libopus-dev libvpx-dev
112
+
113
+ OS X
114
+ ....
115
+
116
+ On OS X run:
117
+
118
+ .. code:: bash
119
+
120
+ brew install opus libvpx
121
+
122
+ License
123
+ -------
124
+
125
+ ``vsaiortc`` is released under the `BSD license`_.
126
+
127
+ .. _BSD license: https://aiortc.readthedocs.io/en/latest/license.html
@@ -0,0 +1,20 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ SPHINXPROJ = vsaiortc
8
+ SOURCEDIR = .
9
+ BUILDDIR = _build
10
+
11
+ # Put it first so that "make" without argument is like "make help".
12
+ help:
13
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
+
15
+ .PHONY: help Makefile
16
+
17
+ # Catch-all target: route all unknown targets to Sphinx using the new
18
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19
+ %: Makefile
20
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,156 @@
1
+ <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
+ <!-- Created with Inkscape (http://www.inkscape.org/) -->
3
+
4
+ <svg
5
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
6
+ xmlns:cc="http://creativecommons.org/ns#"
7
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
8
+ xmlns:svg="http://www.w3.org/2000/svg"
9
+ xmlns="http://www.w3.org/2000/svg"
10
+ xmlns:xlink="http://www.w3.org/1999/xlink"
11
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
12
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
13
+ width="128"
14
+ height="128"
15
+ viewBox="0 0 33.866666 33.866666"
16
+ version="1.1"
17
+ id="svg8"
18
+ inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
19
+ sodipodi:docname="vsaiortc.svg"
20
+ inkscape:export-filename="/home/sharky/aiortc3.png"
21
+ inkscape:export-xdpi="600.55133"
22
+ inkscape:export-ydpi="600.55133">
23
+ <defs
24
+ id="defs2">
25
+ <linearGradient
26
+ inkscape:collect="always"
27
+ id="linearGradient1480">
28
+ <stop
29
+ style="stop-color:#646464;stop-opacity:1"
30
+ offset="0"
31
+ id="stop1476" />
32
+ <stop
33
+ style="stop-color:#3c3c28;stop-opacity:1"
34
+ offset="1"
35
+ id="stop1478" />
36
+ </linearGradient>
37
+ <linearGradient
38
+ inkscape:collect="always"
39
+ id="linearGradient1472">
40
+ <stop
41
+ style="stop-color:#ffe873;stop-opacity:1"
42
+ offset="0"
43
+ id="stop1468" />
44
+ <stop
45
+ style="stop-color:#ffd43b;stop-opacity:1"
46
+ offset="1"
47
+ id="stop1470" />
48
+ </linearGradient>
49
+ <linearGradient
50
+ inkscape:collect="always"
51
+ id="linearGradient1464">
52
+ <stop
53
+ style="stop-color:#4b8bbe;stop-opacity:1"
54
+ offset="0"
55
+ id="stop1460" />
56
+ <stop
57
+ style="stop-color:#306998;stop-opacity:1"
58
+ offset="1"
59
+ id="stop1462" />
60
+ </linearGradient>
61
+ <linearGradient
62
+ inkscape:collect="always"
63
+ xlink:href="#linearGradient1464"
64
+ id="linearGradient1466"
65
+ x1="2.3535423"
66
+ y1="288.07381"
67
+ x2="10.399052"
68
+ y2="288.07381"
69
+ gradientUnits="userSpaceOnUse"
70
+ gradientTransform="matrix(1.2465011,0,0,1.1246456,-1.1340114,-39.600009)" />
71
+ <linearGradient
72
+ inkscape:collect="always"
73
+ xlink:href="#linearGradient1472"
74
+ id="linearGradient1474"
75
+ x1="20.321207"
76
+ y1="288.24508"
77
+ x2="32.139252"
78
+ y2="288.24508"
79
+ gradientUnits="userSpaceOnUse"
80
+ gradientTransform="matrix(1.2465011,0,0,1.1246456,-7.1179002,-39.985345)" />
81
+ <linearGradient
82
+ inkscape:collect="always"
83
+ xlink:href="#linearGradient1480"
84
+ id="linearGradient1482"
85
+ x1="11.399929"
86
+ y1="285.63503"
87
+ x2="19.07011"
88
+ y2="285.63503"
89
+ gradientUnits="userSpaceOnUse"
90
+ gradientTransform="matrix(1.2465011,0,0,1.1246456,-2.809733,-39.970071)" />
91
+ </defs>
92
+ <sodipodi:namedview
93
+ id="base"
94
+ pagecolor="#ffffff"
95
+ bordercolor="#666666"
96
+ borderopacity="1.0"
97
+ inkscape:pageopacity="0.0"
98
+ inkscape:pageshadow="2"
99
+ inkscape:zoom="7.1649804"
100
+ inkscape:cx="11.214495"
101
+ inkscape:cy="71.273863"
102
+ inkscape:document-units="mm"
103
+ inkscape:current-layer="layer1"
104
+ showgrid="false"
105
+ units="px"
106
+ inkscape:window-width="3200"
107
+ inkscape:window-height="1651"
108
+ inkscape:window-x="0"
109
+ inkscape:window-y="0"
110
+ inkscape:window-maximized="1" />
111
+ <metadata
112
+ id="metadata5">
113
+ <rdf:RDF>
114
+ <cc:Work
115
+ rdf:about="">
116
+ <dc:format>image/svg+xml</dc:format>
117
+ <dc:type
118
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
119
+ <dc:title />
120
+ </cc:Work>
121
+ </rdf:RDF>
122
+ </metadata>
123
+ <g
124
+ inkscape:label="Layer 1"
125
+ inkscape:groupmode="layer"
126
+ id="layer1"
127
+ transform="translate(0,-263.13334)">
128
+ <path
129
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:23.5169754px;line-height:1.25;font-family:'Arial Black';-inkscape-font-specification:'Arial Black, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:url(#linearGradient1474);fill-opacity:1;stroke:none;stroke-width:0.32629988"
130
+ d="m 25.638278,275.62853 c -1.487517,0 -2.707067,0.2516 -3.658756,0.75494 -0.599805,0.31844 -1.183623,0.80654 -1.751436,1.464 -0.567815,0.64716 -1.0158,1.38143 -1.343692,2.20324 -0.447855,1.11972 -0.671845,2.52185 -0.671845,4.20656 0,1.61279 0.184154,2.90754 0.552033,3.88343 0.367879,0.97589 0.875619,1.8284 1.52341,2.55774 0.647788,0.71909 1.419357,1.24279 2.315065,1.57151 0.903705,0.31846 2.031502,0.47772 3.383061,0.47772 1.399544,0 2.550855,-0.25159 3.454562,-0.75495 0.911702,-0.50337 1.659755,-1.20686 2.243564,-2.11084 0.583811,-0.91424 1.003393,-1.99301 1.259307,-3.23597 l -4.642368,-0.67825 c -0.21593,0.87319 -0.543753,1.52053 -0.983613,1.94171 -0.431857,0.42118 -0.967999,0.63175 -1.607792,0.63175 -0.767749,0 -1.399241,-0.34933 -1.895081,-1.04787 -0.495837,-0.69853 -0.74399,-1.72057 -0.74399,-3.06629 0,-1.51005 0.248153,-2.63468 0.74399,-3.3743 0.503837,-0.7499 1.159488,-1.12516 1.967225,-1.12516 0.639794,0 1.147529,0.17978 1.523409,0.53933 0.383875,0.34926 -0.397655,-0.29989 0.791657,1.11469 1.189312,1.41459 4.162339,0.79143 4.272493,-1.11755 0.110154,-1.90897 -0.884973,-2.4469 -1.980616,-3.40226 -1.087647,-0.95535 -2.671266,-1.43318 -4.750587,-1.43318 z m 4.550901,3.63353 c 0.521192,-4e-5 0.943712,0.38118 0.943676,0.85141 3.6e-5,0.47025 -0.422484,0.85147 -0.943676,0.85143 -0.521192,4e-5 -0.943711,-0.38118 -0.943676,-0.85143 -3.5e-5,-0.47023 0.422484,-0.85145 0.943676,-0.85141 z"
131
+ id="path825"
132
+ inkscape:connector-curvature="0"
133
+ sodipodi:nodetypes="scccscccscccccscscsczzcsccccc" />
134
+ <path
135
+ inkscape:connector-curvature="0"
136
+ id="path823"
137
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:23.5169754px;line-height:1.25;font-family:'Arial Black';-inkscape-font-specification:'Arial Black, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:url(#linearGradient1482);fill-opacity:1;stroke:none;stroke-width:0.32629988"
138
+ d="m 18.094114,269.78843 v 6.22518 h 2.687126 v 4.57644 h -2.687126 v 5.80916 q 0,1.04779 0.155948,1.38679 0.239923,0.5239 0.839728,0.5239 0.539825,0 1.511508,-0.40062 l 0.359884,4.3299 q -1.811411,0.50849 -3.382901,0.50849 -1.823406,0 -2.687125,-0.60095 -0.86372,-0.60094 -1.283583,-1.81824 -0.407867,-1.23272 -0.407867,-3.9755 v -5.76293 h -1.799414 v -4.57644 h 1.799414 v -3.00473 z" />
139
+ <path
140
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:23.5169754px;line-height:1.25;font-family:'Arial Black';-inkscape-font-specification:'Arial Black, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:url(#linearGradient1466);fill-opacity:1;stroke:none;stroke-width:0.32629988"
141
+ d="m 9.4654326,276.01386 c -0.687776,0 -1.2679961,0.22081 -1.7398421,0.66255 -0.4638491,0.43144 -0.9154287,1.22782 -1.3552859,2.38863 v -2.68155 H 1.7994353 v 16.36418 h 4.90647 v -5.48514 c 0,-2.61951 0.2523929,-4.40717 0.7562289,-5.36251 0.3518856,-0.67799 0.8475441,-1.01706 1.4873359,-1.01706 0.3358905,0 1.0367102,0.50884 1.3675249,0.46261 2.759102,-0.38522 2.8526,-2.97994 1.511169,-4.46867 -0.53607,-0.59494 -1.642966,-0.86304 -2.3627314,-0.86304 z m 0.7697554,1.95158 a 0.9436132,0.85136739 0 0 1 0.943675,0.85143 0.9436132,0.85136739 0 0 1 -0.943675,0.85143 0.9436132,0.85136739 0 0 1 -0.943676,-0.85143 0.9436132,0.85136739 0 0 1 0.943676,-0.85143 z"
142
+ id="path821"
143
+ inkscape:connector-curvature="0" />
144
+ <text
145
+ xml:space="preserve"
146
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.13614035px;line-height:1.25;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#505050;fill-opacity:1;stroke:none;stroke-width:0.22300439"
147
+ x="1.6308562"
148
+ y="272.99597"
149
+ id="text2108"><tspan
150
+ sodipodi:role="line"
151
+ id="tspan2137"
152
+ x="1.6308562"
153
+ y="272.99597"
154
+ style="stroke-width:0.22300439">aio</tspan></text>
155
+ </g>
156
+ </svg>
@@ -0,0 +1,126 @@
1
+ API Reference
2
+ =============
3
+
4
+ .. automodule:: vsaiortc
5
+
6
+ WebRTC
7
+ ------
8
+
9
+ .. autoclass:: RTCPeerConnection
10
+ :members:
11
+
12
+ .. autoclass:: RTCSessionDescription
13
+ :members:
14
+
15
+ .. autoclass:: RTCConfiguration
16
+ :members:
17
+
18
+ Interactive Connectivity Establishment (ICE)
19
+ --------------------------------------------
20
+
21
+ .. autoclass:: RTCIceCandidate
22
+ :members:
23
+
24
+ .. autoclass:: RTCIceGatherer
25
+ :members:
26
+
27
+ .. autoclass:: RTCIceTransport
28
+ :members:
29
+
30
+ .. autoclass:: RTCIceParameters
31
+ :members:
32
+
33
+ .. autoclass:: RTCIceServer
34
+ :members:
35
+
36
+ Datagram Transport Layer Security (DTLS)
37
+ ----------------------------------------
38
+
39
+ .. autoclass:: RTCCertificate()
40
+ :members:
41
+
42
+ .. autoclass:: RTCDtlsTransport
43
+ :members:
44
+
45
+ .. autoclass:: RTCDtlsParameters()
46
+ :members:
47
+
48
+ .. autoclass:: RTCDtlsFingerprint()
49
+ :members:
50
+
51
+ Real-time Transport Protocol (RTP)
52
+ ----------------------------------
53
+
54
+ .. autoclass:: RTCRtpReceiver
55
+ :members:
56
+
57
+ .. autoclass:: RTCRtpSender
58
+ :members:
59
+
60
+ .. autoclass:: RTCRtpTransceiver
61
+ :members:
62
+
63
+ .. autoclass:: RTCRtpSynchronizationSource()
64
+ :members:
65
+
66
+ .. autoclass:: RTCRtpCapabilities()
67
+ :members:
68
+
69
+ .. autoclass:: RTCRtpCodecCapability()
70
+ :members:
71
+
72
+ .. autoclass:: RTCRtpHeaderExtensionCapability()
73
+ :members:
74
+
75
+ .. autoclass:: RTCRtpParameters()
76
+ :members:
77
+
78
+ .. autoclass:: RTCRtpCodecParameters()
79
+ :members:
80
+
81
+ .. autoclass:: RTCRtcpParameters()
82
+ :members:
83
+
84
+ Stream Control Transmission Protocol (SCTP)
85
+ -------------------------------------------
86
+
87
+ .. autoclass:: RTCSctpTransport
88
+ :members:
89
+
90
+ .. autoclass:: RTCSctpCapabilities
91
+ :members:
92
+
93
+ Data channels
94
+ -------------
95
+
96
+ .. autoclass:: RTCDataChannel(transport, parameters)
97
+ :members:
98
+
99
+ .. autoclass:: RTCDataChannelParameters()
100
+ :members:
101
+
102
+ Media
103
+ -----
104
+
105
+ .. autoclass:: MediaStreamTrack
106
+ :members:
107
+
108
+ Statistics
109
+ ----------
110
+
111
+ .. autoclass:: RTCStatsReport()
112
+
113
+ .. autoclass:: RTCInboundRtpStreamStats()
114
+ :members:
115
+
116
+ .. autoclass:: RTCOutboundRtpStreamStats()
117
+ :members:
118
+
119
+ .. autoclass:: RTCRemoteInboundRtpStreamStats()
120
+ :members:
121
+
122
+ .. autoclass:: RTCRemoteOutboundRtpStreamStats()
123
+ :members:
124
+
125
+ .. autoclass:: RTCTransportStats()
126
+ :members: