ADTLib

Automated Drum Transcription Library
Log | Files | Refs | README

usage.md (3701B)

      1 # Usage
      2 
      3 This file contains information regarding using the toolbox.
      4 
      5 ### Command line
      6 
      7     ADT [-h] [-od {None,dir}] [-o {yes,no}] [-ot {yes,no}] [I [I ...]]   
      8     
      9 | Flag   | Name           |   Description                                                       | Default setting  |
     10 | ----  |  -------  | ----- |   ------   |   
     11 | -h     |  help             |   displays help file                                              | n/a     |                                        
     12 | -od    |   output_dir      |   location output .txt files are saved                            | None | 
     13 | -o      | output_text     | defines whether the output is stored in a .txt file or not    | yes |
     14 | -ot    |   output_tab     |   defines whether a tabulature is created and saved to a pdf       | yes|
     15 | I      |   input_file_names|   single or list of drum.wav file names separated by spaces                     |  n/a |
     16 
     17 ##### Examples
     18 
     19     ADT Drum.wav
     20     
     21 Perform ADT on a single audio file. Saves onset times to a .txt file in the current directory. Creates a drum tabulature and saves it as a pdf in the current directory.
     22     
     23     ADT Drum.wav Drum1.wav Drum2.wav
     24 
     25 Perform ADT on multiple audio files. Saves onset times to a .txt file in the current directory. Creates a drum tabulature and saves it as a pdf in the current directory.
     26     
     27     ADT -od ~/Desktop -o no ~/Drum.wav ~/Desktop/Drum1.wav 
     28 
     29 Perform ADT on multiple audio files from different directories. Creates a drum tabulature but not a .txt file and saves it to the desktop.
     30 
     31   
     32 ### Python function
     33 
     34 
     35 ```Python
     36 
     37 Onsets=ADT(filenames, text='yes', tab='yes', save_dir=None, output_act='no')
     38 
     39 ```
     40 | Name           |   Description                                                       | Default setting  |
     41 |  -------  | ----- |   ------   |   
     42 |       filenames      | Drum.wav files, must be in a list.                                        | n/a     |                                           
     43 |   text     |   defines whether the output is stored in a .txt file or not ('yes','no' )                           | 'yes' |
     44 |   tab  |   defines whether a tabulature is created and saved to a pdf ('yes','no' )                           | 'yes' |
     45 |   save_dir      |   location output .txt files are saved ('None' (saves in current dir), dir)                     | None | 
     46 |   output_act    |   defines whether the activation functions are also output ('yes','no')                     | 'no' | 
     47 
     48 ##### Examples
     49 
     50 ```Python
     51 from ADTLib import ADT
     52 
     53 Onsets=ADT(['Drum.wav'])
     54 ```
     55 Perform ADT on a single audio file. Saves onset times to a .txt file in the current directory. Creates a drum tabulature and saves it as a pdf in the current directory. Returns onset times per instrument.
     56 
     57 ```Python
     58 from ADTLib import ADT
     59 
     60 Onsets=ADT(['Drum.wav', 'Drum1.wav', 'Drum2.wav'])
     61 ```
     62 Perform ADT on multiple audio files. Saves onset times to a .txt file in the current directory. Creates a drum tabulature and saves it as a pdf in the current directory. Returns onset times per instrument.
     63 
     64 ```Python
     65 from ADTLib import ADT
     66 
     67 Onsets=ADT('~/Drum.wav', '~/Desktop/Drum1.wav', text='no', save_dir='~/Desktop')
     68 ```    
     69 Perform ADT on multiple audio files from different directories. Creates a drum tabulature but not a .txt file and saves it to the desktop. Returns onset times per instrument.
     70 
     71 ```Python
     72 from ADTLib import ADTDT
     73 
     74 [Onsets, ActivationFunctions]=ADT(['Drum.wav'], output_act='yes')
     75 ```    
     76 Perform ADT on a single audio file. Saves onset times to a .txt file in the current directory. Creates a drum tabulature and saves it as a pdf in the current directory. Returns onset times per instrument and activation functions per track, per instrument.
     77 
     78 
     79