mas01mj@715: Using CAMUS
mas01mj@715: ===========
mas01mj@715: 
mas01mj@715: 1. Installation
mas01mj@715: 
mas01mj@715: To install CAMUS, simply drag the application icon onto your
mas01mj@715: Applications folder. It should then run from this location.
mas01mj@715: 
mas01mj@715: 2. Functionality
mas01mj@715: 
mas01mj@715: Creating a new database
mas01mj@715: =======================
mas01mj@715: 
mas01mj@715: 1. Choose New from the File menu.
mas01mj@715: 2. Select the feature type for the database: pitch allows for
mas01mj@715: comparison based on harmonic or pitch content; timbre based on a
mas01mj@715: broader measure (e.g. for non-pitched instruments).
mas01mj@715: 3. Specify the maximum number of tracks you would like to store in
mas01mj@715: the database.
mas01mj@715: 4. Specify the length, in seconds, of the longest track (e.g. if
mas01mj@715: your longest track is 5 minutes, choose 300).
mas01mj@715: 5. Specify the slice size in milliseconds.
mas01mj@715: 6. Press Create, and then enter the filename where you would like
mas01mj@715: to store your database. Press Save to create it. The file will have
mas01mj@715: a .adb extension, and an associated file with a .plist extension:
mas01mj@715: if you call your database mydb.adb, there will be mydb.plist alongside
mas01mj@715: it. myadb.plist contains the database configuration and content
mas01mj@715: information.
mas01mj@715: 
mas01mj@715: Adding files to an open database
mas01mj@715: ================================
mas01mj@715: 
mas01mj@715: 1. Either click 'Add' from the CAMUS toolbar, or 'Import Audio'
mas01mj@715: from the File menu.
mas01mj@715: 2. Select the audio files you would like to import. You can select
mas01mj@715: multiple by holding down Alt or Shift when clicking. Audio files
mas01mj@715: may be MP3, WAV, AIFF, or un-DRMed M4A.
mas01mj@715: 3. Click 'Open' to import.
mas01mj@715: 
mas01mj@715: Querying the database 
mas01mj@715: =====================
mas01mj@715: 
mas01mj@715: 1. Click 'Query' on the CAMUS toolbar.
mas01mj@715: 2. Click 'Select File' and choose the file to query against. This
mas01mj@715: must already be present in the database.  Once loaded, Query Start
mas01mj@715: and Query Length are populated with the maximum possible values.
mas01mj@715: 3. Select the query start point, either in vectors or seconds. This
mas01mj@715: is the time into the track at which the query will begin.
mas01mj@715: 4. Select the length of the query, again in either vectors or seconds.
mas01mj@715: 5. If these values are invalid, the Query button will be disabled.
mas01mj@715: Press Reset to revert to the very beginning and the length of the
mas01mj@715: track.
mas01mj@715: 6. If you would like to only retrieve the best match for each track,
mas01mj@715: uncheck the 'Find multiple matches within tracks' checkbox.
mas01mj@715: 7. Press query to carry out the query.
mas01mj@715: 
mas01mj@715: Exploring the results
mas01mj@715: =====================
mas01mj@715: 
mas01mj@715: By default, results are sorted in ascending order of distance. As
mas01mj@715: such, the first match will likely be the query itself. The iPos
mas01mj@715: column specifies the position in the track in seconds, and the bars
mas01mj@715: in the left-most column show the distance in graphical form as a
mas01mj@715: (non-scientific) visual indicator. To play a result, either
mas01mj@715: double-click its entry, or select it and click 'Play Result' in the
mas01mj@715: toolbar. To stop playback, press the stop button while playing. To
mas01mj@715: play the query and the result at the same time, select the result
mas01mj@715: and click 'Play Both' in the toolbar.
mas01mj@715: 
mas01mj@715: 3. Behind the Scenes
mas01mj@715: 
mas01mj@715: CAMUS makes use of audioDB (http://omras2.org/audioDB) for similarity
mas01mj@715: matching and Sonic Annotator (http://omras2.org/SonicAnnotator) to
mas01mj@715: extract features from audio via its Vamp plugins
mas01mj@715: (http://vamp-plugins.org/). librdf and its associated libraries are
mas01mj@715: bundled to handle the import of features in N3 format.
mas01mj@715: 
mas01mj@715: 4. Feedback
mas01mj@715: 
mas01mj@715: To report bugs or feedback, please email mas01mj@gold.ac.uk.
mas01mj@715: 
mas01mj@713: Requirements:
mas01mj@713: 
mas01mj@715: * CAMUS requires BWToolkit, which was not included for space reasons.
mas01mj@715: It is freely available at http://brandonwalkin.com/bwtoolkit/. The
mas01mj@715: BWToolkitFramework.framework file should be placed into this folder
mas01mj@715: prior to recompilation.
mas01mj@715: * All other libraries are included, with their binaries patched to
mas01mj@715: allow for their bundling within the CAMUS application.