March 18, 2017

Many thanks to both Blaise Potard and Matthias Schaff for discovering the issue and for their patches! Thanks as well to Timothy Port for helping to correct a docstring.

January 16, 2017

Great thanks to Michael Graczyk for discovering the GIL-related issues and for submitting a patch!

October 19, 2015

October 18, 2015

Many thanks to Tony Jacobson for discovering and helping with the overflow error. Thanks also to Sami Liedes for reporting the IOError exception issue!

April 12, 2014

Many thanks to Jason Roehm for discovering and patching the threading-related issue!

January 30, 2014

October 27, 2012

• Modernized documentation format
• Fix for callback (non-blocking) operation
• Binaries for Python 3.3

Thanks again to Bastian Bechtold for his help converting the documentation for use with Sphinx! In addition, thanks to John K. Luebs for the callback fix.

October 14, 2012

• Python 3 support
• Callback (non-blocking) operation
• Bug fixes

Many thanks to Bastian Bechtold and Bob Jamison for their contributions! Without their patches and Bastian's careful review, this release would still be far away. Also, great thanks to Danilo J. S. Bellini for reporting bugs.

Note: As of this update, PyAudio is compatible with Python 2.6, Python 2.7, and Python 3.2. For Python installations older than 2.6, usePyAudio 0.2.4.

August 22, 2012

April 20, 2012

March 7, 2012

December 7, 2010

November 2, 2010

October 12, 2010

November 2, 2008

March 5, 2008

July 6, 2006

Install usingpip:

python -m pip install pyaudio

Notes:

• If pip is not already bundled with your installation of Python, get ithere.
• pip will fetch and install PyAudio wheels (prepackaged binaries). Currently, there are wheels compatible with theofficial distributions for Python 3.8, 3.9, 3.10, 3.11, and 3.12. Both 32-bit and 64-bit wheels are available.
• These binaries include PortAudio v19 19.7.0, built using the native compiler toolchain. They support the Windows MME API, DirectSound, WASAPI, and WDM-KS. They donot include support for ASIO. If you require support for APIs not included, you will need to compile PortAudio and PyAudio.

UseHomebrew to install the prerequisite portaudio library, then install PyAudio using pip:

brew install portaudio
pip install pyaudio

Notes:

• If not already installed, downloadHomebrew.
• pip will download the PyAudio source and build it for your version of Python.
• Homebrew and building PyAudio also require installing the Command Line Tools for Xcode (more information).

Use the package manager to install PyAudio. For example, on Debian-based systems:

sudo apt-get install python3-pyaudio

If the latest version of PyAudio is not available, install it using pip:

pip install pyaudio

Notes:

• pip will download the PyAudio source and build it for your system. Be sure to install the portaudio library development package (e.g.,portaudio19-dev) and the python development package (e.g.,python3-all-dev) beforehand.
• For better isolation from system packages, consider installing PyAudio in avirtualenv.

Source is available for download at thePython Package Index (PyPI).

Or clone the git repository:

git clone https://people.csail.mit.edu/hubert/git/pyaudio.git

To build PyAudio from source, you will also need to buildPortAudio v19. See the INSTALLATION file in the PyAudio source bundle for build instructions.

• Play
• Record
• Wire
• Play (Callback)
• Wire (Callback)
• Channel Maps

"""PyAudio Example: Play a wave file."""importwaveimportsysimportpyaudioCHUNK=1024iflen(sys.argv)<2:print(f'Plays a wave file. Usage:{sys.argv[0]} filename.wav')sys.exit(-1)withwave.open(sys.argv[1],'rb')aswf:# Instantiate PyAudio and initialize PortAudio system resources (1)p=pyaudio.PyAudio()# Open stream (2)stream=p.open(format=p.get_format_from_width(wf.getsampwidth()),channels=wf.getnchannels(),rate=wf.getframerate(),output=True)# Play samples from the wave file (3)whilelen(data:=wf.readframes(CHUNK)):# Requires Python 3.8+ for :=stream.write(data)# Close stream (4)stream.close()# Release PortAudio system resources (5)p.terminate()

"""PyAudio Example: Record a few seconds of audio and save to a wave file."""importwaveimportsysimportpyaudioCHUNK=1024FORMAT=pyaudio.paInt16CHANNELS=1ifsys.platform=='darwin'else2RATE=44100RECORD_SECONDS=5withwave.open('output.wav','wb')aswf:p=pyaudio.PyAudio()wf.setnchannels(CHANNELS)wf.setsampwidth(p.get_sample_size(FORMAT))wf.setframerate(RATE)stream=p.open(format=FORMAT,channels=CHANNELS,rate=RATE,input=True)print('Recording...')for_inrange(0,RATE//CHUNK*RECORD_SECONDS):wf.writeframes(stream.read(CHUNK))print('Done')stream.close()p.terminate()

"""PyAudio Example: full-duplex wire between input and output."""importsysimportpyaudioRECORD_SECONDS=5CHUNK=1024RATE=44100p=pyaudio.PyAudio()stream=p.open(format=p.get_format_from_width(2),channels=1ifsys.platform=='darwin'else2,rate=RATE,input=True,output=True,frames_per_buffer=CHUNK)print('* recording')foriinrange(0,int(RATE/CHUNK*RECORD_SECONDS)):stream.write(stream.read(CHUNK))print('* done')stream.close()p.terminate()

"""PyAudio Example: Play a wave file (callback version)."""importwaveimporttimeimportsysimportpyaudioiflen(sys.argv)<2:print(f'Plays a wave file. Usage:{sys.argv[0]} filename.wav')sys.exit(-1)withwave.open(sys.argv[1],'rb')aswf:# Define callback for playback (1)defcallback(in_data,frame_count,time_info,status):data=wf.readframes(frame_count)# If len(data) is less than requested frame_count, PyAudio automatically# assumes the stream is finished, and the stream stops.return(data,pyaudio.paContinue)# Instantiate PyAudio and initialize PortAudio system resources (2)p=pyaudio.PyAudio()# Open stream using callback (3)stream=p.open(format=p.get_format_from_width(wf.getsampwidth()),channels=wf.getnchannels(),rate=wf.getframerate(),output=True,stream_callback=callback)# Wait for stream to finish (4)whilestream.is_active():time.sleep(0.1)# Close the stream (5)stream.close()# Release PortAudio system resources (6)p.terminate()

"""PyAudio Example: Audio wire between input and output. Callback version."""importtimeimportsysimportpyaudioDURATION=5# secondsdefcallback(in_data,frame_count,time_info,status):return(in_data,pyaudio.paContinue)p=pyaudio.PyAudio()stream=p.open(format=p.get_format_from_width(2),channels=1ifsys.platform=='darwin'else2,rate=44100,input=True,output=True,stream_callback=callback)start=time.time()whilestream.is_active()and(time.time()-start)<DURATION:time.sleep(0.1)stream.close()p.terminate()

"""PyAudio Example: macOS-only: Play a wave file with channel maps."""importwaveimportsysimportpyaudioCHUNK=1024iflen(sys.argv)<2:print(f'Plays a wave file. Usage:{sys.argv[0]} filename.wav')sys.exit(-1)# standard L-R stereo# channel_map = (0, 1)# reverse: R-L stereo# channel_map = (1, 0)# no audio# channel_map = (-1, -1)# left channel audio --> left speaker; no right channel# channel_map = (0, -1)# right channel audio --> right speaker; no left channel# channel_map = (-1, 1)# left channel audio --> right speaker# channel_map = (-1, 0)# right channel audio --> left speakerchannel_map=(1,-1)# etc...try:stream_info=pyaudio.PaMacCoreStreamInfo(flags=pyaudio.PaMacCoreStreamInfo.paMacCorePlayNice,channel_map=channel_map)exceptAttributeError:print('Could not find PaMacCoreStreamInfo. Ensure you are running on macOS.')sys.exit(-1)print('Stream Info Flags:',stream_info.flags)print('Stream Info Channel Map:',stream_info.channel_map)withwave.open(sys.argv[1],'rb')aswf:p=pyaudio.PyAudio()stream=p.open(format=p.get_format_from_width(wf.getsampwidth()),channels=wf.getnchannels(),rate=wf.getframerate(),output=True,output_host_api_specific_stream_info=stream_info)# Play streamwhilelen(data:=wf.readframes(CHUNK)):# Requires Python 3.8+ for :=stream.write(data)stream.close()p.terminate()

License

Copyright (c) 2006Hubert Pham

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgements

Many thanks to Andrew Baldwin, Alex ThreeD, Timothée Lecomte, Frank Samuelson, Matthieu Brucher, Chris Stawarz, Barry Walker, Bob Jamison, Danilo J. S. Bellini, Bastian Bechtold, Christoph Gohlke, Sebastian Audet, Jason Roehm, Tony Jacobson, Sami Liedes, Michael Graczyk, Blaise Potard, Matthias Schaff, Timothy Port, Sean Zimmermann, Jason Hihn, Eiichi Takamori, Matěj Cepl, Vasily Zakharov, Artur Janowiec, and Bhanu Victor DiCara for their much appreciated suggestions and patches—as well as to others who have written to say hello!

Special thanks to Felipe Sateler and Justin Mazzola Paluska for Debian/Ubuntu packaging help.

The development of PyAudio was funded in part by the Cambridge-MIT Institute and T-Party.

Contact

Comments, suggestions, and patches welcomed. Send mail to my first name atmit.edu.