framefusion

0.0.3 • Public • Published

Framefusion

Dump mp4 frames at specific times in node.

Framefusion is an experimental mp4 frame extraction library based on beamcoder.

Pre-installation setup

Mac (M1)

brew uninstall ffmpeg
brew install ffmpeg@5
export CXXFLAGS="-I/opt/homebrew/Cellar/ffmpeg/5.1.2_6/include/"
ln -s /opt/homebrew/Cellar/ffmpeg/5.1.2_6/ /opt/homebrew/Cellar/ffmpeg/5.0

Mac (Intel)

TODO

Linux

TODO

Installing in a project

yarn add git+ssh://git@github.com:Lumen5/framefusion.git

Example usage

import { BeamcoderExtractor } from 'framefusion';

const inputFile = './video.mp4';

async function run() {
    const extractor = await BeamcoderExtractor.create({
        inputFile,
        //outputFile: 'image-%04d.png', // Uncomment to ouput files to disk
        outputPixelFormat: 'rgba',
    });

    // Get frame at a specific time (in seconds)
    const frame = await extractor.getFrameAtTime(2.0);

    // Do something with frame data
    console.log(frame.data);
}

run();

For a complete working project (with package.json, vite config, typescript config), see here: https://github.com/Lumen5/framefusion/tree/main/examples/mini-framefusion-example

Running test

npm install && npm run test-ui

Philosophy

We want to limit framefusion to 2 simple roles:

  1. Extracting frames from videos
  2. Combining frames into a video

We want to design the API to be as minimal as possible to achieve these two goals.

We also want to build the library in a way that we can provide different backends to acheive these goals, but still keep a similar interface.

Where we are with the philosophy currently

Only point 1 is implemented so far (Extracting frames from videos).

We also only provide a beamcoder backend and we still have to figure out how we can swap backends and skip compiling beamcoder. This could be through different npm packages.

Readme

Keywords

none

Package Sidebar

Install

npm i framefusion

Weekly Downloads

1

Version

0.0.3

License

SEE LICENSE IN LICENSE

Unpacked Size

247 kB

Total Files

39

Last publish

Collaborators

  • antoinemopa