New upstream version 6.12.0~dfsg

3 files changed, 525 insertions, 50 deletions

diff --git a/preface/copy.xml b/preface/copy.xml
index adbb84a..139c0ac 100644
--- a/preface/copy.xml
+++ b/preface/copy.xml
@@ -52,7 +52,7 @@
       CsoundAC is copyright 2001-2008 by Michael Gogins.
     </para>
     <para>
-      Csound and CsoundAC (formerly CsoundVST) are free software; you can redistribute them
+      Csound and CsoundAC are free software; you can redistribute them
       and/or modify them under the terms of the GNU Lesser General Public
       License as published by the Free Software Foundation; either version
       2.1 of the License, or (at your option) any later version.
@@ -70,12 +70,12 @@
       02110-1301 USA.
     </para>
   </simplesect>
-  <simplesect id="VSTSDKLicense">
-    <title>Virtual Synthesis Technology</title>
-    <para>
-      Virtual Synthesis Technology (VST) PlugIn interface technology by
-      Steinberg Soft- und Hardware GmbH.
-    </para>
+  <!-- <simplesect id="VSTSDKLicense"> -->
+  <!--   <title>Virtual Synthesis Technology</title> -->
+  <!--   <para> -->
+  <!--     Virtual Synthesis Technology (VST) PlugIn interface technology by -->
+  <!--     Steinberg Soft- und Hardware GmbH. -->
+  <!--   </para> -->
 <!--    <para>
       CsoundVST source code contains modified versions of source code files
       from the VST SDK distributed by Steinberg. <emphasis>These files are to be
@@ -84,5 +84,5 @@
       on CsoundVST or the modified VST source files herein, you <emphasis>must</emphasis>
       apply to Steinberg for your own license to use the VST SDK.
     </para>-->
-  </simplesect>
+  <!-- </simplesect> -->
 </section>
diff --git a/preface/gettingstarted.xml b/preface/gettingstarted.xml
index 53fda35..7654bd6 100644
--- a/preface/gettingstarted.xml
+++ b/preface/gettingstarted.xml
@@ -51,7 +51,7 @@ csound oscil.csd</screen>
     Csound's <link linkend="CommandUnifile"><citetitle>.csd</citetitle></link> files have three main sections between the <emphasis>&lt;CsSynthesizer&gt;</emphasis> and <emphasis>&lt;/CsSynthesizer&gt;</emphasis> tags:
     <itemizedlist>
       <listitem>
-        <simpara><emphasis>CsOptions</emphasis> - Includes the <link linkend="CommandFlagsCategory"><citetitle>Command Line flags</citetitle></link> specific to this particular file. These options can also be set using the <link linkend="CommandUnifileParFile"><citetitle>.csoundrc</citetitle></link> file, which you can edit in a text editor, or directly in the <link linkend="CommandDesc"><citetitle>command line</citetitle></link>. Some front ends also provide ways to specify global or local options.
+        <simpara><emphasis>CsOptions</emphasis> - Includes the <link linkend="CommandFlagsCategory"><citetitle>Command Line flags</citetitle></link> specific to this particular file. These options can also be set using the <link linkend="CommandUnifileParFile"><citetitle>.csound6rc</citetitle></link> file, which you can edit in a text editor, or directly in the <link linkend="CommandDesc"><citetitle>command line</citetitle></link>. Some front ends also provide ways to specify global or local options.
         </simpara>
       </listitem>
       <listitem>
diff --git a/preface/whatsnew.xml b/preface/whatsnew.xml
index 2164cbc..6c7b36d 100644
--- a/preface/whatsnew.xml
+++ b/preface/whatsnew.xml
@@ -66,16 +66,438 @@
     </itemizedlist>
   </para>-->
 
+  <bridgehead>Release Notes for Csound 6.12 ()</bridgehead>
+  <para>
+    Many changes including the removal of vst2cs functionality due to a
+    copyright issue.
+  </para>
+  <para>
+    The changes made in 6.11 to raw format reading have been modified so
+    gen1 and diskin ignore positive file formats and use the file header,
+    unless the format is negative when it uses the absolute value in a raw
+    audio file. This should preserve most compatibility issues.
+  </para>
+  <para>
+   There are a number of new and improved opcodes, new facilities in
+   scores and many bug fixes.
+  </para>
+  <para>
+    <itemizedlist>
+      <listitem>
+        <para>New opcodes:
+          <itemizedlist>
+            <listitem>
+              <simpara><link
+              linkend="fluidInfo"><citetitle>fluidInfo</citetitle></link>
+              </simpara> retrieves program information from a currently loaded
+              soundfont.
+            </listitem>
+            <listitem>
+              New opcode <simpara><link
+              linkend="ftaudio"><citetitle>ftaudio</citetitle></link></simpara>
+              writes a ftable to an audio file; irate and triggered k-rate
+              version exist and k-rate version supports sync or async writing.
+            </listitem>
+            <listitem>
+              Version of <simpara><link
+              linkend="OSClisten"><citetitle>OSClisten</citetitle></link>
+              </simpara> that writes the data to a k-rate array now exists.
+            </listitem>
+            <listitem>
+              <simpara><link linkend="OSCcount"><citetitle>OSCcount</citetitle>
+              </link></simpara> returns the number of OSC incoming messages
+              pending.
+            </listitem>
+            <listitem>
+              <simpara><link
+              linkend="faustplay"><citetitle>faustplay</citetitle></link>
+              </simpara> and <simpara><link linkend="faustdsp">
+              <citetitle>faustdsp</citetitle></link></simpara> are new opcodes
+              splitting the faust DSP instantiation and performance.
+            </listitem>
+            <listitem>
+              <simpara><link
+              linkend="OSCbundle"><citetitle>OSCbundle</citetitle></link>
+              </simpara> sends a collection of similar OSC messages as a single
+              packet for efficiency.
+            </listitem>
+            <listitem>
+              <simpara><link linkend="beosc"><citetitle>beosc</citetitle></link>
+              </simpara> and <simpara><link linkend="beadsynt">
+              <citetitle>beadsynt</citetitle></link></simpara> are band enhanced
+              oscillator and oscillator bank. <simpara><link
+              linkend="bpfcos"><citetitle>bpfcos</citetitle></link></simpara>
+              is for breakpoint files with interpolation. Similarly <simpara>
+              <link linkend="lincos"><citetitle>lincos</citetitle></link>
+              </simpara> adds cosine interpolation to <simpara><link
+              linkend="linlin"><citetitle>linlin</citetitle></link></simpara>.
+            </listitem>
+            <listitem>
+              <simpara><link
+              linkend="printarray"><citetitle>printarray</citetitle></link>
+              </simpara> and <simpara><link linkend="reshapearray">
+              <citetitle>reshapearray</citetitle></link></simpara> act on
+              arrays.
+            </listitem>
+            <listitem>
+              <simpara><link
+              linkend="trim"><citetitle>trim</citetitle></link>
+              </simpara> and <simpara><link linkend="trim_i">
+              <citetitle>trim_i</citetitle></link></simpara> adjust the size of
+              a 1 dimensional array, either bigger or smaller, preserving data
+              and/or padding with zeros.
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          Orchestra:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                New preprocessor option #includestr.  This is like #include but
+                has macro expansion in the double-quote delimited string.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>Use of tied notes in subinstr fixed.</simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Nesting macro calls more than about 10 caused a crash; now
+                unlimited nesting works.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Runtime error message now (usually) include a line number and a
+                file/macro trace.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Multiple assignments such as ka, kb = 1,2  are again supported
+                by the parser; it had inadvertently got lost.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                The problematic use of i() with an array element directy is now
+                flagged as an error.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                If an included file name has a "/" in it then any nested include
+                is relative to that directory. (Issue #973).
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Redefinition of UDOs with zero output arguments fixed.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                A very obscure bug in running sub-instruments, which has been
+                in the code for nearly a year, was fixed.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Score:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                New preprocessor option #includestr. This is like #include but
+                has macro expansion in the double-quote delimited string.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                'd' score opcode for real-time performance. This was issue #966.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>Bug in np operation fixed.</simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Use of [] syntax in a score could lead to a loss of precision
+                for numbers over about 1 million; older version restored.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Nesting macro calls more than about 10 caused a crash; now
+                unlimited nesting works.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                The forms for delayed ending of sections (e 5 or s 5) now work
+                with fractional delays; previously only read the integer part.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                If an included file name has a "/" in it then any nested include
+                is relative to that directory. (Issue #973).
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Modified Opcodes and Gens:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                Add optional argument to ftom for rounding answer to integer.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                flooper2 and syncgrain etc now allow resampling.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                chnclear can now take a list of channels to clear instead of
+                just one.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                printf and printf_i now are like the manual: all arguments
+                beyond the format and trigger are optional.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                prints and printks can take string arguments printed with %s.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                GEN2 can now take a size of zero, which is interpreted as size
+                sufficient for the number of values provided.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                faustcompile now includes a new optional parameter to allow it
+                to be run in a blocking mode. Defaults (as before) to
+                non-blocking.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                fillarray can be run at k-rate if any of the argument/values
+                are k-rate.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                slicearray for other than i-rate arrays runs at k-rate only.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                pvstrace now has the option also to return an array containing
+                the bin numbers.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Utilities:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                A coding error in mixer was fixed. It was very broken.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Bugs Fixed:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                A typo in p5glove meant that the command to read the button
+                status as a bitmap only returned state of button A.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                diskin to array fixed and also use with small ksmps.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                In loscil it sometimes failed to deal with the ibas argument;
+                this has now been reworked to be correct.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                madsr could overflow an internal counter when given a negative
+                p3.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Fixed mapping from threads to lua_States (issue #959).
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                The time calculation in flooper2, flooper, and syncgrain was
+                corrected.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Resampling and pitch fixed in pvstanal
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Rare buffer overflow case in faust opcodes fixed.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                pvsftw had an incorrect check for fft format which led to
+                incorrect claim of bad format; fixed.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                If ksmps was 1 the opcode linenr at arate failed to work; fixed.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>window opcode fixed.</simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                The test for compatible subtypes of f-values in a number of pvs
+                opcodes was wrong, causing spurious error messages.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                cosseg was broken for more than one segment; now OK.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                monitor opcode did not work correctly when using multiple
+                processes; fixed.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                in the linenr opcode if the release stage was entered before
+                the end of the rise the output value jumped to the end value
+                and then decayed, causing a glitch. This is fixed. (#1048)
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>System Changes:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                The various -zN options now reports the number of opcodes for
+                the request, so differs with respect to deprecated and
+                polymorphic opcodes.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Recompilation of named instruments totally reworked to avoid
+                errors and memory leaks.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                The allocation of instrument names to internal numbers has been
+                rewritten and should now be usable with replacements in live
+                coding.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                Printing the number allocated to a named instrument now behaves
+                the manual, not just for debug.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                If liblo version 0.29 is available csound can be built to use
+                it (with a compiler flag LIBLO29) and this fixes some bugs
+                related to heavy/complex use of OSClisten. Unfortunately the
+                older 0.28 version is being distributed by some Linux distros.
+              </simpara>
+            </listitem>
+            <listitem>
+              <simpara>
+                The orchestra compiler has a number of new optimisations,
+                avoiding unnecessary assignments and doing some more expression
+                optimisations.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>API:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                csound->ReadScore was changed so it behaves the same as a score
+                in a csd or sco file. This could incorrectly give an infinite
+                score or not in unexpected cases.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Platform Specific:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                Bela: allow analog in and out with different channel numbers.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+    </itemizedlist>
+  </para>
+
   <bridgehead>Release Notes for Csound 6.11 (2018 May)</bridgehead>
   <para>
     There has been a great amount of internal reorganisation, which should not
     affect most users. Some components are now independently managed and will
     eventually be installable via a new package manager. The realtime option is
-    now considered stable and has the "experimental" tag removed. There have
+    now considered stable and has the "experimental" tag removed. Special
+    support for the Bela platform has been introduced. There have
     been more steps towards completing the arithmetic operations involving
     a-arrays.
     <note>Note that changes to GEN01 and diskin2 may not be backward compatible
-    if a none zero value is given for the format.</note>
+    if a non zero value is given for the format.</note>
   </para>
   <para>
     <itemizedlist>
@@ -196,6 +618,29 @@
         </para>
       </listitem>
       <listitem>
+        <para>Utilities:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                src_conv is now available on Windows and MacOS.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Frontends:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                Belacsound: a new frontend specific for the Bela platform is
+                introduced in this version.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
         <para>Bugs Fixed:
           <itemizedlist>
             <listitem>
@@ -277,6 +722,34 @@
           </itemizedlist>
         </para>
       </listitem>
+      <listitem>
+        <para>API:
+          <itemizedlist>
+            <listitem>
+              <simpara>No changes to the API.</simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>Platform Specific:
+          <itemizedlist>
+            <listitem>
+              <simpara>
+                WebAudio: from this release onwards, the Csound port for the
+                web platforms has been merged into a single package henceforth
+                called 'WebAudio Csound'. There are many internal changes to
+                this, the AudioWorklet interface is employed wherever supported,
+                with a fallback to ScriptProcessorNode elsewhere. Csound is also
+                available in the form of independent Nodes, in addition to the
+                original CsoundObj API. The csound.js frontend, originally
+                designed for PNaCl Csound, is also ported to WebAudio Csound,
+                following the deprecation of that port of Csound.
+              </simpara>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </listitem>
     </itemizedlist>
   </para>
 
@@ -576,16 +1049,16 @@
       <listitem>
         <para>System Changes:
           <itemizedlist>
-            <listitem>
-              <simpara>
-                The GNU Lesser General Public License, version 2.1, for CsoundVST
-                and the vst4cs opcodes has been modified to grant an exception
-                for compiling and linking with the VST2 SDK, which is available
-                from <ulink url="https://github.com/steinbergmedia/vst3sdk">https://github.com/steinbergmedia/vst3sdk</ulink>.
-                For more information, see <ulink
-                url="https://github.com/csound/csound/blob/develop/Opcodes/vst4cs/licensing_considerations_for_csoundvst_and_vst4cs.md">https://github.com/csound/csound/blob/develop/Opcodes/vst4cs/licensing_considerations_for_csoundvst_and_vst4cs.md</ulink>.
-              </simpara>
-            </listitem>
+            <!-- <listitem> -->
+            <!--   <simpara> -->
+            <!--     The GNU Lesser General Public License, version 2.1, for CsoundVST -->
+            <!--     and the vst4cs opcodes has been modified to grant an exception -->
+            <!--     for compiling and linking with the VST2 SDK, which is available -->
+            <!--     from <ulink url="https://github.com/steinbergmedia/vst3sdk">https://github.com/steinbergmedia/vst3sdk</ulink>. -->
+            <!--     For more information, see <ulink -->
+            <!--     url="https://github.com/csound/csound/blob/develop/Opcodes/vst4cs/licensing_considerations_for_csoundvst_and_vst4cs.md">https://github.com/csound/csound/blob/develop/Opcodes/vst4cs/licensing_considerations_for_csoundvst_and_vst4cs.md</ulink>. -->
+            <!--   </simpara> -->
+            <!-- </listitem> -->
             <listitem>
               <simpara>
                 UDP Server now accepts some new commands, which are prefixed by
@@ -655,16 +1128,16 @@
                 <listitem>
                   <simpara>Continuous integration for Windows with AppVeyor.</simpara>
                 </listitem>
-                <listitem>
-                  <simpara>
-                    The AppVeyor build and installer now includes CsoundVST and
-                    the vst4cs opcodes that enable hosting VST plugins in Csound.
-                    The LGPL v2.1 license for that code has been modified, with
-                    permission of Hermann Seib the original author of the VSTHost
-                    code, to permit use with the separately downloaded VST2 SDK
-                    from Steinberg.
-                  </simpara>
-                </listitem>
+                <!-- <listitem> -->
+                <!--   <simpara> -->
+                <!--     The AppVeyor build and installer now includes CsoundVST and -->
+                <!--     the vst4cs opcodes that enable hosting VST plugins in Csound. -->
+                <!--     The LGPL v2.1 license for that code has been modified, with -->
+                <!--     permission of Hermann Seib the original author of the VSTHost -->
+                <!--     code, to permit use with the separately downloaded VST2 SDK -->
+                <!--     from Steinberg. -->
+                <!--   </simpara> -->
+                <!-- </listitem> -->
               </itemizedlist>
             </listitem>
             <listitem>
@@ -1144,8 +1617,7 @@
             </listitem>
             <listitem>
               <simpara>
-                Boost dependencies removed from Csound interfaces, CsoundAC,
-                and CsoundVST.
+                Boost dependencies removed from Csound interfaces and CsoundAC.
               </simpara>
             </listitem>
             <listitem>
@@ -2093,11 +2565,11 @@
                 now allowing non-power-of-two source tables.
               </simpara>
             </listitem>
-            <listitem>
-              <simpara>
-                vst4cs will now work on 64bit architecture.
-              </simpara>
-            </listitem>
+            <!-- <listitem> -->
+            <!--   <simpara> -->
+            <!--     vst4cs will now work on 64bit architecture. -->
+            <!--   </simpara> -->
+            <!-- </listitem> -->
             <listitem>
               <simpara>
                 <link linkend="strcat"><citetitle>strcat</citetitle></link>
@@ -2659,8 +3131,11 @@
               loop</simpara>
             </listitem>
             <listitem>
-              <simpara>alwayson now starts from score offset; this is part of
-              a fix to the long-standing problem with alwayson in CsoundVST</simpara>
+              <simpara>alwayson now starts from score offset.
+              <!-- ; this is part of -->
+              <!-- a fix to the long-standing problem with alwayson in
+                   CsoundVST -->
+              </simpara>
             </listitem>
             <listitem>
               <simpara>invalue now checks for output string size and reallocates
@@ -3662,11 +4137,11 @@ changeable at audio rate.
               There were cases when it gave strange results.
               </simpara>
             </listitem>
-            <listitem>
-              <simpara>The vst4cs opcodes have been re-factored. FLTK code has been encapsulated.
-              The build system has been updated for Csound 6.
-              </simpara>
-            </listitem>
+            <!-- <listitem> -->
+            <!--   <simpara>The vst4cs opcodes have been re-factored. FLTK code has been encapsulated. -->
+            <!--   The build system has been updated for Csound 6. -->
+            <!--   </simpara> -->
+            <!-- </listitem> -->
             <listitem>
               <simpara>In <emphasis>alwayson</emphasis> opcode changes for better
               handling of pfields, more reliable insert of an instrument instance
@@ -3726,11 +4201,11 @@ changeable at audio rate.
               <emphasis>randi</emphasis> fixed.
               </simpara>
             </listitem>
-            <listitem>
-              <simpara>A number of fixes to CsoundVST: initialization, score
-              handling, and MIDI driver initialization, so it now works for Csound 6.
-              </simpara>
-            </listitem>
+            <!-- <listitem> -->
+            <!--   <simpara>A number of fixes to CsoundVST: initialization, score -->
+            <!--   handling, and MIDI driver initialization, so it now works for Csound 6. -->
+            <!--   </simpara> -->
+            <!-- </listitem> -->
             <listitem>
               <simpara>fixed <emphasis>pycalln</emphasis> for no inputs.
               </simpara>