Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

FFMPEG plugin: Add links to useful FFMPEG-API documentation.

Browse Source 
- As it is rather hard to find useful documentation, on how to use FFMPEG's API
  we cut of some research time by just documenting it at the place where it is
  most visible to other FFMPEG plugin developers :)

Signed-off-by: Colin Günther <coling@gmx.de>
(cherry picked from commit b0ed15d2196ca45de8ab2d5913d760602aacc5f3)
This commit is contained in:
Colin Günther 2014-07-12 14:26:14 +02:00
parent 9e52cc7480
commit 29da3b5548
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/add-ons/media/plugins/ffmpeg/README.md Normal file
View File

@ -0,0 +1,17 @@
This file collects knowledge about the FFMPEG-library used by the FFMPEG plugin.
As it turns out documentation on how to use the FFMPEG-libraries (libavcodec, libavformat, ...) to decode audio and video data is rather thinly spread.
There are three main resources that can be recommended for understanding how to use the FFMPEG-libraries:
1. Example source code provided by the FFMPEG project.
- It is part of the FFMPEG source code and is located in /path/to/ffmpeg/source/doc/examples
- Studying the example "decoding_encoding.c" is especially interesting, as it provides examples on how to decode and encode audio / video files with FFMPEG.
2. An ffmpeg and SDL Tutorial: http://dranger.com/ffmpeg/tutorial01.html
- This tutorial contains several parts, whereby parts 5 to 8 are the most relevant parts, as they provide a lot of advanced knowledge about the usage and inner workings of FFMPEGs APIs.
3. The source code of the Chromium project: http://src.chromium.org/viewvc/chrome/trunk/src/
- Chromium is the basis for Google's Chrome web browser and uses FFMPEG libraries to implement HTML-5 audio and video playback. Chromium's source code is well documented and in wide use. This gives a good real life reference on how to use the FFMPEG-API's and some of its gotchas.
- For video decoding a good starting point is the file media/filters/ffmpeg_video_decoder.cc and within it the method FFmpegVideoDecoder::FFmpegDecode().
- For audio decoding a good starting point is the file media/filters/ffmpeg_audio_decoder.cc and within it the method FFmpegAudioDecoder::FFmpegDecode().