diff --git a/INSTALL b/INSTALL index 184c283..e1b9507 100644 --- a/INSTALL +++ b/INSTALL @@ -1,8 +1,8 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. -The Synthesis ToolKit in C++ can be used in a variety of ways, depending on your particular needs. Some people just choose the classes they need for a particular project and copy those to their project directory. Others like to compile and link to a library of object files. STK was not designed with one particular style of use in mind. +The Synthesis ToolKit in C++ can be used in a variety of ways, depending on your particular needs. Some people simmply choose the classes they need for a particular project and copy those to their project directory. Others like to compile and link to a library of object files. STK was not designed with one particular style of use in mind. To configure and compile (on Unix systems and MinGW): @@ -25,7 +25,7 @@ Several options can be passed to configure, including: --with-asio = choose ASIO API support (windows only) --with-ds = choose DirectSound API support (windows only) -It is now possible to specify more than one audio API where supported. Note however that the ALSA library is required in order to compile the RtMidi class, even if the "--with-oss" option is provided (only the OSS audio API will be used, not the OSS MIDI API). Typing "./configure --help" will display all the available options. In addition, it is possible to specify the RAWWAVES and INCLUDE paths to configure as (ex. to set to /home/gary/rawwaves and /home/gary/include): +It is now possible to specify more than one audio API where supported. Note, however, that the ALSA library is required in order to compile the RtMidi class in Linux, even if the "--with-oss" option is provided (only the OSS audio API will be used, not the OSS MIDI API). Typing "./configure --help" will display all the available options. In addition, it is possible to specify the RAWWAVES and INCLUDE paths to configure as (ex. to set to /home/me/rawwaves and /home/me/include): ./configure RAWWAVE_PATH='$(HOME)/rawwaves/' ./configure INCLUDE_PATH='$(HOME)/include/' @@ -36,8 +36,6 @@ If you wish to use a different compiler than that selected by configure, specify ./configure CXX=CC -In addition, a linux RPM is available from the Planet CCRMA WWW site (http://ccrma.stanford.edu/planetccrma/software/). - For Windows Users: diff --git a/Makefile.in b/Makefile.in index 0ed4442..def454a 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1,5 +1,7 @@ ### Do not edit -- Generated by 'configure --with-whatever' from Makefile.in +RM = /bin/rm + all : cd src && $(MAKE) cd projects/demo && $(MAKE) libdemo @@ -8,7 +10,7 @@ all : cd projects/examples && $(MAKE) -f libMakefile clean : - -rm -f *~ + $(RM) -f *~ cd src && $(MAKE) clean cd projects/demo && $(MAKE) clean cd projects/effects && $(MAKE) clean @@ -16,7 +18,7 @@ clean : cd projects/examples && $(MAKE) clean distclean: clean - -rm -rf config.log config.status autom4te.cache Makefile + $(RM) -rf config.log config.status autom4te.cache Makefile cd src && $(MAKE) distclean cd projects/demo && $(MAKE) distclean cd projects/effects && $(MAKE) distclean diff --git a/README b/README index 6584e92..6a96034 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. This distribution of the Synthesis ToolKit in C++ (STK) contains the following: @@ -23,21 +23,20 @@ programming language. STK was designed to facilitate rapid development of music synthesis and audio processing software, with an emphasis on cross-platform functionality, realtime control, ease of use, and educational example code. The Synthesis ToolKit is extremely -portable (it's mostly platform-independent C and C++ code), and it's +portable (most classes are platform-independent C++ code), and it's completely user-extensible (all source included, no unusual libraries, and no hidden drivers). We like to think that this increases the -chances that our programs will still work in another 5-10 years. In -fact, the ToolKit has been working continuously for nearly 15 years -now. STK currently runs with "realtime" support (audio and MIDI) on -Linux, Macintosh OS X, and Windows computer platforms. Generic, -non-realtime support has been tested under NeXTStep, Sun, and other -platforms and should work with any standard C++ compiler. +chances that our programs will still work in another 5-10 years. STK +currently runs with "realtime" support (audio and MIDI) on Linux, +Macintosh OS X, and Windows computer platforms. Generic, non-realtime +support has been tested under NeXTStep, Sun, and other platforms and +should work with any standard C++ compiler. -The Synthesis ToolKit is free for non-commercial use. The only parts -of the Synthesis ToolKit that are platform-dependent concern real-time -audio and MIDI input and output, and that is taken care of with a few -special classes. The interface for MIDI input and the simple Tcl/Tk -graphical user interfaces (GUIs) provided is the same, so it's easy to +The Synthesis ToolKit is free for non-commercial use. The only +classes of the Synthesis ToolKit that are platform-dependent concern +sockets, threads, mutexes, and real-time audio and MIDI input and +output. The interface for MIDI input and the simple Tcl/Tk graphical +user interfaces (GUIs) provided is the same, so it's easy to experiment in real time using either the GUIs or MIDI. The Synthesis ToolKit can generate simultaneous SND (AU), WAV, AIFF, and MAT-file output soundfile formats (as well as realtime sound output), so you @@ -81,7 +80,8 @@ Despite being available in one form or another since 1996, we still consider STK to be alpha software. We attempt to maintain backward compatability but changes are sometimes made in an effort to improve the overall design or performance of the software. Please read the -Release Notes to see what has changed since the last release. +"Release Notes" in the /doc directory to see what has changed since +the last release. A new StkFrames class has been created to facilitate the handling and passing of multichannel, vectorized audio data. All STK classes have @@ -99,8 +99,7 @@ though the behavior of such is very hardware dependent. Under Linux, Macintosh OS-X, and Irix, audio input and output are possible with very low latency. Using the Windoze DirectSound API, minimum dependable output sound latency seems to be around 20 milliseconds or -so, while input sound latency is on the order of a hundred -milliseconds or more! +so, while input sound latency is generally higher. As mentioned above, it is possible to record the audio ouput of an STK program to .snd, .wav, .raw, .aif, and .mat (Matlab MAT-file) output @@ -146,7 +145,7 @@ LICENSE: STK WWW site: http://ccrma.stanford.edu/software/stk/ The Synthesis ToolKit in C++ (STK) -Copyright (c) 1995-2010 Perry R. Cook and Gary P. Scavone +Copyright (c) 1995-2011 Perry R. Cook and Gary P. Scavone Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -216,6 +215,3 @@ The answers lie below. 6) More rationalizations to follow . . . - - - diff --git a/configure.ac b/configure.ac index fa9887f..dfb7e09 100644 --- a/configure.ac +++ b/configure.ac @@ -40,7 +40,14 @@ AC_MSG_RESULT($INCLUDE_PATH) # Check for realtime support disable AC_MSG_CHECKING(whether to compile realtime support) -AC_ARG_ENABLE(realtime, [ --disable-realtime = only compile generic non-realtime classes], [AC_SUBST( realtime, [no] ) AC_SUBST( sound_api, [] )], [AC_SUBST( realtime, [yes] ) ] ) +AC_ARG_ENABLE(realtime, + [ --disable-realtime = only compile generic non-realtime classes], + realtime=$enableval) +if test "$realtime" = "no"; then + AC_SUBST( sound_api, [] ) +else + AC_SUBST( realtime, [yes] ) +fi AC_MSG_RESULT($realtime) # Check for math library @@ -49,9 +56,19 @@ AC_CHECK_LIB(m, cos, , AC_MSG_ERROR(math library is needed!)) # Check for debug AC_MSG_CHECKING(whether to compile debug version) AC_ARG_ENABLE(debug, - [ --enable-debug = enable various debug output], - [AC_SUBST( cppflag, ["-D_STK_DEBUG_ -D__RTAUDIO_DEBUG__ -D__RTMIDI_DEBUG__"] ) AC_SUBST( cxxflag, ["-g"] ) AC_SUBST( object_path, [Debug] ) AC_MSG_RESULT(yes)], - [AC_SUBST( cppflag, [] ) AC_SUBST( cxxflag, [-O3] ) AC_SUBST( object_path, [Release] ) AC_MSG_RESULT(no)]) + [ --enable-debug = enable various debug output], + debug=$enableval) +if test "$debug" = "yes"; then + AC_SUBST( cppflag, ["-D_STK_DEBUG_ -D__RTAUDIO_DEBUG__ -D__RTMIDI_DEBUG__"] ) + AC_SUBST( cxxflag, ["-g"] ) + AC_SUBST( object_path, [Debug] ) +else + AC_SUBST( debug, [no] ) + AC_SUBST( cppflag, [] ) + AC_SUBST( cxxflag, [-O3] ) + AC_SUBST( object_path, [Release] ) +fi +AC_MSG_RESULT($debug) # Checks for functions if test $realtime = yes; then @@ -63,6 +80,7 @@ fi CPPFLAGS="$CPPFLAGS $cppflag" # For debugging and optimization ... overwrite default because it has both -g and -O2 +echo "$CXXFLAGS" CXXFLAGS="$cxxflag" # Check compiler and use -Wall if gnu. @@ -72,9 +90,20 @@ fi CXXFLAGS="$CXXFLAGS $cxxflag" +AC_CANONICAL_HOST + +AC_SUBST( sharedlib, ["libstk.so"] ) +AC_SUBST( sharedname, ["libstk.so.\$(RELEASE)"] ) +AC_SUBST( libflags, ["-shared -Wl,-soname,\$(SHAREDLIB).\$(MAJOR) -o \$(SHAREDLIB).\$(RELEASE)"] ) +case $host in + *-apple*) + AC_SUBST( sharedlib, ["libstk.dylib"] ) + AC_SUBST( sharedname, ["libstk.\$(RELEASE).dylib"] ) + AC_SUBST( libflags, ["-dynamiclib -o libstk.\$(RELEASE).dylib"] ) +esac + if test $realtime = yes; then # Checks for package options and external software - AC_CANONICAL_HOST AC_MSG_CHECKING(for audio API) case $host in *-*-linux*) diff --git a/doc/README-Linux.txt b/doc/README-Linux.txt index e5f2976..e88516d 100644 --- a/doc/README-Linux.txt +++ b/doc/README-Linux.txt @@ -1,19 +1,13 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. Please read the file README and INSTALL for more general STK information. -Realtime audio support for Linux currently includes the Advanced Linux Sound Architecture (ALSA), the JACK low-latency audio server, and/or Open Sound System (OSS version 4.0 and higher only) APIs. One or more APIs are selected during compilation using the __LINUX_ALSA__, __UNIX_JACK__, and/or __LINUX_OSS__ definitions. Because the ALSA library is now integrated into the standard Linux kernel, it is the default audio/MIDI API with STK versions 4.2 and higher. The __LINUX_ALSASEQ__ definition is required to compile RtMidi with ALSA sequencer support. Native OSS MIDI support no longer exists in RtMidi. If the __LINUX_OSS__ preprocessor definition is specified, only OSS audio support will be compiled and RtMidi will still be compiled using the ALSA API. For this reason, STK now requires the asound library for realtime support. Realtime programs must also link with the pthread library. The OSS audio API can be selected by passing the "--with-oss" option to configure. +Realtime audio support for Linux currently includes the Advanced Linux Sound Architecture (ALSA), the JACK low-latency audio server, and/or Open Sound System (OSS version 4.0 and higher only) APIs. That said, the OSS API support has not been tested in several years and is not considered a high priority. One or more APIs are selected during compilation using the __LINUX_ALSA__, __UNIX_JACK__, and/or __LINUX_OSS__ definitions. Because the ALSA library is now integrated into the standard Linux kernel, it is the default audio/MIDI API with STK versions 4.2 and higher. -STK should compile without much trouble under Linux. Since all Linux distributions typically include the GNU makefile utilities, you should be able to use the default Makefile. Typing "make" will initiate the compilation process. +The __LINUX_ALSASEQ__ definition is required to compile RtMidi with ALSA sequencer support. Native OSS MIDI support no longer exists in RtMidi. If the __LINUX_OSS__ preprocessor definition is specified, only OSS audio support will be compiled and RtMidi will still be compiled using the ALSA API. For this reason, STK now requires the asound library for realtime support. Realtime programs must also link with the pthread library. -MIDIATOR SERIAL PORT MIDI SUPPORT: - -MIDIator support has been removed from RtMidi with STK versions 4.2 and higher. If you really need it, you can contact us to get an old distribution. - -NOTE REGARDING PTHREADS: - -There haven't been any problems with threads since the old days of RedHat Linux 5.0. STK uses the MIT pthreads API. +STK should compile without much trouble under Linux. Since all Linux distributions typically include the GNU makefile utilities, you should be able to use the default Makefiles. Typing "make" in a project directory will initiate the compilation process (after initially running the configure script in the top-level directory). diff --git a/doc/README-MacOSX.txt b/doc/README-MacOSX.txt index c2f4be3..cc5fac8 100644 --- a/doc/README-MacOSX.txt +++ b/doc/README-MacOSX.txt @@ -1,12 +1,12 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. Please read the file README and INSTALL for more general STK information. The default realtime support for Macintosh OS X uses the CoreAudio HAL API and is specified during compilation using the __MACOSX_CORE__ preprocessor definition. There is also support for the JACK audio server using the __UNIX_JACK__ preprocessor definition. -It is necessary to install the OS X developer kit in order to compile STK. STK was successfully tested on OS X versions 10.6. +It is necessary to install the OS X developer kit in order to compile STK. STK was successfully tested on the latest version of OS X. Tcl/Tk on OS X: diff --git a/doc/README-NeXT.txt b/doc/README-NeXT.txt deleted file mode 100644 index 2f8d114..0000000 --- a/doc/README-NeXT.txt +++ /dev/null @@ -1,7 +0,0 @@ -The Synthesis ToolKit in C++ (STK) - -By Perry R. Cook and Gary P. Scavone, 1995-2010. - -Please read the file README and INSTALL for more general STK information. - -STK has always worked under NeXTStep without realtime audio or MIDI support. In general, STK should compile in this way using any generic C++ compiler. C++ exception handling was added to STK with release 3.2. We managed to get a version of gcc compiled for NeXTStep that can deal with C++ exceptions. diff --git a/doc/README-SGI.txt b/doc/README-SGI.txt index 9e74c29..1c8fede 100644 --- a/doc/README-SGI.txt +++ b/doc/README-SGI.txt @@ -1,15 +1,7 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. Please read the file README and INSTALL for more general STK information. -The project Makefiles are created by configure. If you have trouble running "make", try invoking "gmake" (for GNU make). If that doesn't work, try to download the GNU Makefile utilities from the Internet. - -With STK version 4.3, realtime support for IRIX has been discontinued due to the inability to test it. If you need realtime support on an SGI, go back to version 4.2.1. Release 4.0 of STK is confirmed to compile (with various warnings) using CC version 7.30. - -The __IRIX_AL__ and __IRIX_MD__ preprocessor definitions are required for realtime audio and MIDI support. - -NOTE REGARDING PTHREADS: - -Since release 3.1, STK has used the pthread API under Irix. It appears that pthread functionality is standard on SGI, so this change shouldn't cause any problems. If I'm wrong, let me know! +Since STK version 4.3, realtime support for IRIX has been discontinued due to an inability to test it. If you need realtime support on an SGI, go back to version 4.2.1. Release 4.0 of STK is confirmed to compile (with various warnings) using CC version 7.30. diff --git a/doc/README-Win.txt b/doc/README-Win.txt index c65832a..5123ba6 100644 --- a/doc/README-Win.txt +++ b/doc/README-Win.txt @@ -1,19 +1,18 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. Please read the file README for more general STK information. -DirectX and WindowsNT Issues: ------------------------------ +The configure script supports MinGW. As well, STK is distributed with Visual C++ .NET project and workspace files. It no longer compiles with Visual C++ 6.0. -STK is currently distributed with Visual C++ .NET project and workspace files. It no longer compiles with Visual C++ 6.0. I gave up attempting to fix all the problems created by such a bad compiler. This version of STK has been tested using Visual C++ .NET. As well, the configure script now supports MinGW. +With Windows XP/7, piping works as under unix. Simply fire up the script files (ex. StkDemo.bat) by either double-clicking on them or from within a shell. IMPORTANT VC++ NOTE: When compiling "release" versions of STK programs, link to the release multithreaded library. When compiling "debug" versions, link to the debug multithreaded library. Compiler errors will result otherwise. Both the DirectSound and Steinberg ASIO audio APIs are supported for realtime audio input/output. The Visual C++ project files included with this distribution are configured to use the DirectSound API. In order to use the ASIO API, it is necessary to change the preprocessor definition from __WINDOWS_DS__ to __WINDOWS_ASIO__, as well as include all 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 is typically pretty horrendous (should we be surprised?). Also, there is a slight chance you don't have DirectSoundCapture support on your computer. If not, you should download the DirectX 6.0 (or higher) runtime libraries from Microsoft's WWW site (http://www.microsoft.com/directx/download.asp) in order to run the pre-compiled STK executables for Windoze. The last time I checked, there was no DirectSoundCapture support for WindowsNT ... you'll have to switch to Windows 2000 or XP or use an ASIO driver. I stopped supporting the WinMM audio output code with release 3.2. +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. Realtime MIDI input/output is supported by RtMidi using the winmm.lib API and requires the __WINDOWS_MM__ preprocessor definition. @@ -33,22 +32,4 @@ Visual C++ workspaces have been created for the various STK projects. Everythin Remember that items 1-5 above need to be done for each project and for each configuration. There might be an easy way to make global changes, but I couldn't figure it out. -To use the Tcl/Tk GUIs, you will have to install Tcl/Tk. I got version 8.0 and it works very well (and installed easily). The distribution is available on the WWW and is free. - -In order for socketing to work, it is necessary to have the TCP protocol installed on your computer. This can be done from the "Network" control panel. - -Finally, to use it all - - - -WINDOWS XP/2000: - -There is a big advantage in using Windows XP/2000 over 95/98 with STK in that piping works, just as under unix. Also, the scheduler in 2000/XP seems to be much better, so socketed messages don't get clumped together like they do in Windows 95/98. Simply fire up a script file (ex. StkDemo.bat) by either double-clicking on it or typing it within a shell. - - -USE REALTIME MIDI INPUT FOR CONTROL: - -1. Open a DOS console window and start syntmono with MIDI input (eg. demo Clarinet -or -im). - - This assumes you already have MIDI setup correctly for your computer. - - +To use the Tcl/Tk GUIs, you will have to install Tcl/Tk. diff --git a/doc/ReleaseNotes.txt b/doc/ReleaseNotes.txt index 63e714f..4bad1ec 100644 --- a/doc/ReleaseNotes.txt +++ b/doc/ReleaseNotes.txt @@ -1,6 +1,17 @@ The Synthesis ToolKit in C++ (STK) -By Perry R. Cook and Gary P. Scavone, 1995-2010. +By Perry R. Cook and Gary P. Scavone, 1995-2011. + +v4.4.3: (30 August 2011) +- changed SINT24 to be lower 3 bytes of 32-bit word +- bug fixes to vectorized tick functions in Effects classes +- updated versions of RtAudio and RtMidi +- fix to ADSR bugs +- updates to the internal argument checking and reporting scheme +- updates to Bowed class (thanks to Esteban Maestre!) +- fixes for 24-bit support in FileRead and FileWrite +- added WAVE_FORMAT_EXTENSIBLE support in FileWrite +- added sample rate variable reading and writing for MAT-files in FileRead and FileWrite v4.4.2: (4 February 2010) - added various header file includes for newer compilers diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index 8a94e93..f5edbe6 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.5.8 +# Doxyfile 1.6.2 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -31,7 +31,7 @@ PROJECT_NAME = STK # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 4.4.2 +PROJECT_NUMBER = 4.4.3 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -54,11 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, -# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, -# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, -# Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English @@ -214,7 +214,8 @@ OPTIMIZE_OUTPUT_VHDL = NO # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C +# use: inc=Fortran f=C. Note that for custom extensions you also need to set +# FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = @@ -225,7 +226,7 @@ EXTENSION_MAPPING = # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. -BUILTIN_STL_SUPPORT = NO +BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. @@ -386,6 +387,12 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -405,6 +412,16 @@ SORT_MEMBER_DOCS = NO SORT_BRIEF_DOCS = NO +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. @@ -684,7 +701,7 @@ SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. -INLINE_SOURCES = NO +INLINE_SOURCES = YES # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code @@ -790,6 +807,12 @@ HTML_FOOTER = footer.html HTML_STYLESHEET = +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = NO + # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. @@ -891,7 +914,7 @@ QCH_FILE = # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace -QHP_NAMESPACE = +QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see @@ -923,6 +946,23 @@ QHP_SECT_FILTER_ATTRS = QHG_LOCATION = +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -936,21 +976,19 @@ ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. -# If the tag value is set to FRAME, a side panel will be generated +# If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. Other possible values -# for this tag are: HIERARCHIES, which will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list; -# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which -# disables this behavior completely. For backwards compatibility with previous -# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE -# respectively. +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. @@ -965,6 +1003,26 @@ TREEVIEW_WIDTH = 250 FORMULA_FONTSIZE = 10 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = NO + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvances is that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -981,7 +1039,10 @@ GENERATE_LATEX = NO LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. LATEX_CMD_NAME = latex @@ -1041,6 +1102,13 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -1192,7 +1260,7 @@ PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will @@ -1258,7 +1326,7 @@ EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. @@ -1301,7 +1369,7 @@ EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will @@ -1493,12 +1561,3 @@ GENERATE_LEGEND = YES # the various graphs. DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Options related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = NO diff --git a/doc/doxygen/download.txt b/doc/doxygen/download.txt index 38eceee..deb36dc 100644 --- a/doc/doxygen/download.txt +++ b/doc/doxygen/download.txt @@ -1,14 +1,28 @@ /*! \page download Download, Release Notes, and Bug Fixes -\section down Download Version 4.4.2 (4 February 2010): +\section down Download Version 4.4.3 (30 August 2011): \section notes Release Notes: +\subsection v4dot4dot3 Version 4.4.3 + + + \subsection v4dot4dot2 Version 4.4.2 -Windows95/98/2000/XP (specific): +Windows95/98/2000/XP/7 (specific): diff --git a/doc/doxygen/usage.txt b/doc/doxygen/usage.txt index fab8eec..9a47035 100644 --- a/doc/doxygen/usage.txt +++ b/doc/doxygen/usage.txt @@ -2,6 +2,7 @@ - \ref directory - \ref compiling +- \ref debug - \ref control - \ref voices - \ref nort @@ -43,9 +44,9 @@ This release of STK comes with four separate "project" directories: \section compiling Compiling: