This module represents instruments through objects that contain general information such as Metadata for instrument names, classifications, transpositions and default MIDI program numbers. It also contains information specific to each instrument or instrument family, such as string pitches, etc. Information about instrumental ensembles is also included here though it may later be separated out into its own ensemble.py module.
return the name of a generic ensemble with “number” players:
>>> from music21 import *
>>> instrument.ensembleNameBySize(4)
'quartet'
>>> instrument.ensembleNameBySize(1)
'solo'
>>> instrument.ensembleNameBySize(83)
'treoctogetet'
return the instrument with “number” as its assigned midi program:
>>> from music21 import *
>>> instrument.instrumentFromMidiProgram(0)
<music21.instrument.Instrument Piano>
>>> instrument.instrumentFromMidiProgram(21)
<music21.instrument.Instrument Accordion>
>>> instrument.instrumentFromMidiProgram(500)
...
InstrumentException: No instrument found with given midi program
Inherits from: Music21Object, JSONSerializer
Base class for all musical instruments. Designed for subclassing, though usually a more specific instrument class (such as StringInstrument) would be better to subclass.
Instrument attributes
- classSortOrder¶
Property which returns an number (int or otherwise) depending on the class of the Music21Object that represents a priority for an object based on its class alone – used as a tie for stream sorting in case two objects have the same offset and priority. Lower numbers are sorted to the left of higher numbers. For instance, Clef, KeySignature, TimeSignature all come (in that order) before Note. All undefined classes have classSortOrder of 20 – same as note.Note
>>> from music21 import * >>> tc = clef.TrebleClef() >>> tc.classSortOrder 0 >>> ks = key.KeySignature(3) >>> ks.classSortOrder 1New classes can define their own default classSortOrder
>>> class ExampleClass(base.Music21Object): ... classSortOrderDefault = 5 ... >>> ec1 = ExampleClass() >>> ec1.classSortOrder 5Attributes without Documentation: instrumentId, instrumentName, partAbbreviation, partName, highestNote, midiChannel, midiProgram, instrumentAbbreviation, transposition, lowestNote, partId
Attributes inherited from Music21Object: hideObjectOnPrint, id, groups
Instrument properties
- mx¶
- Return a mxScorePart based on this instrument.
Properties inherited from Music21Object: activeSite, beat, beatDuration, beatStr, beatStrength, classes, derivationHierarchy, duration, measureNumber, offset, priority
Properties inherited from JSONSerializer: json
Instrument methods
- autoAssignMidiChannel(usedChannels=[])¶
Assign an unused midi channel given a list of used ones. assigns the number to self.midiChannel and returns it as an int. Note that midi channel 10 is special, and thus is skipped. Currently only 16 channels are used.
>>> from music21 import instrument >>> used = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11] >>> i = instrument.Violin() >>> i.autoAssignMidiChannel(used) 12 >>> i.midiChannel 12
- bestName()¶
- Find a viable name, looking first at instrument, then part, then abbreviations.
- instrumentIdRandomize()¶
- Force a unique id by using an MD5
- partIdRandomize()¶
- Force a unique id by using an MD5
Methods inherited from Music21Object: searchParentByAttr(), getContextAttr(), setContextAttr(), addContext(), addLocation(), addLocationAndActiveSite(), freezeIds(), getAllContextsByClass(), getCommonSiteIds(), getCommonSites(), getContextByClass(), getOffsetBySite(), getSiteIds(), getSites(), getSpannerSites(), hasContext(), mergeAttributes(), purgeLocations(), removeLocationBySite(), removeLocationBySiteId(), setOffsetBySite(), show(), splitAtDurations(), splitAtQuarterLength(), splitByQuarterLengths(), unfreezeIds(), unwrapWeakref(), wrapWeakref(), write()
Methods inherited from JSONSerializer: jsonAttributes(), jsonComponentFactory(), jsonPrint(), jsonRead(), jsonWrite()
Inherits from: Organ, Instrument, Music21Object, JSONSerializer
Inherits from: Guitar, StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Guitar, StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Vocalist, Instrument, Music21Object, JSONSerializer
Inherits from: Saxophone, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Vocalist, Instrument, Music21Object, JSONSerializer
Inherits from: Saxophone, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Vocalist, Instrument, Music21Object, JSONSerializer
Inherits from: Clarinet, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
>>> from music21 import *
>>> bcl = instrument.BassClarinet()
>>> bcl.instrumentName
'Bass clarinet'
>>> bcl.midiProgram
71
>>> 'WoodwindInstrument' in bcl.classes
True
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: KeyboardInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: Guitar, StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Guitar, StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Organ, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Guitar, StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: Organ, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: KeyboardInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: BrassInstrument, Instrument, Music21Object, JSONSerializer
>>> from music21 import *
>>> hn = instrument.Horn()
>>> hn.instrumentName
'Horn'
>>> hn.midiProgram
60
>>> 'BrassInstrument' in hn.classes
True
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: Soprano, Vocalist, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Flute, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Flute, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
Inherits from: KeyboardInstrument, Instrument, Music21Object, JSONSerializer
>>> import music21
>>> p = music21.instrument.Piano()
>>> p.instrumentName
'Piano'
>>> p.midiProgram
0
Inherits from: Flute, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Organ, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Flute, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Organ, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Flute, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Vocalist, Instrument, Music21Object, JSONSerializer
Inherits from: Saxophone, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
StringInstrument attributes
Attributes inherited from Instrument: classSortOrder, instrumentId, instrumentName, partAbbreviation, partName, highestNote, midiChannel, midiProgram, instrumentAbbreviation, transposition, lowestNote, partId
Attributes inherited from Music21Object: hideObjectOnPrint, id, groups
StringInstrument properties
- stringPitches¶
stringPitches is a property that stores a list of Pitches (or pitch names, such as “C4”) that represent the pitch of the open strings from lowest to highest.[*]
>>> vln1 = Violin() >>> vln1.stringPitches [G3, D4, A4, E5]instrument.stringPitches are full pitch objects, not just names:
>>> [x.octave for x in vln1.stringPitches] [3, 4, 4, 5]Scordatura for Scelsi’s violin concerto Anahit. (N.B. that string to pitch conversion is happening automatically)
>>> vln1.stringPitches = ["G3","G4","B4","D4"] >>> vln1.stringPitches [G3, G4, B4, D4]([*]In some tuning methods such as reentrant tuning on the ukulele, lute, or five-string banjo the order might not strictly be from lowest to highest. The same would hold true for certain violin scordatura pieces, such as some of Biber’s *Mystery Sonatas*)
Properties inherited from Instrument: mx
Properties inherited from Music21Object: activeSite, beat, beatDuration, beatStr, beatStrength, classes, derivationHierarchy, duration, measureNumber, offset, priority
Properties inherited from JSONSerializer: json
StringInstrument methods
Methods inherited from Instrument: autoAssignMidiChannel(), bestName(), instrumentIdRandomize(), partIdRandomize()
Methods inherited from Music21Object: searchParentByAttr(), getContextAttr(), setContextAttr(), addContext(), addLocation(), addLocationAndActiveSite(), freezeIds(), getAllContextsByClass(), getCommonSiteIds(), getCommonSites(), getContextByClass(), getOffsetBySite(), getSiteIds(), getSites(), getSpannerSites(), hasContext(), mergeAttributes(), purgeLocations(), removeLocationBySite(), removeLocationBySiteId(), setOffsetBySite(), show(), splitAtDurations(), splitAtQuarterLength(), splitByQuarterLengths(), unfreezeIds(), unwrapWeakref(), wrapWeakref(), write()
Methods inherited from JSONSerializer: jsonAttributes(), jsonComponentFactory(), jsonPrint(), jsonRead(), jsonWrite()
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Vocalist, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Saxophone, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: BrassInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: BrassInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: BrassInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: StringInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Flute, WoodwindInstrument, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Percussion, Instrument, Music21Object, JSONSerializer
Inherits from: Instrument, Music21Object, JSONSerializer
Inherits from: PitchedPercussion, Instrument, Music21Object, JSONSerializer