Chris@4: #ifndef INCLUDED_PORTAUDIO_PORTAUDIOCPP_HXX
Chris@4: #define INCLUDED_PORTAUDIO_PORTAUDIOCPP_HXX
Chris@4:
Chris@4: // ---------------------------------------------------------------------------------------
Chris@4:
Chris@4: //////
Chris@4: /// @mainpage PortAudioCpp
Chris@4: ///
Chris@4: /// PortAudioCpp - A Native C++ Binding of PortAudio V19
Chris@4: /// PortAudio
Chris@4: ///
Chris@4: /// PortAudio is a portable and mature C API for accessing audio hardware. It offers both callback-based and blocking
Chris@4: /// style input and output, deals with sample data format conversions, dithering and much more. There are a large number
Chris@4: /// of implementations available for various platforms including Windows MME, Windows DirectX, Windows and MacOS (Classic)
Chris@4: /// ASIO, MacOS Classic SoundManager, MacOS X CoreAudio, OSS (Linux), Linux ALSA, JACK (MacOS X and Linux) and SGI Irix
Chris@4: /// AL. Note that, currently not all of these implementations are equally complete or up-to-date (as PortAudio V19 is
Chris@4: /// still in development). Because PortAudio has a C API, it can easily be called from a variety of other programming
Chris@4: /// languages.
Chris@4: ///
Chris@4: /// PortAudioCpp
Chris@4: ///
Chris@4: /// Although, it is possible to use PortAudio's C API from within a C++ program, this is usually a little awkward
Chris@4: /// as procedural and object-oriented paradigms need to be mixed. PortAudioCpp aims to resolve this by encapsulating
Chris@4: /// PortAudio's C API to form an equivalent object-oriented C++ API. It provides a more natural integration of PortAudio
Chris@4: /// into C++ programs as well as a more structured interface. PortAudio's concepts were preserved as much as possible and
Chris@4: /// no additional features were added except for some `convenience methods'.
Chris@4: ///
Chris@4: ///
Chris@4: /// PortAudioCpp's main features are:
Chris@4: ///
Chris@4: /// - Structured object model.
Chris@4: /// - C++ exception handling instead of C-style error return codes.
Chris@4: /// - Handling of callbacks using free functions (C and C++), static functions, member functions or instances of classes
Chris@4: /// derived from a given interface.
Chris@4: /// - STL compliant iterators to host APIs and devices.
Chris@4: /// - Some additional convenience functions to more easily set up and use PortAudio.
Chris@4: ///
Chris@4: ///
Chris@4: ///
Chris@4: /// PortAudioCpp requires a recent version of the PortAudio V19 source code. This can be obtained from CVS or as a snapshot
Chris@4: /// from the website. The examples also require the ASIO 2 SDK which can be obtained from the Steinberg website. Alternatively, the
Chris@4: /// examples can easily be modified to compile without needing ASIO.
Chris@4: ///
Chris@4: ///
Chris@4: /// Supported platforms:
Chris@4: ///
Chris@4: /// - Microsoft Visual C++ 6.0, 7.0 (.NET 2002) and 7.1 (.NET 2003).
Chris@4: /// - GNU G++ 2.95 and G++ 3.3.
Chris@4: ///
Chris@4: /// Other platforms should be easily supported as PortAudioCpp is platform-independent and (reasonably) C++ standard compliant.
Chris@4: ///
Chris@4: ///
Chris@4: /// This documentation mainly provides information specific to PortAudioCpp. For a more complete explaination of all of the
Chris@4: /// concepts used, please consult the PortAudio documentation.
Chris@4: ///
Chris@4: ///
Chris@4: /// PortAudioCpp was developed by Merlijn Blaauw with many great suggestions and help from Ross Bencina. Ludwig Schwardt provided
Chris@4: /// GNU/Linux build files and checked G++ compatibility. PortAudioCpp may be used under the same licensing, conditions and
Chris@4: /// warranty as PortAudio. See the PortAudio license for more details.
Chris@4: ///
Chris@4: /// Links
Chris@4: ///
Chris@4: /// Official PortAudio site.
Chris@4: ///
Chris@4: //////
Chris@4:
Chris@4: // ---------------------------------------------------------------------------------------
Chris@4:
Chris@4: //////
Chris@4: /// @namespace portaudio
Chris@4: ///
Chris@4: /// To avoid name collision, everything in PortAudioCpp is in the portaudio
Chris@4: /// namespace. If this name is too long it's usually pretty safe to use an
Chris@4: /// alias like ``namespace pa = portaudio;''.
Chris@4: //////
Chris@4:
Chris@4: // ---------------------------------------------------------------------------------------
Chris@4:
Chris@4: //////
Chris@4: /// @file PortAudioCpp.hxx
Chris@4: /// An include-all header file (for lazy programmers and using pre-compiled headers).
Chris@4: //////
Chris@4:
Chris@4: // ---------------------------------------------------------------------------------------
Chris@4:
Chris@4: #include "portaudio.h"
Chris@4:
Chris@4: #include "portaudiocpp/AutoSystem.hxx"
Chris@4: #include "portaudiocpp/BlockingStream.hxx"
Chris@4: #include "portaudiocpp/CallbackInterface.hxx"
Chris@4: #include "portaudiocpp/CallbackStream.hxx"
Chris@4: #include "portaudiocpp/CFunCallbackStream.hxx"
Chris@4: #include "portaudiocpp/CppFunCallbackStream.hxx"
Chris@4: #include "portaudiocpp/Device.hxx"
Chris@4: #include "portaudiocpp/Exception.hxx"
Chris@4: #include "portaudiocpp/HostApi.hxx"
Chris@4: #include "portaudiocpp/InterfaceCallbackStream.hxx"
Chris@4: #include "portaudiocpp/MemFunCallbackStream.hxx"
Chris@4: #include "portaudiocpp/SampleDataFormat.hxx"
Chris@4: #include "portaudiocpp/DirectionSpecificStreamParameters.hxx"
Chris@4: #include "portaudiocpp/Stream.hxx"
Chris@4: #include "portaudiocpp/StreamParameters.hxx"
Chris@4: #include "portaudiocpp/System.hxx"
Chris@4: #include "portaudiocpp/SystemDeviceIterator.hxx"
Chris@4: #include "portaudiocpp/SystemHostApiIterator.hxx"
Chris@4:
Chris@4: // ---------------------------------------------------------------------------------------
Chris@4:
Chris@4: #endif // INCLUDED_PORTAUDIO_PORTAUDIOCPP_HXX