&h_2SrSSKrSSKrSSKrSSKrSSKJr \RRr \RRr /SQr SS/r SSjr SrSrS rS rS rS rS rSr"SS5r"SS5rSrSr"SS\5rSrSrSrg)apygame.midi pygame module for interacting with midi input and output. The midi module can send output to midi devices, and get input from midi devices. It can also list midi devices on the system. Including real midi devices, and virtual ones. It uses the portmidi library. Is portable to which ever platforms portmidi supports (currently windows, OSX, and linux). This uses pyportmidi for now, but may use its own bindings at some point in the future. The pyportmidi bindings are included with pygame. New in pygame 1.9.0. N)InputMIDIINMIDIOUT MidiExceptionOutput get_countget_default_input_idget_default_output_idget_device_infoinit midis2eventsquitget_inittimefrequency_to_midimidi_to_frequencymidi_to_ansi_noterrcUb U[lU$[R [R$![a gf=f)NF) _module_initvalueAttributeError)states C/var/www/auris/envauris/lib/python3.13/site-packages/pygame/midi.pyrr<sG "      s 2 ??c[5(d;[R"5 [S5 [R"[ 5 gg)zinitialize the midi module pygame.midi.init(): return None Call the initialisation function before using the midi module. It is safe to call this more than once. TN)r_pypm Initializeatexitregisterrrr r Js0 >> T r cd[5(a![R"5 [S5 gg)zuninitialize the midi module pygame.midi.quit(): return None Called automatically atexit if you don't call it. It is safe to call this function more than once. FN)rr Terminaterr rrrXs"~~ Ur c[5$)zreturns True if the midi module is currently initialized pygame.midi.get_init(): return bool Returns True if the pygame.midi module is currently initialized. New in pygame 1.9.5. )rrr rrrgs  >r c8[5(d [S5eg)Nzpygame.midi not initialised.)r RuntimeErrorrr r _check_initr&rs >>9:: r c@[5 [R"5$)ztgets the number of devices. pygame.midi.get_count(): return num_devices Device ids range from 0 to get_count() -1 )r&r CountDevicesrr rrrwsM    r c@[5 [R"5$)aWgets default input device number pygame.midi.get_default_input_id(): return default_id Return the default device ID or -1 if there are no devices. The result can be passed to the Input()/Output() class. On the PC, the user can specify a default device by setting an environment variable. For example, to use device #1. set PM_RECOMMENDED_INPUT_DEVICE=1 The user should first determine the available device ID by using the supplied application "testin" or "testout". In general, the registry is a better place for this kind of info, and with USB devices that can come and go, using integers is not very reliable for device identification. Under Windows, if PM_RECOMMENDED_OUTPUT_DEVICE (or PM_RECOMMENDED_INPUT_DEVICE) is *NOT* found in the environment, then the default device is obtained by looking for a string in the registry under: HKEY_LOCAL_MACHINE/SOFTWARE/PortMidi/Recommended_Input_Device and HKEY_LOCAL_MACHINE/SOFTWARE/PortMidi/Recommended_Output_Device for a string. The number of the first device with a substring that matches the string exactly is returned. For example, if the string in the registry is "USB", and device 1 is named "In USB MidiSport 1x1", then that will be the default input because it contains the string "USB". In addition to the name, get_device_info() returns "interf", which is the interface name. (The "interface" is the underlying software system or API used by PortMidi to access devices. Examples are MMSystem, DirectX (not implemented), ALSA, OSS (not implemented), etc.) At present, the only Win32 interface is "MMSystem", the only Linux interface is "ALSA", and the only Max OS X interface is "CoreMIDI". To specify both the interface and the device name in the registry, separate the two with a comma and a space, e.g.: MMSystem, In USB MidiSport 1x1 In this case, the string before the comma must be a substring of the "interf" string, and the string after the space must be a substring of the "name" name string in order to match the device. Note: in the current release, the default is simply the first device (the input or output device with the lowest PmDeviceID). )r&rGetDefaultInputDeviceIDrr rr r s\M  ( ( **r c@[5 [R"5$)aZgets default output device number pygame.midi.get_default_output_id(): return default_id Return the default device ID or -1 if there are no devices. The result can be passed to the Input()/Output() class. On the PC, the user can specify a default device by setting an environment variable. For example, to use device #1. set PM_RECOMMENDED_OUTPUT_DEVICE=1 The user should first determine the available device ID by using the supplied application "testin" or "testout". In general, the registry is a better place for this kind of info, and with USB devices that can come and go, using integers is not very reliable for device identification. Under Windows, if PM_RECOMMENDED_OUTPUT_DEVICE (or PM_RECOMMENDED_INPUT_DEVICE) is *NOT* found in the environment, then the default device is obtained by looking for a string in the registry under: HKEY_LOCAL_MACHINE/SOFTWARE/PortMidi/Recommended_Input_Device and HKEY_LOCAL_MACHINE/SOFTWARE/PortMidi/Recommended_Output_Device for a string. The number of the first device with a substring that matches the string exactly is returned. For example, if the string in the registry is "USB", and device 1 is named "In USB MidiSport 1x1", then that will be the default input because it contains the string "USB". In addition to the name, get_device_info() returns "interf", which is the interface name. (The "interface" is the underlying software system or API used by PortMidi to access devices. Examples are MMSystem, DirectX (not implemented), ALSA, OSS (not implemented), etc.) At present, the only Win32 interface is "MMSystem", the only Linux interface is "ALSA", and the only Max OS X interface is "CoreMIDI". To specify both the interface and the device name in the registry, separate the two with a comma and a space, e.g.: MMSystem, In USB MidiSport 1x1 In this case, the string before the comma must be a substring of the "interf" string, and the string after the space must be a substring of the "name" name string in order to match the device. Note: in the current release, the default is simply the first device (the input or output device with the lowest PmDeviceID). )r&rGetDefaultOutputDeviceIDrr rr r s\M  ) ) ++r cB[5 [R"U5$)a(returns information about a midi device pygame.midi.get_device_info(an_id): return (interf, name, input, output, opened) interf - a byte string describing the device interface, eg b'ALSA'. name - a byte string for the name of the device, eg b'Midi Through Port-0' input - 0, or 1 if the device is an input device. output - 0, or 1 if the device is an output device. opened - 0, or 1 if the device is opened. If the id is out of range, the function returns None. )r&r GetDeviceInfo)an_ids rr r sM   u %%r c:\rSrSrSrS SjrSrSrSrSr Sr g ) rzInput is used to get midi input from midi devices. Input(device_id) Input(device_id, buffer_size) buffer_size - the number of input events to be buffered waiting to be read using Input.read() c[5 US:Xa [S5e[U5nU(aMUu pEpdU(a#[ R "X5UlXlgU(a [S5e[S5e[S5e![a [S5e[a [ S5ef=f![a [S5ef=f) zl The buffer_size specifies the number of input events to be buffered waiting to be read using Input.read(). _Device id is -1, not a valid output id. -1 usually means there were no default Output devices.an integer is required$long int too large to convert to intz"'++i"EDK"+#R$$NOO BC C/ 645 5 H FG G H!>#$<==>s BB4*B14C c4URc [S5eg)Nmidi not open.)r:rr<s r _check_openInput._check_open*s ;;  01 1 r ct[5 URbURR5 SUlg)zcloses a midi stream, flushing any pending buffers. Input.close(): return None PortMidi attempts to close open streams when the application exits -- this is particularly difficult under Windows. N)r&r:CloserFs rclose Input.close.s*  ;; " KK    r cl[5 UR5 URRU5$)zreads num_events midi events from the buffer. Input.read(num_events): return midi_event_list Reads from the Input buffer and gives back midi events. [[[status,data1,data2,data3],timestamp], [[status,data1,data2,data3],timestamp],...] )r&rGr:Read)r< num_eventss rread Input.read:s*   {{ ++r c[5 UR5 URR5nU[R :XagU[R :Xag[R"U5n[X45e)zkreturns true if there's data, or false if not. Input.poll(): return Bool raises a MidiException on error. TF) r&rGr:PollrTRUEFALSE GetErrorTextr)r<r>err_texts rpoll Input.pollFsc   !!# UZZ  U[[ %%f-V.//r )r:r;N)i) __name__ __module__ __qualname____firstlineno____doc__rBrGrKrPrX__static_attributes__rr rrrs"'DR2  ,0r cr\rSrSrSrSSjrSrSrSrSr SSjr S r SS jr SS jr SS jrSS jrSrg)riZaoOutput is used to send midi to an output device Output(device_id) Output(device_id, latency = 0) Output(device_id, buffer_size = 4096) Output(device_id, latency, buffer_size) The buffer_size specifies the number of output events to be buffered waiting for output. (In some cases -- see below -- PortMidi does not buffer output at all and merely passes data to a lower-level API, in which case buffersize is ignored.) latency is the delay in milliseconds applied to timestamps to determine when the output should actually occur. (If latency is < 0, 0 is assumed.) If latency is zero, timestamps are ignored and all output is delivered immediately. If latency is greater than zero, output is delayed until the message timestamp plus the latency. (NOTE: time is measured relative to the time source indicated by time_proc. Timestamps are absolute, not relative delays or offsets.) In some cases, PortMidi can obtain better timing than your application by passing timestamps along to the device driver or hardware. Latency may also help you to synchronize midi data to audio data by matching midi latency to the audio buffer latency. c[5 SUlUS:Xa [S5e[U5nU(aNUu pVpuU(a$[ R"XU5UlXl g U(a [S5e[S5e[S5e![a [ S5e[ a [ S5ef=f![a [ S5ef=f) a>Output(device_id) Output(device_id, latency = 0) Output(device_id, buffer_size = 4096) Output(device_id, latency, buffer_size) The buffer_size specifies the number of output events to be buffered waiting for output. (In some cases -- see below -- PortMidi does not buffer output at all and merely passes data to a lower-level API, in which case buffersize is ignored.) latency is the delay in milliseconds applied to timestamps to determine when the output should actually occur. (If latency is < 0, 0 is assumed.) If latency is zero, timestamps are ignored and all output is delivered immediately. If latency is greater than zero, output is delayed until the message timestamp plus the latency. (NOTE: time is measured relative to the time source indicated by time_proc. Timestamps are absolute, not relative delays or offsets.) In some cases, PortMidi can obtain better timing than your application by passing timestamps along to the device driver or hardware. Latency may also help you to synchronize midi data to audio data by matching midi latency to the audio buffer latency. rr3r4r5r6zr?r@rAs rrBOutput.__init__vs4   ?"   H$Y/F +1 (AqI>#(<< K#PDL"+#R$$OPP BC C/ 645 5 H FG G H!>#$<==>s BB<*B9<CclURc [S5eUR(a [S5eg)NrEz midi aborted.)rcrrbrFs rrGOutput._check_opens/ <<  01 1 ==0 0 r ct[5 URbURR5 SUlg)zcloses a midi stream, flushing any pending buffers. Output.close(): return None PortMidi attempts to close open streams when the application exits -- this is particularly difficult under Windows. N)r&rcrJrFs rrK Output.closes*  << # LL    r c|[5 UR(aURR5 SUlg)a=terminates outgoing messages immediately Output.abort(): return None The caller should immediately close the output port; this call may result in transmission of a partial midi message. There is no abort for Midi input because the user can simply ignore messages in the buffer and close an input device at any time. N)r&rcAbortrbrFs rabort Output.aborts'  << LL    r cn[5 UR5 URRU5 g)awrites a list of midi data to the Output Output.write(data) writes series of MIDI information in the form of a list: write([[[status <,data1><,data2><,data3>],timestamp], [[status <,data1><,data2><,data3>],timestamp],...]) fields are optional example: choose program change 1 at time 20000 and send note 65 with velocity 100 500 ms later. write([[[0xc0,0,0],20000],[[0x90,60,100],20500]]) notes: 1. timestamps will be ignored if latency = 0. 2. To get a note to play immediately, send MIDI info with timestamp read from function Time. 3. understanding optional data fields: write([[[0xc0,0,0],20000]]) is equivalent to write([[[0xc0],20000]]) Can send up to 1024 elements in your data list, otherwise an IndexError exception is raised. N)r&rGrcWrite)r<datas rwrite Output.writes',    4 r cp[5 UR5 URRXU5 g)awrite_short(status <, data1><, data2>) Output.write_short(status) Output.write_short(status, data1 = 0, data2 = 0) output MIDI information of 3 bytes or less. data fields are optional status byte could be: 0xc0 = program change 0x90 = note on etc. data bytes are optional and assumed 0 if omitted example: note 65 on with velocity 100 write_short(0x90,65,100) N)r&rGrc WriteShort)r<statusdata1data2s r write_shortOutput.write_shorts)    u5r cn[5 UR5 URRX5 g)aswrites a timestamped system-exclusive midi message. Output.write_sys_ex(when, msg) msg - can be a *list* or a *string* when - a timestamp in milliseconds example: (assuming o is an onput MIDI stream) o.write_sys_ex(0,'\xF0\x7D\x10\x11\x12\x13\xF7') is equivalent to o.write_sys_ex(pygame.midi.time(), [0xF0,0x7D,0x10,0x11,0x12,0x13,0xF7]) N)r&rGrc WriteSysEx)r<whenmsgs r write_sys_exOutput.write_sys_exs'    *r cbSUs=::aS::d O [S5eURSU-X5 g)aturns a midi note on. Note must be off. Output.note_on(note, velocity, channel=0) note is an integer from 0 to 127 velocity is an integer from 0 to 127 channel is an integer from 0 to 15 Turn a note on in the output stream. The note must already be off for this to work correctly. rChannel not between 0 and 15.N ValueErrorryr<notevelocitychannels rnote_onOutput.note_on1G!r!<= = 8r cbSUs=::aS::d O [S5eURSU-X5 g)a3turns a midi note off. Note must be on. Output.note_off(note, velocity=0, channel=0) note is an integer from 0 to 127 velocity is an integer from 0 to 127 (release velocity) channel is an integer from 0 to 15 Turn a note off in the output stream. The note must already be on for this to work correctly. rrrNrrs rnote_offOutput.note_off'rr cSUs=::aS::dO [SU35eSUs=::aS::d O [S5eURSU-U5 g)zselect an instrument for a channel, with a value between 0 and 127 Output.set_instrument(instrument_id, channel=0) Also called "patch change" or "program change". rzUndefined instrument id: rrNr)r< instrument_idrs rset_instrumentOutput.set_instrument7sQ M(S(8HI IG!r!<= = 7r cSUs=::aS::d O [S5eSUs=::aS::dO [SUS35eUS-nUS -nUS - nURS U-X45 g ) amodify the pitch of a channel. Output.pitch_bend(value=0, channel=0) Adjust the pitch of a channel. The value is a signed integer from -8192 to +8191. For example, 0 means "no change", +4096 is typically a semitone higher, and -8192 is 1 whole tone lower (though the musical range corresponding to the pitch bend range can also be changed in some synthesizers). If no value is given, the pitch bend is returned to "no change". rrriiz6Pitch bend value must be between -8192 and +8191, not .i rNr)r<rrlsbmsbs r pitch_bendOutput.pitch_bendEstG!r!<= =%%HqQ dlqj 2r )rbrcr;N)r)rr)r)rZr[r\r]r^rBrGrKrmrrryrrrrrr_rr rrrZs@6=D~1  !66&+"9 9 83r c@[5 [R"5$)zreturns the current time in ms of the PortMidi timer pygame.midi.time(): return time The time is reset to 0, when the module is inited. )r&rTimerr rrrns M ::<r c /nUHCnUuupEpgn[RR[UUUUUUS9n UR U 5 ME U$)zconverts midi events to pygame events pygame.midi.midis2events(midis, device_id): return [Event, ...] Takes a sequence of midi events and returns list of pygame events. )rvrwrxdata3 timestampvice_id)pygameeventEventrappend) midisr;evsmidirvrwrxrrrs rr r xse C592 &&  "" #  5 Jr c2^\rSrSrSrU4SjrSrSrU=r$)rizPexception that pygame.midi functions and classes can raise MidiException(errno) c0>[TU]U5 XlgN)superrB parameter)r<r __class__s rrBMidiException.__init__s r c,[UR5$r)reprrrFs r__str__MidiException.__str__sDNN##r )r) rZr[r\r]r^rBrr_ __classcell__)rs@rrrs$$r rc [[SS[R"US- 5-[R"S5- -55$)zconverts a frequency into a MIDI note. Rounds to the closest midi note. ::Examples:: >>> frequency_to_midi(27.5) 21 >>> frequency_to_midi(36.7) 26 >>> frequency_to_midi(4186.0) 108 E {@)introundmathlog) frequencys rrrs9 uR2U): ;;txx{JJK LLr c2[SSUS- S---S5$)zConverts a midi note to a frequency. ::Examples:: >>> midi_to_frequency(21) 27.5 >>> midi_to_frequency(26) 36.7 >>> midi_to_frequency(108) 4186.0 rrrgUUUUUU?rk)r) midi_notes rrrs$  B:>?? CCr cR/SQnSnU[US- U-5nUS- U-nUU3$)zreturns the Ansi Note name for a midi number. ::Examples:: >>> midi_to_ansi_note(21) 'A0' >>> midi_to_ansi_note(102) 'F#7' >>> midi_to_ansi_note(108) 'C8' ) AzA#BCzC#DzD#EFzF#GzG#r)r)rnotes num_notes note_name note_numbers rrrsD NEIc9r>Y678Ir>i/K[ &&r r)r^rrr pygame.locals pygame.pypmpypmrlocalsrr__all____theclasses__rr rrr&rr r r rrrr Exceptionrrrrrr rrs0     --   (8$   ;  /+d/,d&$_0_0DE3E3h0 $I $M" D'r