gomoqt

A Go implementation of Media over QUIC Transport (MOQT), specifically implementing the MOQ Lite specification for efficient media streaming over QUIC.

Table of Contents

• Overview
• Quick Start
• Features
• Components
• Examples
• Documentation
• Specification Compliance
• Development
• Contributing
• License
• Acknowledgments

Overview

This implementation follows the MOQ Lite specification, providing a foundation for building real-time media streaming applications using QUIC transport.

Quick Start

# Install Mage (Go 1.27+)
go install github.com/magefile/mage@latest

# Run the interop test in Docker (TypeScript client + server)
mage interop:ts
# Or run the Go client instead
mage interop:go

Features

• MOQ Lite Protocol — Lightweight version of MoQ specification
  • Low-latency playback — Minimizes latency from data discovery, transmission/reception to playback
  • Uninterrupted playback — Resilient design against network fluctuations through independent data transmission/reception
  • Network environment optimization — Enables behavior optimization according to network conditions
  • Track management — Publisher/Subscriber model for track data transmission/reception
  • Efficient multiplexed delivery — Efficient multiplexing through track announcements and subscriptions
  • Web support — Browser support using WebTransport
  • QUIC native support — Native QUIC support via quic wrappers
• Flexible dependency design — Separates dependencies like QUIC and WebTransport, allowing use of only necessary components
• Examples & Interop — Sample applications and interop suite in examples/ and cmd/interop (broadcast, echo, relay, native_quic, interop server/client)

See also

• moqt/ — core package (frames, session, track muxing)
• msf/ — MSF catalog, delta, timeline, and catalog-track helper package
• transport/ — transport layer interfaces (StreamConn, Stream, SendStream, ReceiveStream)
• moqt/internal/ — internal QUIC (quicgo) and WebTransport (webtransportgo) adapters
• moq-web/ — TypeScript / WebTransport client implementation
• examples/ — sample apps (broadcast, echo, native_quic, relay)

Components

• moqt — Core Go package for Media over QUIC (MOQ) protocol.
• msf — MOQT Streaming Format catalog, delta, and timeline modeling package.
• moq-web — TypeScript implementation for the web client side.
• cmd/interop — Interoperability server and clients (Go/TypeScript).
• examples — Demonstration apps (broadcast, echo, native_quic, relay).

Examples

The examples directory includes sample applications demonstrating how to use gomoqt:

• Interop Server and Client (cmd/interop/): Interoperability testing between different MOQ implementations
• Broadcast Example (examples/broadcast/): Broadcasting functionality demonstration
• Echo Example (examples/echo/): Simple echo server and client implementation
• Native QUIC (examples/native_quic/): Direct QUIC connection examples
• Relay (examples/relay/): Relay functionality for media streaming

Documentation

• GoDoc
• MOQ Lite Specification
• MSF package README
• Implementation Status — Detailed implementation progress

Specification Compliance

This implementation targets the MOQ Lite specification, which provides a simplified approach to Media over QUIC Transport. The current implementation status can be found in the moqt package README, which includes detailed tracking of implemented features according to the specification sections.

Development

Prerequisites

• Go 1.27.0 or later
• Mage build tool (install with go install github.com/magefile/mage@latest)

Development Commands

# Format code
mage fmt

# Run linter (requires golangci-lint: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest)
mage lint

# Run quality checks (fmt and lint)
mage check

# Run all tests
mage test:all

# Run tests with coverage
mage test:coverage

Build & Clean

# Build the code
mage build

# Clean up generated files
mage clean

# Show available commands
mage help

Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Make your changes.
4. Verify code quality:

   mage fmt
   mage lint
   mage test
   

5. Commit your changes (git commit -m 'Add amazing feature').
6. Push your branch (git push origin feature/amazing-feature).
7. Open a Pull Request.

License

This project is licensed under the MIT License; see LICENSE for details.

Acknowledgments

• quic-go — QUIC implementation in Go
• webtransport-go — WebTransport implementation in Go
• MOQ Lite Specification — The specification this implementation follows