ntgcalls-sys 3.0.0-rc06

Raw FFI bindings to the ntgcalls C ABI
docs.rs failed to build ntgcalls-sys-3.0.0-rc06
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

NTgCalls Release PyPI - Downloads npm - Downloads Crates.io - Downloads

NTgCalls is a lightweight open-source library for media streaming in Telegram calls. Built from scratch in C++ with WebRTC & Boost, it prioritizes accessibility to developers and resource efficiency.

Powerful Simple Light
Built from scratch in C++ using Boost and libwebrtc Simple Python, Node.js, Rust, GO, C Bindings and Java for Android SDK We removed anything that could burden the library, keeping every binding a thin layer over the same native core

Build Status

Architecture Windows Linux MacOS
x86_64 BUILD BUILD BUILD
ARM64 BUILD BUILD BUILD

Features

  • Pre-built binaries for macOS (arm64-v8a), Linux (x86_64, arm64-v8a), Windows (x86_64), and Android (x86, 86_64, arm64-v8a, armv7)
  • Call flexibility: Group and private call support
  • Media controls: pause/resume and mute/unmute
  • Codec compatibility: H.264, HEVC (H.265), VP8, VP9, AV1, AAC, MP3, Opus
  • Content sharing: Screen streaming, Microphone and Camera streaming
  • Pre-built wheels for Python, npm packages for Node.js, crates for Rust & AAR SDK library for Android

Installing

Prebuilt packages are published for every supported language, so most users never need to compile anything.

Language Package Install
Python ntgcalls pip install ntgcalls
Node.js ntgcalls npm install ntgcalls
Rust ntgcalls cargo add ntgcalls
Java (Android) io.github.pytgcalls:ntgcalls Gradle dependency
C, C++ and Go Release archives Download the shared or static zip

Building from source

Prerequisites are listed in the Build Guide. All commands are run from the root of the repository.

Target Command Output
Python python3 setup.py install Installed in the current environment
Node.js python3 setup.py build_lib --target=node targets/node/build/Release/ntgcalls.node
C and C++ python3 setup.py build_lib shared-output and static-output

The C target builds both the shared and the static library in a single run. Each output directory also contains an include folder with the headers to add to your project.

The Rust bindings do not build the native library: the ntgcalls-sys build script downloads the matching static libraries from the GitHub release for your platform. Set NTGCALLS_RELEASE_BASE to build against a local release instead.

[!WARNING] Static linking for Windows is not supported yet since our library is built with MSVC and Go uses MinGW for static linking. More info can be found here

Go consumes the C bindings through an example project in ./examples/go/:

  1. Download the shared or static release from the Releases page
  2. Copy ntgcalls.h into ./examples/go/ntgcalls/
  3. Copy the remaining files into ./examples/go/
    • ntgcalls.dll or ntgcalls.lib on Windows amd64
    • libntgcalls.so or libntgcalls.a on Linux amd64
    • libntgcalls.dylib or libntgcalls.a on macOS
  4. Run go build or go run . with CGO_ENABLED=1
    • $env:CGO_ENABLED=1; go run . on Windows PowerShell
    • CGO_ENABLED=1 go run . on UNIX

Key Contributors

  • @Laky-64 (DevOps Engineer, Software Architect, Porting Engineer):
    • Played a crucial role in developing NTgCalls.
    • Created the Python Bindings that made the library accessible to Python developers.
    • Developed the C Bindings, enabling the library's use in various environments.
  • @dadadani (Senior C++ Developer, Performance engineer):
    • Contributed to setting up CMakeLists and integrating with pybind11, greatly simplifying the library's usage for C++ developers.
  • @kuogi (Senior UI/UX designer, Documenter):
    • As a Senior UI/UX Designer, Kuogi has significantly improved the user interface of our documentation, making it more visually appealing and user-friendly.
    • It Has also played a key role in writing and structuring our documentation, ensuring that it is clear, informative, and accessible to all users.
  • @vrumger (Mid-level NodeJS Developer):
    • Avrumy has made important fixes and enhancements to the WebRTC component of the library, improving its stability and performance.
  • @ankit-chaubey (Rust Developer):
    • Authored the first Rust bindings for NTgCalls and generously transferred the ntgcalls crate to the official project.

Junior Developers

  • @TuriOG (Junior Python Developer):
    • Currently working on integrating NTgCalls into PyTgCalls, an important step in expanding the functionality and usability of the library.
  • @doggyhaha (Junior DevOps, Tester):
    • Performs testing of NTgCalls on Linux to ensure its reliability and compatibility.
    • Specializes in creating and maintaining GitHub Actions, focusing on automation tasks.
  • @tappo03 (Junior Go Developer, Tester):
    • Performs testing of NTgCalls on Windows to ensure its reliability and compatibility.
    • It Is in the process of integrating NTgCalls into a Go wrapper, further enhancing the library's versatility and accessibility.

Special Thanks

  • @shiguredo: We extend our special thanks to 時雨堂 (shiguredo) for their invaluable assistance in integrating the WebRTC component. Their contributions, using the Sora C++ SDK, have been instrumental in enhancing the functionality of our library.

  • @evgeny-nadymov: A heartfelt thank you to Evgeny Nadymov for graciously allowing us to use their code from telegram-react. His contribution has been pivotal to the success of this project.

  • @morethanwords: We extend our special thanks to morethanwords for their invaluable help in integrating the connection to WebRTC with Telegram Web K. Their assistance has been instrumental in enhancing the functionality of our library.

  • @MarshalX: for their generous assistance in answering questions and providing insights regarding WebRTC.

  • @LyzCoote: for providing an ARM64 Server and allowing us to build an image with clang-18 preinstalled on manylinux2014 arm64.

We would like to extend a special thanks to @null-nick and @branchscope for their valuable contributions to the testing phase of the library and to @SadLuffy for his assistance as a copywriter. Their dedication to testing and optimizing the library has been instrumental in its success.

Additionally, we extend our gratitude to all contributors for their exceptional work in making this project a reality.