Changeset e06e478


Ignore:
Timestamp:
Aug 21, 2005, 6:43:10 PM (16 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
66834b6
Parents:
2ebf76c
Message:

updated manpages

Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/aubionotes.sgml

    r2ebf76c re06e478  
    2727  <!ENTITY dhemail     "<email>piem@altern.org</email>">
    2828  <!ENTITY dhusername  "Paul Brossier">
    29   <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
     29  <!ENTITY dhucpackage "<refentrytitle>AUBIONOTES</refentrytitle>">
    3030  <!ENTITY dhpackage   "aubionotes">
    3131
     
    103103  <option>--output fileout</option></term>
    104104  <listitem>
    105 <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>
     105
     106  <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>
     108
     109  </listitem>
     110  </varlistentry>
     111  <varlistentry>
     112  <term><option>-P</option>
     113  <option>--pitch mode</option></term>
     114  <listitem>
     115
     116  <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>
     119
     120  </listitem>
     121  </varlistentry>
     122  <varlistentry>
     123  <term><option>-O</option>
     124  <option>--onset mode</option></term>
     125  <listitem>
     126
     127  <para>The onset detection function to run. Available functions are
     128  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
     129  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
     130  <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
     131  <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
     132  domain are used in parallel.</para>
     133
    107134  </listitem>
    108135  </varlistentry>
     
    111138  <option>--threshold value</option></term>
    112139  <listitem>
    113 <para>Set the threshold value for the onset peak picking. Typical values are within
    114 <literal>0.001</literal> and <literal>0.900</literal>. Default is <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
    115 sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
    116   </listitem>
    117   </varlistentry>
    118   <varlistentry>
    119   <term><option>-O</option>
    120   <option>--onset value</option></term>
    121   <listitem>
    122 
    123   <para>The onset detection function to run. Can be one of
    124   <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
    125   <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
    126   <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
    127   complex domain and HFC are used in parallel.</para>
     140
     141  <para>Set the threshold value for the onset peak picking. Typical values are
     142  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>
    128146
    129147  </listitem>
     
    157175    <title>SEE ALSO</title>
    158176
    159     <para><emphasis>aubioonset</emphasis> (1)</para>
     177    <para><command>aubioonset</command> (1)</para>
    160178
    161179  </refsect1>
  • doc/aubioonset.sgml

    r2ebf76c re06e478  
    2727  <!ENTITY dhemail     "<email>piem@altern.org</email>">
    2828  <!ENTITY dhusername  "Paul Brossier">
    29   <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
     29  <!ENTITY dhucpackage "<refentrytitle>AUBIOONSET</refentrytitle>">
    3030  <!ENTITY dhpackage   "aubioonset">
    3131
     
    5858    <refname>&dhpackage;</refname>
    5959
    60     <refpurpose>an sound file onset detector</refpurpose>
     60    <refpurpose>a command line tool for real time onset extraction</refpurpose>
     61
    6162  </refnamediv>
    6263  <refsynopsisdiv>
     
    7071    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
    7172
    72 <para>The library <emphasis remap='B'>aubio</emphasis> provides a small set of functions to extract events and
    73 objects from audio, from live streams or still files. Onsets are used to label
    74 the beginning of notes, pitches to label their height.</para>
    75 
    76 <para><command>aubionotes</command> is still in an experimental state. Its aim is to segment notes
    77 with onsets, and label them with their detected pitch. When started without an
    78 input file argument (<option>-i</option>), aubionotes creates a jack input and a midi
    79 output. When an input file is given, it outputs the results on the console.</para>
     73<para>The library <emphasis>aubio</emphasis> provides a small set of functions
     74to extract events and objects from audio, from live streams or still files.
     75Onsets are used to label the beginning of notes, pitches to label their
     76height.</para>
     77
     78<para><command>aubionotes</command> is still in an experimental state. Its aim
     79is to segment notes with onsets, and label them with their detected pitch. When
     80started without an input file argument (<option>-i</option>), aubionotes
     81creates a jack input and a midi output. When an input file is given, it outputs
     82the results on the console.</para>
    8083
    8184  </refsect1>
     
    8386    <title>OPTIONS</title>
    8487
    85 <para>This program follows the usual GNU command line syntax, with long
    86 options starting with two dashes (`-').
    87 A summary of options is included below.</para>
     88<para>This program follows the usual GNU command line syntax, with long options
     89starting with two dashes (`-').  A summary of options is included below.</para>
     90
    8891<variablelist>
    8992  <varlistentry>
     
    99102  <option>--output fileout</option></term>
    100103  <listitem>
    101 <para>Save results in this file. The file will be created on the model of the input
    102 file. Results are marked by a very short wood-block sample.</para>
     104
     105  <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>
     107
     108  </listitem>
     109  </varlistentry>
     110  <varlistentry>
     111  <term><option>-O</option>
     112  <option>--onset mode</option></term>
     113  <listitem>
     114
     115  <para>The onset detection function to run. Available functions are
     116  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
     117  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
     118  <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
     119  <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
     120  domain are used in parallel.</para>
     121
    103122  </listitem>
    104123  </varlistentry>
     
    107126  <option>--threshold value</option></term>
    108127  <listitem>
    109 <para>Set the threshold value for the onset peak picking. Typical values are within
    110 <literal>0.001</literal> and <literal>0.900</literal>. Default is <literal>0.1</literal>. The <emphasis remap='B'>lower</emphasis> the <emphasis remap='B'>more
    111 sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
    112   </listitem>
    113   </varlistentry>
    114   <varlistentry>
    115   <term><option>-O</option>
    116   <option>--onset value</option></term>
    117   <listitem>
    118 
    119   <para>The onset detection function to run. Can be one of
    120   <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
    121   <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
    122   <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
    123   complex domain and HFC are used in parallel.</para>
     128
     129  <para>Set the threshold value for the onset peak picking. Typical values are
     130  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>
    124134
    125135  </listitem>
Note: See TracChangeset for help on using the changeset viewer.