Mercurial > hg > cmdp

comparison src/uk/ac/qmul/eecs/depic/daw/package-info.java @ 4:473da40f3d39 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added html formatting to Daw/package-info.java
author Fiore Martin <f.martin@qmul.ac.uk>
date Thu, 25 Feb 2016 17:50:09 +0000
parents 7f18cc173c4e
children
comparison
equal deleted inserted replaced
3:7f18cc173c4e 4:473da40f3d39
1 /** 1 /**
2 * 2 * <p>
3 * This package contains the core data of the program. The data model as in the Model-View-Control paradigm 3 * This package contains the core data of the program. The data model as in the Model-View-Control paradigm
4 * It abstracts over the sound engine, that is it provides an abstract interface over the specific sound engine 4 * It abstracts over the sound engine, that is it provides an abstract interface over the specific sound engine
5 * so that it can be reused with other audio systems. The SoundEnfingeFactory class is the entry point for a 5 * so that it can be reused with other audio systems. The SoundEnfingeFactory class is the entry point for a
6 * any sound engine package. The entry point for the sound engine is {@code Daw.getSoundEngineFactory()} 6 * any sound engine package. The entry point for the sound engine is {@code Daw.getSoundEngineFactory()}
7 * so you'd need to modify that call to make your own sound engine. 7 * so you'd need to modify that call to make your own sound engine.
8 * 8 * </p>
9 * <p>
9 * As per the faced design pattern all the functionality of a sound engine package would be attained by 10 * As per the faced design pattern all the functionality of a sound engine package would be attained by
10 * providing an implementation of the {@code SoundEngineFactory} factory interface and of, the interface types 11 * providing an implementation of the {@code SoundEngineFactory} factory interface and of, the interface types
11 * returned by its methods (SoundWave, Parameter, Sonification and Sample) and by SoundWave's methods. 12 * returned by its methods (SoundWave, Parameter, Sonification and Sample) and by SoundWave's methods.
13 * </p>
14 * <p>
15 * A default sound engine is provided using the Beads library (see uk.ac.qmul.eecs.depic.daw.beads package).
16 * </p>
12 * 17 *
13 * A default sound engine is provided using the Beads library (see uk.ac.qmul.eecs.depic.daw.beads package). 18 * <h1>USAGE of the Cross-Modal DAW prototype program</h1>
14 *
15 * 19 *
16 * USAGE of the Cross-Modal DAW prototype program 20 * <p>
17 * 21 * Open a sound file: only mono and short wav files are supported. The wave is placed where the cursor is at the moment of opening.
18 * open a sound file: only mono and short wav files are supported. The wave is placed where the cursor is at the moment of opening. 22 * </p>
19 * 23 * <p>
20 * edit commands: cut copy and paste can be done by the usual key strokes or from the Edit menu. The cut and copy commands take the 24 * edit commands: cut copy and paste can be done by the usual key strokes or from the Edit menu. The cut and copy commands take the
21 * part of wave in the audio track selection and paste pastes it where the cursor is. 25 * part of wave in the audio track selection and paste pastes it where the cursor is.
22 * 26 * </p>
27 * <p>
23 * selection: You make a selection by dragging your mouse on an audio track or using left and right arrow keys to move 28 * selection: You make a selection by dragging your mouse on an audio track or using left and right arrow keys to move
24 * the cursor while holding shift. F2 and F3 keys move the cursor at the edges of the selection. 29 * the cursor while holding shift. F2 and F3 keys move the cursor at the edges of the selection.
25 * 30 * </p>
31 * <p>
26 * View menu: use the items in the "View" menu to change the view of the wave. "Generate Peaks Curve" creates a graph with the 32 * View menu: use the items in the "View" menu to change the view of the wave. "Generate Peaks Curve" creates a graph with the
27 * peak level overlaid on the audio track. If you press right-click on the audio track when the peak curve is visible you 33 * peak level overlaid on the audio track. If you press right-click on the audio track when the peak curve is visible you
28 * can enable the sonification of the peak level graph. "Listen to peak level" will play the whole track from the start to the end 34 * can enable the sonification of the peak level graph. "Listen to peak level" will play the whole track from the start to the end
29 * together with the sonification. 35 * together with the sonification.<br>
30 * "Switch listen peak level on/off" enables and disables the active sonification. In the active sonification it is the user who must 36 * "Switch listen peak level on/off" enables and disables the active sonification. In the active sonification it is the user who must
31 * scan the track with left/right arrow keys and the sonification plays what's under the cursor. The active sonification 37 * scan the track with left/right arrow keys and the sonification plays what's under the cursor. The active sonification
32 * can also be enabled by pressing ctrl+p when the focus is on the audio track ( to focus the audio track tab through all the 38 * can also be enabled by pressing ctrl+p when the focus is on the audio track ( to focus the audio track tab through all the
33 * components until you reach the audio track) 39 * components until you reach the audio track)
34 * 40 * </p>
41 * <p>
35 * Track menu: "Cancel selection" removes the audio track selection. "Switch automation" enables the automation graph, for gain 42 * Track menu: "Cancel selection" removes the audio track selection. "Switch automation" enables the automation graph, for gain
36 * and panning, overlaid on the audio track. When the automation is enabled you can access the automation actions by right 43 * and panning, overlaid on the audio track. When the automation is enabled you can access the automation actions by right
37 * clicking on the automation graph. This allows you to insert/remove automation points, reset the automation and enable 44 * clicking on the automation graph. This allows you to insert/remove automation points, reset the automation and enable
38 * the automation graph sonification that works the same way as the sonification of the peak level graph. 45 * the automation graph sonification that works the same way as the sonification of the peak level graph.
39 * 46 * </p>
47 * <p>
40 * Haptics: "Start haptic device" starts the phantom omni haptic device. Note you need to have the driver installed and the device 48 * Haptics: "Start haptic device" starts the phantom omni haptic device. Note you need to have the driver installed and the device
41 * plugged in. Also you need to have the open haptics toolkit installed. 49 * plugged in. Also you need to have the open haptics toolkit installed.
42 * "Activate current view in haptics" (ctrl+h) will create a haptic representation of one of the following: automation, peak level 50 * "Activate current view in haptics" (ctrl+h) will create a haptic representation of one of the following: automation, peak level
43 * graph, sound wave. Which one depends on what is currently visible: automation overlay, peak level overlay or just the simple wave. 51 * graph, sound wave. Which one depends on what is currently visible: automation overlay, peak level overlay or just the simple wave.
44 * To switch to another type of haptics representation, just make it visible and press ctrl+h again. 52 * To switch to another type of haptics representation, just make it visible and press ctrl+h again.
45 * 53 * </p>
46 * 54 *
47 */ 55 */
48 package uk.ac.qmul.eecs.depic.daw; 56 package uk.ac.qmul.eecs.depic.daw;