mirror of
https://github.com/openlibrecommunity/olcrtc.git
synced 2026-05-26 15:13:40 +00:00
9388a8e494
Lay the groundwork for splitting service-specific logic (WB / Jazz / Telemost API flows) from wire-level transport engines (LiveKit, Goolom, future Jitsi). An engine takes only URL+Token+Name+network knobs; an auth provider produces those credentials and reports which engine it feeds. RoomCreator is an optional capability for the gen mode. Existing carriers and providers are untouched. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
97 lines
3.0 KiB
Go
97 lines
3.0 KiB
Go
// Package engine defines the wire-level transport engine that connects to a
|
|
// remote SFU. An engine is independent of how the room credentials were
|
|
// obtained: it accepts a signaling URL and an access token, and exposes the
|
|
// byte/video primitives the rest of olcrtc consumes.
|
|
//
|
|
// Engines model the SFU protocol family (e.g. LiveKit, Goolom). Service-
|
|
// specific bits (e.g. WB / Jazz / Telemost API flows) live in the auth
|
|
// package, not here.
|
|
package engine
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/pion/webrtc/v4"
|
|
)
|
|
|
|
var (
|
|
// ErrEngineNotFound is returned when a requested engine is not registered.
|
|
ErrEngineNotFound = errors.New("engine not found")
|
|
// ErrByteStreamUnsupported is returned when an engine cannot expose a byte stream.
|
|
ErrByteStreamUnsupported = errors.New("engine does not support byte stream")
|
|
// ErrVideoTrackUnsupported is returned when an engine cannot exchange video tracks.
|
|
ErrVideoTrackUnsupported = errors.New("engine does not support video tracks")
|
|
)
|
|
|
|
// Capabilities describes the transport primitives an engine can expose.
|
|
type Capabilities struct {
|
|
ByteStream bool
|
|
VideoTrack bool
|
|
}
|
|
|
|
// Config is the runtime input to an engine factory. URL/Token are produced by
|
|
// an auth provider (or supplied directly by the caller for "none" auth).
|
|
type Config struct {
|
|
URL string
|
|
Token string
|
|
Name string
|
|
OnData func([]byte)
|
|
DNSServer string
|
|
ProxyAddr string
|
|
ProxyPort int
|
|
}
|
|
|
|
// Session is the engine-level runtime handle. It is shaped to match what
|
|
// the upper transport layer expects: send/receive bytes, optional video
|
|
// tracks, and lifecycle callbacks.
|
|
//
|
|
//nolint:interfacebloat // mirrors the historical provider.Provider surface that the rest of olcrtc consumes
|
|
type Session interface {
|
|
Connect(ctx context.Context) error
|
|
Send(data []byte) error
|
|
Close() error
|
|
SetReconnectCallback(cb func(*webrtc.DataChannel))
|
|
SetShouldReconnect(fn func() bool)
|
|
SetEndedCallback(cb func(string))
|
|
WatchConnection(ctx context.Context)
|
|
CanSend() bool
|
|
GetSendQueue() chan []byte
|
|
GetBufferedAmount() uint64
|
|
Capabilities() Capabilities
|
|
}
|
|
|
|
// VideoTrackCapable is implemented by engines that can exchange video tracks.
|
|
type VideoTrackCapable interface {
|
|
AddVideoTrack(track webrtc.TrackLocal) error
|
|
SetVideoTrackHandler(cb func(*webrtc.TrackRemote, *webrtc.RTPReceiver))
|
|
}
|
|
|
|
// Factory creates a new engine session.
|
|
type Factory func(ctx context.Context, cfg Config) (Session, error)
|
|
|
|
var registry = make(map[string]Factory) //nolint:gochecknoglobals // package-level state intentional
|
|
|
|
// Register adds an engine factory to the registry.
|
|
func Register(name string, factory Factory) {
|
|
registry[name] = factory
|
|
}
|
|
|
|
// New creates an engine session by name.
|
|
func New(ctx context.Context, name string, cfg Config) (Session, error) {
|
|
factory, ok := registry[name]
|
|
if !ok {
|
|
return nil, ErrEngineNotFound
|
|
}
|
|
return factory(ctx, cfg)
|
|
}
|
|
|
|
// Available returns the list of registered engine names.
|
|
func Available() []string {
|
|
names := make([]string, 0, len(registry))
|
|
for name := range registry {
|
|
names = append(names, name)
|
|
}
|
|
return names
|
|
}
|