doc/aubiopitch.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>AUBIOPITCH</refentrytitle>">
  30   <!ENTITY dhpackage   "aubiopitch">
  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>aubionotes</command> attempts to label each fram of the
  75     input sound file with a pitch. When no pitch candidate is found, the
  76     output is 0. Results can be printed in Hertz or in MIDI pitch.  A plotting
  77     module is available via the Gnuplot Python package. 4 functions are
  78     available.</para>
  79
  80   </refsect1>
  81   <refsect1>
  82     <title>OPTIONS</title>
  83
  84     <para>This program follows the usual GNU command line syntax, with long
  85     options starting with two dashes (`-').  A summary of options is included
  86     below.</para>
  87
  88 <variablelist>
  89   <varlistentry>
  90   <term><option>-i</option>
  91   <option>--input filein</option></term>
  92   <listitem>
  93   <para>input sound file</para>
  94   </listitem>
  95   </varlistentry>
  96   <varlistentry>
  97   <term><option>-m</option>
  98   <option>--mode pitch_detection_mode</option></term>
  99   <listitem>
 100   <para>pitch detection mode [default=mcomb] mcomb|yin|fcomb|schmitt</para>
 101   </listitem>
 102   </varlistentry>
 103   <varlistentry>
 104   <term><option>-u</option>
 105   <option>--units unitmode</option></term>
 106   <listitem>
 107   <para>output pitch in units [default=Hz] freq|midi|cent|bin</para>
 108   </listitem>
 109   </varlistentry>
 110   <varlistentry>
 111   <term><option>-B</option>
 112   <option>--bufsize=BUFSIZE</option></term>
 113   <listitem>
 114   <para>buffer size [default=1024]</para>
 115   </listitem>
 116   </varlistentry>
 117   <varlistentry>
 118   <term><option>-H</option>
 119   <option>--hopsize=HOPSIZE</option></term>
 120   <listitem>
 121   <para>overlap size [default=512]</para>
 122   </listitem>
 123   </varlistentry>
 124   <varlistentry>
 125   <term><option>-t</option>
 126   <option>--threshold=THRESHOLD</option></term>
 127   <listitem>
 128   <para>pitch threshold (for yin) [default=0.1]</para>
 129   </listitem>
 130   </varlistentry>
 131   <varlistentry>
 132   <term><option>-s</option>
 133   <option>--silence=SILENCE</option></term>
 134   <listitem>
 135   <para>silence threshold [default=-70]</para>
 136   </listitem>
 137   </varlistentry>
 138   <varlistentry>
 139   <term><option>-D</option>
 140   <option>--delay=DELAY</option></term>
 141   <listitem>
 142   <para>number of seconds to take back [default=0]</para>
 143   </listitem>
 144   </varlistentry>
 145   <varlistentry>
 146   <term><option>-S</option>
 147   <option>--smoothing=frames</option></term>
 148   <listitem>
 149   <para>temporal smoothing using a median filter of N frames [default=0]</para>
 150   </listitem>
 151   </varlistentry>
 152   <varlistentry>
 153   <term><option>-M</option>
 154   <option>--pitchmax=max</option></term>
 155   <listitem>
 156   <para>maximum pitch values to look for (Hz) [default=20000]</para>
 157   </listitem>
 158   </varlistentry>
 159   <varlistentry>
 160   <term><option>-l</option>
 161   <option>--pitchmin=min</option></term>
 162   <listitem>
 163   <para>minimum pitch values to look for (Hz) [default=20]</para>
 164   </listitem>
 165   </varlistentry>
 166   <varlistentry>
 167   <term><option>-n</option>
 168   <option>--note</option></term>
 169   <listitem>
 170   <para>NOT IMPLEMENTED output notes</para>
 171   </listitem>
 172   </varlistentry>
 173   <varlistentry>
 174   <term><option>-p</option>
 175   <option>--plot</option></term>
 176   <listitem>
 177   <para>draw plot of the pitch track</para>
 178   </listitem>
 179   </varlistentry>
 180   <varlistentry>
 181   <term><option>-T</option>
 182   <option>--plottruth</option></term>
 183   <listitem>
 184   <para>draw plot of the ground truth pitch track</para>
 185   </listitem>
 186   </varlistentry>
 187   <varlistentry>
 188   <term><option>-O</option>
 189   <option>--outplot=OUTPLOT</option></term>
 190   <listitem>
 191   <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
 192   </listitem>
 193   </varlistentry>
 194   <varlistentry>
 195   <term><option>-v</option>
 196   <option>--verbose</option></term>
 197   <listitem>
 198   <para>make lots of noise [default]</para>
 199   </listitem>
 200   </varlistentry>
 201   <varlistentry>
 202   <term><option>-q</option>
 203   <option>--quiet</option></term>
 204   <listitem>
 205   <para>be quiet</para>
 206   </listitem>
 207   </varlistentry>
 208   <varlistentry>
 209   <term><option>-h</option>
 210   <option>--help</option></term>
 211   <listitem>
 212   <para>show this help message and exit</para>
 213   </listitem>
 214   </varlistentry>
 215 </variablelist>
 216
 217
 218 </refsect1>
 219   <refsect1>
 220     <title>SEE ALSO</title>
 221
 222     <para>
 223     <command>aubionotes</command>(1)
 224     <command>aubioonset</command>(1)
 225     <command>aubiocut</command>(1)
 226     <command>aubiotrack</command>(1)
 227     </para>
 228
 229   </refsect1>
 230
 231   <refsect1>
 232     <title>AUTHOR</title>
 233
 234     <para>This manual page was written by &dhusername; (&dhemail;). Permission
 235     is granted to copy, distribute and/or modify this document under the terms
 236     of the &gnu; General Public License, Version 2 any later version published
 237     by the Free Software Foundation.</para>
 238
 239     <para>On Debian systems, the complete text of the GNU General Public
 240     License can be found in /usr/share/common-licenses/GPL.</para>
 241
 242   </refsect1>
 243 </refentry>
 244
 245 <!-- Keep this comment at the end of the file
 246 Local variables:
 247 mode: sgml
 248 sgml-omittag:t
 249 sgml-shorttag:t
 250 sgml-minimize-attributes:nil
 251 sgml-always-quote-attributes:t
 252 sgml-indent-step:2
 253 sgml-indent-data:t
 254 sgml-parent-document:nil
 255 sgml-default-dtd-file:nil
 256 sgml-exposed-tags:nil
 257 sgml-local-catalogs:nil
 258 sgml-local-ecat-files:nil
 259 End:
 260 -->
 261
 262