Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 5.25 KB

README.md

File metadata and controls

123 lines (93 loc) · 5.25 KB
Raw

AVx

Elixir CI

Audio/Video Elixir. This is a libav (NIF) backed library for dealing with audio/video files. Takes a functional approach allowing users to decide which runtime they want to design.

We use this library in production to demux/decode audio from the any browser's microphone to raw format for doing realtime transcriptions (whisper, APIs, ecc).

Installation

I'll publish it at some point if there is interest. For now,

def deps do
  [
    {:avx, github: "kim-company/avx"}
  ]
end

Requirements

  • ffmpeg's libraries. pkg-config is used to find them. On macos brew install ffmpeg, debian sid apt-get install -y -t sid pkg-config libfdk-aac-dev libavutil-dev libavcodec-dev libavformat-dev libavutil-dev libswresample-dev (bullseye has an older version of libav* libs that are incompatible, sorry).
  • You need OTP >= 26.0.3 or OTP ~25 (we hit erlang/otp#7292, believe it or not)

Features

  • demux any audio container (mp4, ogg, mkv, ...)
  • decode audio files

The term unpack is used here (probably incorrectly) to denote the action of copying the packet/frame out of the C world into Elixir.

We're not targetting video files anymore for now, as we're do not need a fully-fledged binding to ffmpeg at this time. If we're working with videos or complex setups, we're still either using membrane or ffmpeg as above, but we did not generalize anything to a library as of now.

Before you start

  • It will probably crash your BEAM at some point, as error handling is far from being complete on the C side. It is already pretty stable though.

  • NIFs are supposed to return in <1ms, which does not happen for some functions. I still need to measure the impact and determine the dirty scheduler that should be picked for each function.

Usage

Check the tests, but in practice this is the flow for decoding audio from a multi-track file from file to file in a lazy fashion.

Supports all protocols supported by libav itself (such as RTMP, UDP, HLS, local files, unix sockets, TCP, UDP, ...).

{:ok, demuxer} = Demuxer.new_from_file(input_path)

# Detect available stream and select one (or more)
streams = Demuxer.read_streams(demuxer)
audio_stream = Enum.find(streams, fn stream -> stream.codec_type == :audio end)

# Initialize the decoder. The sample rate, channel and audio format will match
# the one of the input. At this time, the only resampling performed is from
# planar audio to packed (so the data can be processed by Membrane for example, or
# written directly into a file).
decoder = Decoder.new!(audio_stream)
output = File.stream!(output_path, [:raw, :write])

demuxer
|> Demuxer.consume_packets([audio_stream.stream_index])
|> Decoder.decode_raw(decoder)
|> Enum.into(output)

To decode from a live session, use the ThousandIsland handler provided. It will give you a tcp:// endpoint you can use as file source to the demuxer. It carries a little bit of overhead, but keeps the C side super simple.

And that's it. Compared to using the ffmpeg executable directly, here you have access to every single packet, which you can re-route, manipulate and process at will.

This library is suitable as standalone or inside the elements of a membrane pipeline for more complex setups.

Debugging

Cocoa's way

This library works with NIFs. When things go wrong, the BEAM exits! The idea is to run the mix test loop inside a debugger, in my case lldb.

To do so, we need to set some env variables, accomplished with . DEBUG.fish (check cocoa's link below if you shell is bash, or ask some LLM to translate the script 😉). To run the tests under the debugger, lldb -- $ERLEXEC $CMD_ARGS test.

Usually I either let the test crash and then bt to have an overview of the stack, f <frame number> to select the frame I want to inspect, the v <variable name> to check the contents of the variable. Otherwise put a breakpoint with br s -l <line number> -f libav.c.

OTP way

You can achieve the same result as above by:

  • compiling the BEAM with debugging support
  • source the DEBUG.fish file. Substitute ERL_BASE with the base path of your "debug" OTP repo
  • run the debugger with $ERL_BASE/cerl -lldb $CMD_ARGS test

A pro is that if you manage to achieve this, you'll also have the option of starting the BEAM in debug mode, which is the recommeneded VM you are supposed to use when developing NIFs.

Performance

Nothing serious in here for now, but to give an idea:

  • M2 pro
  • input file size 0.7Gb of ISO5 mp4
  • output file size 1.3Gb of raw audio from 1 of the 3 tracks
  • test overall duration 3.4 secs
  • which gives 0.38Gb/s of output throughput

Resources

Copyright and License

Copyright 2023, KIM Keep In Mind GmbH Licensed under the Apache License, Version 2.0