← Back to branch summary

~ubuntu-branches/ubuntu/raring/muse/raring

« back to all changes in this revision

Viewing changes to share/scripts/README.txt

  • Committer: Package Import Robot
  • Author(s): Alessio Treglia
  • Date: 2011-08-12 11:16:41 UTC
  • mfrom: (1.1.9) (10.1.6 sid)
  • Revision ID: package-import@ubuntu.com-20110812111641-sjz0e93fr0ozfv0b
Tags: 2.0~beta2-1
http://bugs.debian.org/627371
http://bugs.debian.org/604584
http://bugs.debian.org/570833
* New maintainer (see bug 637185#12), thanks Daniel!
* New upstream release (Closes: #627371):
  - New interface Qt4-based (Closes: #604584)
* Refresh packaging:
  - Move to DH7 and source format 3.0 (quilt).
  - Refresh patchset.
  - Fix a bunch lintian warnings.
  - debian/postinst:
    + Use set -e in the body rather than pass -e on the #! line to make it
      have actually effect if it is run by hand with "sh /path/to/script".
  - Update instructions on how-to increase RTC clock frequency.
    Thanks to Torquil Macdonald Sørensen for the report (Closes: #570833).
  - Bump Standards.

Show diffs side-by-side

added added

removed removed

Lines of Context:
share/scripts/README.txt
 
1
MusE midi event scripting format 0.5
 
2
 
 
3
Some information for the budding script writer, here is some info 
 
4
about the format currently used.
 
5
     
 
6
Scripts can be put in two different dirs.
 
7
<install_path>/share/muse/scripts
 
8
for scripts bundled
 
9
or $HOME/.muse/scripts
 
10
for user created scripts
 
11
 
 
12
There are two main requirements on scripts.
 
13
 
 
14
1. a script must have the executable flag set, that is, it must be considered 
 
15
an executable from the perspective of the operating system.
 
16
2. a script shall take an input file as argument and will update this
 
17
file with the sought output.
 
18
 
 
19
The tags that may occur in the file sent to the script are:
 
20
PARTLEN <len in ticks>
 
21
BEATLEN <len in ticks>
 
22
QUANTLEN <len in ticks>
 
23
NOTE <tick> <pitch> <len in ticks> <velocity>
 
24
CONTROLLER <tick> <a> <b> <c>
 
25
 
 
26
PARTLEN, BEATLEN and QUANTLEN are there for informational purposes, to 
 
27
make some transformations possible. e.g. quantization, beat delay.
 
28
 
 
29
NOTE and CONTROLLER are the ones that are read back into MusE when the filter
 
30
stops executing. These may be manipulated, removed or multiplied as seen
 
31
fit by the filter.
 
32
-- Note that it is a good idea to just pass on the lines your script is not
 
33
interested in, otherwise data may unintentionally be removed --
 
34
 
 
35
A short example in pyton that does nothing but pass on output from input 
 
36
to output is available in script DoNothing