Vidio
Vidio copied to clipboard
FFmpeg wrapper providing simple, cross-platform Video I/O, GIF Creation, and Webcam Streaming in Go.
Vidio
A simple Video I/O library written in Go. This library relies on FFmpeg, and FFProbe which must be downloaded before usage and added to the system path.
All frames are encoded and decoded in 8-bit RGB format.
For Audio I/O using FFmpeg, see the aio
project.
Installation
go get github.com/AlexEidt/Vidio
Video
The Video
struct stores data about a video file you give it. The code below shows an example of sequentially reading the frames of the given video.
Calling the Read()
function will fill in the Video
struct framebuffer
with the next frame data as 8-bit RGB data, stored in a flattened byte array in row-major order where each pixel is represented by three consecutive bytes representing the R, G and B component of that pixel.
vidio.NewVideo(filename string) (*vidio.Video, error)
FileName() string
Width() int
Height() int
Depth() int
Bitrate() int
Frames() int
Duration() float64
FPS() float64
Codec() string
AudioCodec() string
FrameBuffer() []byte
SetFrameBuffer(buffer []byte) error
Read() bool
Close()
If all frames have been read, video
will be closed automatically. If not all frames are read, call video.Close()
to close the video.
Camera
The Camera
can read from any cameras on the device running Vidio. It takes in the stream index. On most machines the webcam device has index 0.
vidio.NewCamera(stream int) (*vidio.Camera, error)
Name() string
Width() int
Height() int
Depth() int
FPS() float64
Codec() string
FrameBuffer() []byte
SetFrameBuffer(buffer []byte) error
Read() bool
Close()
VideoWriter
The VideoWriter
is used to write frames to a video file. The only required parameters are the output file name, the width and height of the frames being written, and an Options
struct. This contains all the desired properties of the new video you want to create.
vidio.NewVideoWriter(filename string, width, height int, options *vidio.Options) (*vidio.VideoWriter, error)
FileName() string
Width() int
Height() int
Bitrate() int
Loop() int
Delay() int
Macro() int
FPS() float64
Quality() float64
Codec() string
Format() string
AudioCodec() string
Write(frame []byte) error
Close()
type Options struct {
Bitrate int // Bitrate.
Loop int // For GIFs only. -1=no loop, 0=infinite loop, >0=number of loops.
Delay int // Delay for final frame of GIFs.
Macro int // Macroblock size for determining how to resize frames for codecs.
FPS float64 // Frames per second for output video.
Quality float64 // If bitrate not given, use quality instead. Must be between 0 and 1. 0:best, 1:worst.
Codec string // Codec for video.
Format string // Pixel Format for video. Default "rgb24".
Audio string // File path for audio. If no audio, audio="".
AudioCodec string // Codec for audio.
}
Images
Vidio provides some convenience functions for reading and writing to images using an array of bytes. Currently, only png
and jpeg
formats are supported. When reading images, an optional buffer
can be passed in to avoid array reallocation.
Read(filename string, buffer ...[]byte) (int, int, []byte, error)
Write(filename string, width, height int, buffer []byte) error
Examples
Copy input.mp4
to output.mp4
. Copy the audio from input.mp4
to output.mp4
as well.
video, _ := vidio.NewVideo("input.mp4")
options := vidio.Options{
FPS: video.FPS(),
Bitrate: video.Bitrate(),
}
if video.AudioCodec() != "" {
options.Audio = "input.mp4"
}
writer, _ := vidio.NewVideoWriter("output.mp4", video.Width(), video.Height(), &options)
defer writer.Close()
for video.Read() {
writer.Write(video.FrameBuffer())
}
Read 1000 frames of a webcam stream and store in output.mp4
.
webcam, _ := vidio.NewCamera(0)
defer webcam.Close()
options := vidio.Options{FPS: webcam.FPS()}
writer, _ := vidio.NewVideoWriter("output.mp4", webcam.Width(), webcam.Height(), &options)
defer writer.Close()
count := 0
for webcam.Read() && count < 1000 {
writer.Write(webcam.FrameBuffer())
count++
}
Create a gif from a series of png
files enumerated from 1 to 10 that loops continuously with a final frame delay of 1000 centiseconds.
w, h, img, _ := vidio.Read("1.png") // Get frame dimensions from first image
options := vidio.Options{FPS: 1, Loop: 0, Delay: 1000}
gif, _ := vidio.NewVideoWriter("output.gif", w, h, &options)
defer gif.Close()
for i := 1; i <= 10; i++ {
w, h, img, _ := vidio.Read(strconv.Itoa(i)+".png")
gif.Write(img)
}
Acknowledgements
- Special thanks to Zulko and his blog post about using FFmpeg to process video.
- The ImageIO-FFMPEG project on GitHub.