1SNDFILE-WAVEFORM(1)              User Commands             SNDFILE-WAVEFORM(1)
2
3
4

NAME

6       sndfile-waveform - manual page for sndfile-waveform 1.5
7

SYNOPSIS

9       sndfile-waveform [OPTION]  <sound-file> <png-file>
10

DESCRIPTION

12       sndfile-waveform - waveform image generator
13
14       Creates  a  PNG  image  depicting  the  wave-form  of  an  audio  file.
15       Peak-signal and RMS values can be displayed in the same plot, where the
16       horizontal axis always represents time.
17
18       The  vertical  axis  can be plotted logarithmically, and the signal can
19       optionally be rectified.
20
21       The Time-axis annotation unit is either seconds, audio-frames or  time‐
22       code using broadcast-wave time reference meta-data.
23
24       The tool can plot individual channels, reduce the file to mono, or plot
25       all channels in vertically arrangement.
26
27       Colours (ARGB) and image- or waveform geometry can be freely specified.
28

OPTIONS

30       -A, --textcolour <COL>
31              specify text and border colour; default 0xffffffff  all  colours
32              as hexadecimal AA RR GG BB values
33
34       -b, --border
35              display a border with annotations
36
37       -B, --background <COL>
38              specify background colour; default 0x8099999f
39
40       -c, --channel
41              choose  channel  (s)  to plot, 0: merge to mono; < 0: render all
42              channels vertically separated; > 0: render only specified  chan‐
43              nel. (default: 0)
44
45       -C, --centerline <COL>
46              set colour of zero/center line (default 0x4cffffff)
47
48       -F, --foreground <COL>
49              specify foreground colour; default 0xff333333
50
51       -g <w>x<h>, --geometry <w>x<h>
52              specify the size of the image to create default: 800x192
53
54       -G, --borderbg <COL>
55              specify border/annotation background colour; default 0xb3ffffff
56
57       -h, --help
58              display this help and exit
59
60       -l, --logscale
61              use logarithmic scale
62
63       --no-peak
64              only draw RMS signal using foreground colour
65
66       --no-rms
67              only draw signal peaks (exclusive with --no-peak).
68
69       -r, --rectified
70              rectify waveform
71
72       -R, --rmscolour
73              <COL>    specify RMS colour; default 0xffb3b3b3
74
75       -s, --gainscale
76              zoom into y-axis, map max signal to height.
77
78       -S, --separator <px>
79              vertically  separate  channels  by N pixels (default: 12) - only
80              used with -c -1
81
82       -t <NUM>[/<DEN>], --timecode <NUM>[/<DEN>]
83              use timecode instead of seconds for x-axis; The  numerator  must
84              be  set, the denominator defaults to 1 if omitted.  If the value
85              is negative, audio-frames are used.
86
87       -T <offset>
88              override the BWF time-reference (if any); the offset  is  speci‐
89              fied  in  audio-frames  and only used with timecode (-t) annota‐
90              tion.
91
92       -O, --border-width
93              change outer border width default: 1.0
94
95       -V, --version
96              output version information and exit
97
98       -W, --wavesize
99              given geometry applies to the plain wave-form.  image height de‐
100              pends  on  number  of channels.  border-sizes are added to width
101              and height.
102

REPORTING BUGS

104       Report bugs to <robin@gareus.org>.
105       Website and manual: <https://github.com/libsndfile/sndfile-tools/>
106       Example images: <http://gareus.org/wiki/sndfile-waveform/>
107

109       Copyright © 2007-2012 Erik de Castro Lopo <erikd@mega-nerd.com> Written
110       2011,2012 by Robin Gareus <robin@gareus.org>
111
112       This is free software; see the source for copying conditions.  There is
113       NO warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR
114       PURPOSE.
115
116
117
118sndfile-waveform 1.5             January 2021              SNDFILE-WAVEFORM(1)
Impressum