.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.17.
.TH SNDFILE-WAVEFORM "1" "January 2021" "sndfile-waveform 1.5" "User Commands"
.SH NAME
sndfile-waveform \- manual page for sndfile-waveform 1.5
.SH SYNOPSIS
.B sndfile-waveform
[\fI\,OPTION\/\fR]  \fI\,<sound-file> <png-file>\/\fR
.SH DESCRIPTION
sndfile\-waveform \- waveform image generator
.PP
Creates a PNG image depicting the wave\-form of an audio file.
Peak\-signal and RMS values can be displayed in the same plot,
where the horizontal axis always represents time.
.PP
The vertical axis can be plotted logarithmically, and the signal
can optionally be rectified.
.PP
The Time\-axis annotation unit is either seconds, audio\-frames or timecode
using broadcast\-wave time reference meta\-data.
.PP
The tool can plot individual channels, reduce the file to mono,
or plot all channels in vertically arrangement.
.PP
Colours (ARGB) and image\- or waveform geometry can be freely specified.
.SH OPTIONS
.TP
\fB\-A\fR, \fB\-\-textcolour\fR <COL>
specify text and border colour; default 0xffffffff
all colours as hexadecimal AA RR GG BB values
.TP
\fB\-b\fR, \fB\-\-border\fR
display a border with annotations
.TP
\fB\-B\fR, \fB\-\-background\fR <COL>
specify background colour; default 0x8099999f
.TP
\fB\-c\fR, \fB\-\-channel\fR
choose channel (s) to plot, 0: merge to mono;
< 0: render all channels vertically separated;
> 0: render only specified channel. (default: 0)
.TP
\fB\-C\fR, \fB\-\-centerline\fR <COL>
set colour of zero/center line (default 0x4cffffff)
.TP
\fB\-F\fR, \fB\-\-foreground\fR <COL>
specify foreground colour; default 0xff333333
.TP
\fB\-g\fR <w>x<h>, \fB\-\-geometry\fR <w>x<h>
specify the size of the image to create
default: 800x192
.TP
\fB\-G\fR, \fB\-\-borderbg\fR <COL>
specify border/annotation background colour;
default 0xb3ffffff
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit
.TP
\fB\-l\fR, \fB\-\-logscale\fR
use logarithmic scale
.TP
\fB\-\-no\-peak\fR
only draw RMS signal using foreground colour
.TP
\fB\-\-no\-rms\fR
only draw signal peaks (exclusive with \fB\-\-no\-peak\fR).
.TP
\fB\-r\fR, \fB\-\-rectified\fR
rectify waveform
.TP
\fB\-R\fR, \fB\-\-rmscolour\fR
<COL>    specify RMS colour; default 0xffb3b3b3
.TP
\fB\-s\fR, \fB\-\-gainscale\fR
zoom into y\-axis, map max signal to height.
.TP
\fB\-S\fR, \fB\-\-separator\fR <px>
vertically separate channels by N pixels
(default: 12) \- only used with \fB\-c\fR \fB\-1\fR
.TP
\fB\-t\fR <NUM>[/<DEN>], \fB\-\-timecode\fR <NUM>[/<DEN>]
use timecode instead of seconds for x\-axis;
The numerator must be set, the denominator
defaults to 1 if omitted.
If the value is negative, audio\-frames are used.
.TP
\fB\-T\fR <offset>
override the BWF time\-reference (if any);
the offset is specified in audio\-frames
and only used with timecode (\fB\-t\fR) annotation.
.TP
\fB\-O\fR, \fB\-\-border\-width\fR
change outer border width
default: 1.0
.TP
\fB\-V\fR, \fB\-\-version\fR
output version information and exit
.TP
\fB\-W\fR, \fB\-\-wavesize\fR
given geometry applies to the plain wave\-form.
image height depends on number of channels.
border\-sizes are added to width and height.
.SH "REPORTING BUGS"
Report bugs to <robin@gareus.org>.
.br
Website and manual: <https://github.com/libsndfile/sndfile\-tools/>
.br
Example images: <http://gareus.org/wiki/sndfile\-waveform/>
.SH COPYRIGHT
Copyright \(co 2007\-2012 Erik de Castro Lopo <erikd@mega\-nerd.com>
Written 2011,2012 by Robin Gareus <robin@gareus.org>
.PP
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.