VCVRack
/
Rack
mirror of https://github.com/VCVRack/Rack.git
1
0
Fork 0
Code Issues 0 Releases 43 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1026 Commits
4 Branches
540MB
Tree: f455deed13
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f455deed13'
${ noResults }
Rack/plugins/community/repos/Autodafe/dep/stk/doc/doxygen/compile.txt

128 lines
7.7KB
Raw Blame History 

  1. /*! \page compile Compiling

  2. 

  3. 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 <TT>Makefiles</TT> that compile project-specific class objects from common <TT>src</TT> and <TT>include</TT> 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.

  4. 

  5. 

  6. \section rtvsnonrt "Realtime" vs. "Non-Realtime"

  7. 

  8. Most of the Synthesis ToolKit classes are platform independent.  That

  9. means that they should compile on any reasonably current C++ compiler.

  10. The functionality needed for realtime audio and MIDI input/output, as

  11. well as realtime control message acquistion, is inherently platform

  12. and operating-system (OS) <I>dependent</I>.  STK classes that require

  13. specific platform/OS support include RtAudio, RtWvOut, RtWvIn,

  14. RtDuplex, RtMidi, InetWvIn, InetWvOut, Socket, UdpSocket, TcpServer,

  15. TcpClient, Thread, and Mutex.  These classes currently can only be

  16. compiled on Linux, Macintosh OS X, and Windows systems.

  17. 

  18. Without the "realtime" classes, it is still possible to read SKINI

  19. scorefiles for control input and to read and write to/from a variety

  20. of audio file formats (WAV, SND, AIFF, MAT-file, and RAW).  If

  21. compiling for a "little-endian" host processor, the

  22. <TT>__LITTLE_ENDIAN__</TT> preprocessor definition should be provided.

  23. 

  24. 

  25. \section unix Unix Systems:

  26. 

  27. STK compiles with realtime support on the following flavors of the Unix operating system: Linux, Irix, and Macintosh OS X.  Aside from differences in compilers, audio/MIDI APIs, and host endianness, the steps necessary to compile STK programs and classes on these platforms are the same.  The following table summarizes these differences.

  28. 

  29. <CENTER>

  30. <TABLE BORDER=2 COLS=5 WIDTH="100%">

  31. <TR BGCOLOR="beige">

  32.   <TD WIDTH="5%"><B>OS:</B></TD>

  33.   <TD WIDTH="5%"><B>Realtime Audio/MIDI API:</B></TD>

  34.   <TD WIDTH="5%"><B>Preprocessor Definition:</B></TD>

  35.   <TD WIDTH="5%"><B>Library or Framework:</B></TD>

  36. </TR>

  37. <TR>

  38.   <TD>Linux</TD>

  39.   <TD>ALSA</TD>

  40.   <TD>__LINUX_ALSA__, __LITTLE_ENDIAN__</TD>

  41.   <TD><TT>asound, pthread</TT></TD>

  42. </TR>

  43. <TR>

  44.   <TD>Linux</TD>

  45.   <TD>OSS (version 4.0 only, use ALSA for MIDI support)</TD>

  46.   <TD>__LINUX_OSS__, __LINUX_ALSA__, __LITTLE_ENDIAN__</TD>

  47.   <TD><TT>asound, pthread</TT></TD>

  48. </TR>

  49. <TR>

  50.   <TD>Linux and Macintosh OS-X</TD>

  51.   <TD>Jack</TD>

  52.   <TD>__UNIX_JACK__, __LITTLE_ENDIAN__</TD>

  53.   <TD><TT>asound, pthread, jack</TT></TD>

  54. </TR>

  55. <TR>

  56.   <TD>Macintosh OS X</TD>

  57.   <TD>CoreAudio</TD>

  58.   <TD>__MACOSX_CORE__</TD>

  59.   <TD><TT>pthread, CoreAudio, CoreMIDI, CoreFoundation</TT></TD>

  60. </TR>

  61. </TABLE>

  62. </CENTER>

  63. 

  64. The available C++ compilers on any of these systems can vary.

  65. 

  66. One approach in using STK is to simply copy the class files needed for

  67. a particular program into a project directory.  Taking the

  68. <TT>sineosc.cpp</TT> example from the previous tutorial chapter, it

  69. would be necessary to set up a directory that includes the files

  70. <TT>sineosc.cpp</TT>, the rawwave file <TT>sinewave.raw</TT> in a

  71. subdirectory called <TT>rawwaves</TT>, and the header and source files

  72. for the classes Stk, FileRead, FileWrite, FileWvIn, FileLoop, and

  73. FileWvOut.  The program could then be compiled on a little-endian

  74. system, such as a PC running Linux, using the GNU g++ compiler as

  75. follows:

  76. \code g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc Stk.cpp FileRead.cpp FileWrite.cpp FileWvIn.cpp FileLoop.cpp FileWvOut.cpp sineosc.cpp \endcode

  77. 

  78. Note that the <TT>sineosc.cpp</TT> example does not make use of realtime audio or MIDI input/output classes.  For programs using any of the STK realtime classes mentioned above, it is necessary to specify an audio/MIDI API preprocessor definition and link with the appropriate libraries or frameworks.

  79. 

  80. When working with a number of different projects that make use of ToolKit classes, the above approach can become cumbersome (especially when trying to synchronize with new STK releases).  Most of the STK projects (e.g., demo, effects, ...) contain <TT>Makefiles</TT> (built by the configure script) that compile project-specific class objects from the distribution <TT>src</TT> and <TT>include</TT> directories.  This approach makes it relatively easy when upgrading to a new STK release (by making path substitutions in the <TT>Makefile</TT> or by moving the projects to a similar relative path within the new STK source tree).  A <TT>Makefile</TT> is provided in the <TT>projects/examples</TT> directory for compiling all the tutorial programs, as well as other example programs.  To compile the <TT>sineosc.cpp</TT> program, for example, one need only type <TT>make sineosc</TT> from within the <TT>projects/examples</TT> directory.

  81. 

  82. 

  83. \subsection library Library Use:

  84. 

  85. The STK distribution provides a <TT>Makefile</TT> that can be used on Unix systems to build a static library.  After unpacking the distribution (<TT>tar -xzf stk-4.x.x.tar.gz</TT>), run the configure script by typing <TT>./configure</TT> from the top level distribution directory (see the INSTALL file in the same directory for more information).  Then from within the <TT>src</TT> directory, type <TT>make</TT>.  After a successful build, you may wish to move the library (<TT>libstk.a</TT>) and the contents of the <TT>include</TT> directory to standard library and include search paths on your system.  For example, the linux RPM distribution of STK puts the library in <TT>/usr/lib/</TT> and the STK header files in <TT>/usr/include/stk/</TT>.

  86. 

  87. Assuming the library is located in a standard search path and the header files are located in <TT>/usr/include/stk/</TT>, the <TT>sineosc.cpp</TT> example from the previous tutorial chapter can be compiled on a little-endian system using the GNU g++ compiler as follows:

  88. 

  89. \code

  90. g++ -Wall -D__LITTLE_ENDIAN__ -I/usr/include/stk -o sineosc sineosc.cpp -lstk

  91. \endcode

  92. 

  93. With the header files in a standard search path, it is possible to modify the <TT>\#include</TT> statements in the <TT>sineosc.cpp</TT> program as follows:

  94. 

  95. \code

  96. #include "stk/FileLoop.h"

  97. #include "stk/FileWvOut.h"

  98. \endcode

  99. 

  100. and then compile without an explicit include path argument to the compiler:

  101. 

  102. \code

  103. g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc sineosc.cpp -lstk

  104. \endcode

  105. 

  106. 

  107. \section compileWin Windows:

  108. 

  109. STK has been tested on Windows platforms using the Visual .NET compiler

  110. only.  It is assumed here that you're familiar with Visual C++ and its

  111. particular idiosyncrasies.  STK won't compile in Visual C++ 6.0 any more.

  112. 

  113. The approach when using Visual C++ is to build a project that

  114. includes the necessary ToolKit files from the distribution

  115. <TT>src</TT> and <TT>include</TT> directories.  For the example

  116. program from the previous tutorial chapter, create a VC++ console

  117. application project, add the Stk, FileRead, FileWrite, WvIn, FileWvIn,

  118. FileLoop, WvOut, and FileWvOut class files, as well as

  119. <TT>sineosc.cpp</TT>, and make sure the <TT>sinewave.raw</TT> file is

  120. in the subdirectory <TT>rawwaves</TT>.

  121. 

  122. For programs using any of the STK realtime classes mentioned above, it is necessary to link with the DirectSound (<TT>dsound.lib</TT>), <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries, select the multithreaded library, and provide the <TT>__LITTLE_ENDIAN__</TT>, <TT>__WINDOWS_DS__</TT>, and <TT>__WINDOWS_MM__</TT> preprocessor definitions.

  123. 

  124. For Steinberg ASIO support, use the <TT>__WINDOWS_ASIO__</TT> preprocessor definition (and the <TT>__WINDOWS_MM__</TT> definition for RtMidi support), include all the files in the <TT>src/asio/</TT> directory (i.e., <TT>asio.h,cpp</TT>, <TT>asiodrivers.h,cpp</TT>, ...), and link with the <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries.

  125. 

  126. [<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="filtering.html">Next tutorial</A>]

  127. */