3 ZX@sddlmZmZddlZddlZddlZdZdZddiZdZ dZ dZ d:Z dd d d d gZ Gd ddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZGd!d"d"eZGd#d$d$eZGd%d&d&eZGd'd(d(eZGd)d*d*eZGd+d,d,eZGd-d.d.eZGd/ddeZ d0d1Z!d2d3Z"d4d5Z#d6d7Z$d8d9Z%dS);)divisionprint_functionNHEADipan MIDIFileMAJORMINORSHARPSFLATSc@s0eZdZdZdZdZddZddZdd ZdS) GenericEventz@ The event class from which specific events are derived NrcCs||_||_dS)N)tickinsertion_order)selfrrr3/usr/really-local/MIDIUtil/src/midiutil/MidiFile.py__init__,szGenericEvent.__init__cCs|j|jko|j|jkS)a Equality operator. In the processing of the event list, we have need to remove duplicates. To do this we rely on the fact that the classes are hashable, and must therefore have an equality operator (__hash__() and __eq__() must both be defined). Some derived classes will need to override and consider their specific attributes in the comparison. )evtnamer)rotherrrr__eq__0s zGenericEvent.__eq__cCsnt|j}|d|d>}|dA|d?A}|d|d>}|d|d>A}|d |d >}|d A|d ?A}|S) a Return a hash code for the object. This is needed in order to allow GenericObject classes to be used as the key in a dict or set. duplicate objects are removed from the event list by storing all the objects in a set, and then reconstructing the list from the set. The only real requirement for the algorithm is that the hash of equal objects must be equal. There is probably great opportunity for improvements in the hashing function. i]~ ls zGenericEvent.__hash__) __name__ __module__ __qualname____doc__rsec_sort_orderrrrrrrrr %s r csLeZdZdZdZdZdZdfdd Zdd Ze j Z d d Z d d Z Z S)NoteOnz* A class that encapsulates a note rNrcs4||_||_||_||_||_tt|j||dS)N)pitchdurationvolumechannel annotationsuperr%r)rr*r'rr(r)r+r) __class__rrr]s zNoteOn.__init__cCs0|j|jko.|j|jko.|j|jko.|j|jkS)N)rrr'r*)rrrrrrfsz NoteOn.__eq__cCsd|j|j|j|j|jfS)Nz-NoteOn %d at tick %d duration %d ch %d vel %d)r'rr(r*r))rrrr__str__nszNoteOn.__str__cCstd}|j|jB}t|j|}x|D]}|tjd|7}q$W|tjd|7}|tjd|j7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. z>B) midi_statusr*writeVarLengthrstructpackr'r))rprevious_event_tick midibytescodevarTimetimeByterrr serializers  zNoteOn.serialize)Nr)r r!r"r#rr0r$rrr rr.r9 __classcell__rr)r-rr%Usr%csLeZdZdZdZdZdZdfdd Zdd Ze j Z d d Z d d Z Z S)NoteOffz4 A class that encapsulates a Note Off event Nrcs.||_||_||_||_tt|j||dS)N)r'r)r*r+r,r;r)rr*r'rr)r+r)r-rrrs zNoteOff.__init__cCs0|j|jko.|j|jko.|j|jko.|j|jkS)N)rrr'r*)rrrrrrszNoteOff.__eq__cCsd|j|j|j|jfS)Nz"NoteOff %d at tick %d ch %d vel %d)r'rr*r))rrrrr.szNoteOff.__str__cCstd}|j|jB}t|j|}x|D]}|tjd|7}q$W|tjd|7}|tjd|j7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>B)r0r*r1rr2r3r'r))rr4r5r6r7r8rrrr9s  zNoteOff.serialize)Nr)r r!r"r#rr0r$rrr rr.r9r:rr)r-rr;sr;cs@eZdZdZdZdZd fdd ZddZej Z dd Z Z S) Tempoz6 A class that encapsulates a tempo meta-event rrcs$td||_tt|j||dS)Ni)rtempor,r>r)rrr?r)r-rrrszTempo.__init__cCs$|j|jko"|j|jko"|j|jkS)N)rrr?)rrrrrrs  z Tempo.__eq__c Csd}d}d}tjd|j}|dd}t|j|}x|D]}|tjd|7}q:W|tjd|7}|tjd|7}|tjdd7}||7}|S) zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/Qz>Lrz>Br)r2r3r?r1r) rr4r5r6subcodefourbite threebiter7r8rrrr9s  zTempo.serialize)r) r r!r"r#rr$rrr rr9r:rr)r-rr>sr>cs2eZdZdZdZdZdfdd ZddZZS) Copyrightz5 A class that encapsulates a copyright event rrcs"|jd|_tt|j||dS)Nz ISO-8859-1)encodenoticer,rFr)rrrHr)r-rrrs zCopyright.__init__c Csd}d}d}t|j|}x|D]}|tjd|7}q W|tjd|7}|tjd|7}t|j}t|}x|D]} |tjd| 7}qpW||j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/r@r=z>Bb)r1rr2r3lenrH) rr4r5r6rCr7r8 payloadLengthpayloadLengthVarirrrr9s     zCopyright.serialize)r) r r!r"r#rr$rr9r:rr)r-rrFs rFcs2eZdZdZdZdZdfdd ZddZZS) Textz0 A class that encapsulates a text event rrcs"|jd|_tt|j||dS)Nz ISO-8859-1)rGtextr,rNr)rrrOr)r-rrrs z Text.__init__c Csd}d}d}t|j|}x|D]}|tjd|7}q W|tjd|7}|tjd|7}t|j}t|}x|D]} |tjd| 7}qpW||j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/r@rz>BB)r1rr2r3rJrO) rr4r5r6rCr7r8rKrLrMrrrr9s    zText.serialize)r) r r!r"r#rr$rr9r:rr)r-rrNs rNcs2eZdZdZdZdZdfdd ZddZZS) KeySignaturez0 A class that encapsulates a text event rrcs(||_||_||_tt|j||dS)N) accidentalsaccidental_typemoder,rQr)rrrRrSrTr)r-rrr4szKeySignature.__init__cCsd}d}d}d}t|j|}x|D]}|tjd|7}q$W|tjd|7}|tjd|7}|tjd|7}|tjd|j|j7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/r@Yr=z>Bz>b)r1rr2r3rRrSrT)rr4r5r6rC event_subtyper7r8rrrr9;s zKeySignature.serialize)r) r r!r"r#rr$rr9r:rr)r-rrQ-s rQcsDeZdZdZdZdZdZd fdd ZddZe j Z d d Z Z S) ProgramChangez; A class that encapsulates a program change event. rrcs"||_||_tt|j||dS)N) programNumberr*r,rWr)rr*rrYr)r-rrrVszProgramChange.__init__cCs0|j|jko.|j|jko.|j|jko.|j|jkS)N)rrrYr*)rrrrrr\s   zProgramChange.__eq__cCs^d}|j|jB}t|j}x|D]}|tjd|7}q W|tjd|7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>B)r0r*r1rr2r3rY)rr4r5r6r7r8rrrr9ds   zProgramChange.serialize)r) r r!r"r#rr0r$rrr rr9r:rr)r-rrWNsrWcs@eZdZdZdZdZd fdd ZddZej Z d d Z Z S) SysExEventz> A class that encapsulates a System Exclusive event. SysExrrcs"||_||_tt|j||dS)N)manIDpayloadr,rZr)rrr\r]r)r-rrryszSysExEvent.__init__cCsdS)NFr)rrrrrr~szSysExEvent.__eq__cCsd}d}t|j|}x|D]}|tjd|7}qW|tjd|7}tt|jd}x|D]}|tjd|7}q\W|tjd|j7}||j7}|tjdd7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>Br=)r1rr2r3rJr]r\)rr4r5r6r7r8rKlenByterrrr9s   zSysExEvent.serialize)r) r r!r"r#rr$rrr rr9r:rr)r-rrZrsrZcs@eZdZdZdZdZd fdd ZddZej Z d d Z Z S) UniversalSysExEventzH A class that encapsulates a Universal System Exclusive event. UniversalSysExrrcs4||_||_||_||_||_tt|j||dS)N)realTime sysExChannelr6rCr]r,rar)rrrcrdr6rCr]r)r-rrrs zUniversalSysExEvent.__init__cCsdS)NFr)rrrrrrszUniversalSysExEvent.__eq__cCsd}d}t|j|}x|D]}|tjd|7}qW|tjd|7}tt|jd}x|D]}|tjd|7}q\W|jr|tjdd7}n|tjdd7}|tjd|j7}|tjd|j7}|tjd|j 7}||j7}|tjdd7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/r^z>Br~r_) r1rr2r3rJr]rcrdr6rC)rr4r5r6r7r8rKr`rrrr9s$   zUniversalSysExEvent.serialize)r) r r!r"r#rr$rrr rr9r:rr)r-rrasracsDeZdZdZdZdZdZd fdd ZddZe j Z d d Z Z S) ControllerEventz; A class that encapsulates a program change event. rrcs(||_||_||_tt|j||dS)N) parameterr*controller_numberr,rgr)rr*rrjrir)r-rrrszControllerEvent.__init__cCsdS)NFr)rrrrrrszControllerEvent.__eq__cCstd}|j|jB}t|j|}x|D]}|tjd|7}q$W|tjd|7}|tjd|j7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>B)r0r*r1rr2r3rjri)rr4r5r6r7r8rrrr9s  zControllerEvent.serialize)r) r r!r"r#rr0r$rrr rr9r:rr)r-rrgsrgcsDeZdZdZdZdZdZd fdd Zdd Ze j Z d d Z Z S) ChannelPressureEventzJ A class that encapsulates a Channel Pressure (Aftertouch) event. ChannelPressurerrcs"||_||_tt|j||dS)N)r*pressure_valuer,rkr)rr*rrnr)r-rrrszChannelPressureEvent.__init__cCs4|jj|jjko2|j|jko2|j|jko2|j|jkS)N)r-r rrnr*)rrrrrrs  zChannelPressureEvent.__eq__cCsbd}|j|jB}t|j|}x|D]}|tjd|7}q$W|tjd|7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>B)r0r*r1rr2r3rn)rr4r5r6vartickxrrrr9s  zChannelPressureEvent.serialize)r) r r!r"r#rr0r$rrr rr9r:rr)r-rrksrkcsDeZdZdZdZdZdZd fdd ZddZe j Z d d Z Z S) PitchWheelEventz? A class that encapsulates a pitch wheel change event. rrcs"||_||_tt|j||dS)N)r*pitch_wheel_valuer,rqr)rr*rrsr)r-rrrszPitchWheelEvent.__init__cCsdS)NFr)rrrrrrszPitchWheelEvent.__eq__cCsd}|j|jB}t|j|}x|D]}|tjd|}q$W|jdd?}|jdd@}|tjd|}|tjd|}|tjd|}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>Bi re)r0r*r1rr2r3rs)rr4r5r6r7r8MSBLSBrrrr9"s  zPitchWheelEvent.serialize)r) r r!r"r#rr0r$rrr rr9r:rr)r-rrqsrqcs@eZdZdZdZdZd fdd ZddZej Z ddZ Z S) TrackNamez; A class that encapsulates a program change event. rcs"|jd|_tt|j||dS)Nz ISO-8859-1)rG trackNamer,rwr)rrrxr)r-rrr:s zTrackName.__init__cCs$|j|jko"|j|jko"|j|jkS)N)rrrx)rrrrrr?s  zTrackName.__eq__cCsd}t|j|}x|D]}|tjd|7}qW|tjdd7}|tjdd7}t|j}t|}x|D]}|tjd|7}qhW||j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/z>BrPr@r)r1rr2r3rJrx)rr4r5r7r8 dataLength dataLengthVarrMrrrr9Fs    zTrackName.serialize)r) r r!r"r#rr$rrr rr9r:rr)r-rrw3srwcs2eZdZdZdZdZdfdd ZddZZS) TimeSignaturez5 A class that encapsulates a time signature. rcs.||_||_||_||_tt|j||dS)N) numerator denominatorclocks_per_ticknotes_per_quarterr,r{r)rrr|r}r~rr)r-rrr_s zTimeSignature.__init__cCsd}d}d}t|j|}x|D]}|tjd|7}q W|tjd|7}|tjd|7}|tjdd7}|tjd|j7}|tjd|j7}|tjd|j7}|tjd|j7}|S)zReturn a bytestring representation of the event, in the format required for writing into a standard midi file. r/r@Xz>BrB)r1rr2r3r|r}r~r)rr4r5r6rCr7r8rrrr9gs zTimeSignature.serialize)r) r r!r"r#rr$rr9r:rr)r-rr{Xs r{c@seZdZdZddZd5ddZd6dd Zd7d d Zd8d d Zd9ddZ d:ddZ d;ddZ dddZd?ddZd@ddZdAd d!ZdBd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4ZdS)C MIDITrackz0 A class that encapsulates a MIDI track cCsBtjddddd|_d|_d|_d|_g|_g|_||_||_ d S) z)Initialize the MIDITrack object. ccccMTrkrr/FN) r2r3 headerStringryMIDIdataclosed eventList MIDIEventListremdep deinterleave)rremoveDuplicatesrrrrrszMIDITrack.__init__Nrc CsB|jjt|||||||d|jjt|||||||ddS)z5 Add a note by chromatic MIDI number )r+rN)rappendr%r;)rr*r'rr(r)r+rrrraddNoteByNumbers  zMIDITrack.addNoteByNumbercCs|jjt|||||ddS)z) Add a controller event. )rN)rrrg)rr*rrjrirrrraddControllerEventszMIDITrack.addControllerEventcCs|jjt||||ddS)z* Add a pitch wheel event. )rN)rrrq)rr*rrsrrrraddPitchWheelEventszMIDITrack.addPitchWheelEventcCs|jjt|||ddS)z4 Add a tempo change (or set) event. )rN)rrr>)rrr?rrrraddTempos zMIDITrack.addTempocCs|jjt||||ddS)z$ Add a SysEx event. )rN)rrrZ)rrr\r]rrrraddSysExszMIDITrack.addSysExreFc Cs"|jjt|||||||ddS)z. Add a Universal SysEx event. )rN)rrra)rrr6rCr]rdrcrrrraddUniversalSysExszMIDITrack.addUniversalSysExcCs|jjt||||ddS)z- Add a program change event. )rN)rrrW)rr*rprogramrrrraddProgramChangeszMIDITrack.addProgramChangecCs|jjt||||ddS)z/ Add a channel pressure event. )rN)rrrk)rr*rrnrrrraddChannelPressureszMIDITrack.addChannelPressurecCs|jjt|||ddS)z) Add a track name event. )rN)rrrw)rrrxrrrr addTrackNames zMIDITrack.addTrackNamec Cs |jjt||||||ddS)z' Add a time signature. )rN)rrr{)rrr|r}r~rrrrraddTimeSignatureszMIDITrack.addTimeSignaturecCs|jjt|||ddS)z( Add a copyright notice )rN)rrrF)rrrHrrrr addCopyrights zMIDITrack.addCopyrightcCs|jjt|||||ddS)z( Add a copyright notice )rN)rrrQ)rrrRrSrTrrrraddKeySignatureszMIDITrack.addKeySignaturecCs|jjt|||ddS)z" Add a text event )rN)rrrN)rrrOrrrraddTexts zMIDITrack.addTextTc Cstjd|}|tjdt|}xF|D]>\}}|tjd|}t|} x| D]} |tjd| }qLWq&W|jjtd||dd||ddS)z1 Change the tuning of MIDI notes z>Brr=)rN)r2r3rJfrequencyTransformrrra) rtuningsrdrc tuningProgamrr] noteNumber frequency MIDIFreqencybyterrrchangeNoteTunings  zMIDITrack.changeNoteTuningcCs2dd|jD|_|jjtd|jr.|jdS)z Process the event list, creating a MIDIEventList, which is then sorted to be in chronological order by start tick. cSsg|]}|qSrr).0evtrrr sz.MIDITrack.processEventList..)keyN)rrsort sort_eventsrdeInterleaveNotes)rrrrprocessEventList szMIDITrack.processEventListcCs&t|j}t||_|jjtddS)z Remove duplicates from the eventList. This function will remove duplicates from the eventList. This is necessary because we the MIDI event stream can become confused otherwise. )rN)setrlistrr)rsrrrrs  zMIDITrack.removeDuplicatescCs*|jr dSd|_|jr|j|jdS)a= Called to close a track before writing This function should be called to "close a track," that is to prepare the actual data stream for writing. Duplicate events are removed from the eventList, and the MIDIEventList is created. Called by the parent MIDIFile object. NT)rrrr)rrrr closeTrack(s zMIDITrack.closeTrackcCs<|j|jtjddddd7_tjdt|j|_dS)zN Write the meta data and note data to the packed MIDI stream. BBBBrr@/z>LN)writeEventsToStreamrr2r3rJry)rrrrwriteMIDIStream<szMIDITrack.writeMIDIStreamcCs,d}x"|jD]}|j|j|7_q WdS)z Write the events in MIDIEvents to the MIDI stream. MIDIEventList is presumed to be already sorted in chronological order. rN)rrr9)rr4eventrrrrMs zMIDITrack.writeEventsToStreamcCsg}i}x|jD]}|jdkrt|jt|j}|jdkrn||krV||j|jn |jg||<|j|q|jdkrt||dkr||j|_|j|q||j|j|q|j|qW||_|jj t ddS)a7 Correct Interleaved notes. Because we are writing multiple notes in no particular order, we can have notes which are interleaved with respect to their start and stop times. This method will correct that. It expects that the MIDIEventList has been time-ordered. r%r;r)rN)r%r;) rrstrr'r*rrrJpoprr)r tempEventListstackr noteeventkeyrrrrZs&          zMIDITrack.deInterleaveNotescCsbt|jdkrdSg}|r|nd}d}x0|jD]&}|j|}|||_|}|j|q.W||_dS)z Adjust Times to be relative, and zero-origined. If adjust is True, the track will be shifted. Regardelss times are converted to relative values here. rN)rJrrr)roriginadjustrinternal_origin runningTickr adjustedTickrrradjustTimeAndOrigins    zMIDITrack.adjustTimeAndOrigincCs(|j|j|j|j|j|jdS)z& Write track to disk. N)writerryr)r fileHandlerrr writeTracks  zMIDITrack.writeTrack)Nr)r)r)r)r)reFr)r)r)r)r)r)r)r)reTrr)r r!r"r#rrrrrrrrrrrrrrrrrrrrrrrrrrrr|s4               ,rc@s eZdZdZddZddZdS) MIDIHeaderaJ Class to encapsulate the MIDI header structure. This class encapsulates a MIDI header structure. It isn't used for much, but it will create the appropriately packed identifier string that all MIDI files should contain. It is used by the MIDIFile class to create a complete and well formed MIDI pattern. cCsVtjddddd|_tjdd|_tjd||_||_tjd||_tjd||_d S) a  Initialize the data structures :param numTracks: The number of tracks the file contains. Integer, one or greater :param file_format: The format of the multi-track file. This should either be ``1`` (the default, and the most widely supported format) or ``2``. :param ticks_per_quarternote: The number of ticks per quarter note is what the Standard MIDI File Format Specification calls "division". Ticks are the integer unit of time in the SMF, and in every MIDI sequencer I am aware of. Common values are 120, 240, 384, 480, 960. Note that all these numbers are evenly divisible by 2,3,4,6,8,12,16, and 24, except 120 does not have 16 as a divisor. rrrhdz>Lz>HN)r2r3r headerSize formatnumnumeric_format numTracksticks_per_quarternote)rr file_formatrrrrrs zMIDIHeader.__init__cCs@|j|j|j|j|j|j|j|j|j|jdS)N)rrrrrr)rrrrr writeFiles     zMIDIHeader.writeFileN)r r!r"r#rrrrrrrs rc@seZdZdZdddddedfddZddZd d Zd;d d ZddZ dd$d%Zd?d&d'Zd@d(d)ZdAd*d+ZdBd-d.Zd/d0ZdCd1d2Zd3d4ZdDd5d6Zd7d8Zd9d:Zd S)Era A class that encapsulates a full, well-formed MIDI file object. This is a container object that contains a header (:class:`MIDIHeader`), one or more tracks (class:`MIDITrack`), and the data associated with a proper and well-formed MIDI file. rTFc Cst|_|dkr|d|_n||_t|j|||_||_d|_||_||_|jr\dd|_ n|j |_ x&t d|jD]}|jj t ||qrWd|_dS)a Initialize the MIDIFile class :param numTracks: The number of tracks the file contains. Integer, one or greater :param removeDuplicates: If set to ``True`` remove duplicate events before writing to disk :param deinterleave: If set to ``True`` deinterleave the notes in the stream :param adjust_origin: If set to ``True`` shift all the events in the tracks so that the first event takes place at time t=0. Default is ``False`` :param file_format: The format of the multi-track file. This should either be ``1`` (the default, and the most widely supported format) or ``2``. :param ticks_per_quarternote: The number of ticks per quarter note is what the Standard MIDI File Format Specification calls "division". Ticks are the integer unit of time in the SMF, and in most if not all MIDI sequencers. Common values are 120, 240, 384, 480, 960. Note that all these numbers are evenly divisible by 2,3,4,6,8,12,16, and 24, except 120 does not have 16 as a divisor. :param eventtime_is_ticks: If set True means event time and duration argument values are integer ticks instead of fractional quarter notes. Note that the default for ``adjust_origin`` will change in a future release, so one should probably explicitly set it. In a format 1 file, it would be a rare cirumstance where adjusting the origin of each track to the track's first note makes any sense. Example: .. code:: # Create a two-track MIDIFile from midiutil.MidiFile import MIDIFile midi_file = MIDIFile(1, adjust_origin=False) A Note on File Formats ---------------------- In previous versions of this code the file written was format 2 (which can be thought of as a collection of independent tracks) but was identified as format 1. In this version one can specify either format 1 or 2. In format 1 files there is a separate tempo track which contains tempo and time signature data, but contains no note data. If one creates a single track format 1 file the actual file has two tracks -- one for tempo data and one for note data. In the track indexing the tempo track can be ignored. In other words track 0 is the note track (the second track in the file). However, tempo and time signature data will be written to the first, tempo track. This is done to try and preserve as much interoperability with previous versions as possible. In a format 2 file all tracks are indexed and the track parameter is interpreted literally. rFcSs|S)Nr)rprrr%sz#MIDIFile.__init__..rN)rtracksrrheader adjust_originrreventtime_is_ticks time_to_ticksquarter_to_tickrangerr event_counter) rrrrrrrrrMrrrrs@  zMIDIFile.__init__cCst||jS)N)rr)rquarternote_timerrrr1szMIDIFile.quarter_to_tickcCst||jS)N)floatr)rticknumrrrtick_to_quarter4szMIDIFile.tick_to_quarterNc CsR|jjdkr|d7}|j|j|||j||j||||jd|jd7_dS)a| Add notes to the MIDIFile object :param track: The track to which the note is added. :param channel: the MIDI channel to assign to the note. [Integer, 0-15] :param pitch: the MIDI pitch number [Integer, 0-127]. :param time: the time at which the note sounds. The value can be either quarter notes [Float], or ticks [Integer]. Ticks may be specified by passing eventtime_is_ticks=True to the MIDIFile constructor. The default is quarter notes. :param duration: the duration of the note. Like the time argument, the value can be either quarter notes [Float], or ticks [Integer]. :param volume: the volume (velocity) of the note. [Integer, 0-127]. :param annotation: Arbitrary data to attach to the note. The ``annotation`` parameter attaches arbitrary data to the note. This is not used in the code, but can be useful anyway. As an example, I have created a project that uses MIDIFile to write `csound `_ orchestra files directly from the class ``EventList``. r)r+rN)rrrrrr)rtrackr*r'timer(r)r+rrraddNote7s  zMIDIFile.addNotecCsD|jjdkr|d7}|j|j|j|||jd|jd7_dS)aU Name a track. :param track: The track to which the name is assigned. :param time: The time (in beats) at which the track name event is placed. In general this should probably be time 0 (the beginning of the track). :param trackName: The name to assign to the track [String] r)rN)rrrrrr)rrrrxrrrrWs  zMIDIFile.addTrackNamercCsF|jjdkrd}|j|j|j||||||jd|jd7_dS)a> Add a time signature event. :param track: The track to which the signature is assigned. Note that in a format 1 file this parameter is ignored and the event is written to the tempo track :param time: The time (in beats) at which the event is placed. In general this should probably be time 0 (the beginning of the track). :param numerator: The numerator of the time signature. [Int] :param denominator: The denominator of the time signature, expressed as a power of two (see below). [Int] :param clocks_per_tick: The number of MIDI clock ticks per metronome click (see below). :param notes_per_quarter: The number of annotated 32nd notes in a MIDI quarter note. This is almost always 8 (the default), but some sequencers allow this value to be changed. Unless you know that your sequencing software supports it, this should be left at its default value. The data format for this event is a little obscure. The ``denominator`` should be specified as a power of 2, with a half note being one, a quarter note being two, and eight note being three, etc. Thus, for example, a 4/4 time signature would have a ``numerator`` of 4 and a ``denominator`` of 2. A 7/8 time signature would be a ``numerator`` of 7 and a ``denominator`` of 3. The ``clocks_per_tick`` argument specifies the number of clock ticks per metronome click. By definition there are 24 ticks in a quarter note, so a metronome click per quarter note would be 24. A click every third eighth note would be 3 * 12 = 36. The ``notes_per_quarter`` value is also a little confusing. It specifies the number of 32nd notes in a MIDI quarter note. Usually there are 8 32nd notes in a quarter note (8/32 = 1/4), so the default value is 8. However, one can change this value if needed. Setting it to 16, for example, would cause the music to play at double speed, as there would be 16/32 (or what could be considered *two* quarter notes for every one MIDI quarter note. Note that both the ``clocks_per_tick`` and the ``notes_per_quarter`` are specified in terms of quarter notes, even is the score is not a quarter-note based score (i.e., even if the denominator is not ``4``). So if you're working with a time signature of, say, 6/8, one still needs to specify the clocks per quarter note. rr)rN)rrrrrr)rrrr|r}r~rrrrrgs 3  zMIDIFile.addTimeSignaturecCs@|jjdkrd}|j|j|j|||jd|jd7_dS)a{ Add notes to the MIDIFile object :param track: The track to which the tempo event is added. Note that in a format 1 file this parameter is ignored and the tempo is written to the tempo track :param time: The time (in beats) at which tempo event is placed :param tempo: The tempo, in Beats per Minute. [Integer] rr)rN)rrrrrr)rrrr?rrrrs  zMIDIFile.addTempocCsD|jjdkr|d7}|j|j|j|||jd|jd7_dS)a, Add a copyright notice to the MIDIFile object :param track: The track to which the notice is added. :param time: The time (in beats) at which notice event is placed. In general this sould be time t=0 :param notice: The copyright notice [String] r)rN)rrrrrr)rrrrHrrrrs  zMIDIFile.addCopyrightrcCsD|jjdkrd}|j|j|j|||||jd|jd7_dS)a Add a Key Signature to a track :param track: The track to which this should be added :param time: The time at which the signature should be placed :param accidentals: The number of accidentals in the key signature :param accidental_type: The type of accidental :param mode: The mode of the scale The easiest way to use this function is to make sure that the symbolic constants for accidental_type and mode are imported. By doing this: .. code:: from midiutil.MidiFile import * one gets the following constants defined: * ``SHARPS`` * ``FLATS`` * ``MAJOR`` * ``MINOR`` So, for example, if one wanted to create a key signature for a minor scale with three sharps: .. code:: MyMIDI.addKeySignature(0, 0, 3, SHARPS, MINOR) rr)rN)rrrrrr)rrrrRrSrTrrrrrs  zMIDIFile.addKeySignaturecCsD|jjdkr|d7}|j|j|j|||jd|jd7_dS)z Add a text event :param track: The track to which the notice is added. :param time: The time (in beats) at which text event is placed. :param text: The text to adde [ASCII String] r)rN)rrrrrr)rrrrOrrrrs  zMIDIFile.addTextcCsF|jjdkr|d7}|j|j||j|||jd|jd7_dS)a Add a MIDI program change event. :param tracknum: The zero-based track number to which program change event is added. :param channel: the MIDI channel to assign to the event. [Integer, 0-15] :param time: The time (in beats) at which the program change event is placed [Float]. :param program: the program number. [Integer, 0-127]. r)rN)rrrrrr)rtracknumr*rrrrrrs  zMIDIFile.addProgramChangecCsJ|jjdkr|d7}|j|}|j||j|||jd|jd7_dS)a Add a Channel Pressure event. :param tracknum: The zero-based track number to which channel pressure event is added. :param channel: the MIDI channel to assign to the event. [Integer, 0-15] :param time: The time (in beats) at which the channel pressure event is placed [Float]. :param pressure_value: the pressure value. [Integer, 0-127]. r)rN)rrrrrr)rrr*rrnrrrrr s   zMIDIFile.addChannelPressurecCsH|jjdkr|d7}|j|j||j||||jd|jd7_dS)a Add a channel control event :param track: The track to which the event is added. :param channel: the MIDI channel to assign to the event. [Integer, 0-15] :param time: The time (in beats) at which the event is placed [Float]. :param controller_number: The controller ID of the event. :param parameter: The event's parameter, the meaning of which varies by event type. r)rN)rrrrrr)rrr*rrjrirrrrs   zMIDIFile.addControllerEventcCsF|jjdkr|d7}|j|j||j|||jd|jd7_dS)a] Add a channel pitch wheel event :param track: The track to which the event is added. :param channel: the MIDI channel to assign to the event. [Integer, 0-15] :param time: The time (in beats) at which the event is placed [Float]. :param pitchWheelValue: 0 for no pitch change. [Integer, -8192-8192] r)rN)rrrrrr)rrr*rpitchWheelValuerrrr0s  zMIDIFile.addPitchWheelEventc Cs|j|} |jjdkr|d7}|j|}|r0dnd} |j|| d||jd|jd7_| | 7} |j|| d||jd|jd7_| | 7} |j|| d||jd|jd7_| | 7} |dk r|j|| d||jd|jd7_dS) aB Perform a Registered Parameter Number Call :param track: The track to which this applies :param channel: The channel to which this applies :param time: The time of the event :param controller_msb: The Most significant byte of the controller. In common usage this will usually be 0 :param controller_lsb: The Least significant Byte for the controller message. For example, for a fine-tuning change this would be 01. :param data_msb: The Most Significant Byte of the controller's parameter. :param data_lsb: The Least Significant Byte of the controller's parameter. If not needed this should be set to ``None`` :param time_order: Order the control events in time (see below) As an example, if one were to change a channel's tuning program:: makeRPNCall(track, channel, time, 0, 3, 0, program) (Note, however, that there is a convenience function, ``changeTuningProgram``, that does this for you.) Registered/Non-Registered Parameter Number (RPN / NRPN) ------------------------------------------------------- Controller number 6 (Data Entry), in conjunction with Controller numbers 96 (Data Increment), 97 (Data Decrement), 98 (Registered Parameter Number LSB), 99 (Registered Parameter Number MSB), 100 (Non-Registered Parameter Number LSB), and 101 (Non-Registered Parameter Number MSB), extend the number of controllers available via MIDI. Parameter data is transferred by first selecting the parameter number to be edited using controllers 98 and 99 or 100 and 101, and then adjusting the data value for that parameter using controller number 6, 96, or 97. RPN and NRPN are typically used to send parameter data to a synthesizer in order to edit sound patches or other data. Registered parameters are those which have been assigned some particular function by the MIDI Manufacturers Association (MMA) and the Japan MIDI Standards Committee (JMSC). For example, there are Registered Parameter numbers assigned to control pitch bend sensitivity and master tuning for a synthesizer. Non-Registered parameters have not been assigned specific functions, and may be used for different functions by different manufacturers. The ``time_order`` parameter is something of a work-around for sequencers that do not preserve the order of events from the MIDI files they import. Within this code care is taken to preserve the order of events as specified, but some sequencers seem to transmit events occurring at the same time in an arbitrary order. By setting this parameter to ``True`` something of a work-around is performed: each successive event (of which there are three or four for this event type) is placed in the time stream a small delta from the preceding one. Thus, for example, the controllers are set before the data bytes in this call. rre)rdrN&)rrrrrr) rrr*rcontroller_msbcontroller_lsbdata_msbdata_lsb time_orderr tick_incrrrr makeRPNCall@s*9            zMIDIFile.makeRPNCallc Cs|j|} |jjdkr|d7}|j|}|r0dnd} |j|| d||jd|jd7_| | 7} |j|| d||jd|jd7_| | 7} |j|| d||jd|jd7_| | 7} |dk r|j|| d||jd|jd7_dS) a Perform a Non-Registered Parameter Number Call :param track: The track to which this applies :param channel: The channel to which this applies :param time: The time of the event :param controller_msb: The Most significant byte of thecontroller. In common usage this will usually be 0 :param controller_lsb: The least significant byte for the controller message. For example, for a fine-tunning change this would be 01. :param data_msb: The most significant byte of the controller's parameter. :param data_lsb: The least significant byte of the controller's parameter. If none is needed this should be set to ``None`` :param time_order: Order the control events in time (see below) The ``time_order`` parameter is something of a work-around for sequencers that do not preserve the order of events from the MIDI files they import. Within this code care is taken to preserve the order of events as specified, but some sequencers seem to transmit events occurring at the same time in an arbitrary order. By setting this parameter to ``True`` something of a work-around is performed: each successive event (of which there are three or four for this event type) is placed in the time stream a small delta from the preceding one. Thus, for example, the controllers are set before the data bytes in this call. rrc)rbrNr)rrrrrr) rrr*rrrrrrrrrrr makeNRPNCalls*            zMIDIFile.makeNRPNCallc Cs|j|||ddd||ddS)a Change the tuning bank for a selected track :param track: The track to which the data should be written :param channel: The channel for the event :param time: The time of the event :param bank: The tuning bank (0-127) :param time_order: Preserve the ordering of the component events by ordering in time. See ``makeRPNCall()`` for a discussion of when this may be necessary Note that this is a convenience function, as the same functionality is available from directly sequencing controller events. The specified tuning should already have been written to the stream with ``changeNoteTuning``. rrB)rN)r)rrr*rbankrrrrchangeTuningBankszMIDIFile.changeTuningBankc Cs|j|||ddd||ddS)a Change the tuning program for a selected track :param track: The track to which the data should be written :param channel: The channel for the event :param time: The time of the event :param program: The tuning program number (0-127) :param time_order: Preserve the ordering of the component events by ordering in time. See ``makeRPNCall()`` for a discussion of when this may be necessary Note that this is a convenience function, as the same functionality is available from directly sequencing controller events. The specified tuning should already have been written to the stream with ``changeNoteTuning``. rr)rN)r)rrr*rrrrrrchangeTuningProgramszMIDIFile.changeTuningProgramrecCsB|jjdkr|d7}|j|j|||||jd|jd7_dS)a> Add a real-time MIDI tuning standard update to a track. :param track: The track to which the tuning is applied. :param tunings: A list to tuples representing the tuning. See below for an explanation. :param sysExChannel: The SysEx channel of the event. This is mapped to "manufacturer ID" in the event which is written. Unless there is a specific reason for changing it, it should be left at its default value. :param realTime: Speicifes if the Universal SysEx event should be flagged as real-time or non-real-time. As with the ``sysExChannel`` argument, this should in general be left at it's default value. :param tuningProgram: The tuning program number. This function specifically implements the "real time single note tuning change" (although the name is misleading, as multiple notes can be included in each event). It should be noted that not all hardware or software implements the MIDI tuning standard, and that which does often does not implement it in its entirety. The ``tunings`` argument is a list of tuples, in (*note number*, *frequency*) format. As an example, if one wanted to change the frequency on MIDI note 69 to 500 (it is normally 440 Hz), one could do it thus: .. code:: python from midiutil.MidiFile import MIDIFile MyMIDI = MIDIFile(1) tuning = [(69, 500)] MyMIDI.changeNoteTuning(0, tuning, tuningProgam=0) r)rN)rrrrr)rrrrdrcrrrrrs #  zMIDIFile.changeNoteTuningcCsJ|j|}|jjdkr|d7}|j|j||||jd|jd7_dS)a Add a System Exclusive event. :param track: The track to which the event should be written :param time: The time of the event. :param manID: The manufacturer ID for the event :param payload: The payload for the event. This should be a binary-packed value, and will vary for each type and function. **Note**: This is a low-level MIDI function, so care must be used in constructing the payload. It is recommended that higher-level helper functions be written to wrap this function and construct the payload if a developer finds him or herself using the function heavily. r)rN)rrrrrr)rrrr\r]rrrrr s    zMIDIFile.addSysExc CsP|j|}|jjdkr|d7}|j|j|||||||jd|jd7_dS)a8 Add a Univeral System Exclusive event. :param track: The track to which the event should be written :param time: The time of the event, in beats. :param code: The event code. [Integer] :param subcode: The event sub-code [Integer] :param payload: The payload for the event. This should be a binary-packed value, and will vary for each type and function. :param sysExChannel: The SysEx channel. :param realTime: Sets the real-time flag. Defaults to non-real-time. :param manID: The manufacturer ID for the event **Note**: This is a low-level MIDI function, so care must be used in constructing the payload. It is recommended that higher-level helper functions be written to wrap this function and construct the payload if a developer finds him or herself using the function heavily. As an example of such a helper function, see the ``changeNoteTuning()`` function, which uses the event to create a real-time note tuning update. r)rN)rrrrrr) rrrr6rCr]rdrcrrrrr8s   zMIDIFile.addUniversalSysExcCs>|jj||jx$td|jD]}|j|j|q"WdS)z Write the MIDI File. :param fileHandle: A file handle that has been opened for binary writing. rN)rrcloserrrr)rrrMrrrrZs zMIDIFile.writeFilecCsd}|j|}x<|jD]2}t|jdkrx|jD]}|j|kr0|j}q0WqWxF|jD]<}g}x,|jD]"}|j|}|||_|j|qdW||_qTWdS)aSShift tracks to be zero-origined, or origined at offset. Note that the shifting of the time in the tracks uses the MIDIEventList -- in other words it is assumed to be called in the stage where the MIDIEventList has been created. This function, however, it meant to operate on the eventList itself. irN)rrrJrrr)roffsetr tick_offsetrrrrrrr shiftTracksks        zMIDIFile.shiftTrackscCs|jr dSx6td|jD]&}|j|j|j|jjtdqW|j}x6td|jD]&}|j|j ||j |j|j qXWd|_dS)z Close the MIDIFile for further writing. To close the File for events, we must close the tracks, adjust the time to be zero-origined, and have the tracks write to their MIDI Stream data structure. Nr)rT) rrrrrrrr findOriginrrr)rrMrrrrrs zMIDIFile.closecCsBd}x8|jD].}t|jdkr |jdj|kr |jdj}q W|S)zE Find the earliest time in the file's tracks.append. ir)rrJrr)rrrrrrrs  zMIDIFile.findOrigin)N)r)r)F)F)F)F)reTr)reF)r)r r!r"r#TICKSPERQUARTERNOTErrrrrrrrrrrrrrrrrrrrrrrrrrrrrrs:W  : % Q 6   ) ! cCsR|dkrdgSg}d}x.|dkrD|j|d@|Bd@|dL}d}qW|j|S)a Accept an integer, and serialize it as a MIDI file variable length quantity Some numbers in MTrk chunks are represented in a form called a variable- length quantity. These numbers are represented in a sequence of bytes, each byte holding seven bits of the number, and ordered most significant bits first. All bytes in the sequence except the last have bit 7 set, and the last byte has bit 7 clear. This form allows smaller numbers to be stored in fewer bytes. For example, if the number is between 0 and 127, it is thus represented exactly as one byte. A number between 128 and 16383 uses two bytes, and so on. Examples: Number VLQ 128 81 00 8192 C0 00 16383 FF 7F 16384 81 80 00 rrer@rtr<)rreverse)rMvlbyteshibitrrrr1s r1cCs^|}d}d}xH|d>}tjd||d}|d}|d}||d@}|d@dkrPqW||fS)z A function to read a MIDI variable length variable. It returns a tuple of the value read and the number of bytes processed. The input is an offset into the buffer, and the buffer itself. rrtz>Brrer<)r2 unpack_from)rbuffertoffsetoutput bytesReadrrrr readVarLengths  rc Csd}t|}ddtj|tdd}t|}dtdt|dd}||krfd tj||dnd }t|d |}tt|d ?d g}||d >}t|d g}|d kr|d kr|d krd}t|}|||gS)z8 Returns a three-byte transform of a frequency. i@Erir=g@g@Q@g(@irrrtrerf)rmathlogrpowroundmin) freq resolutiondollars firstByte lowerFreqcentDifcents secondByte thirdByterrrrs   rcCs`d}dtdt|ddd}tt|dd>t|d d |}|td|d }|S) zU The reverse of frequencyTransform. Given a byte stream, return a frequency. g@ig@rg@Q@g(@rrtr=gY@g@)rrr) freqBytesr  baseFrequencyfracrrrrreturnFrequencys (rcCs|j|j|jfS)ai .. py:function:: sort_events(event) The key function used to sort events (both MIDI and Generic) :param event: An object of type :class:`MIDIEvent` or (a derrivative) :class:`GenericEvent` This function should be provided as the ``key`` for both ``list.sort()`` and ``sorted()``. By using it sorting will be as follows: * Events are ordered in time. An event that takes place earlier will appear earlier * If two events happen at the same time, the secondary sort key is ``sec_sort_order``. Thus a class of events can be processed earlier than another. One place this is used in the code is to make sure that note off events are processed before note on events. * If event time and event ordinality are the same, they are sorted in the order in which they were originally added to the list. Thus, for example, if one is making an RPN call one can specify the controller change events in the proper order and be sure that they will end up in the file that way. )rr$r)rrrrrsr)& __future__rrrr2warnings __version__rcontrollerEventTypesr r r r __all__objectr r%r;r>rFrNrQrWrZrargrkrqrwr{rrrr1rrrrrrrr sR0,-8(!$&2###%$,)q#