go-astiav

astiav is a Golang library providing C bindings for ffmpeg

It's only compatible with ffmpeg n8.0.

Its main goals are to:

• provide a better GO idiomatic API
  • standard error pattern
  • typed constants and flags
  • struct-based functions
  • ...
• provide the GO version of ffmpeg examples
• be fully tested

:warning: breaking changes will be introduced in go-astiav without using the v2 golang pattern. You can see the list of breaking changes here.

Examples

Examples are located in the examples directory and mirror as much as possible the ffmpeg examples.

Tip: you can use the video sample located in the testdata directory for your tests

Patterns

NB: errors are not checked below for readibility purposes, however you should!

First off, all use cases are different and it's impossible to provide patterns that work in every situation. That's why ffmpeg's doc or source code should be your ultimate source of truth regarding how to use this library. That's why all methods of this library have been documented with a link referencing the documentation of the C function they use.

However it's possible to give rules of thumb and patterns that fit most use cases and can kickstart most people. Here's a few of them:

When to call Alloc(), .Unref() and .Free()

Let's take the FormatContext.ReadFrame() pattern as an example. The pattern is similar with frames.

…

Install ffmpeg from source

Check out the ffmpeg section in the Devcontainer Dockerfile to see how to install ffmpeg from source.

For your GO code to pick up ffmpeg dependency automatically, you'll need to update the following environment variables :

(don't forget to replace {{ path to your ffmpeg directory }} with the absolute path to your ffmpeg directory)

export CGO_CFLAGS="-I{{ path to your ffmpeg directory }}/include/",
export CGO_LDFLAGS="-L{{ path to your ffmpeg directory }}/lib/",
export PKG_CONFIG_PATH="{{ path to your ffmpeg directory }}/lib/pkgconfig",

Building on Windows

Building on Windows requires msys2 / mingw64 gcc toolchain. Read the Quickstart guide to install Msys2.

Once complete run the Mingw64 shell from the installation folder, run the below commands:

# Update Packages
pacman -Syu
# Install Requirements to Build
pacman -S --noconfirm --needed git diffutils mingw-w64-x86_64-toolchain pkg-config make nasm
# Clone the repository using git
git clone https://github.com/asticode/go-astiav
cd go-astiav

Then once you clone this repository, follow along the build instructions above.

Notes: For pkg-config use pkgconfiglite from choco. Remember to set CGO and PKG_CONFIG env vars properly to point to the folder where ffmpeg was built.

Why astiav?

After maintaining for several years the most starred fork of goav, I've decided to write from scratch my own C bindings to fix most of the problems I still encountered using goav.