doc/aubiocut.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3 <!-- Process this file with docbook-to-man to generate an nroff manual
   4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
   5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
   6      less'.  A typical entry in a Makefile or Makefile.am is:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10
  11
  12         The docbook-to-man binary is found in the docbook-to-man package.
  13         Please remember that if you create the nroff version in one of the
  14         debian/rules file targets (such as build), you will need to include
  15         docbook-to-man in your Build-Depends control field.
  16
  17   -->
  18
  19   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  20   <!ENTITY dhfirstname "<firstname>Paul</firstname>">
  21   <!ENTITY dhsurname   "<surname>Brossier</surname>">
  22   <!-- Please adjust the date whenever revising the manpage. -->
  23   <!ENTITY dhdate      "<date>December 1, 2004</date>">
  24   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  25        allowed: see man(7), man(1). -->
  26   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  27   <!ENTITY dhemail     "<email>piem@altern.org</email>">
  28   <!ENTITY dhusername  "Paul Brossier">
  29   <!ENTITY dhucpackage "<refentrytitle>AUBIOCUT</refentrytitle>">
  30   <!ENTITY dhpackage   "aubiocut">
  31
  32   <!ENTITY debian      "<productname>Debian</productname>">
  33   <!ENTITY gnu         "<acronym>GNU</acronym>">
  34   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  35 ]>
  36
  37 <refentry>
  38   <refentryinfo>
  39     <address>
  40       &dhemail;
  41     </address>
  42     <author>
  43       &dhfirstname;
  44       &dhsurname;
  45     </author>
  46     <copyright>
  47       <year>2003</year>
  48       <holder>&dhusername;</holder>
  49     </copyright>
  50     &dhdate;
  51   </refentryinfo>
  52   <refmeta>
  53     &dhucpackage;
  54
  55     &dhsection;
  56   </refmeta>
  57   <refnamediv>
  58     <refname>&dhpackage;</refname>
  59
  60     <refpurpose>a command line tool for real time wav to midi
  61     conversion</refpurpose>
  62
  63   </refnamediv>
  64   <refsynopsisdiv>
  65     <cmdsynopsis>
  66       <command>&dhpackage; <parameter>[options] -i soundfile</parameter></command>
  67     </cmdsynopsis>
  68   </refsynopsisdiv>
  69   <refsect1>
  70     <title>DESCRIPTION</title>
  71
  72     <para>This manual page documents briefly the <command>&dhpackage;</command> command. </para>
  73
  74     <para><command>&dhpackage;</command> takes an input sound file and produce
  75     small file sliced at onset locations. The slices can then be sent to a
  76     player, a sequencer, a sampler, or wherever else. The files can be cut at
  77     onset times or at silences.</para>
  78
  79   </refsect1>
  80   <refsect1>
  81     <title>OPTIONS</title>
  82
  83 <para>This program follows the usual GNU command line syntax, with long options
  84 starting with two dashes (`-').  A summary of options is included below.</para>
  85
  86 <variablelist>
  87   <varlistentry>
  88   <term><option>-h</option>
  89   <option>--help</option></term>
  90   <listitem>
  91   <para>show this help message and exit</para>
  92   </listitem>
  93   </varlistentry>
  94   <varlistentry>
  95   <term><option>-i</option>
  96   <option>--input filein</option></term>
  97   <listitem>
  98   <para>input sound file</para>
  99   </listitem>
 100   </varlistentry>
 101   <varlistentry>
 102   <term><option>-m</option>
 103   <option>--mode onset_detection_mode</option></term>
 104   <listitem>
 105   <para>onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual</para>
 106   </listitem>
 107   </varlistentry>
 108   <varlistentry>
 109   <term><option>-B</option>
 110   <option>--bufsize=BUFSIZE</option></term>
 111   <listitem>
 112   <para>buffer size [default=512]</para>
 113   </listitem>
 114   </varlistentry>
 115   <varlistentry>
 116   <term><option>-H</option>
 117   <option>--hopsize=HOPSIZE</option></term>
 118   <listitem>
 119   <para>overlap size [default=256]</para>
 120   </listitem>
 121   </varlistentry>
 122   <varlistentry>
 123   <term><option>-t</option>
 124   <option>--threshold=THRESHOLD</option></term>
 125   <listitem>
 126   <para>onset peak picking threshold [default=0.3]</para>
 127   </listitem>
 128   </varlistentry>
 129   <varlistentry>
 130   <term><option>-C</option>
 131   <option>--dcthreshold=DCTHRESHOLD</option></term>
 132   <listitem>
 133   <para>onset peak picking DC component [default=1.]</para>
 134   </listitem>
 135   </varlistentry>
 136   <varlistentry>
 137   <term><option>-s</option>
 138   <option>--silence=SILENCE</option></term>
 139   <listitem>
 140   <para>silence threshold [default=-70]</para>
 141   </listitem>
 142   </varlistentry>
 143   <varlistentry>
 144   <term><option>-M</option>
 145   <option>--mintol=MINIOI</option></term>
 146   <listitem>
 147   <para>minimum inter onset interval [default=0.048s]</para>
 148   </listitem>
 149   </varlistentry>
 150   <varlistentry>
 151   <term><option>-D</option>
 152   <option>--delay=DELAY</option></term>
 153   <listitem>
 154   <para>number of seconds to take back [default=system]
 155   default system delay is 3*hopsize/samplerate</para>
 156   </listitem>
 157   </varlistentry>
 158   <varlistentry>
 159   <term><option>-L</option>
 160   <option>--localmin</option></term>
 161   <listitem>
 162   <para>use local minima after peak detection</para>
 163   </listitem>
 164   </varlistentry>
 165   <varlistentry>
 166   <term><option>-c</option>
 167   <option>--cut</option></term>
 168   <listitem>
 169   <para>cut input sound file at detected labels (best used with option -L)</para>
 170   </listitem>
 171   </varlistentry>
 172   <varlistentry>
 173   <term><option>-d</option>
 174   <option>--derivate</option></term>
 175   <listitem>
 176   <para>derivate onset detection function</para>
 177   </listitem>
 178   </varlistentry>
 179   <varlistentry>
 180   <term><option>-S</option>
 181   <option>--silencecut</option></term>
 182   <listitem>
 183   <para>outputs silence locations instead of onset locations</para>
 184   </listitem>
 185   </varlistentry>
 186   <varlistentry>
 187   <term><option>-z</option>
 188   <option>--zerocross=ZEROTHRES</option></term>
 189   <listitem>
 190   <para>zero-crossing threshold for slicing [default=0.00008]</para>
 191   </listitem>
 192   </varlistentry>
 193   <varlistentry>
 194   <term><option>-p</option>
 195   <option>--plot</option></term>
 196   <listitem>
 197   <para>draw plot</para>
 198   </listitem>
 199   </varlistentry>
 200   <varlistentry>
 201   <term><option>-x</option>
 202   <option>--xsize=SIZE</option></term>
 203   <listitem>
 204   <para>define horizontal plot size [default=1.]</para>
 205   </listitem>
 206   </varlistentry>
 207   <varlistentry>
 208   <term><option>-y</option>
 209   <option>--ysize=SIZE</option></term>
 210   <listitem>
 211   <para>define vertical plot size [default=1.]</para>
 212   </listitem>
 213   </varlistentry>
 214   <varlistentry>
 215   <term><option>-f</option>
 216   <option>--function</option></term>
 217   <listitem>
 218   <para>print detection function</para>
 219   </listitem>
 220   </varlistentry>
 221   <varlistentry>
 222   <term><option>-n</option>
 223   <option>--no-onsets</option></term>
 224   <listitem>
 225   <para>do not plot detected onsets, only detection functions</para>
 226   </listitem>
 227   </varlistentry>
 228   <varlistentry>
 229   <term><option>-O</option>
 230   <option>--outplot=OUTPLOT</option></term>
 231   <listitem>
 232   <para>save plot to output.{eps,ps,png,svg}</para>
 233   </listitem>
 234   </varlistentry>
 235   <varlistentry>
 236   <term><option>-v</option>
 237   <option>--verbose</option></term>
 238   <listitem>
 239   <para>make lots of noise [default]</para>
 240   </listitem>
 241   </varlistentry>
 242   <varlistentry>
 243   <term><option>-q</option>
 244   <option>--quiet</option></term>
 245   <listitem>
 246   <para>be quiet</para>
 247   </listitem>
 248   </varlistentry>
 249   <varlistentry>
 250   <term><option>-b</option>
 251   <option>--beat</option></term>
 252   <listitem>
 253   <para>detect beats and output beat locations</para>
 254   </listitem>
 255   </varlistentry>
 256 </variablelist>
 257
 258 </refsect1>
 259   <refsect1>
 260     <title>SEE ALSO</title>
 261
 262     <para>
 263     <command>aubioonset</command>(1)
 264     <command>aubiotrack</command>(1)
 265     <command>aubionotes</command>(1)
 266     <command>aubiopitch</command>(1)
 267     </para>
 268
 269   </refsect1>
 270
 271   <refsect1>
 272     <title>AUTHOR</title>
 273
 274     <para>This manual page was written by &dhusername; (&dhemail;). Permission
 275     is granted to copy, distribute and/or modify this document under the terms
 276     of the &gnu; General Public License, Version 2 any later version published
 277     by the Free Software Foundation.</para>
 278
 279     <para>On Debian systems, the complete text of the GNU General Public
 280     License can be found in /usr/share/common-licenses/GPL.</para>
 281
 282   </refsect1>
 283 </refentry>
 284
 285 <!-- Keep this comment at the end of the file
 286 Local variables:
 287 mode: sgml
 288 sgml-omittag:t
 289 sgml-shorttag:t
 290 sgml-minimize-attributes:nil
 291 sgml-always-quote-attributes:t
 292 sgml-indent-step:2
 293 sgml-indent-data:t
 294 sgml-parent-document:nil
 295 sgml-default-dtd-file:nil
 296 sgml-exposed-tags:nil
 297 sgml-local-catalogs:nil
 298 sgml-local-ecat-files:nil
 299 End:
 300 -->
 301
 302