apps/monibuca
1
0
Fork 0
mirror of https://github.com/langhuihui/monibuca.git synced 2025-10-08 13:20:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: snap plugin

Browse Source
This commit is contained in:
langhuihui
2025-04-02 16:19:03 +08:00
committed by dexter
parent 0914fb8da7
commit 4e46ecc8cd
7 changed files with 144 additions and 308 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
example/8080/snap.yaml Normal file
View File

@@ -0,0 +1,14 @@
snap:
watermark:
text: "" # 水印文字内容
fontpath: "" # 水印字体文件路径
fontcolor: "rgba(255,165,0,1)" # 水印字体颜色，支持rgba格式
fontsize: 36 # 水印字体大小
offsetx: 0 # 水印位置X偏移
offsety: 0 # 水印位置Y偏移
timeinterval: 1s # 截图时间间隔，默认1分钟
savepath: "snaps" # 截图保存路径
filter: ".*" # 截图流过滤器，支持正则表达式
iframeinterval: 3 # 间隔多少帧截图
mode: 0 # 截图模式：0-时间间隔，1-关键帧间隔 2-HTTP请求模式（手动触发）
querytimedelta: 3 # 查询截图时允许的最大时间差（秒）

12
plugin/snap/README.md
View File

@@ -6,19 +6,19 @@ Snap 插件提供了对流媒体的截图功能，支持定时截图、按关键
```yaml ```yaml
snap: snap:
snapwatermark: watermark:
text: "" # 水印文字内容 text: "" # 水印文字内容
fontpath: "" # 水印字体文件路径 fontpath: "" # 水印字体文件路径
fontcolor: "rgba(255,165,0,1)" # 水印字体颜色，支持rgba格式 fontcolor: "rgba(255,165,0,1)" # 水印字体颜色，支持rgba格式
fontsize: 36 # 水印字体大小 fontsize: 36 # 水印字体大小
offsetx: 0 # 水印位置X偏移 offsetx: 0 # 水印位置X偏移
offsety: 0 # 水印位置Y偏移 offsety: 0 # 水印位置Y偏移
snaptimeinterval: 1m # 截图时间间隔，默认1分钟 timeinterval: 1s # 截图时间间隔，默认1分钟
snapsavepath: "snaps" # 截图保存路径 savepath: "snaps" # 截图保存路径
filter: ".*" # 截图流过滤器，支持正则表达式 filter: ".*" # 截图流过滤器，支持正则表达式
snapiframeinterval: 3 # 间隔多少帧截图 iframeinterval: 3 # 间隔多少帧截图
snapmode: 1 # 截图模式：0-时间间隔，1-关键帧间隔 2-HTTP请求模式（手动触发） mode: 0 # 截图模式：0-时间间隔，1-关键帧间隔 2-HTTP请求模式（手动触发）
snapquerytimedelta: 3 # 查询截图时允许的最大时间差（秒） querytimedelta: 3 # 查询截图时允许的最大时间差（秒）
``` ```
## HTTP API ## HTTP API

7
plugin/snap/index.go
View File

@@ -9,10 +9,9 @@ import (
"image/color" "image/color"
snap_pkg "m7s.live/v5/plugin/snap/pkg" snap "m7s.live/v5/plugin/snap/pkg"
m7s "m7s.live/v5" m7s "m7s.live/v5"
snap "m7s.live/v5/plugin/snap/pkg"
) )
var _ = m7s.InstallPlugin[SnapPlugin](snap.NewTransform) var _ = m7s.InstallPlugin[SnapPlugin](snap.NewTransform)
@@ -67,7 +66,7 @@ func (p *SnapPlugin) OnInit() (err error) {
// 初始化数据库 // 初始化数据库
if p.DB != nil { if p.DB != nil {
err = p.DB.AutoMigrate(&snap_pkg.SnapRecord{}) err = p.DB.AutoMigrate(&snap.SnapRecord{})
if err != nil { if err != nil {
p.Error("failed to migrate database", "error", err.Error()) p.Error("failed to migrate database", "error", err.Error())
return return
@@ -137,7 +136,7 @@ func (p *SnapPlugin) OnInit() (err error) {
} }
//如果截图模式不是时间模式，则不加定时任务 //如果截图模式不是时间模式，则不加定时任务
if p.Mode != snap_pkg.SnapModeTimeInterval { if p.Mode != snap.SnapModeTimeInterval {
return return
} }

295
plugin/snap/pkg/transform.go
View File

@@ -3,12 +3,7 @@ package snap
import ( import (
"bytes" "bytes"
"fmt" "fmt"
"io"
"os" "os"
"os/exec"
"path/filepath"
"regexp"
"strings"
"time" "time"
"m7s.live/v5/pkg" "m7s.live/v5/pkg"
@@ -23,86 +18,8 @@ const (
SnapModeManual SnapModeManual
) )
// GetVideoFrame 获取视频帧数据
func GetVideoFrame(streamPath string, server *m7s.Server) (pkg.AnnexB, *pkg.AVTrack, error) {
// 获取发布者
publisher, ok := server.Streams.Get(streamPath)
if !ok || publisher.VideoTrack.AVTrack == nil {
return pkg.AnnexB{}, nil, pkg.ErrNotFound
}
// 等待视频就绪
if err := publisher.VideoTrack.WaitReady(); err != nil {
return pkg.AnnexB{}, nil, err
}
// 创建读取器并等待 I 帧
reader := pkg.NewAVRingReader(publisher.VideoTrack.AVTrack, "Origin")
if err := reader.StartRead(publisher.VideoTrack.GetIDR()); err != nil {
return pkg.AnnexB{}, nil, err
}
defer reader.StopRead()
if reader.Value.Raw == nil {
if err := reader.Value.Demux(publisher.VideoTrack.ICodecCtx); err != nil {
return pkg.AnnexB{}, nil, err
}
}
var annexb pkg.AnnexB
var track pkg.AVTrack
var err error
track.ICodecCtx, track.SequenceFrame, err = annexb.ConvertCtx(publisher.VideoTrack.ICodecCtx)
if err != nil {
return pkg.AnnexB{}, nil, err
}
if track.ICodecCtx == nil {
return pkg.AnnexB{}, nil, pkg.ErrUnsupportCodec
}
annexb.Mux(track.ICodecCtx, &reader.Value)
return annexb, &track, nil
}
// ProcessWithFFmpeg 使用 FFmpeg 处理视频帧并生成截图
func ProcessWithFFmpeg(annexb pkg.AnnexB, output io.Writer) error {
// 创建ffmpeg命令
cmd := exec.Command("ffmpeg", "-hide_banner", "-i", "pipe:0", "-vframes", "1", "-f", "mjpeg", "pipe:1")
// 获取输入和输出pipe
stdin, err := cmd.StdinPipe()
if err != nil {
return err
}
stdout, err := cmd.StdoutPipe()
if err != nil {
return err
}
// 启动ffmpeg进程
if err = cmd.Start(); err != nil {
return err
}
// 将annexb数据写入到ffmpeg的stdin
if _, err = annexb.WriteTo(stdin); err != nil {
stdin.Close()
return err
}
stdin.Close()
// 从ffmpeg的stdout读取图片数据并写入到输出
if _, err = io.Copy(output, stdout); err != nil {
return err
}
// 等待ffmpeg进程结束
return cmd.Wait()
}
// 保存截图到文件 // 保存截图到文件
func saveSnapshot(annexb pkg.AnnexB, savePath string, plugin *m7s.Plugin, streamPath string, snapMode int) error { func saveSnapshot(annexb []*pkg.AnnexB, savePath string, plugin *m7s.Plugin, streamPath string, snapMode int) error {
var buf bytes.Buffer var buf bytes.Buffer
if err := ProcessWithFFmpeg(annexb, &buf); err != nil { if err := ProcessWithFFmpeg(annexb, &buf); err != nil {
return fmt.Errorf("process with ffmpeg error: %w", err) return fmt.Errorf("process with ffmpeg error: %w", err)
@@ -145,223 +62,25 @@ var _ task.TaskGo = (*Transformer)(nil)
func NewTransform() m7s.ITransformer { func NewTransform() m7s.ITransformer {
ret := &Transformer{} ret := &Transformer{}
ret.SetDescription(task.OwnerTypeKey, "Snap")
return ret return ret
} }
type Transformer struct { type Transformer struct {
m7s.DefaultTransformer task.Job
ffmpeg *exec.Cmd TransformJob m7s.TransformJob
snapTimeInterval time.Duration }
savePath string
filterRegex *regexp.Regexp func (r *Transformer) GetTransformJob() *m7s.TransformJob {
snapMode int // 截图模式：0-时间间隔，1-帧间隔 return &r.TransformJob
snapFrameCount int // 当前帧计数
snapFrameInterval int // 帧间隔
} }
func (t *Transformer) Start() (err error) { func (t *Transformer) Start() (err error) {
// 获取配置，带默认值检查
if t.TransformJob.Plugin.Config.Has("TimeInterval") {
t.snapTimeInterval = t.TransformJob.Plugin.Config.Get("TimeInterval").GetValue().(time.Duration)
} else {
t.snapTimeInterval = time.Minute // 默认1分钟
}
if t.TransformJob.Plugin.Config.Has("SavePath") {
t.savePath = t.TransformJob.Plugin.Config.Get("SavePath").GetValue().(string)
} else {
t.savePath = "snaps" // 默认保存路径
}
if t.TransformJob.Plugin.Config.Has("Mode") {
t.snapMode = t.TransformJob.Plugin.Config.Get("Mode").GetValue().(int)
} else {
t.snapMode = SnapModeIFrameInterval // 默认使用关键帧模式
}
// 检查snapmode是否有效
if t.snapMode != SnapModeIFrameInterval && t.snapMode != SnapModeTimeInterval {
t.Debug("invalid snap mode, skip snapshot",
"mode", t.snapMode,
)
return nil
}
if t.TransformJob.Plugin.Config.Has("IFrameInterval") {
t.snapFrameInterval = t.TransformJob.Plugin.Config.Get("IFrameInterval").GetValue().(int)
} else {
t.snapFrameInterval = 3 // 默认每3个I帧截图一次
}
t.snapFrameCount = 0
t.Info("snap transformer started",
"stream", t.TransformJob.StreamPath,
"save_path", t.savePath,
"mode", t.snapMode,
"frame_interval", t.snapFrameInterval,
)
// 获取过滤器配置
if t.TransformJob.Plugin.Config.Has("Filter") {
filterStr := t.TransformJob.Plugin.Config.Get("Filter").GetValue().(string)
t.filterRegex = regexp.MustCompile(filterStr)
}
// 检查保存路径
if err := os.MkdirAll(t.savePath, 0755); err != nil {
return fmt.Errorf("create save path failed: %w", err)
}
// 如果是时间间隔模式且间隔时间不为0，则跳过订阅模式
if t.snapMode == SnapModeTimeInterval && t.snapTimeInterval != 0 {
t.Info("snap interval is set, skipping subscriber mode",
"interval", t.snapTimeInterval,
"save_path", t.savePath,
)
return nil
}
// 使用 TransformJob 的 Subscribe 方法
return t.TransformJob.Subscribe()
} }
func (t *Transformer) Go() error { func (t *Transformer) Go() error {
// 检查snapmode是否有效
if t.snapMode != SnapModeIFrameInterval && t.snapMode != SnapModeTimeInterval {
t.Debug("invalid snap mode, skip snapshot",
"mode", t.snapMode,
)
return nil return nil
} }
if t.snapMode == SnapModeTimeInterval && t.snapTimeInterval != 0 {
t.Info("snap interval is set, skipping subscriber mode",
"interval", t.snapTimeInterval,
"save_path", t.savePath,
)
return nil
}
// 1. 通过 TransformJob 获取 Subscriber
subscriber := t.TransformJob.Subscriber
// 检查流名称是否匹配过滤器
if t.filterRegex != nil && !t.filterRegex.MatchString(subscriber.StreamPath) {
t.Info("stream path not match filter, skip",
"stream", subscriber.StreamPath,
"filter", t.filterRegex.String(),
)
return nil
}
// 2. 设置数据处理回调
handleVideo := func(video *pkg.AVFrame) error {
// 处理视频数据
if !video.IDR {
return nil
}
shouldSnap := false
if t.snapMode == 0 { // 时间间隔模式
shouldSnap = true
} else { // 帧间隔模式
t.snapFrameCount++
if t.snapFrameCount >= t.snapFrameInterval {
shouldSnap = true
t.snapFrameCount = 0
}
}
if !shouldSnap {
return nil
}
t.Debug("received IDR frame",
"stream", subscriber.StreamPath,
"timestamp", video.Timestamp,
"mode", t.snapMode,
"frame_count", t.snapFrameCount,
)
// 获取视频帧
annexb, _, err := GetVideoFrame(subscriber.StreamPath, t.TransformJob.Plugin.Server)
if err != nil {
t.Error("get video frame failed",
"error", err.Error(),
"stream", subscriber.StreamPath,
)
return nil
}
t.Debug("got video frame",
"stream", subscriber.StreamPath,
"timestamp", video.Timestamp,
)
// 生成文件名
filename := fmt.Sprintf("%s_%s.jpg", subscriber.StreamPath, time.Now().Format("20060102150405.000"))
filename = strings.ReplaceAll(filename, "/", "_")
savePath := filepath.Join(t.savePath, filename)
// 保存截图（带水印）
if err := saveSnapshot(annexb, savePath, t.TransformJob.Plugin, subscriber.StreamPath, t.snapMode); err != nil {
t.Error("save snapshot failed",
"error", err.Error(),
"stream", subscriber.StreamPath,
"path", savePath,
)
} else {
fileInfo, err := os.Stat(savePath)
size := int64(0)
if err == nil {
size = fileInfo.Size()
}
t.Info("take snapshot success",
"stream", subscriber.StreamPath,
"path", savePath,
"size", size,
"watermark", GlobalWatermarkConfig.Text != "",
"mode", t.snapMode,
)
}
return nil
}
handleAudio := func(audio *pkg.AVFrame) error {
// 处理音频数据
return nil
}
// 3. 开始接收数据
t.Info("starting stream processing",
"stream", subscriber.StreamPath,
"mode", t.snapMode,
"frame_interval", t.snapFrameInterval,
)
return m7s.PlayBlock(subscriber, handleAudio, handleVideo)
}
func (t *Transformer) Dispose() { func (t *Transformer) Dispose() {
t.Info("disposing snap transformer",
"stream", t.TransformJob.StreamPath,
)
// 清理 FFmpeg 进程
if t.ffmpeg != nil {
if err := t.ffmpeg.Process.Kill(); err != nil {
t.Error("kill ffmpeg process failed",
"error", err.Error(),
"pid", t.ffmpeg.Process.Pid,
)
} else {
t.Info("ffmpeg process killed",
"pid", t.ffmpeg.Process.Pid,
)
}
t.ffmpeg = nil
}
t.Info("snap transformer disposed",
"stream", t.TransformJob.StreamPath,
)
} }

95
plugin/snap/pkg/util.go Normal file
View File

@@ -0,0 +1,95 @@
package snap
import (
"fmt"
"io"
"os/exec"
m7s "m7s.live/v5"
"m7s.live/v5/pkg"
)
// GetVideoFrame 获取视频帧数据
func GetVideoFrame(streamPath string, server *m7s.Server) ([]*pkg.AnnexB, *pkg.AVTrack, error) {
// 获取发布者
publisher, err := server.GetPublisher(streamPath)
if err != nil {
return nil, nil, err
}
if publisher.VideoTrack.AVTrack == nil {
return nil, nil, pkg.ErrNotFound
}
// 等待视频就绪
if err = publisher.VideoTrack.WaitReady(); err != nil {
return nil, nil, err
}
// 创建读取器并等待 I 帧
reader := pkg.NewAVRingReader(publisher.VideoTrack.AVTrack, "snapshot")
if err = reader.StartRead(publisher.VideoTrack.GetIDR()); err != nil {
return nil, nil, err
}
defer reader.StopRead()
var track pkg.AVTrack
var annexb pkg.AnnexB
track.ICodecCtx, track.SequenceFrame, err = annexb.ConvertCtx(publisher.VideoTrack.ICodecCtx)
if err != nil {
return nil, nil, err
}
if track.ICodecCtx == nil {
return nil, nil, pkg.ErrUnsupportCodec
}
var annexbList []*pkg.AnnexB
for lastFrameSequence := publisher.VideoTrack.AVTrack.LastValue.Sequence; reader.Value.Sequence <= lastFrameSequence; reader.ReadNext() {
if reader.Value.Raw == nil {
if err := reader.Value.Demux(publisher.VideoTrack.ICodecCtx); err != nil {
return nil, nil, err
}
}
var annexb pkg.AnnexB
annexb.Mux(track.ICodecCtx, &reader.Value)
annexbList = append(annexbList, &annexb)
}
return annexbList, &track, nil
}
// ProcessWithFFmpeg 使用 FFmpeg 处理视频帧并生成截图
func ProcessWithFFmpeg(annexb []*pkg.AnnexB, output io.Writer) error {
// 创建ffmpeg命令，使用select过滤器选择最后一帧
cmd := exec.Command("ffmpeg", "-hide_banner", "-i", "pipe:0", "-vf", fmt.Sprintf("select='eq(n,%d)'", len(annexb)-1), "-vframes", "1", "-f", "mjpeg", "pipe:1")
// 获取输入和输出pipe
stdin, err := cmd.StdinPipe()
if err != nil {
return err
}
stdout, err := cmd.StdoutPipe()
if err != nil {
return err
}
// 启动ffmpeg进程
if err = cmd.Start(); err != nil {
return err
}
// 将annexb数据写入到ffmpeg的stdin
for _, annex := range annexb {
if _, err = annex.WriteTo(stdin); err != nil {
stdin.Close()
return err
}
}
stdin.Close()
// 从ffmpeg的stdout读取图片数据并写入到输出
if _, err = io.Copy(output, stdout); err != nil {
return err
}
// 等待ffmpeg进程结束
return cmd.Wait()
}

14
plugin/transcode/api.go
View File

@@ -4,14 +4,15 @@ import (
"context" "context"
"encoding/base64" "encoding/base64"
"fmt" "fmt"
"google.golang.org/protobuf/types/known/emptypb"
m7s "m7s.live/v5"
"net/url" "net/url"
"os" "os"
"path" "path"
"strconv" "strconv"
"strings" "strings"
"google.golang.org/protobuf/types/known/emptypb"
m7s "m7s.live/v5"
globalPB "m7s.live/v5/pb" globalPB "m7s.live/v5/pb"
"m7s.live/v5/plugin/transcode/pb" "m7s.live/v5/plugin/transcode/pb"
transcode "m7s.live/v5/plugin/transcode/pkg" transcode "m7s.live/v5/plugin/transcode/pkg"
@@ -137,13 +138,8 @@ func parseCrop(cropString string) (string, error) {
func (t *TranscodePlugin) Launch(ctx context.Context, transReq *pb.TransRequest) (response *globalPB.SuccessResponse, err error) { func (t *TranscodePlugin) Launch(ctx context.Context, transReq *pb.TransRequest) (response *globalPB.SuccessResponse, err error) {
var publisher *m7s.Publisher var publisher *m7s.Publisher
var ok bool publisher, err = t.Server.GetPublisher(transReq.SrcStream)
t.Server.Server.Call(func() error { if err != nil {
publisher, ok = t.Server.Streams.Get(transReq.SrcStream)
return nil
})
if !ok {
err = fmt.Errorf("src stream not found")
return return
} }
response = &globalPB.SuccessResponse{} response = &globalPB.SuccessResponse{}

13
server.go
View File

@@ -568,6 +568,19 @@ func (s *Server) Dispose() {
} }
} }
func (s *Server) GetPublisher(streamPath string) (publisher *Publisher, err error) {
var ok bool
s.Streams.Call(func() error {
publisher, ok = s.Streams.Get(streamPath)
return nil
})
if !ok {
err = fmt.Errorf("src stream not found")
return
}
return
}
func (s *Server) OnPublish(p *Publisher) { func (s *Server) OnPublish(p *Publisher) {
for plugin := range s.Plugins.Range { for plugin := range s.Plugins.Range {
plugin.OnPublish(p) plugin.OnPublish(p)