Small FFmpeg Tasks
This page contains ideas for small, relatively simple tasks for the FFmpeg project. People who might be interested in trying one of these tasks:
- Someone who wants to contribute to FFmpeg and needs to find a well-defined task to start with
- Someone who wishes to qualify for one of FFmpeg's coveted Summer of Code project slots
- An existing FFmpeg developer who has been away from the project for a while and needs a smaller task as motivation for re-learning the codebase
For other tasks of varying difficulty, see the Interesting Patches page.
If you would like to work on one of these tasks, please take these steps:
- Subscribe to the FFmpeg development mailing list and indicate your interest
- Ask Multimedia Mike for a Wiki account so you can claim your task on this Wiki
If you would like to add to this list, please be prepared to explain some useful details about the task. Excessively vague tasks with no supporting details will be ruthlessly deleted.
The FFmpeg project always needs people to do the following tasks:
- Review bugs on the FFmpeg bug tracker
- verifying bugreports are complete with 'ffmpeg -i' output
- making sure samples are mirrored/available
- verifying bugs against current git master
- Review patches posted to ffmpeg-devel mailing list
- also test to make sure they compile against git master and dont break 'make fate' / compilation
- Review documentation and update examples in documentation.
- updating and adding more information to the howto and api documents
- make a guide how to embed ffmpeg into various programming languages, be it c++, java, mono, c#, etc
- 1 Programming Tasks
- 1.1 Finish up a previous incomplete SoC project
- 1.2 Add code to validate get_buffer usage of decoders
- 1.3 Port missing demuxers from MPlayer
- 1.4 M95 Playback System
- 1.5 BRP Playback System
- 1.6 16-bit VQA Video Decoder
- 1.7 Apple RPZA encoder
- 1.8 QuickTime Edit List Support
- 1.9 merge all fixed point decoders back into libavcodec
- 1.10 flip flag for upside-down codecs
- 1.11 support for YCoCg/RGB colorspace in FFV1
- 1.12 IFF ANIM decoder
- 1.13 port missing decoders/demuxers from other open source projects.
- 1.14 vloopback output support
- 1.15 Port video filters from MPlayer/VLC/Mjpegtools/Effectv/etc etc to libavfilter
- 1.16 rar/zip/gz/bz2 etc demuxer
- 1.17 Less common AAC decoder features
- 1.18 arithmetic decoding (and encoding) for mjpeg
- 1.19 adobe http f4f segmented fragmentation dynamic streaming format
- 1.20 get 3IV1 decoder working and benchmark
- 2 Reverse Engineering Tasks
- 3 Non-Programming Tasks
- 3.1 Check Linux distributions for patches to ffmpeg
- 3.2 improve layout and accessability of ffmpeg website
- 3.3 restore and update compatability page on ffmpeg website
- 3.4 contact large ffmpeg users for broken / unplayable samples
- 3.5 review sample request error messages
- 3.6 write bluray and 3d howtos
- 3.7 write ipad/iphone/ios howto
- 3.8 talk to downstream
Finish up a previous incomplete SoC project
Several SoC projects from previous years have not yet made it into FFmpeg. Taking any of them and finishing them up to the point that they can be included should make for a good qualification task. Check out the FFmpeg Summer Of Code overview page and look for the unfinished projects, like the TS muxer.
Add code to validate get_buffer usage of decoders
Change the default_get_buffer etc. functions to enforce the minimum guarantees the decoder requests. E.g. if a decoder does not set FF_BUFFER_HINTS_READABLE, return a buffer without read permissions (using e.g. mprotect). If the decoder does not use reget_buffer, always return a buffer initialized with random data. If the decoder does not set FF_BUFFER_HINTS_PRESERVE, always destroy the buffer contents as soon as possible. Make reget_buffer always fail if FF_BUFFER_HINTS_REUSABLE was not used. Probably more things that could be done.
Port missing demuxers from MPlayer
MPlayer supports a few container formats in libmpdemux that are not yet present in libavformat. Porting them over and gettting them relicensed as LGPL or reimplementing them from scratch should make reasonable small tasks.
- TiVo --
- SL support for MPEG-TS (anyone got samples?)
- MNG -- Paul B Mahol is working on this
M95 Playback System
This task is to implement a playback subsystem for M95 files. This will entail writing a new file demuxer and video decoder (the audio is already uncompressed), both of which should be fairly easy by FFmpeg standards. The M95 page contains the specs necessary to complete this task and points to downloadable samples.
BRP Playback System
This task is to implement a playback subsystem for BRP files. This will entail writing a new file demuxer as well as a video decoder that can handle at least 2 variations of format data. Further, write an audio decoder for the custom DPCM format in the file. All of these tasks are considered fairly easy by FFmpeg standards. The BRP page contains the specs necessary to complete this task and points to downloadable samples for both known variations.
16-bit VQA Video Decoder
Westwood VQA files are already supported. However, there are three variations of its custom video codec, only the first two of which are supported. This task involves implementing support for the third variation. Visit the VQA samples repository: http://samples.multimedia.cx/game-formats/vqa/ -- The files in the directories Tiberian Sun VQAs/, bladerunner/, and dune2000/ use the 3rd variation of this codec. The VQA page should link to all the details you need to support this format.
Apple RPZA encoder
A patch was once sent to the ffmpeg-devel mailing list to include an encoder for the Apple RPZA video codec. That code can be found on the "Interesting Patches" page. This qualification task involves applying that patch so that it can compile with current HEAD and then cleaning it up per the standards of the project. Engage the mailing list to learn more about what to do.
QuickTime Edit List Support
Implement edit list support in the QuickTime demuxer (libavformat/mov.c). This involves parsing the 'elst' atom in a QuickTime file. For a demonstration of how this is a problem, download the file menace00.mov from http://samples.mplayerhq.hu/mov/editlist/ and play it with ffplay or transcode it with ffmpeg. Notice that the audio and video are ever so slightly out of sync. Proper edit list support will solve that. Other samples in that directory also presumably exhibit edit list-related bugs. The Xine demuxer has support for this, it might be useful for hints.
(patch was submitted to ffmpeg-devel , around 14 March 2009)
merge all fixed point decoders back into libavcodec
http://git.rockbox.org/?p=rockbox.git;a=tree;f=lib/rbcodec/codecs Rockbox's fixed-point decoders are based on decoders from libavcodec.
flip flag for upside-down codecs
about the flip, a patch that decodes images fliped when codec_tag == ff_get_fourcc("GEOX") is welcome. its a metter of 2lines manipulating data/linesize of imgages after get_buffer() or something similar [...] -- Michael GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB
more info: http://ffmpeg.org/trac/ffmpeg/ticket/317
support for YCoCg/RGB colorspace in FFV1
This would add a free lossless intra-frame RGB codec for all supported platforms (most important OS X + Windows) which is often asked for video editing in video forums (e.g. slashcam.de)
IFF ANIM decoder
Modify libavformat/iff.c to handle this chunk and write a decoder for the format. The wiki page at IFF ANIM has links to more information and source code. Samples can be found at http://www-user.tu-chemnitz.de/~womar/projects/iffanim/iffanim_samplepack.zip .
port missing decoders/demuxers from other open source projects.
GNU Octave 2.0 MAT4 GNU Octave 2.1 MAT5 Designer II SD2
samples are here: http://www.mega-nerd.com/tmp/SoundFileCollection-20050711-0902.tgz
HVDI_VOICE_DATA- packet GSM LPC CELP LPC10
many image formats not supported yet.
MPEG-4 BIFS 3GPP DIMS LASeR SAF SVG SMIL VRML X3D XMT
many OPL2/OPL3 audio formats not supported yet.
many music pattern formats not supported yet.
AY GBS GYM HES KSS NSF, NSFE SAP SNES-SPC700 Sound Format VGM, VGZ
vloopback output support
vloopback is a linux kernel device which allows to create a virtual video device where programs can write, and can be accessed as a normal video device: http://www.lavrsen.dk/twiki/bin/view/Motion/VideoFourLinuxLoopbackDevice
This would allow to write the ffmpeg output to a vloopdevice and be displayed by some a program reading from such device (e.g. skype, a voip client etc.).
An example of a program which uses vloopback: http://www.ws4gl.org/
Port video filters from MPlayer/VLC/Mjpegtools/Effectv/etc etc to libavfilter
There are plenty programs providing their own filters, many of them may be easily ported to the superior ;-) framework of libavfilter. Also may be possible to create wrappers around other libraries (e.g. opencv, libgimp, libshowphoto, libaa).
rar/zip/gz/bz2 etc demuxer
there are still compressed files out there (zipped raw wav, multi-rar'ed videos etc). create a decompression demuxer for them.
Less common AAC decoder features
Add support to the AAC decoder for object type ER AAC LC or AAC LC 960.
arithmetic decoding (and encoding) for mjpeg
Following marker codes are not supported by our mjpeg decoder: DAC, SOF9, SOF10, SOF11, SOF13, SOF14 and SOF15.
- any samples?
adobe http f4f segmented fragmentation dynamic streaming format
sample streams on http://www.fox.com . command line instructions for creating such files: http://help.adobe.com/en_US/HTTPStreaming/1.0/Using/WS9463dbe8dbe45c4c-c126f3b1260533756d-7ffc.html . spec is available under adobe NDA. not to be confused with freely available F4V specification. open source php to convert f4f to flv: https://github.com/svnpenn/dotfiles/blob/master/etc/AdobeHDS.php
get 3IV1 decoder working and benchmark
we have a decoder for 3IV1. its currently if 0'd in the mpeg4 decoder. your task is to test if it still builds and works, and fix it so that it does not slow down mpeg4 decoder if enabled. the end goal is to enable it by default.
Reverse Engineering Tasks
Demuxer for csf format and video codec
This is partially analyzed in http://ffmpeg.org/trac/ffmpeg/ticket/1060
pick a random binary codec from mplayer
MPlayer has over 100 binary codecs which have no opensource decoder. pick one, find a sample and try to reverse engineer it. note that some work has been done on some codecs, and its a good idea to ask on the mailing list before starting.
emblaze demuxer/decoder from java code
samples and java decoder: http://samples.mplayerhq.hu/internets/emblaze/
audio sample suite
check and add support for these old audio formats: http://www-mmsp.ece.mcgill.ca/documents/AudioFormats/index.html
Check Linux distributions for patches to ffmpeg
check various distros like Fedora, Ubuntu, Debian, Mint, Arch, Suse etc for patches to ffmpeg. write down location of patches so it can be checked on an annual basis. if patches are found , report to ffmpeg-devel mailing list or bug trac.
improve layout and accessability of ffmpeg website
test ffmpeg.org with various browsers, including screen readers and get it optimized and available to people with poor vision. check wording and general ease of use. for example putting large download links for users like vlc and firefox have.
restore and update compatability page on ffmpeg website
we used to have a page that detailed how to create files for other software players and operating systems. restore this page from git history and update it for new devices and standardized codecs (h264 is the preferred codec now).
contact large ffmpeg users for broken / unplayable samples
contact the largest users of ffmpeg, like youtube, facebook, archive.org, blip.tv and others and ask them for access to samples that do not decode correctly.
review sample request error messages
ffmpeg has an av_log_ask_for_sample generic log message to ask the user for a sample when there is a problem. your task is to review ffmpeg decoders and demuxers (and possibly other inputs) and replace regular av_log messages requesting samples with it. example commit here: http://ffmpeg.org/pipermail/ffmpeg-cvslog/2011-April/036509.html
write bluray and 3d howtos
write a document or wiki article or just link to some info on how to play + encode + rip bluray using ffmpeg/mplayer and the various bluray libs required. also a guide on how to use ffmpeg/mplayer/vlc to encode and play various 3D formats. including maybe some supported hardware screens/video cards w/ examples. includes updating this wiki page Blu Ray and HD-DVD Playback Status How to make a 3d movie with ffmpeg
write ipad/iphone/ios howto
write up some documentation on how to compile ffmpeg/ffplay/ffserver for iOS. exact tool versions, command lines, library requirements. both native compilation on the device and cross-compile using OS X. an android howto for various devices would be useful too.
talk to downstream
talk to the big projects that use ffmpeg. see if there is anything ffmpeg can do to make things easier, be it api stabilization, backwards compatability, or turning private functions into public headers.
examples include videolan, perian, mplayer, xbmc, ffdshow-tryouts, gstreamer.
migrate bugs from other projects
many projects that use ffmpeg or libavcodec have bugs that are meant for ffmpeg. some of these projects dont have time to send them to us, so they rot on bugzillas.
review any local patches
some projects may patch ffmpeg. collect these patches and compare them with other projects. see if there is anything we can do to reduce external patches.