astra/Vidio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Alex Eidt 2021-11-22 19:17:31 -08:00
parent 059f46f9ed
commit 3b9be17551
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,6 @@
# ImageIO # Video-IO
A simple Image and Video I/O library written in Go. This library relies on [FFMPEG](https://www.ffmpeg.org/), which must be downloaded before usage. A simple Video I/O library written in Go. This library relies on [FFMPEG](https://www.ffmpeg.org/), which must be downloaded before usage.
One of the key features of this library is it's simplicity: The FFMPEG commands used to read and write video are readily available in `video.go` and `videowriter.go` for you to modify as you need. One of the key features of this library is it's simplicity: The FFMPEG commands used to read and write video are readily available in `video.go` and `videowriter.go` for you to modify as you need.
@ -8,7 +8,7 @@ For portability, all the library code can be found in the `videoio.go` file.
## Documentation ## Documentation
ImageIO features `Video` and `VideoWriter` structs which can read and write videos. Video-IO features `Video` and `VideoWriter` structs which can read and write videos.
## `Video` ## `Video`
@ -40,8 +40,8 @@ The `VideoWriter` is used to write frames to a video file. You first need to cre
```go ```go
video := Video{ video := Video{
// width and height are required, defaults available for all other parameters. // width and height are required, defaults available for all other parameters.
width: 1920 width: 1920,
height: 1080 height: 1080,
... // Initialize other desired properties of the video you want to create. ... // Initialize other desired properties of the video you want to create.
} }
writer := NewVideoWriter("output.mp4", video) writer := NewVideoWriter("output.mp4", video)
@ -57,12 +57,12 @@ Alternatively, you could manually create a `VideoWriter` struct and fill it in y
```go ```go
writer := VideoWriter{ writer := VideoWriter{
filename: "output.mp4" filename: "output.mp4",
width: 1920 width: 1920,
height: 1080 height: 1080
... ...
} }
defer writer.Close() // Make sure to close writer. defer writer.Close()
w, h, c := 1920, 1080, 3 w, h, c := 1920, 1080, 3
frame = make([]byte, w*h*c) // Create Frame as RGB Image and modify. frame = make([]byte, w*h*c) // Create Frame as RGB Image and modify.