Fomus

Accessors

instr-sym

this is a unique symbol identifying the instrument. it is used as a lookup value so that it may easily be specified in part objects.

instr-clefs

this is either a symbol or list of symbols, specifying valid clefs for the instrument in order of preference. the following clefs are supported: :bass, :c-baritone, :f-baritone, :tenor, :alto, :mezzosoprano, :soprano, :treble and :percussion. the user may also add an -8up or -8dn suffix to the symbol to specify an octave transposition.

instr-staves

this is an integer specifying the number of staves to use. the default is 1.

instr-minp

this is an integer specifying the lowest pitch in the instrument's range. it may also be set to nil, in which case the lower range is considered to be unlimited. this is only useful if the check-ranges setting is set to t.

instr-maxp

this is an integer specifying the highest pitch in the instrument's range. it may also be set to nil, in which case the upper range is considered to be unlimited. this is only useful if the check-ranges setting is set to t.

instr-simultlim

this is an integer of 1 or greater specifying the maximum number of simultaneous pitches allowed in a single voice. it may also be set to nil, indicating that there is no limit.

instr-tpose

this is set to the value nil or an integer indicating the number of semitones to transpose the instrument before notating it. this number only has an effect if the transpose setting is set to t.

instr-cleflegls

the value of this slot influences how fomus decides when to change clefs. a clef change isn't considered necessary until the number of ledger lines required exceeds a threshold value. other factors determine if there is actually a clef change or not. if the value is an integer, it designates the threshold number of ledger lines in all cases. if it's a list, the first element of the list must be an integer specifying a default threshold. this is followed by one or more exceptions, each in the form of a list. this exception list contains a clef symbol (see the slot above) followed by one of the two symbols :up or :dn and ended by an integer specifying the number of ledger lines. an example illustrates this data structure.

'(2 (:bass :up 3) (:tenor :down 3))

instr-8uplegls

this value influences how fomus chooses where to place ottava brackets above the staff. an ottava bracket isn't considered necessary until the number of ledger lines required exceeds a threshold value. an integer in this slot indicates the threshold value, while a list of two elements specifies the threshold for the ottava bracket to begin and the threshold below which the number of ledger lines must drop for it to end.

instr-8dnlegls

this is the same as instr-8uplegls above, only for ottava brackets placed below the staff

instr-percs

this is a list of symbols, perc objects, numbers or lists indicating all of the percussion instruments that are to be notated together as a group. perc objects provide necessary extra information for notating percussion. all of these value types function to lookup percussion instruments in the same way as the slot of the part class. symbols are used as lookup values into a user-defined percussion instrument table (see the percussion setting) or fomus's own predefined table. lists contain a symbol lookup value followed by keyword-argument pairs signifying values to replace in the predefined percussion table–it will usually be necessary to use a list instead of a symbol since the and slots are empty in fomus's table.

(list '(:low-tom :note 0 :voice 1) '(:high-tom :note 4 :voice 1)
      (make-perc :anvil :note -3 :voice 2 :midinote-ex 79))

midiprgch-im

this is a number from 0 to 127 or a list of such numbers specifying which midi program change values can translate to this instrument. this is used when specifying an instrument as a program change number (see the slot in the part class) or calling the get-midi-instr function. when given a program change number, fomus finds the first instrument that matches in its list.

midiprgch-ex

this is usually a number from 0 to 127 specifying which program change value is to be used when exporting midi data. it can also be set to a list, the first element of which is the number mentioned above followed by keyword/value pairs indicating alternate program change values for different playing modes. (for example, the list '(40 :pizz 45) is a valid value for a violin instrument.) the keywords currently allowed are :pizz, :stopped, :open and :harmonic. (more will be added in future releases.)