README
¶
Simple Go FFMPEG Library for RTSP streams (IP cameras)
Capture video footage from RTSP IP cameras.
Provides a simple interface to set FFMPEG options and capture video from an RTSP source.
Lots of other libraries out there do ffmpeg and rtsp things, but I couldn't find any that fit this simple task of "get a video snippet from a camera."
Example
package main
import (
"log"
"golift.io/ffmpeg"
)
func main() {
/*
* Example non-transcode direct-save from securityspy.
*/
securitypsy := "rtsp://user:pass@127.0.0.1:8000/++stream?cameraNum=1"
output := "/tmp/securitypsy_captured_file.mov"
c := &ffmpeg.Config{
FFMPEG: "/usr/local/bin/ffmpeg",
Copy: true, // do not transcode
Audio: true, // retain audio stream
Time: 10, // 10 seconds
}
encode := ffmpeg.Get(c)
cmd, out, err := encode.SaveVideo(securitypsy, output, "SecuritySpyVideoTitle")
log.Println("Command Used:", cmd)
log.Println("Command Output:", out)
if err != nil {
log.Fatalln(err)
}
log.Println("Saved file from", securitypsy, "to", output)
/*
* Example transcode from a Dahua IP camera.
*/
dahua := "rtsp://admin:password@192.168.1.12/live"
output = "/tmp/dahua_captured_file.m4v"
f := ffmpeg.Get(&ffmpeg.Config{
Audio: true, // retain audio stream
Time: 10, // 10 seconds
Width: 1920,
Height: 1080,
CRF: 23,
Level: "4.0",
Rate: 5,
Prof: "baseline",
})
cmd, out, err = f.SaveVideo(dahua, output, "DahuaVideoTitle")
log.Println("Command Used:", cmd)
log.Println("Command Output:", out)
if err != nil {
log.Fatalln(err)
}
log.Println("Saved file from", dahua, "to", output)
}
Documentation
¶
Overview ¶
Package ffmpeg captures video from RTSP streams, like IP cameras.
Provides a simple interface to set FFMPEG options and capture video from an RTSP source.
Example (Dahua) ¶
Example transcode from a Dahua IP camera.
dahua := "rtsp://admin:password@192.168.1.12/live"
output := "/tmp/dahua_captured_file.m4v"
encode := Get(&Config{
Audio: true, // retain audio stream
Time: 10, // 10 seconds
Width: 1920,
Height: 1080,
CRF: 23,
Level: "4.0",
Rate: 5,
Prof: "baseline", // or main or high
})
cmd, out, err := encode.SaveVideo(dahua, output, "DahuaVideoTitle")
log.Println("Command Used:", cmd)
log.Println("Command Output:", out)
if err != nil {
log.Fatalln(err)
}
log.Println("Saved file from", dahua, "to", output)
Output:
Example (SecuritySpy) ¶
Example non-transcode direct-save from securityspy.
securitypsy := "rtsp://user:pass@127.0.0.1:8000/++stream?cameraNum=1"
output := "/tmp/securitypsy_captured_file.mov"
config := &Config{
FFMPEG: "/usr/local/bin/ffmpeg",
Copy: true, // do not transcode
Audio: true, // retain audio stream
Time: 10, // 10 seconds
}
encode := Get(config)
cmd, out, err := encode.SaveVideo(securitypsy, output, "SecuritySpyVideoTitle")
log.Println("Command Used:", cmd)
log.Println("Command Output:", out)
if err != nil {
log.Fatalln(err)
}
log.Println("Saved file from", securitypsy, "to", output)
Output:
Index ¶
- Variables
- type Config
- type Encoder
- func (e *Encoder) Config() Config
- func (e *Encoder) GetVideo(input, title string) (string, io.ReadCloser, error)
- func (e *Encoder) SaveVideo(input, output, title string) (string, string, error)
- func (e *Encoder) SetAudio(audio string) bool
- func (e *Encoder) SetCRF(crf string) int
- func (e *Encoder) SetHeight(height string) int
- func (e *Encoder) SetLevel(level string) string
- func (e *Encoder) SetProfile(profile string) string
- func (e *Encoder) SetRate(rate string) int
- func (e *Encoder) SetSize(size string) int64
- func (e *Encoder) SetTime(seconds string) int
- func (e *Encoder) SetWidth(width string) int
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ( DefaultFrameRate = 5 MinimumFrameRate = 1 MaximumFrameRate = 60 DefaultFrameHeight = 720 DefaultFrameWidth = 1280 MinimumFrameSize = 100 MaximumFrameSize = 5000 DefaultEncodeCRF = 21 MinimumEncodeCRF = 16 MaximumEncodeCRF = 30 DefaultCaptureTime = 15 MaximumCaptureTime = 1200 // 10 minute max. DefaultCaptureSize = int64(2500000) // 2.5MB default (roughly 5-10 seconds) MaximumCaptureSize = int64(104857600) // 100MB max. DefaultFFmpegPath = "/usr/local/bin/ffmpeg" DefaultProfile = "main" DefaultLevel = "3.0" )
Default, Maximum and Minimum Values for encoder configuration. Change these if your needs differ.
var ( ErrorInvalidOutput = fmt.Errorf("output path is not valid") ErrorInvalidInput = fmt.Errorf("input path is not valid") )
Custom errors that this library outputs. The library also outputs errors created elsewhere.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Copy bool // Copy original stream, rather than transcode.
Audio bool // include audio?
Width int // 1920
Height int // 1080
CRF int // 24
Time int // 15 (seconds)
Rate int // framerate (5-20)
Size int64 // max file size (always goes over). use 2000000 for 2.5MB
FFMPEG string // "/usr/local/bin/ffmpeg"
Level string // 3.0, 3.1 ..
Prof string // main, high, baseline
}
Config defines how ffmpeg shall transcode a stream. If Copy is true, these options are ignored: profile, level, width, height, crf and frame rate.
type Encoder ¶
type Encoder struct {
// contains filtered or unexported fields
}
Encoder is the struct returned by this library. Contains all the bound methods.
func (*Encoder) GetVideo ¶
GetVideo retreives video from an input and returns an io.ReadCloser to consume the output. Input must be an RTSP URL. Title is encoded into the video as the "movie title." Returns command used, io.ReadCloser and error or nil.
func (*Encoder) SaveVideo ¶
SaveVideo saves a video snippet to a file. Input must be an RTSP URL and output must be a file path. It will be overwritten. Returns command used, command output and error or nil.
func (*Encoder) SetAudio ¶
SetAudio turns audio on or off based on a string value. This can also be passed into Get() as a boolean.
func (*Encoder) SetCRF ¶
SetCRF sets the h264 transcode CRF value from a string. This can also be passed into Get() as an int.
func (*Encoder) SetHeight ¶
SetHeight sets the transcode frame width from a string. This can also be passed into Get() as an int.
func (*Encoder) SetLevel ¶
SetLevel sets the h264 transcode level. This can also be passed into Get().
func (*Encoder) SetProfile ¶
SetProfile sets the h264 transcode profile. This can also be passed into Get().
func (*Encoder) SetRate ¶
SetRate sets the transcode framerate from a string. This can also be passed into Get() as an int.
func (*Encoder) SetSize ¶
SetSize sets the maximum transcode file size as a string. This can also be passed into Get() as an int64.
Source Files