trunk/man/sf2extract.1.in

.TH "sf2extract" "1" "1 Jul 2015" "libgig @VERSION@" "libgig tools"
.SH NAME
sf2extract \- Extract samples from SoundFont version 2 (.sf2) files.
.SH SYNOPSIS
.B sf2extract
[ \-v ] SF2FILE DESTDIR [SAMPLENR] [ [SAMPLENR] ... ]
.SH DESCRIPTION
Extract samples from SoundFont version 2 (.sf2) files. All extracted samples
will be written in .wav format. You must at least supply name of the .sf2 input
file and an output path where all extracted samples should be written to.
By default
.B sf2extract
extracts all samples contained in the SoundFont file, even if they are not
linked by any instrument in the .sf2 file, but you can also extract only
particular samples by supplying a list of samples indices at the end of the
command line. You can use the
.BR sf2dump (1)
tool to see the list of available samples and their sample indices of a
SoundFont file.

.B Stereo Samples:
Note that stereo samples are always stored as pair of separate two mono samples
with Sound Font files. Keep that in mind when selecting individual samples by
index.
.BR sf2dump (1)
shows you which (mono) sample is linked to which other (mono) sample to form a
stereo sample pair.
.B sf2extract
automatically detects if one of the samples is part of a stereo pair and
automatically extracts the two as combined interleaved stereo sample data to the
output .wav file. Hence it is sufficient to pass the index of one of the
two (mono) samples of each stereo pair you want to extract.

.SH OPTIONS
.TP
.B \ SF2FILE
filename of the input SoundFont file
.TP
.B \ DESTDIR
output path where all samples should be extracted to
.TP
.B \ SAMPLENR
optional index of sample(s) to be exclusively extracted
.TP
.B \ -v
print version and exit

.SH "SEE ALSO"
.BR sf2dump(1),
.BR gigextract(1),
.BR gigdump(1)

.SH "BUGS"
Check and report bugs at http://bugs.linuxsampler.org
.SH "Author"
Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>
1	schoenebeck	2780	.TH "sf2extract" "1" "1 Jul 2015" "libgig @VERSION@" "libgig tools"
2			.SH NAME
3			sf2extract \- Extract samples from SoundFont version 2 (.sf2) files.
4			.SH SYNOPSIS
5			.B sf2extract
6	schoenebeck	3047	[ \-v ] SF2FILE DESTDIR [SAMPLENR] [ [SAMPLENR] ... ]
7	schoenebeck	2780	.SH DESCRIPTION
8			Extract samples from SoundFont version 2 (.sf2) files. All extracted samples
9			will be written in .wav format. You must at least supply name of the .sf2 input
10			file and an output path where all extracted samples should be written to.
11			By default
12			.B sf2extract
13			extracts all samples contained in the SoundFont file, even if they are not
14			linked by any instrument in the .sf2 file, but you can also extract only
15			particular samples by supplying a list of samples indices at the end of the
16			command line. You can use the
17			.BR sf2dump (1)
18			tool to see the list of available samples and their sample indices of a
19			SoundFont file.
20
21			.B Stereo Samples:
22			Note that stereo samples are always stored as pair of separate two mono samples
23			with Sound Font files. Keep that in mind when selecting individual samples by
24			index.
25			.BR sf2dump (1)
26			shows you which (mono) sample is linked to which other (mono) sample to form a
27			stereo sample pair.
28			.B sf2extract
29			automatically detects if one of the samples is part of a stereo pair and
30			automatically extracts the two as combined interleaved stereo sample data to the
31			output .wav file. Hence it is sufficient to pass the index of one of the
32			two (mono) samples of each stereo pair you want to extract.
33
34			.SH OPTIONS
35			.TP
36			.B \ SF2FILE
37			filename of the input SoundFont file
38			.TP
39			.B \ DESTDIR
40			output path where all samples should be extracted to
41			.TP
42			.B \ SAMPLENR
43			optional index of sample(s) to be exclusively extracted
44			.TP
45			.B \ -v
46			print version and exit
47
48			.SH "SEE ALSO"
49			.BR sf2dump(1),
50			.BR gigextract(1),
51			.BR gigdump(1)
52
53			.SH "BUGS"
54			Check and report bugs at http://bugs.linuxsampler.org
55			.SH "Author"
56			Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>