Fix wrong use of "an" in some comments.
[ffmpeg.git] / doc / libswresample.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle Libswresample Documentation
4 @titlepage
5 @center @titlefont{Libswresample Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Description
13 @c man begin DESCRIPTION
14
15 The libswresample library performs highly optimized audio resampling,
16 rematrixing and sample format conversion operations.
17
18 Specifically, this library performs the following conversions:
19
20 @itemize
21 @item
22 @emph{Resampling}: is the process of changing the audio rate, for
23 example from a high sample rate of 44100Hz to 8000Hz. Audio
24 conversion from high to low sample rate is a lossy process. Several
25 resampling options and algorithms are available.
26
27 @item
28 @emph{Format conversion}: is the process of converting the type of
29 samples, for example from 16-bit signed samples to unsigned 8-bit or
30 float samples. It also handles packing conversion, when passing from
31 packed layout (all samples belonging to distinct channels interleaved
32 in the same buffer), to planar layout (all samples belonging to the
33 same channel stored in a dedicated buffer or "plane").
34
35 @item
36 @emph{Rematrixing}: is the process of changing the channel layout, for
37 example from stereo to mono. When the input channels cannot be mapped
38 to the output streams, the process is lossy, since it involves
39 different gain factors and mixing.
40 @end itemize
41
42 Various other audio conversions (e.g. stretching and padding) are
43 enabled through dedicated options.
44
45 @c man end DESCRIPTION
46
47 @chapter See Also
48
49 @ifhtml
50 @url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
51 @url{ffmpeg-resampler.html,ffmpeg-resampler},
52 @url{libavutil.html,libavutil}
53 @end ifhtml
54
55 @ifnothtml
56 ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
57 ffmpeg-resampler(1),
58 libavutil(3)
59 @end ifnothtml
60
61 @include authors.texi
62
63 @ignore
64
65 @setfilename libswresample
66 @settitle audio resampling library
67
68 @end ignore
69
70 @bye