summaryrefslogtreecommitdiff
path: root/3rdparty/portaudio/doc/src/tutorial/compile_windows_asio_msvc.dox
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/portaudio/doc/src/tutorial/compile_windows_asio_msvc.dox')
-rw-r--r--3rdparty/portaudio/doc/src/tutorial/compile_windows_asio_msvc.dox97
1 files changed, 97 insertions, 0 deletions
diff --git a/3rdparty/portaudio/doc/src/tutorial/compile_windows_asio_msvc.dox b/3rdparty/portaudio/doc/src/tutorial/compile_windows_asio_msvc.dox
new file mode 100644
index 0000000..cf3a0e5
--- /dev/null
+++ b/3rdparty/portaudio/doc/src/tutorial/compile_windows_asio_msvc.dox
@@ -0,0 +1,97 @@
+/** @page compile_windows_asio_msvc Building Portaudio for Windows with ASIO support using MSVC
+@ingroup tutorial
+
+@section comp_win_asiomsvc1 Portaudio Windows ASIO with MSVC
+
+This tutorial describes how to build PortAudio with ASIO support using MSVC *from scratch*, without an existing Visual Studio project. For instructions for building PortAudio (including ASIO support) using the bundled Visual Studio project file see the compiling instructions for \ref compile_windows.
+
+ASIO is a low latency audio API from Steinberg. To compile an ASIO
+application, you must first download the ASIO SDK from Steinberg. You also
+need to obtain ASIO drivers for your audio device. Download the ASIO SDK from Steinberg at http://www.steinberg.net/en/company/developer.html . The SDK is free but you will need to set up a developer account with Steinberg.
+
+This tutorial assumes that you have 3 directories set up at the same level (side by side), one containing PortAudio, one containing the ASIO SDK and one containing your Visual Studio project:
+
+@code
+/ASIOSDK2
+/portaudio
+/DirContainingYourVisualStudioProject (should directly contain the .sln, .vcproj or .vcprojx etc.)
+@endcode
+
+First, make sure that the Steinberg SDK and the portaudio files are "side by side" in the same directory.
+
+Open Microsoft Visual C++ and create a new blank Console exe Project/Workspace in that same directory.
+
+For example, the paths for all three groups might read like this:
+
+@code
+C:\Program Files\Microsoft Visual Studio\VC98\My Projects\ASIOSDK2
+C:\Program Files\Microsoft Visual Studio\VC98\My Projects\portaudio
+C:\Program Files\Microsoft Visual Studio\VC98\My Projects\Sawtooth
+@endcode
+
+
+Next, add the following Steinberg ASIO SDK files to the project Source Files:
+
+@code
+asio.cpp (ASIOSDK2\common)
+asiodrivers.cpp (ASIOSDK2\host)
+asiolist.cpp (ASIOSDK2\host\pc)
+@endcode
+
+
+Then, add the following PortAudio files to the project Source Files:
+
+@code
+pa_asio.cpp (portaudio\src\hostapi\asio)
+pa_allocation.c (portaudio\src\common)
+pa_converters.c (portaudio\src\common)
+pa_cpuload.c (portaudio\src\common)
+pa_dither.c (portaudio\src\common)
+pa_front.c (portaudio\src\common)
+pa_process.c (portaudio\src\common)
+pa_ringbuffer.c (portaudio\src\common)
+pa_stream.c (portaudio\src\common)
+pa_trace.c (portaudio\src\common)
+pa_win_hostapis.c (portaudio\src\os\win)
+pa_win_util.c (portaudio\src\os\win)
+pa_win_coinitialize.c (portaudio\src\os\win)
+pa_win_waveformat.c (portaudio\src\os\win)
+pa_x86_plain_converters.c (portaudio\src\os\win)
+paex_saw.c (portaudio\examples) (Or another file containing main()
+ for the console exe to be built.)
+@endcode
+
+
+Although not strictly necessary, you may also want to add the following files to the project Header Files:
+
+@code
+portaudio.h (portaudio\include)
+pa_asio.h (portaudio\include)
+@endcode
+
+These header files define the interfaces to the PortAudio API.
+
+
+Next, go to Project Settings > All Configurations > C/C++ > Preprocessor > Preprocessor Definitions and add
+PA_USE_ASIO=1 to any entries that might be there.
+
+eg: WIN32;_CONSOLE;_MBCS changes to WIN32;_CONSOLE,_MBCS;PA_USE_ASIO=1
+
+Then, on the same Project Settings tab, go down to Additional Include Directories (in VS2010 you'll find this setting under C/C++ > General) and enter the following relative include paths:
+
+@code
+..\portaudio\include;..\portaudio\src\common;..\portaudio\src\os\win;..\asiosdk2\common;..\asiosdk2\host;..\asiosdk2\host\pc
+@endcode
+
+You'll need to make sure the relative paths are correct for the particular directory layout you're using. The above should work fine if you use the side-by-side layout we recommended earlier.
+
+Some source code in the ASIO SDK is not compatible with the Win32 API UNICODE mode (The ASIO SDK expects the non-Unicode Win32 API). Therefore you need to make sure your project is set to not use Unicode. You do this by setting the project Character Set to "Use Multi-Byte Character Set" (NOT "Use Unicode Character Set"). In VS2010 the Character Set option can be found at Configuration Properties > General > Character Set. (An alternative to setting the project to non-Unicode is to patch asiolist.cpp to work when UNICODE is defined: put #undef UNICODE at the top of the file before windows.h is included.)
+
+You should now be able to build any of the test executables in the portaudio\\examples directory.
+We suggest that you start with paex_saw.c because it's one of the simplest example files.
+
+--- Chris Share, Tom McCandless, Ross Bencina
+
+Back to the Tutorial: \ref tutorial_start
+
+*/ \ No newline at end of file