From e4d373b65866493e70ff542d96d5f8120d425066 Mon Sep 17 00:00:00 2001 From: cepthomas Date: Tue, 13 Nov 2018 12:28:23 -0600 Subject: [PATCH] Updated docs for windows. Still could use some re-org but would need to consider all platforms. Fixed a few links. Still lots more broken. --- doc/README-Win.txt | 4 ++-- doc/doxygen/compile.txt | 20 +------------------- doc/doxygen/system.txt | 4 ++-- doc/doxygen/usage.txt | 6 +++--- 4 files changed, 8 insertions(+), 26 deletions(-) diff --git a/doc/README-Win.txt b/doc/README-Win.txt index 5c67a17..8c271af 100644 --- a/doc/README-Win.txt +++ b/doc/README-Win.txt @@ -6,7 +6,7 @@ Please read the file README.md for more general STK information. The configure script supports MinGW. -Alternatively Visual Studio may be used. The folders in the projects directory contain VS2017 solution files. +STK has been built and tested on Windows platforms using Visual Studio. It is assumed here that you're familiar with Visual C++ and its particular idiosyncrasies. The currently supported version is VS2017. You can download the free non-commercial community edition from the Microsoft website. The folders in the projects directory contain VS2017 solution files. If you are creating a new stk application, it's easiest to use the supplied template: - Copy stk\projects\stk-template.zip to C:\Users\\Documents\Visual Studio 2017\Templates\ProjectTemplates\Visual C++ Project\ - Start VS2017. @@ -19,7 +19,7 @@ To use the Tcl/Tk GUIs, you will have to install Tcl/Tk and build using MinGW. With Windows XP and later, piping works as under unix. Simply fire up the script files (e.g. StkDemo.bat) by either double-clicking on them or from within a shell. -The DirectSound, WASAPI and Steinberg ASIO audio APIs are supported for realtime audio input/output. The VS2017 project files included with this distribution are configured to use all supported APIs. In order to use the ASIO API, it is necessary to use the preprocessor definition __WINDOWS_ASIO__, as well as include most of the files in the /src/include/ directory (i.e. asio.h, asio.cpp, ...). If you have a good quality soundcard and a native ASIO driver (not emulated), you are likely to get much better input/output response using that. +The DirectSound, WASAPI and Steinberg ASIO audio APIs are supported for realtime audio input/output. The VS2017 project files included with this distribution are configured to use all supported APIs. The default (as in stk-template) is the DirectSound API (preprocessor definition __WINDOWS_DS__). In order to use the ASIO API, it is necessary to use the preprocessor definition __WINDOWS_ASIO__, as well as include most of the files in the /src/include/ directory (i.e. asio.h, asio.cpp, ...). If you have a good quality soundcard and a native ASIO driver (not emulated), you are likely to get much better input/output response using that. When using the DirectSound API for audio input, latency can be high. If you experience realtime audio "stuttering", you should experiment with different "buffer size" and "number of buffers" values. diff --git a/doc/doxygen/compile.txt b/doc/doxygen/compile.txt index c95e88c..1a72527 100644 --- a/doc/doxygen/compile.txt +++ b/doc/doxygen/compile.txt @@ -2,6 +2,7 @@ The Synthesis ToolKit can be used in a variety of ways, depending on your particular needs. Some people choose the classes they need for a particular project and copy those to their working directory. Others create Makefiles that compile project-specific class objects from common src and include directories. And still others like to compile and link to a common library of object files. STK was not designed with one particular style of use in mind. +For specifics on creating Windows applications, see README-Win.txt. \section rtvsnonrt "Realtime" vs. "Non-Realtime" @@ -104,24 +105,5 @@ g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc sineosc.cpp -lstk \endcode -\section compileWin Windows: - -STK has been tested on Windows platforms using the Visual .NET compiler -only. It is assumed here that you're familiar with Visual C++ and its -particular idiosyncrasies. STK won't compile in Visual C++ 6.0 any more. - -The approach when using Visual C++ is to build a project that -includes the necessary ToolKit files from the distribution -src and include directories. For the example -program from the previous tutorial chapter, create a VC++ console -application project, add the Stk, FileRead, FileWrite, WvIn, FileWvIn, -FileLoop, WvOut, and FileWvOut class files, as well as -sineosc.cpp, and make sure the sinewave.raw file is -in the subdirectory rawwaves. - -For programs using any of the STK realtime classes mentioned above, it is necessary to link with the DirectSound (dsound.lib), winmm.lib, and Wsock32.lib libraries, select the multithreaded library, and provide the __LITTLE_ENDIAN__, __WINDOWS_DS__, and __WINDOWS_MM__ preprocessor definitions. - -For Steinberg ASIO support, use the __WINDOWS_ASIO__ preprocessor definition (and the __WINDOWS_MM__ definition for RtMidi support), include all the files in the src/asio/ directory (i.e., asio.h,cpp, asiodrivers.h,cpp, ...), and link with the winmm.lib, and Wsock32.lib libraries. - [Main tutorial page]   [Next tutorial] */ diff --git a/doc/doxygen/system.txt b/doc/doxygen/system.txt index febd57f..ffb67c7 100644 --- a/doc/doxygen/system.txt +++ b/doc/doxygen/system.txt @@ -3,7 +3,7 @@ General: Linux (specific): @@ -23,7 +23,7 @@ It appears that socket support in Tcl/Tk uses the Nagle algorithm, which produce -Windows95/98/2000/XP/7 (specific): +Windows95 and later (specific):