webrtc-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f669ae95db387b78ddd0d490c472154f5cd59d1879fbec7581cbb97f902cfb74
+  data.tar.gz: 8b991089f2a4d8c559dfa3a8c8bad9e26583354712f22c4ae5c9e9662b9356db
+SHA512:
+  metadata.gz: e863ef46eea8a0e372619c6fb6d22951fe3b38f59e1f6757308dbd3c90d4c1124f1ad3f8981535ce9da06d575c93293c442b043886d1ab35312585029e860060
+  data.tar.gz: ad1df4b5f2d5f1e626cac7a63fe09bc94890b565d678aa85e16c917f02cd80648271d5f3995ca17e2da0d10dc55978231cc3cdfac4a95b3fed15a3767675b90b

data/.dockerignore

@@ -0,0 +1,19 @@
+# Build directories
+ext/webrtc_ruby/build/
+vendor/libdatachannel/
+
+# Git
+.git/
+
+# Ruby
+*.gem
+.bundle/
+tmp/
+coverage/
+
+# IDE
+.vscode/
+.idea/
+
+# Logs
+*.log

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 1.0.0 - 2026-02-15
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,49 @@
+FROM ruby:3.3-slim
+
+# Install build dependencies
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    cmake \
+    git \
+    libssl-dev \
+    pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+# Copy gemfiles first for better caching
+COPY Gemfile Gemfile.lock* webrtc-ruby.gemspec ./
+COPY lib/webrtc/version.rb ./lib/webrtc/
+
+# Install Ruby dependencies
+RUN bundle install
+
+# Clone and build libdatachannel
+RUN git clone --depth 1 --recurse-submodules https://github.com/paullouisageneau/libdatachannel.git /tmp/libdatachannel \
+    && cd /tmp/libdatachannel \
+    && mkdir build && cd build \
+    && cmake -DUSE_GNUTLS=0 -DUSE_NICE=0 -DNO_WEBSOCKET=1 -DNO_EXAMPLES=1 -DNO_TESTS=1 -DCMAKE_BUILD_TYPE=Release .. \
+    && make -j$(nproc) \
+    && mkdir -p /app/vendor/libdatachannel/build \
+    && mkdir -p /app/vendor/libdatachannel/include \
+    && cp -r /tmp/libdatachannel/include/* /app/vendor/libdatachannel/include/ \
+    && cp /tmp/libdatachannel/build/libdatachannel.so* /app/vendor/libdatachannel/build/ \
+    && rm -rf /tmp/libdatachannel
+
+# Copy extension source
+COPY ext/ ./ext/
+
+# Build webrtc_ruby extension
+RUN cd ext/webrtc_ruby \
+    && mkdir -p build && cd build \
+    && cmake .. \
+    && make -j$(nproc)
+
+# Copy the rest of the application
+COPY . .
+
+# Set library path
+ENV LD_LIBRARY_PATH=/app/ext/webrtc_ruby/build:/app/vendor/libdatachannel/build
+
+# Run tests by default
+CMD ["bundle", "exec", "rspec", "--format", "documentation"]

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [2026] [Yudai Takada]
+
+   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.

data/README.md

@@ -0,0 +1,264 @@
+# WebRTC Ruby
+
+WebRTC bindings for Ruby, providing real-time audio, video, and data channel capabilities.
+
+## Status
+
+This project provides a practical, `webrtc-rs`-compatible API surface in Ruby, with a mix of:
+
+- native-backed features through `libdatachannel` C API
+- Ruby compatibility/typing layers for API parity
+
+### Native-backed (current)
+
+- `WebRTC.init` / `WebRTC.cleanup`
+- `RTCPeerConnection`
+  - offer/answer
+  - local/remote description
+  - ICE candidate add
+  - connection/ICE/signaling/gathering states + callbacks
+  - data channel callbacks
+  - track callbacks
+  - add/remove track path (via native track ID)
+- `RTCDataChannel`
+  - create/close/send
+  - open/message/close callbacks
+  - buffered amount
+- `RTCSessionDescription`
+- `RTCIceCandidate`
+
+### Compatibility and typed layer (current)
+
+- Factory API
+  - `CurrentTaskQueueFactory`
+  - `PeerConnectionFactory`
+  - `WebRTC.create_modular_peer_connection_factory`
+- Observer API
+  - `CreateSessionDescriptionObserver`
+  - `SetLocalDescriptionObserver`
+  - `SetRemoteDescriptionObserver`
+  - `AddIceCandidateObserver`
+  - `DataChannelObserver`
+  - `RTCStatsCollectorCallback`
+- Typed parity classes
+  - `CreateOfferOptions`, `CreateAnswerOptions`
+  - `DataChannelInit`, `DataChannelMessage`
+  - RTP parameter/capability classes
+  - `RTCError` and enum modules
+  - media interface classes
+  - `VideoFrame`, `I420Buffer`
+
+### Stats note
+
+- `RTCStatsCollectorCallback` and `RTCStatsResponse` are wired.
+- DataChannel message/byte counters are measured from actual send/receive events.
+- Low-level RTP/ICE transport metrics remain limited by `libdatachannel` C API exposure.
+
+## Requirements
+
+- Ruby 3.1+
+- CMake
+- OpenSSL development libraries
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webrtc-ruby'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Building Native Extension
+
+The gem requires a native extension (`ext/webrtc_ruby`) and `libdatachannel`.
+
+### macOS
+
+```bash
+brew install cmake openssl
+
+# Clone and build libdatachannel
+git clone --depth 1 --recurse-submodules https://github.com/paullouisageneau/libdatachannel.git vendor/libdatachannel
+cd vendor/libdatachannel
+mkdir build && cd build
+cmake -DUSE_GNUTLS=0 -DUSE_NICE=0 -DNO_WEBSOCKET=1 -DNO_EXAMPLES=1 -DNO_TESTS=1 ..
+make -j$(sysctl -n hw.ncpu)
+cd ../../..
+
+# Build extension
+cd ext/webrtc_ruby
+mkdir -p build && cd build
+cmake ..
+make
+```
+
+### Linux (Ubuntu/Debian)
+
+```bash
+sudo apt install build-essential cmake git libssl-dev pkg-config
+
+# Clone and build libdatachannel
+git clone --depth 1 --recurse-submodules https://github.com/paullouisageneau/libdatachannel.git vendor/libdatachannel
+cd vendor/libdatachannel
+mkdir build && cd build
+cmake -DUSE_GNUTLS=0 -DUSE_NICE=0 -DNO_WEBSOCKET=1 -DNO_EXAMPLES=1 -DNO_TESTS=1 ..
+make -j$(nproc)
+cd ../../..
+
+# Build extension
+cd ext/webrtc_ruby
+mkdir -p build && cd build
+cmake ..
+make
+```
+
+## Quick Start
+
+```ruby
+require 'webrtc'
+
+WebRTC.init
+
+pc1 = WebRTC::RTCPeerConnection.new
+pc2 = WebRTC::RTCPeerConnection.new
+
+pc1_candidates = []
+pc2_candidates = []
+
+pc1.on_ice_candidate { |c| pc1_candidates << c if c }
+pc2.on_ice_candidate { |c| pc2_candidates << c if c }
+
+pc2.on_data_channel do |dc|
+  dc.on_message { |msg| puts "pc2 recv: #{msg.data}" }
+end
+
+dc1 = pc1.create_data_channel('chat')
+dc1.on_open { puts 'pc1 data channel open' }
+dc1.on_message { |msg| puts "pc1 recv: #{msg.data}" }
+
+offer = pc1.create_offer.await
+pc1.set_local_description(offer).await
+pc2.set_remote_description(offer).await
+
+answer = pc2.create_answer.await
+pc2.set_local_description(answer).await
+pc1.set_remote_description(answer).await
+
+pc1_candidates.each { |c| pc2.add_ice_candidate(c).await rescue nil }
+pc2_candidates.each { |c| pc1.add_ice_candidate(c).await rescue nil }
+
+pc1.close
+pc2.close
+WebRTC.cleanup
+```
+
+## Factory Example
+
+```ruby
+factory = WebRTC.create_modular_peer_connection_factory
+pc = factory.create_peer_connection(
+  ice_servers: [{ urls: 'stun:stun.l.google.com:19302' }]
+)
+```
+
+## Observer Example
+
+```ruby
+observer = WebRTC::CreateSessionDescriptionObserver.new(
+  on_success: ->(desc) { puts "created: #{desc.type}" },
+  on_failure: ->(err) { warn err.message }
+)
+
+pc.create_offer(observer: observer).await
+```
+
+## Stats Example
+
+```ruby
+report = pc.get_stats.await
+
+report.each do |_id, stat|
+  case stat
+  when WebRTC::RTCDataChannelStats
+    puts "dc bytes sent=#{stat.bytes_sent} recv=#{stat.bytes_received}"
+  when WebRTC::RTCTransportStats
+    puts "transport bytes sent=#{stat.bytes_sent} recv=#{stat.bytes_received}"
+  end
+end
+```
+
+## API Coverage (`shiguredo/webrtc-rs` parity)
+
+| Area | Status | Notes |
+| --- | --- | --- |
+| PeerConnection core | Implemented | state callbacks, data channel callbacks, track callbacks |
+| Factory API | Implemented | `CurrentTaskQueueFactory`, `PeerConnectionFactory`, `create_modular_peer_connection_factory` |
+| SDP Observer API | Implemented | create/set description observers and option classes |
+| ICE Candidate Observer API | Implemented | `RTCIceCandidateInit`, `AddIceCandidateObserver` |
+| DataChannel typed API | Implemented | `DataChannelInit`, `DataChannelObserver`, `DataChannelMessage`, state constants |
+| RTP Sender/Receiver/Transceiver | Implemented | native add/remove track path + typed parameter classes |
+| Media interfaces | Implemented | audio/video track/source/sink interfaces |
+| Video frame API | Implemented | `VideoFrame`, `I420Buffer` |
+| Error and helper types | Implemented | `RTCError`, `RTCCertificate`, `RTCEncodedImage`, enum modules |
+| Stats callback API | Partial | DataChannel bytes/messages are measured; low-level RTP/ICE metrics are constrained by `libdatachannel` C API |
+
+## Development
+
+After checking out the repo, install dependencies:
+
+```bash
+bundle install
+```
+
+### Important note about `libdatachannel`
+
+- Building the native extension and running tests require `libdatachannel`.
+- You must use one of these approaches before testing:
+
+```bash
+# Option A (recommended): keep a local vendor copy
+git clone --depth 1 --recurse-submodules https://github.com/paullouisageneau/libdatachannel.git vendor/libdatachannel
+cd vendor/libdatachannel
+mkdir -p build && cd build
+cmake .. -DCMAKE_BUILD_TYPE=Release -DNO_EXAMPLES=ON -DNO_TESTS=ON
+cmake --build .
+cd ../../..
+```
+
+```bash
+# Option B: install libdatachannel system-wide (pkg-config discoverable)
+# In this case CMake falls back to pkg-config when vendor/libdatachannel is absent.
+```
+
+### Run tests
+
+```bash
+# Build native extension first
+cd ext/webrtc_ruby
+mkdir -p build && cd build
+cmake ..
+cmake --build .
+cd ../../..
+
+# Run test suite (macOS)
+DYLD_LIBRARY_PATH="ext/webrtc_ruby/build:vendor/libdatachannel/build" bundle exec rspec
+
+# Run test suite (Linux)
+LD_LIBRARY_PATH="ext/webrtc_ruby/build:vendor/libdatachannel/build" bundle exec rspec
+```
+
+## License
+
+This project is available under the [Apache License 2.0](LICENSE).
+
+## Contributing
+
+Bug reports and pull requests are welcome at:
+
+- https://github.com/ydah/webrtc-ruby

data/Rakefile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :native do
+  desc 'Build native library'
+  task :build do
+    ext_dir = File.join(__dir__, 'ext', 'webrtc_ruby')
+    build_dir = File.join(ext_dir, 'build')
+
+    Dir.mkdir(build_dir) unless Dir.exist?(build_dir)
+
+    case RbConfig::CONFIG['host_os']
+    when /darwin/
+      lib_name = 'libwebrtc_ruby.dylib'
+      flags = '-dynamiclib'
+    when /mswin|mingw/
+      lib_name = 'webrtc_ruby.dll'
+      flags = '-shared'
+    else
+      lib_name = 'libwebrtc_ruby.so'
+      flags = '-shared'
+    end
+
+    cmd = "cc -Wall -Wextra -fPIC -O2 -DWEBRTC_RUBY_BUILDING #{flags} " \
+          "-o #{File.join(build_dir, lib_name)} " \
+          "#{File.join(ext_dir, 'webrtc_ruby.c')}"
+
+    system(cmd) || abort('Native build failed')
+  end
+
+  desc 'Clean native build'
+  task :clean do
+    build_dir = File.join(__dir__, 'ext', 'webrtc_ruby', 'build')
+    FileUtils.rm_rf(build_dir)
+  end
+end
+
+task default: %i[native:build spec]