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