Google Git
Sign in
chromium/external/github.com/PortAudio/portaudio/refs/heads/upstream/master
commit
a880212eea40537d4c7906d70dc6adb17c8949e9
[log]
author
David Huggins-Daines <dhd@ecolingui.ca>
Sat Aug 08 01:40:04 2026
committer
GitHub <noreply@github.com>
Sat Aug 08 01:40:04 2026
tree
14a8183a40ebada0814d7ba94d9d81966d81cf78
parent
71bf8c8d024d89f39220dc00162c3c32ed4d6cd0 [diff]
Correct and improve CMake documentation (#1151)

* correct mentions of `--config` which does not work as claimed

* use `cmake --build .` command instead of `make`

* correct some paths

* unix: makefiles are the default, mention ninja

* correct some things about multi-config cmake

* fixes #745 (everything about `CMAKE_MODULE_PATH` was wrong, add the correct way to point to an installed PortAudio)

* clarify how to make `find_package()` work and what to do if you cannot

* clarify `add_subdirectory` and remove `<tt>` from headings

* tweak language slightly
1 file changed
tree: 14a8183a40ebada0814d7ba94d9d81966d81cf78
  1. .github/
  2. bindings/
  3. cmake/
  4. doc/
  5. examples/
  6. include/
  7. msvc/
  8. qa/
  9. src/
  10. test/
  11. .editorconfig
  12. .gitattributes
  13. .gitignore
  14. aclocal.m4
  15. clear_gitrevision.sh
  16. CMakeLists.txt
  17. config.guess
  18. config.sub
  19. configure
  20. configure.ac
  21. Doxyfile
  22. Doxyfile.developer
  23. filtered1.wav
  24. install-sh
  25. LICENSE.txt
  26. ltmain.sh
  27. Makefile.in
  28. pa_compare_def_files.py
  29. pa_whitelint.py
  30. portaudio-2.0.pc.in
  31. README.configure.txt
  32. README.md
  33. update_gitrevision.sh
  34. vcpkg.json
README.md

PortAudio - portable audio I/O library

PortAudio is a portable audio I/O library designed for cross-platform support of audio. It uses either a callback mechanism to request audio processing, or blocking read/write calls to buffer data between the native audio subsystem and the client. Audio can be processed in various formats, including 32 bit floating point, and will be converted to the native format internally.

Documentation:

  • Documentation is available at http://www.portaudio.com/docs/
  • Or at /doc/html/index.html after running Doxygen.
  • Also see src/common/portaudio.h for the API spec.
  • And see the examples/ and test/ directories for many examples of usage. (We suggest examples/paex_saw.c for an example.)

For information on compiling programs with PortAudio, please see the tutorial at:

http://portaudio.com/docs/v19-doxydocs/tutorial_start.html

We have an active mailing list for user and developer discussions. Please feel free to join. See http://www.portaudio.com for details.

Important Files and Folders:

include/portaudio.h     = header file for PortAudio API. Specifies API.	
src/common/             = platform independent code, host independent 
                          code for all implementations.
src/os                  = os specific (but host api neutral) code
src/hostapi             = implementations for different host apis

Host API Implementations:

src/hostapi/alsa        = Advanced Linux Sound Architecture (ALSA)
src/hostapi/asihpi      = AudioScience HPI
src/hostapi/asio        = ASIO for Windows and Macintosh
src/hostapi/audioio     = /dev/audio (Solaris/NetBSD Audio)
src/hostapi/coreaudio   = Macintosh Core Audio for OS X
src/hostapi/dsound      = Windows Direct Sound
src/hostapi/jack        = JACK Audio Connection Kit
src/hostapi/oss         = Unix Open Sound System (OSS)
src/hostapi/pulseaudio  = Sound system for POSIX OSes
src/hostapi/sndio       = Small audio and MIDI framework (sndio)
src/hostapi/wasapi      = Windows Vista WASAPI
src/hostapi/wdmks       = Windows WDM Kernel Streaming
src/hostapi/wmme        = Windows MultiMedia Extensions (MME)

Test Programs:

test/pa_fuzz.c         = guitar fuzz box
test/pa_devs.c         = print a list of available devices
test/pa_minlat.c       = determine minimum latency for your machine
test/paqa_devs.c       = self test that opens all devices
test/paqa_errs.c       = test error detection and reporting
test/patest_clip.c     = hear a sine wave clipped and unclipped
test/patest_dither.c   = hear effects of dithering (extremely subtle)
test/patest_pink.c     = fun with pink noise
test/patest_record.c   = record and playback some audio
test/patest_maxsines.c = how many sine waves can we play? Tests Pa_GetCPULoad().
test/patest_sine.c     = output a sine wave in a simple PA app
test/patest_sync.c     = test synchronization of audio and video
test/patest_wire.c     = pass input to output, wire simulator