shadowdaoandClaude Sonnet 5
969b8db94a
Owner sign-off: replace root LICENSE with Apache License 2.0, add a root NOTICE file, and swap the GPL-2.0 boilerplate header in every first-party core/ and obs-adapter/ source file for a short Apache-2.0 notice. This resolves review finding C2 (GPLv2 top-level LICENSE vs. the vendored Apache-2.0 LiveKit SDK is a license-compatibility violation): the whole repo is now Apache-2.0, matching LiveKit, so there's no GPL/Apache clash left. Updated the README Status gate and the CI workflow comment to reflect that C2 is resolved, while leaving the C1 WebRTC/OpenH264 patent/royalty gate untouched -- that question is still open and still blocks release. third_party/ stays under its own upstream licenses; only this project's own code changed hands. All 6 CTest suites still pass after the header swap. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RL8abRmgFXkVASHkkqiJbE
112 lines
4.0 KiB
C++
112 lines
4.0 KiB
C++
/*
|
|
streamer-tools OBS Camera Plugin - LiveKit session wrapper
|
|
Copyright (C) 2026 CyberCoveLLC <jknapp85@gmail.com>
|
|
|
|
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
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "stplugin/session_types.h"
|
|
|
|
namespace stplugin {
|
|
|
|
struct SessionConfig {
|
|
/// LiveKit websocket URL, from POST /api/obs/:slug/token.
|
|
std::string ws_url;
|
|
/// LiveKit JWT, from the same call.
|
|
std::string token;
|
|
/// The slot's participant identity to subscribe to.
|
|
std::string participant_identity;
|
|
|
|
/// Pixel format requested from the SDK. I420 costs no conversion on
|
|
/// either side.
|
|
PixelFormat video_format = PixelFormat::I420;
|
|
|
|
/// Ring-buffer depth for decoded video. Non-zero means the SDK drops the
|
|
/// OLDEST frame when the queue is full, which is the structural answer to
|
|
/// the stale-frame-after-publisher-swap bug that motivated this plugin
|
|
/// (see the design doc's Approach section): a stalled consumer can only
|
|
/// ever fall this far behind, and what it then sees is the newest frame,
|
|
/// not a backlog.
|
|
std::size_t video_queue_capacity = 3;
|
|
|
|
/// Same for audio. A little deeper because audio frames are 10ms each.
|
|
std::size_t audio_queue_capacity = 20;
|
|
|
|
bool subscribe_audio = true;
|
|
|
|
/// How long connect() waits for the room to come up before giving up.
|
|
int connect_timeout_ms = 15000;
|
|
};
|
|
|
|
/// Wraps livekit::Room for exactly one subscribed slot.
|
|
///
|
|
/// Threading contract, which the OBS adapter depends on:
|
|
/// - connect() and disconnect() are blocking and must be called from an
|
|
/// ordinary thread. They must NOT be called from inside a handler this
|
|
/// class invokes: the SDK documents that Room::disconnect() deadlocks if
|
|
/// called from a room event callback, and Room's own callback registration
|
|
/// is not re-entrant either.
|
|
/// - The video and audio handlers are invoked on dedicated reader threads,
|
|
/// one per track. Frame pointers are valid only for the duration of the
|
|
/// call.
|
|
/// - The state handler is invoked from whichever thread observed the
|
|
/// change. It must not block and must not call back into this object.
|
|
/// - All handlers must be installed before connect(); they are not
|
|
/// synchronised against a running session.
|
|
class LiveKitSession {
|
|
public:
|
|
LiveKitSession();
|
|
~LiveKitSession();
|
|
|
|
LiveKitSession(const LiveKitSession &) = delete;
|
|
LiveKitSession &operator=(const LiveKitSession &) = delete;
|
|
|
|
void setVideoHandler(VideoFrameHandler handler);
|
|
void setAudioHandler(AudioFrameHandler handler);
|
|
void setStateHandler(SessionStateHandler handler);
|
|
|
|
/// Connect and start subscribing. Returns true once the room is up; the
|
|
/// selected slot's tracks may still arrive later (or not at all, if the
|
|
/// camera is dark), which is reported through hasVideo()/the state
|
|
/// handler rather than as a connect failure.
|
|
bool connect(const SessionConfig &config);
|
|
|
|
/// Tear everything down. Safe to call when never connected, and safe to
|
|
/// call twice.
|
|
void disconnect();
|
|
|
|
SessionState state() const;
|
|
std::string stateDetail() const;
|
|
bool hasVideo() const;
|
|
bool hasAudio() const;
|
|
/// True when connected but the slot is not publishing: the source should
|
|
/// show its placeholder, not an error.
|
|
bool waitingForCamera() const;
|
|
|
|
/// Monotonic counters, for logging and for the adapter to tell "connected
|
|
/// but silent" from "never started".
|
|
std::uint64_t videoFrameCount() const;
|
|
std::uint64_t audioFrameCount() const;
|
|
|
|
/// Process-wide SDK init/teardown. Reference-counted, so several sources
|
|
/// can each hold one. The OBS adapter calls these from obs_module_load /
|
|
/// obs_module_unload.
|
|
static void globalInitialize();
|
|
static void globalShutdown();
|
|
|
|
private:
|
|
struct Impl;
|
|
std::unique_ptr<Impl> impl_;
|
|
};
|
|
|
|
} // namespace stplugin
|