Frei0r :: Free Video Effect Plugins

 

What Frei0r is

Frei0r is a minimalistic plugin API for video effects. The main emphasis is on simplicity for an API that will round up the most common video effects into simple filters, sources and mixersthat can be controlled by parameters. It’s our hope that this way these simple effects can be shared between many applications, avoiding their reimplementation by different projects.

What Frei0r is not

Frei0r is not meant as a competing standard to more ambitious efforts that try to satisfy the needs of many different applications and more complex effects. It is not meant as a generic API for all kinds of video applications, as it doesn’t provides things like an extensive parameter mechanism or event handling. Eventually the frei0r API can be wrapped by higher level APIs expanding its functionalities (for instance as GStreamer, MLT, FFmpeg and others do).

Current Status

Frei0r is mostly adopted on GNU/Linux and OSX platforms, counts more than 100 plugins and is used by several video software applications: FFMpeg, PureData, Open Movie Editor, DVEdit, Gephex, LiVES, FreeJ, VeeJay, MLT, KDEnLive, Shotcut and flowblade. Find our more on the Wikipedia page about Frei0r, where also contributions are welcome to complete our documentation.

Latest release announcement

For a quick glance of what is this project status, you can visit the Frei0r page on Ohloh and on Freecode. A more detailed overview on code activity is provided on code.dyne.org/frei0r.

We are happy if more people like to get involved, so let us know about your creations! Code and patches are well accepted, get in touch with us on the frei0r mailinglist.

History

Frei0r has been around since 2006, born from yearly brainstorms held at the Piksel conference with the participation of various free and open source video software developers. However, these meetings are not held anymore at Piksel and nowadays most of the discussion between developers is held online on the Frei0r mailinglist.

Downloads

Source code

Stable source releases file zone

Frei0r sourcecode is released under the terms of the GNU General Public License and, eventually other compatible Free Software licenses. The latest source for frei0r plugins can be attained using our revisioning system GIT

git clone git://code.dyne.org/frei0r.git

As well simply downloading a daily snapshot in tarball format from files.dyne.org/frei0r/snapshots

To build frei0r you have two options: one using GNU Autotools ( ./configure && make ) and one using CMake ( cmake . && make ) which works best when using on cygwin32.

Auxiliary libraries

Optionally, frei0r can be built linking the following libraries:

  • Gavl - required for the scale0tilt and vectorscope filters
  • OpenCV - required for face detection filters
  • Cairo - required for some fine color blending mixers

GNU/Linux/BSD

Overview of packages in distributions

summary courtesy of OSWatershed

Apple / OSX

MacPorts provides ready to install packages for OSX: in case you have this packaging system installed you just need to open a terminal and give the following command:

sudo port install frei0r-plugins

Miscro$oft / Windoz

Zeranoe kindly provides some solid builds of FFMpeg which also include a recent version of the Frei0r plugin collection.

Documentation

If you are new to frei0r (but not to programming) the best thing is probably to have a look at the frei0r header, which is quite simple and well documented. While the main source of documentation for the Frei0r API is the header, the sourcecode is well commented so you can study its full doxyfied documentationonline.

C++ filter example

A simple skeleton for a frei0r video filter looks like this:

#include 
 
typedef struct {
  int16_t w, h;
  uint8_t bpp;
  uint32_t size;
} ScreenGeometry;
 
class MyExample: public frei0r::filter {
public:
  MyExample(int wdt, int hgt);
  ~MyExample();
  virtual void update();
private:
  ScreenGeometry geo;
  void _init(int wdt, int hgt);
}
 
MyExample::MyExample() { /* constructor */ }
MyExample::~MyExample() { /* destructor */ }
 
void MyExample::_init(int wdt, int hgt) {
  geo.w = wdt;
  geo.h = hgt;
  geo.bpp = 32; // this filter works only in RGBA 32bit
  geo.size = geo.w*geo.h*(geo.bpp/8); // calculate the size in bytes
}
 
void MyExample::update() {
  // we get video input via buffer pointer (void*)in 
  uint32_t *src = (uint32_t*)in;
  // and we give video output via buffer pointer (void*)out
  uint32_t *dst = (uint32_t*)out;
  // this example here does just a copy of input to output
  memcpy(dst, src, geo.size);
}
 
frei0r::construct
        plugin("MyExample", "short and simple description for my example",
	       "Who did it", 1, 0);

Communication

You can get in touch with our developer community, send your new effects and share your intentions with us. We have a free mailinglist open to subscriptions. This mailinglist is new, since the old mailinglist maintainer went bonkers. However, we are currently migrating the infrastructure and the archive link will be updated soon. If you have a contribution and like using GitHub, you can also file a pull request on the Frei0r repository by ddennedy, still good to notice us on the mailinglist about it.

Acknowledgments

Frei0r is the result of a collective effort in coordination with several software developers meeting at Piksel between 2003 and 2005 to find a common standard for video effect plugins to be used among their applications: Andraz Tori (Cinelerra/CVS), Daniel Fischer (Pakt/GStreamet), Denis Jaromil Rojo (FreeJ/Dyne), Gabriel "Salsaman" Finch (LiVES), Kentaro Fukuchi (EffecTV), Niels Elburg (VeeJay), Øyvind Kolås (Gegl/Babl/Gimp), Tom Schouten (PDP/PureData), Georg Seidel, Martin Bayer and Phillip Promesberger (Gephex). We first aimed at the realisation of a comprehensive specification for dynamically loaded plugins named LiViDO, which then spawned two implementations: one being Frei0r, a minimalistic implementation contributed by the Gephex team and the other one being the WEED implementation by LiVES developer Salsaman, sporting more features for GUI integration and scriptability. Within the span of a few years, the minimalistic approach of frei0r has been widely adopted among more applications and became a de-facto standard. Maintenance and further refinements were contributed by Carlo Prelz (MøB/BEK), Richard Spindler (Open Movie Editor) and Dan Dennedy (MLT/KDEnLive), while Debian/Ubuntu packaging and build system standardization were taken care of by dyne.org developers Filippo Giunchedi and Luca Bigliardi. For a complete list of contributors, please refer to the AUTHORS file.

Dyne.org on GitHub