Documentation
¶
Index ¶
- Constants
- Variables
- func Run(ctx context.Context, configFile string) (err error)
- type AudioDeConf
- type AudioFrame
- type AudioRTP
- type AuthPub
- type AuthSub
- type ClientConfig
- type ClientIO
- type DefaultYaml
- type FLVFrame
- type FirstConfig
- type GlobalConfig
- func (conf *GlobalConfig) API_closeStream(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_getConfig(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_list_pull(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_list_push(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_modifyConfig(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_plugins(rw http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_replay_rtpdump(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_replay_ts(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_stopPush(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_stream(rw http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_summary(rw http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_sysInfo(rw http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) API_updateConfig(w http.ResponseWriter, r *http.Request)
- func (conf *GlobalConfig) ServeHTTP(rw http.ResponseWriter, r *http.Request)
- type HasAnnexB
- type IIO
- type IO
- type IOConfig
- type IPublisher
- type IPuller
- type IPusher
- type ISubscriber
- type NetWorkInfo
- type PlayContext
- type Plugin
- func (opt *Plugin) Publish(streamPath string, pub IPublisher) error
- func (opt *Plugin) Pull(streamPath string, url string, puller IPuller, save int) (err error)
- func (opt *Plugin) Push(streamPath string, url string, pusher IPusher, save bool) (err error)
- func (opt *Plugin) Save() error
- func (opt *Plugin) Subscribe(streamPath string, sub ISubscriber) error
- func (opt *Plugin) SubscribeBlock(streamPath string, sub ISubscriber, t byte) (err error)
- func (opt *Plugin) SubscribeExist(streamPath string, sub ISubscriber) error
- func (opt *Plugin) Update(conf config.Config)
- type Publisher
- type Puller
- type Pusher
- type RTPDumpPublisher
- type SEKick
- type SEclose
- type SEpublish
- type SEwaitClose
- type SEwaitPublish
- type StateEvent
- type Stream
- func (s *Stream) AddTrack(t Track)
- func (r *Stream) Close()
- func (r *Stream) IsClosed() bool
- func (r *Stream) IsShutdown() bool
- func (r *Stream) NewDataTrack(locker sync.Locker) (dt *track.Data)
- func (s *Stream) Receive(event any) bool
- func (s *Stream) RemoveTrack(t Track)
- func (s *Stream) SSRC() uint32
- func (s *Stream) Summary() (r StreamSummay)
- type StreamAction
- type StreamList
- type StreamState
- type StreamSummay
- type StreamTimeoutConfig
- type Subscriber
- func (s *Subscriber) AddTrack(t Track) bool
- func (s *Subscriber) GetSubscriber() *Subscriber
- func (s *Subscriber) IsPlaying() bool
- func (s *Subscriber) OnEvent(event any)
- func (s *Subscriber) PlayBlock(subType byte)
- func (s *Subscriber) PlayFLV()
- func (s *Subscriber) PlayRTP()
- func (s *Subscriber) PlayRaw()
- type Subscribers
- func (s *Subscribers) AbortWait()
- func (s *Subscribers) Add(suber ISubscriber, wait *waitTracks)
- func (s *Subscribers) Broadcast(event any)
- func (s *Subscribers) Delete(suber ISubscriber)
- func (s *Subscribers) Dispose()
- func (s *Subscribers) Init()
- func (s *Subscribers) Len() int
- func (s *Subscribers) MarshalJSON() ([]byte, error)
- func (s *Subscribers) OnPublisherLost(event StateEvent)
- func (s *Subscribers) OnTrack(track common.Track)
- func (s *Subscribers) Pick() ISubscriber
- func (s *Subscribers) RangeAll(f func(sub ISubscriber, wait *waitTracks))
- type Summary
- type TSPublisher
- type TrackPlayer
- type TrackRemoved
- type Tracks
- type UnsubscribeEvent
- type VideoDeConf
- type VideoFrame
- type VideoRTP
Constants ¶
View Source
const ( NO_SUCH_CONIFG = "no such config" NO_SUCH_STREAM = "no such stream" )
View Source
const ( SUBTYPE_RAW = iota SUBTYPE_AVCC SUBTYPE_RTP SUBTYPE_FLV )
View Source
const ( SUBSTATE_INIT = iota SUBSTATE_FIRST SUBSTATE_NORMAL )
Variables ¶
View Source
var ( SysInfo struct { StartTime time.Time //启动时间 LocalIP string Version string } ExecPath = os.Args[0] ExecDir = filepath.Dir(ExecPath) // ConfigRaw 配置信息的原始数据 ConfigRaw []byte Plugins = make(map[string]*Plugin) // Plugins 所有的插件配置 EngineConfig = &GlobalConfig{ Engine: config.Global, } Engine = InstallPlugin(EngineConfig) //复用安装插件逻辑,将全局配置信息注入,并启动server MergeConfigs = []string{"Publish", "Subscribe", "HTTP"} //需要合并配置的属性项,插件若没有配置则使用全局配置 EventBus chan any )
View Source
var ActionNames = [...]string{"publish", "timeout", "publish lost", "close", "last leave", "first enter", "no tracks"}
View Source
var ErrBadName = errors.New("Stream Already Exist")
View Source
var ErrNoPullConfig = errors.New("no pull config")
View Source
var ErrNoPushConfig = errors.New("no push config")
View Source
var ErrPublisherLost = errors.New("Publisher Lost")
View Source
var ErrStreamIsClosed = errors.New("Stream Is Closed")
View Source
var ErrStreamNotExist = errors.New("stream not exist")
View Source
var OnAuthPub func(p *util.Promise[IPublisher]) error
View Source
var OnAuthSub func(p *util.Promise[ISubscriber]) error
View Source
var Pullers sync.Map
View Source
var Pushers sync.Map
View Source
var StateNames = [...]string{"⌛", "🟢", "🟡", "🔴"}
View Source
var StreamFSM = [len(StateNames)]map[StreamAction]StreamState{ { ACTION_PUBLISH: STATE_PUBLISHING, ACTION_TIMEOUT: STATE_CLOSED, ACTION_LASTLEAVE: STATE_CLOSED, ACTION_CLOSE: STATE_CLOSED, }, { ACTION_PUBLISHLOST: STATE_WAITPUBLISH, ACTION_LASTLEAVE: STATE_WAITCLOSE, ACTION_CLOSE: STATE_CLOSED, }, { ACTION_PUBLISHLOST: STATE_CLOSED, ACTION_TIMEOUT: STATE_CLOSED, ACTION_FIRSTENTER: STATE_PUBLISHING, ACTION_CLOSE: STATE_CLOSED, }, {}, }
Streams 所有的流集合
Functions ¶
Types ¶
type AudioDeConf ¶
type AudioDeConf DecoderConfiguration[[]byte]
type AudioFrame ¶
type AudioFrame AVFrame[[]byte]
type ClientIO ¶ added in v4.1.0
type ClientIO[C ClientConfig] struct { Config *C StreamPath string // 本地流标识 RemoteURL string // 远程服务器地址(用于推拉) ReConnectCount int //重连次数 }
ClientIO 作为Client角色(Puller,Pusher)的公共结构体
type DefaultYaml ¶ added in v4.9.6
type DefaultYaml string
type FirstConfig ¶
type GlobalConfig ¶
func (*GlobalConfig) API_closeStream ¶
func (conf *GlobalConfig) API_closeStream(w http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_getConfig ¶
func (conf *GlobalConfig) API_getConfig(w http.ResponseWriter, r *http.Request)
API_getConfig 获取指定的配置信息
func (*GlobalConfig) API_list_pull ¶ added in v4.6.4
func (conf *GlobalConfig) API_list_pull(w http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_list_push ¶ added in v4.6.4
func (conf *GlobalConfig) API_list_push(w http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_modifyConfig ¶
func (conf *GlobalConfig) API_modifyConfig(w http.ResponseWriter, r *http.Request)
API_modifyConfig 修改并保存配置
func (*GlobalConfig) API_plugins ¶ added in v4.1.4
func (conf *GlobalConfig) API_plugins(rw http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_replay_rtpdump ¶ added in v4.8.6
func (conf *GlobalConfig) API_replay_rtpdump(w http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_replay_ts ¶ added in v4.9.8
func (conf *GlobalConfig) API_replay_ts(w http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_stopPush ¶ added in v4.7.2
func (conf *GlobalConfig) API_stopPush(w http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_stream ¶ added in v4.1.0
func (conf *GlobalConfig) API_stream(rw http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_summary ¶
func (conf *GlobalConfig) API_summary(rw http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_sysInfo ¶
func (conf *GlobalConfig) API_sysInfo(rw http.ResponseWriter, r *http.Request)
func (*GlobalConfig) API_updateConfig ¶
func (conf *GlobalConfig) API_updateConfig(w http.ResponseWriter, r *http.Request)
API_updateConfig 热更新配置
func (*GlobalConfig) ServeHTTP ¶
func (conf *GlobalConfig) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type IO ¶
type IO struct { ID string Type string context.Context `json:"-"` //不要直接设置,应当通过OnEvent传入父级Context context.CancelFunc `json:"-"` //流关闭是关闭发布者或者订阅者 *zap.Logger `json:"-"` StartTime time.Time //创建时间 Stream *Stream `json:"-"` io.Reader `json:"-"` io.Writer `json:"-"` io.Closer `json:"-"` Args url.Values Spesific IIO `json:"-"` }
发布者或者订阅者的共用结构体
func (*IO) IsShutdown ¶ added in v4.9.0
type IPublisher ¶
type IPuller ¶
type IPuller interface { IPublisher Connect() error Pull() error Reconnect() bool // contains filtered or unexported methods }
type IPusher ¶
type IPusher interface { ISubscriber Push() error Connect() error Reconnect() bool // contains filtered or unexported methods }
type ISubscriber ¶
type ISubscriber interface { IIO GetSubscriber() *Subscriber IsPlaying() bool PlayRaw() PlayBlock(byte) PlayFLV() Stop() }
type NetWorkInfo ¶
type NetWorkInfo struct { Name string Receive uint64 Sent uint64 ReceiveSpeed uint64 SentSpeed uint64 }
NetWorkInfo 网速信息
type PlayContext ¶
type PlayContext[T interface { GetDecConfSeq() int ReadRing() *AVRing[R] GetDecoderConfiguration() DecoderConfiguration[R] }, R RawSlice] struct { Track T Frame *AVFrame[R] // contains filtered or unexported fields }
func (*PlayContext[T, R]) MarshalJSON ¶
func (p *PlayContext[T, R]) MarshalJSON() ([]byte, error)
type Plugin ¶
type Plugin struct { context.Context `json:"-"` context.CancelFunc `json:"-"` Name string //插件名称 Config config.Plugin `json:"-"` //类型化的插件配置 Version string //插件版本 Yaml string //配置文件中的配置项 RawConfig config.Config //最终合并后的配置的map形式方便查询 Modified config.Config //修改过的配置项 *zap.Logger `json:"-"` // contains filtered or unexported fields }
Plugin 插件信息
func InstallPlugin ¶
InstallPlugin 安装插件,传入插件配置生成插件信息对象
func (*Plugin) Subscribe ¶
func (opt *Plugin) Subscribe(streamPath string, sub ISubscriber) error
Subscribe 订阅一个流,如果流不存在则创建一个等待流
func (*Plugin) SubscribeBlock ¶
func (opt *Plugin) SubscribeBlock(streamPath string, sub ISubscriber, t byte) (err error)
SubscribeBlock 阻塞订阅一个流,直到订阅结束
func (*Plugin) SubscribeExist ¶ added in v4.8.8
func (opt *Plugin) SubscribeExist(streamPath string, sub ISubscriber) error
SubscribeExist 订阅已经存在的流
type Publisher ¶
type Publisher struct { IO Config *config.Publish common.AudioTrack `json:"-"` common.VideoTrack `json:"-"` }
func (*Publisher) Equal ¶
func (p *Publisher) Equal(p2 IPublisher) bool
func (*Publisher) GetPublisher ¶ added in v4.9.0
func (*Publisher) WriteAVCCAudio ¶ added in v4.1.0
type RTPDumpPublisher ¶ added in v4.8.6
type RTPDumpPublisher struct { Publisher DumpFile string VCodec codec.VideoCodecID ACodec codec.AudioCodecID // contains filtered or unexported fields }
func (*RTPDumpPublisher) OnEvent ¶ added in v4.8.6
func (t *RTPDumpPublisher) OnEvent(event any)
type SEclose ¶
type SEclose struct {
StateEvent
}
type SEpublish ¶
type SEpublish struct {
StateEvent
}
type SEwaitClose ¶
type SEwaitClose struct {
StateEvent
}
type SEwaitPublish ¶
type SEwaitPublish struct { StateEvent Publisher IPublisher }
type StateEvent ¶
type StateEvent struct { Action StreamAction From StreamState Stream *Stream `json:"-"` }
func (StateEvent) Next ¶
func (se StateEvent) Next() (next StreamState, ok bool)
type Stream ¶
type Stream struct { *zap.Logger StartTime time.Time //创建时间 StreamTimeoutConfig Path string Publisher IPublisher State StreamState StateEvent StateEvent // 进入当前状态的事件 Subscribers Subscribers // 订阅者 Tracks Tracks AppName string StreamName string // contains filtered or unexported fields }
Stream 流定义
func FilterStreams ¶
func FilterStreams[T IPublisher]() (ss []*Stream)
func (*Stream) IsShutdown ¶ added in v4.6.5
func (*Stream) RemoveTrack ¶
func (s *Stream) RemoveTrack(t Track)
func (*Stream) Summary ¶ added in v4.1.0
func (s *Stream) Summary() (r StreamSummay)
Summary 返回流的简要信息
type StreamAction ¶
type StreamAction byte
const ( ACTION_PUBLISH StreamAction = iota ACTION_TIMEOUT // 发布流长时间没有数据/长时间没有发布者发布流/等待关闭时间到 ACTION_PUBLISHLOST // 发布者意外断开 ACTION_CLOSE // 主动关闭流 ACTION_LASTLEAVE // 最后一个订阅者离开 ACTION_FIRSTENTER // 第一个订阅者进入 )
type StreamList ¶ added in v4.8.2
type StreamList []*Stream
func GetSortedStreamList ¶ added in v4.8.2
func GetSortedStreamList() StreamList
func (StreamList) Len ¶ added in v4.8.2
func (l StreamList) Len() int
func (StreamList) Less ¶ added in v4.8.2
func (l StreamList) Less(i, j int) bool
func (StreamList) Sort ¶ added in v4.8.2
func (l StreamList) Sort()
func (StreamList) Swap ¶ added in v4.8.2
func (l StreamList) Swap(i, j int)
type StreamState ¶
type StreamState byte
const ( STATE_WAITPUBLISH StreamState = iota // 等待发布者状态 STATE_PUBLISHING // 正在发布流状态 STATE_WAITCLOSE // 等待关闭状态(自动关闭延时开启) STATE_CLOSED // 流已关闭,不可使用 )
四状态机
type StreamSummay ¶ added in v4.1.0
type StreamTimeoutConfig ¶
type Subscriber ¶
type Subscriber struct { IO IsInternal bool //是否内部订阅,不放入订阅列表 Config *config.Subscribe TrackPlayer `json:"-"` }
Subscriber 订阅者实体定义
func (*Subscriber) AddTrack ¶
func (s *Subscriber) AddTrack(t Track) bool
func (*Subscriber) GetSubscriber ¶ added in v4.9.0
func (s *Subscriber) GetSubscriber() *Subscriber
func (*Subscriber) IsPlaying ¶
func (s *Subscriber) IsPlaying() bool
func (*Subscriber) OnEvent ¶
func (s *Subscriber) OnEvent(event any)
func (*Subscriber) PlayFLV ¶ added in v4.3.0
func (s *Subscriber) PlayFLV()
func (*Subscriber) PlayRTP ¶ added in v4.4.0
func (s *Subscriber) PlayRTP()
func (*Subscriber) PlayRaw ¶ added in v4.3.0
func (s *Subscriber) PlayRaw()
type Subscribers ¶ added in v4.9.3
type Subscribers struct {
// contains filtered or unexported fields
}
func (*Subscribers) AbortWait ¶ added in v4.9.5
func (s *Subscribers) AbortWait()
func (*Subscribers) Add ¶ added in v4.9.3
func (s *Subscribers) Add(suber ISubscriber, wait *waitTracks)
func (*Subscribers) Broadcast ¶ added in v4.9.3
func (s *Subscribers) Broadcast(event any)
func (*Subscribers) Delete ¶ added in v4.9.3
func (s *Subscribers) Delete(suber ISubscriber)
func (*Subscribers) Dispose ¶ added in v4.9.5
func (s *Subscribers) Dispose()
func (*Subscribers) Init ¶ added in v4.9.5
func (s *Subscribers) Init()
func (*Subscribers) Len ¶ added in v4.9.5
func (s *Subscribers) Len() int
func (*Subscribers) MarshalJSON ¶ added in v4.9.3
func (s *Subscribers) MarshalJSON() ([]byte, error)
func (*Subscribers) OnPublisherLost ¶ added in v4.9.5
func (s *Subscribers) OnPublisherLost(event StateEvent)
func (*Subscribers) OnTrack ¶ added in v4.9.5
func (s *Subscribers) OnTrack(track common.Track)
func (*Subscribers) Pick ¶ added in v4.9.3
func (s *Subscribers) Pick() ISubscriber
func (*Subscribers) RangeAll ¶ added in v4.9.5
func (s *Subscribers) RangeAll(f func(sub ISubscriber, wait *waitTracks))
type Summary ¶
type Summary struct { Address string Memory struct { Total uint64 Free uint64 Used uint64 Usage float64 } CPUUsage float64 HardDisk struct { Total uint64 Free uint64 Used uint64 Usage float64 } NetWork []NetWorkInfo Streams []StreamSummay // contains filtered or unexported fields }
ServerSummary 系统摘要定义
type TSPublisher ¶
type TSPublisher struct { Publisher mpegts.MpegTsStream // contains filtered or unexported fields }
func (*TSPublisher) OnEvent ¶
func (t *TSPublisher) OnEvent(event any)
func (*TSPublisher) OnPmtStream ¶
func (t *TSPublisher) OnPmtStream(s mpegts.MpegTsPmtStream)
func (*TSPublisher) ReadPES ¶ added in v4.9.8
func (t *TSPublisher) ReadPES()
type TrackPlayer ¶
type TrackPlayer struct { context.Context `json:"-"` context.CancelFunc `json:"-"` Audio PlayContext[*track.Audio, []byte] Video PlayContext[*track.Video, NALUSlice] SkipTS uint32 //跳过的时间戳 FirstAbsTS uint32 //订阅起始时间戳 }
func (*TrackPlayer) ReadAudio ¶ added in v4.6.9
func (tp *TrackPlayer) ReadAudio() (ap *AVFrame[[]byte])
func (*TrackPlayer) ReadVideo ¶ added in v4.6.9
func (tp *TrackPlayer) ReadVideo() (vp *AVFrame[NALUSlice])
type TrackRemoved ¶
type TrackRemoved struct {
Track
}
type Tracks ¶ added in v4.5.1
func (*Tracks) MarshalJSON ¶ added in v4.5.1
type UnsubscribeEvent ¶ added in v4.9.0
type UnsubscribeEvent struct {
Subscriber ISubscriber
}
type VideoDeConf ¶
type VideoDeConf DecoderConfiguration[NALUSlice]
func (VideoDeConf) GetAnnexB ¶ added in v4.2.0
func (v VideoDeConf) GetAnnexB() (r net.Buffers)
type VideoFrame ¶
type VideoFrame AVFrame[NALUSlice]
func (*VideoFrame) GetAnnexB ¶ added in v4.2.0
func (v *VideoFrame) GetAnnexB() (r net.Buffers)
func copyBuffers(b net.Buffers) (r net.Buffers) { return append(r, b...) }
Source Files
¶
Click to show internal directories.
Click to hide internal directories.