fX@s6ddlmZmZddlZddlZddlZdZdZddiZdZ 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-ddeZd.d/Z d0d1Z!d2d3Z"d4d5Z#d6d7Z$dS)8)divisionprint_functionNHEADipan MIDIFileMAJORMINORSHARPSFLATSc@s.eZdZdZddddddZdS) MIDIEventzH The class to contain the MIDI Event (placed on MIDIEventList). unknownrcCs(||_||_||_||_dS)N)typetimeordinsertion_order)selfrrordinalrr3/usr/really-local/MIDIUtil/src/midiutil/MidiFile.py__init__*s   zMIDIEvent.__init__N)__name__ __module__ __qualname____doc__rrrrrr &s r c@s:eZdZdZddZddZddZdS) GenericEventz@ The event class from which specific events are derived cCs(||_||_||_||_dS)N)rrrr)rZ event_typerrrrrrr5s   zGenericEvent.__init__cCs|j|jks$|j|jkr(dS|jdkr_|j|jks[|j|jkr_dS|jdkr|j|jkrdS|jdkr|j|jks|j|jkrdS|jdkr|j|jkrdS|jd krdSd S) a Equality operator for Generic Events and derived classes. 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). This is the most embarrassing portion of the code, and anyone who knows about OO programming would find this almost unbelievable. Here we have a base class that knows specifics about derived classes, thus breaking the very spirit of OO programming. I suppose I should go back and restructure the code, perhaps removing the derived classes altogether. At some point perhaps I will. Fnotetempo programChange trackNamecontrollerEventpitchWheelEventSysExUniversalSysExT)r!r"r#r$)rrpitchchannelr programNumberr )rotherrrr__eq__<s$$$zGenericEvent.__eq__cCst|j}|d|d>}|dA|d?A}|d|d>}|d|d>A}|d |d >}|d A|d ?A}|S) aK Return a hash code for the object. This is needed for the removal of duplicate objects from the event list. 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]~ lrr)r8rrrsz Text.__init__)rrrrrrr)r8rr=s r=cs.eZdZdZddfddZS) KeySignaturez0 A class that encapsulates a text event rrcs>||_||_||_tt|jd|||dS)Nr?) accidentalsaccidental_typemoder7r?r)rrr@rArBrr)r8rrrs    zKeySignature.__init__)rrrrrrr)r8rr?s r?cs.eZdZdZddfddZS) ProgramChangez; A class that encapsulates a program change event. rrcs5||_||_tt|jd|||dS)Nr)r'r&r7rCr)rr&rr'rr)r8rrrs  zProgramChange.__init__)rrrrrrr)r8rrCs rCcs.eZdZdZddfddZS) SysExEventz> A class that encapsulates a System Exclusive event. rrcs5||_||_tt|jd|||dS)Nr#)manIDpayloadr7rDr)rrrErFrr)r8rrrs  zSysExEvent.__init__)rrrrrrr)r8rrDs rDcs.eZdZdZddfddZS)UniversalSysExEventzH A class that encapsulates a Universal System Exclusive event. rrc sP||_||_||_||_||_tt|jd|||dS)Nr$)realTime sysExChannelcodesubcoderFr7rGr) rrrHrIrJrKrFrr)r8rrrs     zUniversalSysExEvent.__init__)rrrrrrr)r8rrGs rGcs.eZdZdZddfddZS)ControllerEventz; A class that encapsulates a program change event. rrcs>||_||_||_tt|jd|||dS)Nr!) parameterr&controller_numberr7rLr)rr&rrNrMrr)r8rrrs    zControllerEvent.__init__)rrrrrrr)r8rrLs rLcs.eZdZdZddfddZS)PitchWheelEventz? A class that encapsulates a pitch wheel change event. rrcs5||_||_tt|jd|||dS)Nr")r&pitch_wheel_valuer7rOr)rr&rrPrr)r8rrrs  zPitchWheelEvent.__init__)rrrrrrr)r8rrOs rOcs.eZdZdZddfddZS) TrackNamez; A class that encapsulates a program change event. rcs5|jd|_tt|jd|||dS)Nz ISO-8859-1r )r;r r7rQr)rrr rr)r8rrrszTrackName.__init__)rrrrrrr)r8rrQs rQcs.eZdZdZddfddZS) TimeSignaturez5 A class that encapsulates a time signature. rcsG||_||_||_||_tt|jd|||dS)NrR) numerator denominatorclocks_per_ticknotes_per_quarterr7rRr)rrrSrTrUrVrr)r8rrrs     zTimeSignature.__init__)rrrrrrr)r8rrRs rRc@sWeZdZdZddZddddZddd Zdd d Zdd d ZdddZ dddddZ dddZ dddZ dddZ dddZdddZdddZdd ddd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2ZdS)3 MIDITrackz0 A class that encapsulates a MIDI track cCsatjddddd|_d|_d|_d|_g|_g|_||_||_ d S) z)Initialize the MIDITrack object. ccccMTrkrFN) structpack headerString dataLengthMIDIdataclosed eventList MIDIEventListremdep deinterleave)rremoveDuplicatesrgrrrrs      zMIDITrack.__init__Nrc Cs2|jjt|||||d|d|dS)z5 Add a note by chromatic MIDI number r6rN)rdappendr3)rr&r%rr4r5r6rrrraddNoteByNumberszMIDITrack.addNoteByNumbercCs)|jjt||||d|dS)z) Add a controller event. rN)rdrirL)rr&rrNrMrrrraddControllerEvent'szMIDITrack.addControllerEventcCs&|jjt|||d|dS)z* Add a pitch wheel event. rN)rdrirO)rr&rrPrrrraddPitchWheelEvent1szMIDITrack.addPitchWheelEventcCs#|jjt||d|dS)z4 Add a tempo change (or set) event. rN)rdrir9)rrrrrrraddTempo7szMIDITrack.addTempocCs&|jjt|||d|dS)z$ Add a SysEx event. rN)rdrirD)rrrErFrrrraddSysEx>szMIDITrack.addSysExFc Cs/|jjt||||||d|dS)z. Add a Universal SysEx event. rN)rdrirG)rrrJrKrFrIrHrrrraddUniversalSysExEs zMIDITrack.addUniversalSysExcCs&|jjt|||d|dS)z- Add a program change event. rN)rdrirC)rr&rprogramrrrraddProgramChangeOszMIDITrack.addProgramChangecCs#|jjt||d|dS)z) Add a track name event. rN)rdrirQ)rrr rrrr addTrackNameVszMIDITrack.addTrackNamec Cs,|jjt|||||d|dS)z' Add a time signature. rN)rdrirR)rrrSrTrUrVrrrraddTimeSignature]s zMIDITrack.addTimeSignaturecCs#|jjt||d|dS)z( Add a copyright notice rN)rdrir:)rrr<rrrr addCopyrightfszMIDITrack.addCopyrightcCs)|jjt||||d|dS)z( Add a copyright notice rN)rdrir?)rrr@rArBrrrraddKeySignaturemszMIDITrack.addKeySignaturecCs#|jjt||d|dS)z" Add a text event rN)rdrir=)rrr>rrrraddTextvszMIDITrack.addTextTc Cstjd|}|tjdt|}x]|D]U\}}|tjd|}t|} x$| D]} |tjd| }qjWq5W|jjtd||dd|d|dS)z1 Change the tuning of MIDI notes z>BrrN)r^r_lenfrequencyTransformrdrirG) rtuningsrIrH tuningProgamrrFZ noteNumber frequencyZ MIDIFreqencybyterrrchangeNoteTuning}s  zMIDITrack.changeNoteTuningcCs2x|jD]}|jdkrtd|jt|j|j}|j|_|j|_|j |_ |j j |td|j|j t|jd|j}|j|_|j|_|j |_ |j j |q |jdkr)td|jt|j|j}|j |_ |j j |q |jdkrytd|jt|j|j}|j|_|j j |q |jdkrtd|jt|j|j}|j|_|j j |q |jd kr1td |jt|j|j}|j|_|j|_|j|_|j j |q |jd krtd |jt|j|j}|j|_|j |_ |j j |q |jd krtd |jt|j|j}|j|_|j j |q |jdkrEtd|jt|j|j}|j|_|j |_ |j|_|j j |q |jdkrtd|jt|j|j}|j|_|j |_ |j j |q |jdkrtd|jt|j|j}|j|_|j|_|j j |q |jdkr}td|jt|j|j}|j|_|j|_|j|_|j|_|j|_|j j |q |jdkrtd|jt|j|j}|j|_|j|_|j |_ |j!|_!|j j |q t"d|jq W|j j#dt$|j%r.|j&dS)z Process the event list, creating a MIDIEventList For each item in the event list, one or more events in the MIDIEvent list are created. rNoteOnNoteOffg?rr9r:r=r?rrCr rQr!rLr"rOr#r$rRz)Error in MIDITrack: Unknown event type %skeyN)'rdrr r TICKSPERBEATrrr%r5r&rerir4rr<r>r@rArBr'r rNrMrPrErFrHrIrJrKrSrTrUrV ValueErrorsort sort_eventsrgdeInterleaveNotes)rthingeventrrrprocessEventLists                    "              zMIDITrack.processEventListcCsBdd|jD}t|j|_|jjdtdS)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. cSsi|]}d|qS)rr).0itemrrr s z.MIDITrack.removeDuplicates..rN)rdlistkeysrr)rZtempDictrrrrhs zMIDITrack.removeDuplicatescCs7|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)rcrfrhr)rrrr closeTracks    zMIDITrack.closeTrackcCsP|j|jtjddddd7_tjdt|j|_dS)zN Write the meta data and note data to the packed MIDI stream. ZBBBBr/z>LN)writeEventsToStreamrbr^r_rzra)rrrrwriteMIDIStream&s $zMIDITrack.writeMIDIStreamcCs d}d}x|jD]}||j}d}t|j}x$|D]}|tjd|}qEWtd|\}}||} || } |j| |_d}t|j}x$|D]}|tjd|}qWtd|\}}||}qWx |jD] }|jdkrd+|jB} t|j}x)|D]!}|jtjd|7_q?W|jtjd| 7_|jtjd|j 7_|jtjd|j 7_q|jdkrod,|jB} t|j}x)|D]!}|jtjd|7_qW|jtjd| 7_|jtjd|j 7_|jtjd|j 7_q|jd krMd } d } tjd |j } | dd}t|j}x)|D]!}|jtjd|7_qW|jtjd| 7_|jtjd| 7_|jtjdd7_|j|7_q|jdkrEd } d} t|j}x)|D]!}|jtjd|7_q~W|jtjd| 7_|jtjd| 7_t |j }t|}x9tt |D]%}|jtjd||7_qW|j|j 7_q|jdkr=d } d} t|j}x)|D]!}|jtjd|7_qvW|jtjd| 7_|jtjd| 7_t |j}t|}x9tt |D]%}|jtjd||7_qW|j|j7_q|jdkr_d } d} t|j}x)|D]!}|jtjd|7_qnW|jtjd| 7_|jtjd| 7_|jtjdd7_|jtjd|j7_|jtjd|j7_|jtjd|j7_|jtjd|j7_q|jdkrRd } d} d}t|j}x)|D]!}|jtjd|7_qW|jtjd| 7_|jtjd| 7_|jtjd|7_|jtjd|j|j7_|jtjd|j7_q|jdkrd-|jB} t|j}x)|D]!}|jtjd|7_qW|jtjd| 7_|jtjd|j7_q|jdkrt|j}x)|D]!}|jtjd|7_q W|jtjdd 7_|jtjdd7_t |j}t|}x<tdt |D]%}|jtjd||7_qW|j|j7_q|jdkr d.|jB} t|j}x)|D]!}|jtjd|7_q W|jtjd| 7_|jtjd|j7_|jtjd|j7_q|jdkrV d/|jB} t|j}x*|D]"}|jtjd||_q W|jd!d"?}|jd!d#@}|jtjd| |_|jtjd||_|jtjd||_q|jd$krT d%} t|j}x)|D]!}|jtjd|7_q W|jtjd| 7_tt |jd}x)|D]!}|jtjd|7_q W|jtjd|j7_|j|j7_|jtjdd&7_q|jd'krd%} t|j}x)|D]!}|jtjd|7_q W|jtjd| 7_tt |jd(}x)|D]!}|jtjd|7_q W|jr+ |jtjdd#7_n|jtjdd)7_|jtjd|j7_|jtjd|j 7_|jtjd|j!7_|j|j7_|jtjdd&7_qWd*S)0zD Write the events in MIDIEvents to the MIDI stream. gr]z>Brrr-rrxr9rQz>Lrr.r=br:ryrRXr?Yz>brCr*rQBrL rOi ror#r$r,~N)"rerwriteVarLengthr^r_ readVarLengthrr&rbr%r5rrzr>ranger<rSrTrUrVr@rArBr'r rNrMrPrFrErHrIrJrK)rZ preciseTimeZ actualTimerZ testBufferZvarTimeZtimeByteZ roundedValdiscardZ roundedTimedeltarJrKZfourbiteZ threebiteZ payloadLengthZpayloadLengthVariZ event_subtyperaZ dataLenghtVarZMSBZLSBZlenByterrrr7sH       !  !   #  # ! !  !  #  !        zMIDITrack.writeEventsToStreamcCsg}i}xZ|jD]O}|jdkrt|jt|j|krz|t|jt|jj|jn&|jg|t|jt|j<|j|q|jdkrXt|t|jt|jdkr$|t|jt|jj|_|j|qe|t|jt|jj|j|q|j|qW||_|jj dt dS)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. rrrrN) rerstrr%r&rirrzpoprr)r tempEventListstackrrrrrs" "-&,)$ zMIDITrack.deInterleaveNotescCst|jdkrdSg}|r+|nd}d}x>|jD]3}|j|}|||_|}|j|qAW||_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. rNg)rzrerri)roriginZadjustrZinternal_originZ runningTimer adjustedTimerrradjustTimeAndOrigins  zMIDITrack.adjustTimeAndOrigincCs4|j|j|j|j|j|jdS)z& Write track to disk. N)writer`rarb)r fileHandlerrr writeTrack2szMIDITrack.writeTrack)rrrrrrjrkrlrmrnrprrrsrtrurvrwrrrhrrrrrrrrrrrW s2     t    ' rWc@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. cCstjddddd|_tjdd|_tjd||_||_|d krcd nd }tjd|||_tjdt|_d S) z( Initialize the data structures rXrYrZhdz>Lz>HrrN) r^r_r` headerSizeformatnumeric_format numTracksr ticksPerBeat)rr file_formatrrrrrFs zMIDIHeader.__init__cCsT|j|j|j|j|j|j|j|j|j|jdS)N)rr`rrrr)rrrrr writeFileRs zMIDIHeader.writeFileN)rrrrrrrrrrr<s  rc@sTeZdZdZdddddddZdddZd d Zd d d ZddZddZ dddZ ddZ ddZ ddZ ddZdddZdd d!Zdd"d#Zdd$d%Zd&ddd'd(Zd)d*Zd&dd+d,Zd-d.Zdd/d0Zd1d2Zd3d4ZdS)5ra 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. rTNcCst|||_t|_|dkr3d}nd}|||_d|_|dkrwd|_tjdt n ||_x3t d|jD]}|jj t ||qWd|_ 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`` (or left at the default of ``None``) shift all the events in the tracks so that the first event takes place at time t=0 :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``. Note that the default for ``adjust_origin`` will change in a future release, so one should probably explicitly set it. Example: .. code:: # Create a two-track MIDIFile from midiutil.MidiFile import MIDIFile midi_file = MIDIFile(2) 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. rrFNTzWPlease explicitly set adjust_origin. Default behaviour will change in a future version.)rheaderrtracksrrc adjust_originwarningswarn FutureWarningrrirW event_counter)rrrhrgrrrrrrrrcs4          zMIDIFile.__init__c Cs^|jjdkr|d7}|j|j|||||d|d|j|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 (in beats) at which the note sounds [Float]. :param duration: the duration of the note (in beats) [Float]. :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``. rr6rN)rrrrjr)rtrackr&r%rr4r5r6rrraddNotes    zMIDIFile.addNotecCsO|jjdkr|d7}|j|j||d|j|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] rrN)rrrrsr)rrrr rrrrss   zMIDIFile.addTrackNamerxcCsT|jjdkrd}|j|j|||||d|j|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. rrrN)rrrrtr)rrrrSrTrUrVrrrrts $  zMIDIFile.addTimeSignaturecCsK|jjdkrd}|j|j||d|j|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] rrrN)rrrrmr)rrrrrrrrms  zMIDIFile.addTempocCsO|jjdkr|d7}|j|j||d|j|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] rrN)rrrrur)rrrr<rrrrus   zMIDIFile.addCopyrightrcCsU|jjdkr|d7}|j|j||||d|j|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) rrN)rrrrvr)rrrr@rArBrrrrrv(s   zMIDIFile.addKeySignaturecCsO|jjdkr|d7}|j|j||d|j|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] rrN)rrrrwr)rrrr>rrrrwOs   zMIDIFile.addTextcCs6|j|j|||d|j|jd7_dS)a Add a MIDI program change event. :param track: The track 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]. rrN)rrrr)rrr&rrqrrrrr^s  zMIDIFile.addProgramChangecCsU|jjdkr|d7}|j|j||||d|j|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. rrN)rrrrkr)rrr&rrNrMrrrrkns  zMIDIFile.addControllerEventcCsR|jjdkr|d7}|j|j|||d|j|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] rrN)rrrrlr)rrr&rZpitchWheelValuerrrrls  #zMIDIFile.addPitchWheelEventFc Cs.|jjdkr|d7}|r0dtdnd} |j|j||d|d|j|jd7_|j|j||| d|d|j|jd7_|j|j||d| d |d|j|jd7_|d k r*|j|j||d | d |d|j|jd7_d S) a 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.) 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. rg?rgerdg@rNg@&)rrrrrkr) rrr&rcontroller_msbcontroller_lsbdata_msbdata_lsb time_orderrrrr makeRPNCalls %  zMIDIFile.makeRPNCallc Cs.|jjdkr|d7}|r0dtdnd} |j|j||d|d|j|jd7_|j|j||| d|d|j|jd7_|j|j||d| d |d|j|jd7_|d k r*|j|j||d | d |d|j|jd7_d S) 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. rg?rgcrbryrNr.r)rrrrrkr) rrr&rrrrrrrrrr makeNRPNCalls   zMIDIFile.makeNRPNCallc Cs)|j|||ddd|d|dS)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``. rrrN)r)rrr&rZbankrrrrchangeTuningBankszMIDIFile.changeTuningBankc Cs)|j|||ddd|d|dS)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&rrqrrrrchangeTuningProgram szMIDIFile.changeTuningProgramrocCsU|jjdkr|d7}|j|j||||d|j|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) rrN)rrrrr)rrr|rIrHr}rrrr$s #  zMIDIFile.changeNoteTuningcCsR|jjdkr|d7}|j|j|||d|j|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. rrN)rrrrnr)rrrrErFrrrrnNs   zMIDIFile.addSysExc Cs[|jjdkr|d7}|j|j||||||d|j|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. rrN)rrrrpr)rrrrJrKrFrIrHrrrrpes    zMIDIFile.addUniversalSysExcCsO|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)rrrrrrrs zMIDIFile.writeFilecCsd}xR|jD]G}t|jdkrx)|jD]}|j|kr5|j}q5WqWx[|jD]P}g}x8|jD]-}|j|}|||_|j|q{W||_qeWdS)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. i@BrN)rrzrdrri)roffsetrrrrrrrr shiftTrackss  zMIDIFile.shiftTrackscCs|jr dSxEtd|jD]1}|j|j|j|jjdtq W|j}xEtd|jD]1}|j|j ||j |j|j qtWd|_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. NrrT) rcrrrrrerr findOriginrrr)rrrrrrrs  zMIDIFile.closecCsYd}xL|jD]A}t|jdkr|jdj|kr|jdj}qW|S)zE Find the earliest time in the file's tracks.append. i@Br)rrzrer)rrrrrrrs zMIDIFile.findOrigin)rrrrrrrsrtrmrurvrwrrrkrlrrrrrrnrprrrrrrrrrZs2  M +  &    6/)   cCst|d}ddddg}ddddg}d}|d@}|||<|d}|d?}xB|dkr|d@}|dB}|||<|d}|d?}qeW|d|d<|d|d<|d|d<|d|d<|d |d S) a_ Accept an input, and write a MIDI-compatible variable length stream The MIDI format is a little strange, and makes use of so-called variable length quantities. These quantities are a stream of bytes. If the most significant bit is 1, then more bytes follow. If it is zero, then the byte in question is the last in the stream g?rrorrrr.ryr)r0)rinputoutputreversedcountresultrrrrs&         rcCsy|}d}d}xZ|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. rrz>Brror)r^ unpack_from)rbufferZtoffsetrZ bytesReadrrrrrs   rc Cs"d}t|}ddtj|tdd}t|}dtdt|dd}||krd tj||dnd }t|d |}tt|d ?d g}||d >}t|d g}|d kr |d kr |d kr d}t|}|||gS)z8 Returns a three-byte transform of a frequency. i@Er*iryg@g@Q@g(@irrrror)floatmathlogr0powroundmin) Zfreq resolutionZdollarsZ firstByteZ lowerFreqZcentDifZcentsZ secondByteZ thirdByterrrr{s $ !,$ r{cCsvd}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(@rrrygY@g@)rrr0)Z freqBytesrZ baseFrequencyfracr~rrrreturnFrequency/s %% rcCs|j|j|jfS)aR .. 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 ``ord``. 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 time and 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. )rrr)rrrrr;sr)% __future__rrrr^r __version__rZcontrollerEventTypesr r r r __all__objectr rr3r9r:r=r?rCrDrGrLrOrQrRrWrrrrr{rrrrrr sJ     H        1 !