base on Rust library for Media over QUIC <p align="center"> <img height="128px" src="https://github.com/kixelated/moq-rs/blob/main/.github/logo.svg" alt="Media over QUIC"> </p> Media over QUIC (MoQ) is a live media delivery protocol utilizing QUIC. It's a client-server model that is designed to scale to enormous viewership via clustered relay servers (aka a CDN). The application determines the trade-off between latency and quality, potentially on a per viewer-basis. See [quic.video](https://quic.video) for more information. Note: this project is a [fork of the IETF draft](https://quic.video/blog/transfork) to speed up development. The project is split into a few crates: - [moq-relay](moq-relay): A server that forwards content from publishers to any interested subscribers. It can optionally be clustered, allowing N servers to transfer between themselves. - [moq-web](moq-web): A web client utilizing Rust and WASM. Supports both consuming media (and soon publishing). - [moq-transfork](moq-transfork): The underlying network protocol. It can be used by live applications that need real-time and scale, even if they're not media. - [moq-karp](moq-karp): The underlying media protocol powered by moq-transfork. It includes a CLI for importing/exporting to other formats, for example integrating with ffmpeg. - [moq-gst](moq-gst): A gstreamer plugin for producing Karp broadcasts. Note: ffmpeg is supported via moq-karp directly. - [moq-clock](moq-clock): A dumb clock client/server just to prove MoQ can be used for more than media. - [moq-native](moq-native): Helpers to configure the native MoQ tools. There are additional components that have been split into other repositories for development reasons: # Usage ## Requirements - [Rust](https://www.rust-lang.org/tools/install) (duh) - [Go](https://golang.org/doc/install) (for mkcert, somebody please replace this) - [Bun](https://bun.sh/) (for web only) - (optional) [Docker](https://docs.docker.com/get-docker/) ## Local There's a few scripts in the [dev](dev) directory to help you get started: ```sh # Run as a single (hacky) command: ./dev/all # Or individually: ./dev/relay ./dev/pub ./dev/web ``` Then, visit [https://localhost:8080](localhost:8080) to watch the simple demo. ## Docker Alternatively, you can use docker to launch a full cluster: ```sh make ``` This will start two relays (clustered!), a ffmpeg publisher, and web server. Then, visit [https://localhost:8080](localhost:8080) to watch the simple demo. Live updates aren't supported in this mode. # Components ## moq-relay [moq-relay](moq-relay) is a server that forwards subscriptions from publishers to subscribers, caching and deduplicating along the way. It's designed to be run in a datacenter, relaying media across multiple hops to deduplicate and improve QoS. Notable arguments: - `--bind <ADDR>` Listen on this address, default: `[::]:4443` - `--tls-cert <CERT>` Use the certificate file at this path - `--tls-key <KEY>` Use the private key at this path - `--announce <URL>` Forward all announcements to this address, typically a root relay. This listens for WebTransport connections on `UDP https://localhost:4443` by default. You need a client to connect to that address, to both publish and consume media. ## moq-web [moq-web](moq-web) is a web client that can consume media (and soon publish). It's available [on NPM](https://www.npmjs.com/package/@kixelated/moq) as both a JS library and web component. For example: ```html <script type="module"> import '@kixelated/moq/video' </script> <moq-video src="https://relay.quic.video/demo/bbb"></moq-video> ``` The package is a gross frankenstein of Rust+Typescript. To make changes, you'll need to install (Bun)[https://bun.sh/] and then run: ```sh bun i bun dev ``` You can also test the package locally by linking. Replace `bun` with your favorite package manager; it might work. ```sh bun pack bun link # In your other package bun link @kixelated/moq ``` See the [moq-web README](moq-web/README.md) for more information. ## moq-karp [moq-karp](moq-karp) is a simple media layer on top of MoQ. The crate includes a binary that accepts fMP4 with a few restrictions: - `separate_moof`: Each fragment must contain a single track. - `frag_keyframe`: A keyframe must be at the start of each keyframe. - `fragment_per_frame`: (optional) Each frame should be a separate fragment to minimize latency. This can be used in conjunction with ffmpeg to publish media to a MoQ relay. See [dev/pub](dev/pub) for the required ffmpeg flags. Alternatively, see [moq-gst](./moq-gst) for a gstreamer plugin. ## moq-transfork A media-agnostic library used by [moq-relay](moq-relay) and [moq-karp](moq-karp) to serve the underlying subscriptions. It has caching/deduplication built-in, so your application is oblivious to the number of connections under the hood. See the published [crate](https://crates.io/crates/moq-transfork) and [documentation](https://docs.rs/moq-transfork/latest/moq_transfork/). ## moq-clock [moq-clock](moq-clock) is a simple client that can publish or subscribe to the current time. It's meant to demonstate that [moq-transfork](moq-transfork) can be used for more than just media. ## nix/nixos moq also has nix support see [`nix/README.md`](nix/README.md) # License Licensed under either: - Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) ", Assign "at most 3 tags" to the expected json: {"id":"4391","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"