Changeset beea3cf for doc


Ignore:
Timestamp:
Oct 7, 2006, 11:46:54 PM (18 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
823fa09
Parents:
042e095
Message:

update the manual pages
update the manual pages

Location:
doc
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • doc/aubiocut.sgml

    r042e095 rbeea3cf  
    5858    <refname>&dhpackage;</refname>
    5959
    60     <refpurpose>a command line tool for real time wav to midi
    61     conversion</refpurpose>
     60    <refpurpose>a command line tool to extract onsets and tempo from sound files.</refpurpose>
    6261
    6362  </refnamediv>
    … …  
    7069    <title>DESCRIPTION</title>
    7170
    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>
     71    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
     72
     73    <para>The <emphasis>aubio</emphasis> library provides a small set of
     74    functions to extract events and objects from audio, from live streams or
     75    still files. Onsets are used to label the beginning of notes, pitches to
     76    label their height.</para>
     77
     78    <para><command>&dhpackage;</command> attempts to detect onset times, the
     79    beginning of discreted sound events, or beat locations, in audio
     80    signals.</para>
     81
     82    <para>When using the <option>--cut</option> option,
     83    <command>&dhpackage;</command> takes an input sound file and produce small
     84    files sliced at onset locations (or silences). The slices can then be sent
     85    for example to a player, a sequencer, or a sampler.</para>
     86
     87    <para>A plotting module is available via the Gnuplot Python package.</para>
    7888
    7989  </refsect1>
    … …  
    8191    <title>OPTIONS</title>
    8292
    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>
     93    <para>This program follows the usual GNU command line syntax, with long
     94    options starting with two dashes (`-').  A summary of options is included
     95    below.</para>
    8596
    8697<variablelist>
     98  <varlistentry>
     99  <term><option>-i</option>
     100  <option>--input filein</option></term>
     101  <listitem>
     102  <para>input sound file</para>
     103  </listitem>
     104  </varlistentry>
     105  <varlistentry>
     106  <term><option>-m</option>
     107  <option>--mode onset_detection_mode</option></term>
     108  <listitem>
     109  <para>onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual</para>
     110  </listitem>
     111  </varlistentry>
     112  <varlistentry>
     113  <term><option>-b</option>
     114  <option>--beat</option></term>
     115  <listitem>
     116  <para>detect beats and output beat locations</para>
     117  </listitem>
     118  </varlistentry>
     119  <varlistentry>
     120  <term><option>-B</option>
     121  <option>--bufsize=BUFSIZE</option></term>
     122  <listitem>
     123  <para>buffer size [default=512]</para>
     124  </listitem>
     125  </varlistentry>
     126  <varlistentry>
     127  <term><option>-H</option>
     128  <option>--hopsize=HOPSIZE</option></term>
     129  <listitem>
     130  <para>overlap size [default=256]</para>
     131  </listitem>
     132  </varlistentry>
     133  <varlistentry>
     134  <term><option>-t</option>
     135  <option>--threshold=THRESHOLD</option></term>
     136  <listitem>
     137  <para>onset peak picking threshold [default=0.3]</para>
     138  </listitem>
     139  </varlistentry>
     140  <varlistentry>
     141  <term><option>-C</option>
     142  <option>--dcthreshold=DCTHRESHOLD</option></term>
     143  <listitem>
     144  <para>onset peak picking DC component [default=1.]</para>
     145  </listitem>
     146  </varlistentry>
     147  <varlistentry>
     148  <term><option>-s</option>
     149  <option>--silence=SILENCE</option></term>
     150  <listitem>
     151  <para>silence threshold [default=-70]</para>
     152  </listitem>
     153  </varlistentry>
     154  <varlistentry>
     155  <term><option>-M</option>
     156  <option>--mintol=MINIOI</option></term>
     157  <listitem>
     158  <para>minimum inter onset interval [default=0.048s]</para>
     159  </listitem>
     160  </varlistentry>
     161  <varlistentry>
     162  <term><option>-D</option>
     163  <option>--delay=DELAY</option></term>
     164  <listitem>
     165  <para>number of seconds to take back [default=system]
     166  default system delay is 3*hopsize/samplerate</para>
     167  </listitem>
     168  </varlistentry>
     169  <varlistentry>
     170  <term><option>-L</option>
     171  <option>--localmin</option></term>
     172  <listitem>
     173  <para>use local minima after peak detection</para>
     174  </listitem>
     175  </varlistentry>
     176  <varlistentry>
     177  <term><option>-c</option>
     178  <option>--cut</option></term>
     179  <listitem>
     180  <para>cut input sound file at detected labels (best used with option -L)</para>
     181  </listitem>
     182  </varlistentry>
     183  <varlistentry>
     184  <term><option>-d</option>
     185  <option>--derivate</option></term>
     186  <listitem>
     187  <para>derivate onset detection function</para>
     188  </listitem>
     189  </varlistentry>
     190  <varlistentry>
     191  <term><option>-S</option>
     192  <option>--silencecut</option></term>
     193  <listitem>
     194  <para>outputs silence locations instead of onset locations</para>
     195  </listitem>
     196  </varlistentry>
     197  <varlistentry>
     198  <term><option>-z</option>
     199  <option>--zerocross=ZEROTHRES</option></term>
     200  <listitem>
     201  <para>zero-crossing threshold for slicing [default=0.00008]</para>
     202  </listitem>
     203  </varlistentry>
     204  <varlistentry>
     205  <term><option>-f</option>
     206  <option>--function</option></term>
     207  <listitem>
     208  <para>print detection function</para>
     209  </listitem>
     210  </varlistentry>
     211  <varlistentry>
     212  <term><option>-q</option>
     213  <option>--quiet</option></term>
     214  <listitem>
     215  <para>be quiet</para>
     216  </listitem>
     217  </varlistentry>
    87218  <varlistentry>
    88219  <term><option>-h</option>
    89220  <option>--help</option></term>
    90221  <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>
     222  <para>Show a summary of options.</para>
     223  </listitem>
     224  </varlistentry>
     225  <varlistentry>
     226  <term><option>-v</option>
     227  <option>--verbose</option></term>
     228  <listitem>
     229  <para>make lots of noise [default]</para>
     230  </listitem>
     231  </varlistentry>
     232  </variablelist>
     233
     234  <refsect2>
     235    <title>Plotting options</title>
     236
     237  <para>When the Python interface to Gnuplot is installed, the following
     238  additional options are available.</para>
     239
     240  <variablelist>
    193241  <varlistentry>
    194242  <term><option>-p</option>
    … …  
    199247  </varlistentry>
    200248  <varlistentry>
     249  <term><option>-n</option>
     250  <option>--no-onsets</option></term>
     251  <listitem>
     252  <para>do not plot detected onsets, only detection functions</para>
     253  </listitem>
     254  </varlistentry>
     255  <varlistentry>
    201256  <term><option>-x</option>
    202257  <option>--xsize=SIZE</option></term>
    … …  
    213268  </varlistentry>
    214269  <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>
    229270  <term><option>-O</option>
    230271  <option>--outplot=OUTPLOT</option></term>
    231272  <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>
     273  <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
     274  </listitem>
     275  </varlistentry>
     276  </variablelist>
     277  </refsect2>
     278
     279  </refsect1>
     280  <refsect1>
     281  <title>BUGS</title>
     282
     283  <para>For now the program has only been tested on audio signals sampled at
     284  44.1&nbsp;kHz.</para>
     285
     286  </refsect1>
     287
    259288  <refsect1>
    260289    <title>SEE ALSO</title>

  • doc/aubionotes.sgml

    r042e095 rbeea3cf  
    5858    <refname>&dhpackage;</refname>
    5959
    60     <refpurpose>a command line tool for real time wav to midi
    61     conversion</refpurpose>
     60    <refpurpose>a command line tool for real time extraction of musical notes.</refpurpose>
    6261
    6362  </refnamediv>
    6463  <refsynopsisdiv>
    6564    <cmdsynopsis>
    66       <command>&dhpackage;</command>
     65      <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
    6766    </cmdsynopsis>
    6867  </refsynopsisdiv>
    … …  
    7271    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
    7372
    74     <para><command>&dhpackage;</command> is still in an experimental state.
    75     Its aim is to extract the melody and output it as a midi stream with a
    76     minimal deleay. Pitch candidates are selected at each frame, onset and
    77     silences are used to segment the notes.</para>
    78 
    79     <para>When started without an input file argument (<option>-i</option>),
    80     aubionotes creates a jack input and a midi output. When an input file is
    81     given, it outputs the results on the console.</para>
    82 
     73    <para>The <emphasis>aubio</emphasis> library provides a small set of
     74    functions to extract events and objects from audio, from live streams or
     75    still files. Onsets are used to label the beginning of notes, pitches to
     76    label their height.</para>
     77
     78    <para><command>&dhpackage;</command> attempts to detect notes in audio
     79    signals, segmenting consecutive events using onset detection, and
     80    determining their pitch using a fundamental frequency extraction algorithm.
     81    </para>
     82   
     83    <para>When started without an input file argument
     84    (<option>--input</option>), <command>&dhpackage;</command> creates a jack
     85    input and a MIDI output. When an input file is given, the results are given
     86    on the console.</para>
    8387
    8488  </refsect1>
    … …  
    9599  <option>--input filein</option></term>
    96100  <listitem>
    97 <para>Run analysis on this audio file. Most common (uncompressed) formats are
    98 supported.</para>
     101
     102  <para>Run analysis on this audio file. Most common uncompressed formats are
     103  supported.</para>
     104
    99105  </listitem>
    100106  </varlistentry>
    … …  
    105111
    106112  <para>Save results in this file. The file will be created on the model of the
    107   input file. Results are marked by a very short wood-block sample.</para>
     113  input file. Results are marked by a short wood-block sample.</para>
    108114
    109115  </listitem>
    … …  
    115121
    116122  <para>The pitch detection function to run. Available functions are
    117   <emphasis>mcomb</emphasis>, <emphasis>yin</emphasis>,
    118   <emphasis>fcomb</emphasis> and <emphasis>schmitt</emphasis>.</para>
     123  <emphasis>yinfft</emphasis>, <emphasis>yin</emphasis>,
     124  <emphasis>mcomb</emphasis>, <emphasis>fcomb</emphasis>, and
     125  <emphasis>schmitt</emphasis>.</para>
    119126
    120127  </listitem>
    … …  
    141148  <para>Set the threshold value for the onset peak picking. Typical values are
    142149  within <literal>0.001</literal> and <literal>0.900</literal>. Default is
    143   <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
    144   sensible</emphasis>.  Try <literal>0.3</literal> in case of
    145   over-detections.</para>
     150  <literal>0.1</literal>. <emphasis>Lower</emphasis> threshold values imply
     151  <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
     152  case of over-detections.</para>
    146153
    147154  </listitem>
    … …  
    151158  <option>--jack</option></term>
    152159  <listitem>
    153 <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
     160  <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
     161  </listitem>
     162  </varlistentry>
     163  <varlistentry>
     164  <term><option>-v</option>
     165  <option>--verbose</option></term>
     166  <listitem>
     167  <para>Show results on the console (default).</para>
    154168  </listitem>
    155169  </varlistentry>
    … …  
    158172  <option>--help</option></term>
    159173  <listitem>
    160 <para>Show summary of options.</para>
    161   </listitem>
    162   </varlistentry>
    163   <varlistentry>
    164   <term><option>-v</option>
    165   <option>--verbose</option></term>
    166   <listitem>
    167 <para>Show results on the console.</para>
    168 
     174  <para>Show summary of options.</para>
    169175  </listitem>
    170176  </varlistentry>
    … …  
    172178
    173179  </refsect1>
     180  <refsect1>
     181  <title>BUGS</title>
     182
     183  <para>For now the program has only been tested on audio signals sampled at
     184  44.1&nbsp;kHz.</para>
     185
     186  </refsect1>
     187
    174188  <refsect1>
    175189    <title>SEE ALSO</title>
    … …  
    178192    <command>aubioonset</command>(1)
    179193    <command>aubiotrack</command>(1)
    180     <command>aubionotes</command>(1)
     194    <command>aubiocut</command>(1)
    181195    <command>aubiopitch</command>(1)
    182196    </para>
    183197
    184198  </refsect1>
    185 
    186 <refsect1>
    187 <title>BUGS</title>
    188 
    189 <para>For now the program has been only tested on audio signals sampled at 44.1
    190 kHz. The pitch detectors are also way too cpu-intensive.</para>
    191 
    192 </refsect1>
    193199
    194200  <refsect1>

  • doc/aubioonset.sgml

    r042e095 rbeea3cf  
    6363  <refsynopsisdiv>
    6464    <cmdsynopsis>
    65       <command>&dhpackage;</command>
     65      <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
    6666    </cmdsynopsis>
    6767  </refsynopsisdiv>
    … …  
    7171    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
    7272
    73 <para>The library <emphasis>aubio</emphasis> provides a small set of functions
    74 to extract events and objects from audio, from live streams or still files.
    75 Onsets are used to label the beginning of notes, pitches to label their
    76 height.</para>
    77 
    78 <para><command>aubionotes</command> is still in an experimental state. Its aim
    79 is to segment notes with onsets, and label them with their detected pitch. When
    80 started without an input file argument (<option>-i</option>), aubionotes
    81 creates a jack input and a midi output. When an input file is given, it outputs
    82 the results on the console.</para>
     73    <para>The <emphasis>aubio</emphasis> library provides a small set of
     74    functions to extract events and objects from audio, from live streams or
     75    still files. Onsets are used to label the beginning of notes, pitches to
     76    label their height.</para>
     77
     78    <para><command>&dhpackage;</command> attempts to detect onset times, the
     79    beginning of discreted sound events, in audio signals.</para>
     80
     81    <para>When started without an input file argument
     82    (<option>--input</option>), <command>&dhpackage;</command> creates jack
     83    input and output ports. When an input file is given, the results are given
     84    on the console.</para>
    8385
    8486  </refsect1>
    … …  
    8688    <title>OPTIONS</title>
    8789
    88 <para>This program follows the usual GNU command line syntax, with long options
    89 starting with two dashes (`-').  A summary of options is included below.</para>
     90    <para>This program follows the usual GNU command line syntax, with long
     91    options starting with two dashes (`-').  A summary of options is included
     92    below.</para>
    9093
    9194<variablelist>
    … …  
    9497  <option>--input filein</option></term>
    9598  <listitem>
    96 <para>Run analysis on this audio file. Most common (uncompressed) formats are
    97 supported.</para>
     99
     100  <para>Run analysis on this audio file. Most common uncompressed formats are
     101  supported.</para>
     102
    98103  </listitem>
    99104  </varlistentry>
    … …  
    104109
    105110  <para>Save results in this file. The file will be created on the model of the
    106   input file. Results are marked by a very short wood-block sample.</para>
     111  input file. Results are marked by a short wood-block sample.</para>
    107112
    108113  </listitem>
    … …  
    129134  <para>Set the threshold value for the onset peak picking. Typical values are
    130135  within <literal>0.001</literal> and <literal>0.900</literal>. Default is
    131   <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
    132   sensible</emphasis>.  Try <literal>0.3</literal> in case of
    133   over-detections.</para>
     136  <literal>0.1</literal>. <emphasis>Lower</emphasis> threshold values imply
     137  <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
     138  case of over-detections.</para>
    134139
    135140  </listitem>
    … …  
    139144  <option>--jack</option></term>
    140145  <listitem>
    141 <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
     146  <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
     147  </listitem>
     148  </varlistentry>
     149  <varlistentry>
     150  <term><option>-v</option>
     151  <option>--verbose</option></term>
     152  <listitem>
     153  <para>Show results on the console (default).</para>
    142154  </listitem>
    143155  </varlistentry>
    … …  
    146158  <option>--help</option></term>
    147159  <listitem>
    148 <para>Show summary of options.</para>
    149   </listitem>
    150   </varlistentry>
    151   <varlistentry>
    152   <term><option>-v</option>
    153   <option>--verbose</option></term>
    154   <listitem>
    155 <para>Show results on the console.</para>
    156 
     160  <para>Show summary of options.</para>
    157161  </listitem>
    158162  </varlistentry>
    … …  
    160164
    161165  </refsect1>
    162 <refsect1>
    163 <title>BUGS</title>
    164 
    165 <para>For now the program has been only tested on audio signals sampled at 44.1
    166 kHz.</para>
    167 
    168 </refsect1>
     166  <refsect1>
     167  <title>BUGS</title>
     168
     169  <para>For now the program has only been tested on audio signals sampled at
     170  44.1&nbsp;kHz.</para>
     171
     172  </refsect1>
    169173
    170174  <refsect1>
    171175    <title>SEE ALSO</title>
    172176
    173         <para>
    174         <command>aubiocut</command>(1)
    175         <command>aubiotrack</command>(1)
    176         <command>aubionotes</command>(1)
    177         <command>aubiopitch</command>(1)
    178         </para>
    179 
     177    <para>
     178    <command>aubiotrack</command>(1)
     179    <command>aubionotes</command>(1)
     180    <command>aubiocut</command>(1)
     181    <command>aubiopitch</command>(1)
     182    </para>
    180183
    181184  </refsect1>
    … …  
    213216
    214217
    215 

  • doc/aubiopitch.sgml

    r042e095 rbeea3cf  
    5858    <refname>&dhpackage;</refname>
    5959
    60     <refpurpose>a command line tool for real time wav to midi
    61     conversion</refpurpose>
     60    <refpurpose>a command line tool to extract pitch candidates from sound files.</refpurpose>
    6261
    6362  </refnamediv>
    … …  
    7271    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
    7372
    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>
     73    <para>The <emphasis>aubio</emphasis> library provides a small set of
     74    functions to extract events and objects from audio, from live streams or
     75    still files. Onsets are used to label the beginning of notes, pitches to
     76    label their height.</para>
     77
     78    <para><command>&dhpackage;</command> attempts to extract fundamental
     79    frequency in sound files. When no pitch candidate is found, the output is
     80    0. Five fundamental frequency extraction methods are available. Results can
     81    be printed in Hertz or in MIDI pitch.</para>
     82
     83    <para>A plotting module is available via the Gnuplot Python package.</para>
    7984
    8085  </refsect1>
    … …  
    172177  </varlistentry>
    173178  <varlistentry>
     179  <term><option>-q</option>
     180  <option>--quiet</option></term>
     181  <listitem>
     182  <para>be quiet</para>
     183  </listitem>
     184  </varlistentry>
     185  <varlistentry>
     186  <term><option>-h</option>
     187  <option>--help</option></term>
     188  <listitem>
     189  <para>Show a summary of options.</para>
     190  </listitem>
     191  </varlistentry>
     192  <varlistentry>
     193  <term><option>-v</option>
     194  <option>--verbose</option></term>
     195  <listitem>
     196  <para>make lots of noise [default]</para>
     197  </listitem>
     198  </varlistentry>
     199  </variablelist>
     200
     201  <refsect2>
     202    <title>Plotting options</title>
     203
     204  <para>When the Python interface to Gnuplot is installed, the following
     205  additional options are available.</para>
     206
     207  <variablelist>
     208  <varlistentry>
    174209  <term><option>-p</option>
    175210  <option>--plot</option></term>
    … …  
    186221  </varlistentry>
    187222  <varlistentry>
     223  <term><option>-x</option>
     224  <option>--xsize=SIZE</option></term>
     225  <listitem>
     226  <para>define horizontal plot size [default=1.]</para>
     227  </listitem>
     228  </varlistentry>
     229  <varlistentry>
     230  <term><option>-y</option>
     231  <option>--ysize=SIZE</option></term>
     232  <listitem>
     233  <para>define vertical plot size [default=1.]</para>
     234  </listitem>
     235  </varlistentry>
     236  <varlistentry>
    188237  <term><option>-O</option>
    189238  <option>--outplot=OUTPLOT</option></term>
    … …  
    192241  </listitem>
    193242  </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>
     243  </variablelist>
     244  </refsect2>
     245
     246  </refsect1>
     247  <refsect1>
     248  <title>BUGS</title>
     249
     250  <para>For now the program has only been tested on audio signals sampled at
     251  44.1&nbsp;kHz.</para>
     252
     253  </refsect1>
     254
    219255  <refsect1>
    220256    <title>SEE ALSO</title>
    221257
    222258    <para>
     259    <command>aubioonset</command>(1)
     260    <command>aubiotrack</command>(1)
    223261    <command>aubionotes</command>(1)
    224     <command>aubioonset</command>(1)
    225262    <command>aubiocut</command>(1)
    226     <command>aubiotrack</command>(1)
    227263    </para>
    228264

  • doc/aubiotrack.sgml

    r042e095 rbeea3cf  
    6363  <refsynopsisdiv>
    6464    <cmdsynopsis>
    65       <command>&dhpackage; <parameter>[options]</parameter></command>
     65      <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
    6666    </cmdsynopsis>
    6767  </refsynopsisdiv>
    … …  
    7070
    7171    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
     72
     73    <para>The <emphasis>aubio</emphasis> library provides a small set of
     74    functions to extract events and objects from audio, from live streams or
     75    still files. Onsets are used to label the beginning of notes, pitches to
     76    label their height.</para>
    7277
    7378    <para><command>&dhpackage;</command> attempts to tap the beat and detect
    7479    beat locations in musical sounds. When started with an input file argument
    7580    (<option>-i</option>), aubiotrack print the beat locations in second
    76     detected in the file. Without an input file is given, aubiotrack will start
    77     as a jack client and play a woodblock sound at predicted beat
    78     locations.</para>
     81    detected in the file.</para>
     82   
     83    <para>When started without an input file argument
     84    (<option>--input</option>), <command>&dhpackage;</command> creates jack
     85    input and output ports. When an input file is given, the results are given
     86    on the console.</para>
    7987
    8088  </refsect1>
    … …  
    8290    <title>OPTIONS</title>
    8391
    84 <para>This program follows the usual GNU command line syntax, with long options
    85 starting with two dashes (`-').  A summary of options is included below.</para>
     92    <para>This program follows the usual GNU command line syntax, with long
     93    options starting with two dashes (`-').  A summary of options is included
     94    below.</para>
    8695
    8796<variablelist>
    … …  
    9099  <option>--input filein</option></term>
    91100  <listitem>
    92 <para>Run analysis on this audio file. Most common (uncompressed) formats are
    93 supported.</para>
     101
     102  <para>Run analysis on this audio file. Most common uncompressed formats are
     103  supported.</para>
     104
    94105  </listitem>
    95106  </varlistentry>
    … …  
    100111
    101112  <para>Save results in this file. The file will be created on the model of the
    102   input file. Results are marked by a very short wood-block sample.</para>
     113  input file. Results are marked by a short wood-block sample.</para>
    103114
    104115  </listitem>
    … …  
    125136  <para>Set the threshold value for the onset peak picking. Typical values are
    126137  within <literal>0.001</literal> and <literal>0.900</literal>. Default is
    127   <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
    128   sensible</emphasis>.  Try <literal>0.3</literal> in case of
    129   over-detections.</para>
     138  <literal>0.1</literal>. <emphasis>Lower</emphasis> threshold values imply
     139  <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
     140  case of over-detections.</para>
    130141
    131142  </listitem>
    … …  
    135146  <option>--jack</option></term>
    136147  <listitem>
    137 <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
     148  <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
     149  </listitem>
     150  </varlistentry>
     151  <varlistentry>
     152  <term><option>-v</option>
     153  <option>--verbose</option></term>
     154  <listitem>
     155  <para>Show results on the console (default).</para>
    138156  </listitem>
    139157  </varlistentry>
    … …  
    142160  <option>--help</option></term>
    143161  <listitem>
    144 <para>Show summary of options.</para>
    145   </listitem>
    146   </varlistentry>
    147   <varlistentry>
    148   <term><option>-v</option>
    149   <option>--verbose</option></term>
    150   <listitem>
    151 <para>Show results on the console.</para>
    152 
     162  <para>Show summary of options.</para>
    153163  </listitem>
    154164  </varlistentry>
    … …  
    156166
    157167  </refsect1>
     168  <refsect1>
     169  <title>BUGS</title>
     170
     171  <para>For now the program has only been tested on audio signals sampled at
     172  44.1&nbsp;kHz.</para>
     173
     174  </refsect1>
     175
    158176  <refsect1>
    159177    <title>SEE ALSO</title>
    … …  
    161179    <para>
    162180    <command>aubioonset</command>(1)
     181    <command>aubionotes</command>(1)
    163182    <command>aubiocut</command>(1)
    164     <command>aubionotes</command>(1)
    165183    <command>aubiopitch</command>(1)
    166184    </para>
    167185
    168186  </refsect1>
    169 
    170 <refsect1>
    171 <title>BUGS</title>
    172 
    173 <para>For now the program has been only tested on audio signals sampled at 44.1
    174 kHz.</para>
    175 
    176 </refsect1>
    177187
    178188  <refsect1>
    … …  
    208218
    209219
    210 
Note: See TracChangeset for help on using the changeset viewer.