[SCM] drc/master: man pages added
mira-guest at users.alioth.debian.org
mira-guest at users.alioth.debian.org
Tue Aug 30 22:41:19 UTC 2011
The following commit has been merged in the master branch:
commit a338add41bfc2274b960d7376e1ce21d8f361c50
Author: Jaromír Mikeš <mira.mikes at seznam.cz>
Date: Wed Aug 31 00:40:37 2011 +0200
man pages added
diff --git a/debian/drc.1 b/debian/drc.1
new file mode 100644
index 0000000..cbf7443
--- /dev/null
+++ b/debian/drc.1
@@ -0,0 +1,232 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH DRC 1 "August 30, 2011"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+\fBdrc\fP \- a program for acoustic compensation of audio systems
+.SH SYNOPSIS
+\fBdrc\fP [\fIoptions\fP] DRCFile
+.br
+\fBDRCFile\fP is name of DRC configration file
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+\fBdrc\fP program.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBdrc\fP is program used to generate correction filters for acoustic compensation of HiFi and audio systems in general, including listening room compensation.
+ Program generates just the FIR correction filters, which can be used with a real time or offline convolver to provide real time or offline correction.
+.PP
+\fBdrc\fP doesn't provide convolution features, and provides only some simplified, although really accurate, measuring tools.
+.SH OPTIONS
+.PP
+.B \ -\-help
+ Show the full options list
+.PP
+ \-\-BCBaseDir <STRING>
+ \-\-BCInFile <STRING>
+ \-\-BCInFileType <STRING>
+ \-\-BCSampleRate <INTEGER>
+ \-\-BCImpulseCenterMode <STRING>
+ \-\-BCImpulseCenter <INTEGER>
+ \-\-BCInitWindow <INTEGER>
+ \-\-BCPreWindowLen <INTEGER>
+ \-\-BCPreWindowGap <INTEGER>
+ \-\-BCNormFactor <FLOAT>
+ \-\-BCNormType <STRING>
+ \-\-MCFilterType <STRING>
+ \-\-MCInterpolationType <STRING>
+ \-\-MCMultExponent <INTEGER>
+ \-\-MCFilterLen <INTEGER>
+ \-\-MCNumPoints <INTEGER>
+ \-\-MCPointsFile <STRING>
+ \-\-MCMagType <STRING>
+ \-\-MCFilterFile <STRING>
+ \-\-MCFilterFileType <STRING>
+ \-\-MCOutWindow <INTEGER>
+ \-\-MCNormFactor <FLOAT>
+ \-\-MCNormType <STRING>
+ \-\-MCOutFile <STRING>
+ \-\-MCOutFileType <STRING>
+ \-\-BCDLType <STRING>
+ \-\-BCDLMinGain <FLOAT>
+ \-\-BCDLStartFreq <FLOAT>
+ \-\-BCDLEndFreq <FLOAT>
+ \-\-BCDLStart <FLOAT>
+ \-\-BCDLMultExponent <INTEGER>
+ \-\-HDMultExponent <INTEGER>
+ \-\-HDMPNormFactor <FLOAT>
+ \-\-HDMPNormType <STRING>
+ \-\-HDMPOutFile <STRING>
+ \-\-HDMPOutFileType <STRING>
+ \-\-HDEPNormFactor <FLOAT>
+ \-\-HDEPNormType <STRING>
+ \-\-HDEPOutFile <STRING>
+ \-\-HDEPOutFileType <STRING>
+ \-\-MPPrefilterType <STRING>
+ \-\-MPPrefilterFctn <STRING>
+ \-\-MPWindowGap <INTEGER>
+ \-\-MPLowerWindow <INTEGER>
+ \-\-MPUpperWindow <INTEGER>
+ \-\-MPStartFreq <FLOAT>
+ \-\-MPEndFreq <FLOAT>
+ \-\-MPWindowExponent <FLOAT>
+ \-\-MPFilterLen <INTEGER>
+ \-\-MPFSharpness <FLOAT>
+ \-\-MPBandSplit <INTEGER>
+ \-\-MPHDRecover <STRING>
+ \-\-MPEPPreserve <STRING>
+ \-\-MPHDMultExponent <INTEGER>
+ \-\-MPPFFinalWindow <INTEGER>
+ \-\-MPPFNormFactor <FLOAT>
+ \-\-MPPFNormType <STRING>
+ \-\-MPPFOutFile <STRING>
+ \-\-MPPFOutFileType <STRING>
+ \-\-DLType <STRING>
+ \-\-DLMinGain <FLOAT>
+ \-\-DLStartFreq <FLOAT>
+ \-\-DLEndFreq <FLOAT>
+ \-\-DLStart <FLOAT>
+ \-\-DLMultExponent <INTEGER>
+ \-\-EPPrefilterType <STRING>
+ \-\-EPPrefilterFctn <STRING>
+ \-\-EPWindowGap <INTEGER>
+ \-\-EPLowerWindow <INTEGER>
+ \-\-EPUpperWindow <INTEGER>
+ \-\-EPStartFreq <FLOAT>
+ \-\-EPEndFreq <FLOAT>
+ \-\-EPWindowExponent <FLOAT>
+ \-\-EPFilterLen <INTEGER>
+ \-\-EPFSharpness <FLOAT>
+ \-\-EPBandSplit <INTEGER>
+ \-\-EPPFFlatGain <FLOAT>
+ \-\-EPPFOGainFactor <FLOAT>
+ \-\-EPPFFlatType <STRING>
+ \-\-EPPFFGMultExponent <INTEGER>
+ \-\-EPPFFinalWindow <INTEGER>
+ \-\-EPPFNormFactor <FLOAT>
+ \-\-EPPFNormType <STRING>
+ \-\-EPPFOutFile <STRING>
+ \-\-EPPFOutFileType <STRING>
+ \-\-PCOutWindow <INTEGER>
+ \-\-PCNormFactor <FLOAT>
+ \-\-PCNormType <STRING>
+ \-\-PCOutFile <STRING>
+ \-\-PCOutFileType <STRING>
+ \-\-ISType <STRING>
+ \-\-ISPETType <STRING>
+ \-\-ISPrefilterFctn <STRING>
+ \-\-ISPELowerWindow <INTEGER>
+ \-\-ISPEUpperWindow <INTEGER>
+ \-\-ISPEStartFreq <INTEGER>
+ \-\-ISPEEndFreq <INTEGER>
+ \-\-ISPEFilterLen <INTEGER>
+ \-\-ISPEFSharpness <FLOAT>
+ \-\-ISPEBandSplit <INTEGER>
+ \-\-ISPEWindowExponent <FLOAT>
+ \-\-ISPEOGainFactor <FLOAT>
+ \-\-ISSMPMultExponent <INTEGER>
+ \-\-ISOutWindow <INTEGER>
+ \-\-ISNormFactor <FLOAT>
+ \-\-ISNormType <STRING>
+ \-\-ISOutFile <STRING>
+ \-\-ISOutFileType <STRING>
+ \-\-PTType <STRING>
+ \-\-PTReferenceWindow <INTEGER>
+ \-\-PTDLType <STRING>
+ \-\-PTDLMinGain <FLOAT>
+ \-\-PTDLStart <FLOAT>
+ \-\-PTDLStartFreq <FLOAT>
+ \-\-PTDLEndFreq <FLOAT>
+ \-\-PTDLMultExponent <INTEGER>
+ \-\-PTBandWidth <FLOAT>
+ \-\-PTPeakDetectionStrength <FLOAT>
+ \-\-PTMultExponent <INTEGER>
+ \-\-PTFilterLen <INTEGER>
+ \-\-PTFilterFile <STRING>
+ \-\-PTFilterFileType <STRING>
+ \-\-PTNormFactor <FLOAT>
+ \-\-PTNormType <STRING>
+ \-\-PTOutFile <STRING>
+ \-\-PTOutFileType <STRING>
+ \-\-PTOutWindow <INTEGER>
+ \-\-PLType <STRING>
+ \-\-PLMaxGain <FLOAT>
+ \-\-PLStart <FLOAT>
+ \-\-PLStartFreq <FLOAT>
+ \-\-PLEndFreq <FLOAT>
+ \-\-PLMultExponent <INTEGER>
+ \-\-PLOutWindow <INTEGER>
+ \-\-PLNormFactor <FLOAT>
+ \-\-PLNormType <STRING>
+ \-\-PLOutFile <STRING>
+ \-\-PLOutFileType <STRING>
+ \-\-RTType <STRING>
+ \-\-RTPrefilterFctn <STRING>
+ \-\-RTWindowGap <INTEGER>
+ \-\-RTLowerWindow <INTEGER>
+ \-\-RTUpperWindow <INTEGER>
+ \-\-RTStartFreq <FLOAT>
+ \-\-RTEndFreq <FLOAT>
+ \-\-RTWindowExponent <FLOAT>
+ \-\-RTFilterLen <INTEGER>
+ \-\-RTFSharpness <FLOAT>
+ \-\-RTBandSplit <INTEGER>
+ \-\-RTOutWindow <INTEGER>
+ \-\-RTNormFactor <FLOAT>
+ \-\-RTNormType <STRING>
+ \-\-RTOutFile <STRING>
+ \-\-RTOutFileType <STRING>
+ \-\-PSFilterType <STRING>
+ \-\-PSInterpolationType <STRING>
+ \-\-PSMultExponent <INTEGER>
+ \-\-PSFilterLen <INTEGER>
+ \-\-PSNumPoints <INTEGER>
+ \-\-PSPointsFile <STRING>
+ \-\-PSMagType <STRING>
+ \-\-PSOutWindow <INTEGER>
+ \-\-PSNormFactor <FLOAT>
+ \-\-PSNormType <STRING>
+ \-\-PSOutFile <STRING>
+ \-\-PSOutFileType <STRING>
+ \-\-MSMultExponent <INTEGER>
+ \-\-MSOutWindow <INTEGER>
+ \-\-MSFilterDelay <INTEGER>
+ \-\-MSNormFactor <FLOAT>
+ \-\-MSNormType <STRING>
+ \-\-MSOutFile <STRING>
+ \-\-MSOutFileType <STRING>
+ \-\-TCNormFactor <FLOAT>
+ \-\-TCNormType <STRING>
+ \-\-TCOutFile <STRING>
+ \-\-TCOutFileType <STRING>
+ \-\-TCOWFile <STRING>
+ \-\-TCOWFileType <STRING>
+ \-\-TCOWNormFactor <FLOAT>
+ \-\-TCOWNormType <STRING>
+ \-\-TCOWSkip <INTEGER>
+ \-\-TCOWPrewindow <INTEGER>
+ \-\-TCOWLength <INTEGER>
+.PP
+.B Refer to the manual and samples for options details and file format.
+.PP
+.SH AUTHOR
+This manual page was written by Jaromír Mikeš <mira.mikes at seznam.cz>,
+for the Debian project (but may be used by others).
diff --git a/debian/drc.manpages b/debian/drc.manpages
new file mode 100644
index 0000000..57ccfba
--- /dev/null
+++ b/debian/drc.manpages
@@ -0,0 +1,3 @@
+debian/drc.1
+debian/glsweep.1
+debian/lsconv.1
diff --git a/debian/glsweep.1 b/debian/glsweep.1
new file mode 100644
index 0000000..a5f28d1
--- /dev/null
+++ b/debian/glsweep.1
@@ -0,0 +1,74 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH GLSWEEP 1 "August 30, 2011"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+\fBglsweep\fP \- a program generating log sweep and inverse filter.
+.SH SYNOPSIS
+\fBglsweep\fP [\fIparameters\fP] sweepfile inversefile
+.PP
+\fBUsage:\fP glsweep rate amplitude hzstart hzend duration silence leadin leadout sweepfile inversefile
+.PP
+\fBExample:\fP glsweep 44100 0.5 10 21000 45 2 0.05 0.005 sweep.pcm inverse.pcm
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+\fBglsweep\fP program.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBglsweep\fP is program to perform accurate time aligned impulse response measurements.
+.PP
+\fBglsweep\fP is based on the log sweep method for impulse response measurement, which is one of the most accurate, especially for acoustic measurements. This method is based on a special signal, which is a logarithmic sinusoidal sweep, that need to be reproduced through the system under test, and an inverse filter, which, when convolved with the measured log sweep, gives back the impulse response of the system.
+.PP
+The output format is the usual raw file with 32 bit IEEE floating point samples. If you need to convert the sweep generated using the example above to a 16 bit mono WAV file you can use SoX with a command line like this one:
+.PP
+sox \-t f32 \-r 44100 \-c 1 sweep.pcm \-t wav \-c 1 sweep.wav
+.PP
+.SH PARAMETERS
+.PP
+\fBrate:\fP reference sample rate
+.br
+\fBamplitude:\fP sweep amplitude
+.br
+\fBhzstart:\fP sweep start frequency
+.br
+\fBhzend:\fP sweep end frequency
+.br
+\fBduration:\fP sweep duration in seconds
+.br
+\fBsilence:\fP leading and trailing silence duration in seconds
+.br
+\fBleadin:\fP leading window length as a fraction of duration
+.br
+\fBleadout:\fP trailing window length as a fraction of duration
+.br
+\fBsweepfile:\fP sweep file name
+.br
+\fBinversefile:\fP inverse sweep file name
+.PP
+.B Refer to html documentation for more details.
+.PP
+.SH SEE ALSO
+.BR sox(1).
+.br
+.PP
+.SH AUTHOR
+This manual page was written by Jaromír Mikeš <mira.mikes at seznam.cz>,
+for the Debian project (but may be used by others).
diff --git a/debian/lsconv.1 b/debian/lsconv.1
new file mode 100644
index 0000000..fdc779e
--- /dev/null
+++ b/debian/lsconv.1
@@ -0,0 +1,64 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH LSCONV 1 "August 30, 2011"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+\fBlsconv\fP \- a program does Log Sweep convolution.
+.SH SYNOPSIS
+\fBlsconv\fP [\fIparameters\fP] sweepfile inversefile
+.PP
+\fBUsage:\fP lsconv sweepfile inversefile outfile [refsweep mingain [dlstart]]
+.PP
+\fBExample:\fP lsconv sweep.pcm inverse.pcm impulse.pcm refchannel.pcm 0.1 0.8
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+\fBlsconv\fP program.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBlsconv\fP is program to perform accurate time aligned impulse response measurements.
+.PP
+\fBlsconv\fP is based on the log sweep method for impulse response measurement, which is one of the most accurate, especially for acoustic measurements. This method is based on a special signal, which is a logarithmic sinusoidal sweep, that need to be reproduced through the system under test, and an inverse filter, which, when convolved with the measured log sweep, gives back the impulse response of the system.
+.PP
+Files used by \fBlsconv\fP must be in the raw 32 bit floating point format. Use for e.g. sox program for converting if needed.
+.PP
+.SH PARAMETERS
+.PP
+\fBsweepfile:\fP sweep file name
+.br
+\fBinversefile:\fP inverse sweep file name
+.br
+\fBoutfile:\fP output impulse response file
+.br
+\fBrefsweep:\fP reference channel sweep file name
+.br
+\fBmingain:\fP min gain for reference channel inversion
+.br
+\fBdlstart:\fP dip limiting start for reference channel inversion
+.PP
+.B Refer to html documentation for more details.
+.PP
+.SH SEE ALSO
+.BR sox(1).
+.br
+.PP
+.SH AUTHOR
+This manual page was written by Jaromír Mikeš <mira.mikes at seznam.cz>,
+for the Debian project (but may be used by others).
--
drc packaging
More information about the pkg-multimedia-commits
mailing list