|
|
// Copyright 2019, Chef. All rights reserved.
|
|
|
// https://github.com/q191201771/lal
|
|
|
//
|
|
|
// Use of this source code is governed by a MIT-style license
|
|
|
// that can be found in the License file.
|
|
|
//
|
|
|
// Author: Chef (191201771@qq.com)
|
|
|
|
|
|
package logic
|
|
|
|
|
|
import (
|
|
|
"github.com/q191201771/lal/pkg/base"
|
|
|
)
|
|
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
type ILalServer interface {
|
|
|
RunLoop() error
|
|
|
Dispose()
|
|
|
|
|
|
// AddCustomizePubSession 定制化增强功能。业务方可以将自己的流输入到 ILalServer 中
|
|
|
//
|
|
|
// @example 示例见 lal/app/demo/customize_lalserver
|
|
|
//
|
|
|
// @doc 文档见 <lalserver二次开发 - pub接入自定义流> https://pengrl.com/lal/#/customize_pub
|
|
|
//
|
|
|
AddCustomizePubSession(streamName string) (ICustomizePubSessionContext, error)
|
|
|
|
|
|
// DelCustomizePubSession 将 ICustomizePubSessionContext 对象从 ILalServer 中删除
|
|
|
//
|
|
|
// 注意，业务方调用该函数后，就不要再使用该 ICustomizePubSessionContext 对象的方法了，比如继续 FeedAvPacket 是无效的
|
|
|
//
|
|
|
DelCustomizePubSession(ICustomizePubSessionContext)
|
|
|
|
|
|
// WithOnHookSession
|
|
|
//
|
|
|
// hook所有输入到lal server的流。
|
|
|
// 二次开发时使用。
|
|
|
// 当有流进入lal server时， onHookSession 被调用，业务方应该在回调中返回一个实现了 ICustomizeHookSessionContext 接口的对象。
|
|
|
// 后续收到流数据以及流停止时， ICustomizeHookSessionContext 对象的 OnMsg 和 OnStop 方法会被调用。
|
|
|
WithOnHookSession(onHookSession func(uniqueKey string, streamName string) ICustomizeHookSessionContext)
|
|
|
|
|
|
// StatLalInfo StatAllGroup StatGroup CtrlStartPull CtrlKickOutSession
|
|
|
//
|
|
|
// 一些获取状态、发送控制命令的API。
|
|
|
// 目的是方便业务方在不修改logic包内代码的前提下，在外层实现一些特定逻辑的定制化开发。
|
|
|
//
|
|
|
StatLalInfo() base.LalInfo
|
|
|
StatAllGroup() (sgs []base.StatGroup)
|
|
|
StatGroup(streamName string) *base.StatGroup
|
|
|
CtrlStartRelayPull(info base.ApiCtrlStartRelayPullReq) base.ApiCtrlStartRelayPullResp
|
|
|
CtrlStopRelayPull(streamName string) base.ApiCtrlStopRelayPullResp
|
|
|
CtrlKickSession(info base.ApiCtrlKickSessionReq) base.ApiCtrlKickSessionResp
|
|
|
}
|
|
|
|
|
|
// NewLalServer 创建一个lal server
|
|
|
//
|
|
|
// @param modOption: 定制化配置。可变参数，如果不关心，可以不填，具体字段见 Option
|
|
|
func NewLalServer(modOption ...ModOption) ILalServer {
|
|
|
return NewServerManager(modOption...)
|
|
|
}
|
|
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
type ICustomizePubSessionContext interface {
|
|
|
// IAvPacketStream 传入音视频数据相关的接口。详细说明见 base.IAvPacketStream
|
|
|
//
|
|
|
base.IAvPacketStream
|
|
|
|
|
|
FeedRtmpMsg(msg base.RtmpMsg) error
|
|
|
|
|
|
UniqueKey() string
|
|
|
StreamName() string
|
|
|
}
|
|
|
|
|
|
// ICustomizeHookSessionContext
|
|
|
//
|
|
|
// 业务方实现该接口，从而hook所有输入到lalserver中的流以及流中的数据。
|
|
|
type ICustomizeHookSessionContext interface {
|
|
|
// OnMsg
|
|
|
//
|
|
|
// 注意，业务方应尽快处理回调消息，否则会阻塞lal server内部处理逻辑。
|
|
|
//
|
|
|
// @param msg: 注意，业务方不应该修改或持有该内存块，如果有需要，应对该内存块进行拷贝，比如调用 msg.Clone() 生成新的 base.RtmpMsg 再使用
|
|
|
OnMsg(msg base.RtmpMsg)
|
|
|
OnStop()
|
|
|
}
|
|
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
// INotifyHandler 事件通知接口
|
|
|
type INotifyHandler interface {
|
|
|
OnServerStart(info base.LalInfo)
|
|
|
OnUpdate(info base.UpdateInfo)
|
|
|
OnPubStart(info base.PubStartInfo)
|
|
|
OnPubStop(info base.PubStopInfo)
|
|
|
OnSubStart(info base.SubStartInfo)
|
|
|
OnSubStop(info base.SubStopInfo)
|
|
|
OnRelayPullStart(info base.PullStartInfo)
|
|
|
OnRelayPullStop(info base.PullStopInfo)
|
|
|
OnRtmpConnect(info base.RtmpConnectInfo)
|
|
|
OnHlsMakeTs(info base.HlsMakeTsInfo)
|
|
|
}
|
|
|
|
|
|
type Option struct {
|
|
|
// ConfFilename 配置文件。
|
|
|
//
|
|
|
// 注意，如果为空，内部会尝试从 DefaultConfFilenameList 读取默认配置文件
|
|
|
ConfFilename string
|
|
|
|
|
|
// ConfRawContent 配置内容，json格式。
|
|
|
//
|
|
|
// 应用场景：有的业务方配置内容并非从配置文件中读取，比如集成 ILalServer 时配置内容来自配置中心网络下发，所以提供这个字段供业务方直接传入配置内容。
|
|
|
//
|
|
|
// 注意，读取加载配置的优先级是 ConfRawContent > ConfFilename > DefaultConfFilenameList
|
|
|
ConfRawContent []byte
|
|
|
|
|
|
// NotifyHandler
|
|
|
//
|
|
|
// 事件监听
|
|
|
// 业务方可实现 INotifyHandler 接口并传入从而获取到对应的事件通知。
|
|
|
// 如果不填写保持默认值nil，内部默认走http notify的逻辑（当然，还需要在配置文件中开启http notify功能）。
|
|
|
// 注意，如果业务方实现了自己的事件监听，则lal server内部不再走http notify的逻辑（也即二选一）。
|
|
|
//
|
|
|
NotifyHandler INotifyHandler
|
|
|
|
|
|
// TODO(chef): [refactor] 考虑用INotifyHandler实现ModConfigGroupCreator和IAuthentication 202209
|
|
|
|
|
|
// ModConfigGroupCreator
|
|
|
// This func help us modify the group configuration base on appName or streamName
|
|
|
// so that group can have it own configuration (configuration can be in other source like db)
|
|
|
// It will help us reduce resource usage if we just want some specific group record flv or hls...
|
|
|
ModConfigGroupCreator ModConfigGroupCreator
|
|
|
|
|
|
// Authentication
|
|
|
// This interface make authenticate customizable so that we can implement any authenticate strategy like jwt...
|
|
|
//
|
|
|
// 这是一个同步接口，回调函数处于内部的处理逻辑与锁中
|
|
|
Authentication IAuthentication
|
|
|
}
|
|
|
|
|
|
var defaultOption = Option{
|
|
|
NotifyHandler: nil, // 注意，为nil时，内部会赋值为 HttpNotify
|
|
|
}
|
|
|
|
|
|
type ModOption func(option *Option)
|
|
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
// TODO(chef): [doc] 整理散乱在源码文件中的以注释形式存在的文档 202302
|
|
|
//
|
|
|
// - base/t_session.go session相关的
|
|
|
// - logic/group__.go 1) group内的流转关系 2) group对session的接口要求
|
|
|
// - base/dump_file.go session对debug dump的支持情况
|
|
|
// - innertest/iface_impl.go 所有interface以及实现了interface的struct
|