doc: libgme
authorGyan Doshi <ffmpeg@gyani.pro>
Tue, 4 Dec 2018 12:35:53 +0000 (18:05 +0530)
committerGyan Doshi <ffmpeg@gyani.pro>
Tue, 4 Dec 2018 12:36:43 +0000 (18:06 +0530)
Add entry in external library list and add details to demuxer entry.

doc/demuxers.texi
doc/general.texi

index aad94eb..e0f6ec3 100644 (file)
@@ -481,14 +481,26 @@ ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
 
 The Game Music Emu library is a collection of video game music file emulators.
 
-See @url{http://code.google.com/p/game-music-emu/} for more information.
+See @url{https://bitbucket.org/mpyne/game-music-emu/overview} for more information.
 
-Some files have multiple tracks. The demuxer will pick the first track by
-default. The @option{track_index} option can be used to select a different
-track. Track indexes start at 0. The demuxer exports the number of tracks as
-@var{tracks} meta data entry.
+It accepts the following options:
+
+@table @option
+
+@item track_index
+Set the index of which track to demux. The demuxer can only export one track.
+Track indexes start at 0. Default is to pick the first track. Number of tracks
+is exported as @var{tracks} metadata entry.
 
-For very large files, the @option{max_size} option may have to be adjusted.
+@item sample_rate
+Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100.
+
+@item max_size @emph{(bytes)}
+The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
+which in turn, acts as a ceiling for the size of files that can be read.
+Default is 50 MiB.
+
+@end table
 
 @section libopenmpt
 
index 7b6efdb..cfab63f 100644 (file)
@@ -59,6 +59,12 @@ FFmpeg can make use of the Chromaprint library for generating audio fingerprints
 It is licensed under LGPL version 2.1. Pass @code{--enable-chromaprint} to configure to
 enable it. See @url{https://acoustid.org/chromaprint}.
 
+@section Game Music Emu
+
+FFmpeg can make use of the Game Music Emu library to read audio from supported video game
+music file formats. It is licensed under LGPL version 2.1. Pass @code{--enable-libgme} to configure to
+enable it. See @url{https://bitbucket.org/mpyne/game-music-emu/overview}.
+
 @section OpenJPEG
 
 FFmpeg can use the OpenJPEG libraries for encoding/decoding J2K videos.  Go to