hls

Documentation

Index

• Constants
• Variables
• func CalcM3U8Duration(content []byte) (durationSec float64, err error)
• func RemoveAll(path string) error
• func SetUseMemoryAsDiskFlag(flag bool)
• func SplitFragment2TSPackets(content []byte) (ret [][]byte, err error)
• type Fragment
  • func (f *Fragment) CloseFile() error
  • func (f *Fragment) OpenFile(filename string) (err error)
  • func (f *Fragment) WriteFile(b []byte) (err error)
• type Muxer
  • func NewMuxer(streamName string, config *MuxerConfig, observer MuxerObserver, ...) *Muxer
  • func (m *Muxer) Dispose()
  • func (m *Muxer) FeedRTMPMessage(msg base.RTMPMsg)
  • func (m *Muxer) OnFrame(streamer *Streamer, frame *mpegts.Frame)
  • func (m *Muxer) OutPath() string
  • func (m *Muxer) Start()
• type MuxerConfig
• type MuxerEventObserver
• type MuxerObserver
• type ReadFileFallback
• type Server
  • func NewServer(addr string, outPath string) *Server
  • func (s *Server) Dispose()
  • func (s *Server) Listen() (err error)
  • func (s *Server) RunLoop() error
  • func (s *Server) ServeHTTP(resp http.ResponseWriter, req *http.Request)
  • func (s *Server) SetReadFileFallback(fallback ReadFileFallback)
• type Streamer
  • func NewStreamer(observer StreamerObserver) *Streamer
  • func (s *Streamer) AudioCacheEmpty() bool
  • func (s *Streamer) AudioSeqHeaderCached() bool
  • func (s *Streamer) FeedRTMPMessage(msg base.RTMPMsg)
  • func (s *Streamer) FlushAudio()
  • func (s *Streamer) VideoSeqHeaderCached() bool
• type StreamerObserver

Constants

const (
	CleanupModeNever    = 0
	CleanupModeInTheEnd = 1
	CleanupModeASAP     = 2
	CleanupOnlyIndex    = 3
)

Variables

var ErrHLS = errors.New("lal.hls: fxxk")

Functions

func CalcM3U8Duration

func CalcM3U8Duration(content []byte) (durationSec float64, err error)

content 传入m3u8文件内容

@return durationSec m3u8中所有ts的时间总和。注意，使用的是m3u8文件中描述的ts时间，而不是读取ts文件中实际音视频数据的时间。

func RemoveAll

func RemoveAll(path string) error

func SetUseMemoryAsDiskFlag

func SetUseMemoryAsDiskFlag(flag bool)

func SplitFragment2TSPackets

func SplitFragment2TSPackets(content []byte) (ret [][]byte, err error)

Types

type Fragment

type Fragment struct {
	// contains filtered or unexported fields
}

func (*Fragment) CloseFile

func (f *Fragment) CloseFile() error

func (*Fragment) OpenFile

func (f *Fragment) OpenFile(filename string) (err error)

func (*Fragment) WriteFile

func (f *Fragment) WriteFile(b []byte) (err error)

type Muxer

type Muxer struct {
	UniqueKey string
	// contains filtered or unexported fields
}

func NewMuxer

func NewMuxer(streamName string, config *MuxerConfig, observer MuxerObserver, eventObserver MuxerEventObserver) *Muxer

@param observer 可以为nil，如果不为nil，TS流将回调给上层 eventObserver 可以为nil，主要用于触发新增 frag 和关闭 frag 事件给外部

func (*Muxer) Dispose

func (m *Muxer) Dispose()

func (*Muxer) FeedRTMPMessage

func (m *Muxer) FeedRTMPMessage(msg base.RTMPMsg)

@param msg 函数调用结束后，内部不持有msg中的内存块

func (*Muxer) OnFrame

func (m *Muxer) OnFrame(streamer *Streamer, frame *mpegts.Frame)

func (*Muxer) OutPath

func (m *Muxer) OutPath() string

func (*Muxer) Start

func (m *Muxer) Start()

type MuxerConfig

type MuxerConfig struct {
	Enable             bool   `json:"enable"`   // 如果false，说明hls功能没开，也即不写文件，但是MuxerObserver依然会回调
	OutPath            string `json:"out_path"` // m3u8和ts文件的输出根目录，注意，末尾需以'/'结束
	FragmentDurationMS int    `json:"fragment_duration_ms"`
	FragmentNum        int    `json:"fragment_num"`

	// hls文件清理模式：
	// 0 不删除m3u8+ts文件，可用于录制等场景
	// 1 在输入流结束后删除m3u8+ts文件
	//   注意，确切的删除时间是推流结束后的<fragment_duration_ms> * <fragment_num> * 2的时间点
	//   推迟一小段时间删除，是为了避免输入流刚结束，hls的拉流端还没有拉取完
	// 2 推流过程中，持续删除过期的ts文件，只保留最近的<fragment_num> * 2个左右的ts文件
	// TODO chef: lalserver的模式1的逻辑是在上层做的，应该重构到hls模块中
	CleanupMode int `json:"cleanup_mode"`
}

type MuxerEventObserver

type MuxerEventObserver interface {
	// rightNow 记录发生时间
	// ts 新建立fragment时的时间戳，毫秒 * 90
	// id fragment的自增序号
	// discont 不连续标志，会在m3u8文件的fragment前增加`#EXT-X-DISCONTINUITY`
	// fileName fragment 文件名
	// streamName 流名称
	OnOpenFragment(rightNow time.Time, ts uint64, id int, discont bool, fileName string, streamName string)
	// id fragment的自增序号
	// duration 当前fragment中数据的时长，单位秒
	// streamName 流名称
	OnCloseFragment(id int, duration float64, streamName string)
}

type MuxerObserver

type MuxerObserver interface {
	// @param rawFrame TS流，回调结束后，内部不再使用该内存块
	// @param boundary 新的TS流接收者，应该从该标志为true时开始发送数据
	//
	OnTSPackets(rawFrame []byte, boundary bool)
}

type ReadFileFallback

type ReadFileFallback func(rootOutPath string, fileName string, streamName string, fileType string) ([]byte, error)

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(addr string, outPath string) *Server

func (*Server) Dispose

func (s *Server) Dispose()

func (*Server) Listen

func (s *Server) Listen() (err error)

func (*Server) RunLoop

func (s *Server) RunLoop() error

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(resp http.ResponseWriter, req *http.Request)

func (*Server) SetReadFileFallback

func (s *Server) SetReadFileFallback(fallback ReadFileFallback)

type Streamer

type Streamer struct {
	UniqueKey string
	// contains filtered or unexported fields
}

func NewStreamer

func NewStreamer(observer StreamerObserver) *Streamer

func (*Streamer) AudioCacheEmpty

func (s *Streamer) AudioCacheEmpty() bool

func (*Streamer) AudioSeqHeaderCached

func (s *Streamer) AudioSeqHeaderCached() bool

func (*Streamer) FeedRTMPMessage

func (s *Streamer) FeedRTMPMessage(msg base.RTMPMsg)

msg msg.Payload 调用结束后，函数内部不会持有这块内存

TODO chef: 可以考虑数据有问题时，返回给上层，直接主动关闭输入流的连接

func (*Streamer) FlushAudio

func (s *Streamer) FlushAudio()

吐出音频数据的三种情况： 1. 收到音频或视频时，音频缓存队列已达到一定长度 2. 打开一个新的TS文件切片时 3. 输入流关闭时

func (*Streamer) VideoSeqHeaderCached

func (s *Streamer) VideoSeqHeaderCached() bool

type StreamerObserver

type StreamerObserver interface {
	// streamer: 供上层获取streamer内部的一些状态，比如spspps是否已缓存，音频缓存队列是否有数据等
	//
	// frame:    各字段含义见mpegts.Frame结构体定义
	//                  frame.CC  注意，回调结束后，Streamer会保存frame.CC，上层在TS打包完成后，可通过frame.CC将cc值传递给Streamer
	//                  frame.Raw 回调结束后，这块内存可能会被内部重复使用
	//
	OnFrame(streamer *Streamer, frame *mpegts.Frame)
}