CsoundUnity Package (UPM) development

giovannibedetti · 12 January 2021 19:46

Csound doesn’t seem to be null since calling ‘some’ methods work.
I tried calling performKsmps after csoundStart, it crashes!
EDIT It works on editor (so on Windows), returning 0.

rorywalsh · 12 January 2021 19:45

Right. I think we might need to file an issue on github. I can’t think what the problem might be. We don’t have any way of debugging this do we?

giovannibedetti · 12 January 2021 19:48

It’s the call to the native code that crashes, I can try to put some breakpoints and see, but I cannot debug the .so lib

rorywalsh · 12 January 2021 19:49

But wouldn’t a call to any of the native method crash it also?

giovannibedetti · 12 January 2021 19:53

I don’t have a clear view on this, I discovered this morning that the Csound test was working, so GetOpcodeList() and GetNamedGens() work!

rorywalsh · 12 January 2021 20:02

The simple test we do for errors in the csd file?

giovannibedetti · 12 January 2021 20:05

Now the Csound test in the Samples is just this:

github.com

rorywalsh/CsoundUnity/blob/develop/Samples~/CsoundTest/CsoundTest.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class CsoundTest : MonoBehaviour
{
    CsoundUnity csound;

    // Start is called before the first frame update
    void Start()
    {
        csound = this.GetComponent<CsoundUnity>();

        var opcodeList = csound.GetOpcodeList();

        var count = 0;
        foreach (var opcode in opcodeList)
        {
            var types = "";
            foreach (var argumentType in opcode.Value)

This file has been truncated. show original

rorywalsh · 12 January 2021 20:19

Right, so calls to the library seem to be working fine UNTIL we call performKsmps()? I’m afraid that doesn’t really help much does it

rorywalsh · 13 January 2021 09:54

We know it used to work with earlier versions of Csound/Unity? I wonder if you might try an earlier version of Csound? It would make things easier if we can identify when things went south?

giovannibedetti · 13 January 2021 15:33

I did some tests with the older libraries (version 6.12), but I have the same crash as when using version 6.15.
The crash occurs as soon as PerformKsmps method is called (now it’s right after start):

    int ret = Csound6.NativeMethods.csoundCompileCsdText(csound, csdFile);
    Csound6.NativeMethods.csoundStart(csound);
    compiledOk = ret == 0 ? true : false;
    Debug.Log("csoundCompile: " + compiledOk);
    Debug.Log($"started Csound version {GetVersion()}, API Version: {GetAPIVersion()}");
    /// CRASHES HERE
    var res = PerformKsmps();
    /// THIS IS NEVER PRINTED
    Debug.Log("PerformKsmps: " + res);

EDIT: This is the csound address right before the crash:
before csound crash 2021-01-13 150457

EDIT:
the crash occurs when setting memory?

    at libc.memset(memset:48)
    at libcsoundandroid.kperf_nodebug(kperf_nodebug:210)
    at libcsoundandroid.csoundPerformKsmps(csoundPerformKsmps:70)

rorywalsh · 13 January 2021 18:41

I think that might be enough info to post an issue on the Csound github tracker? Now, I’m expecting a few people to get back to us and say that CsoundAndroid is working fine, so the problem must be with Unity. I wonder should we prepare a simple CsoundAndroid app first to check? Without Unity?

giovannibedetti · 14 January 2021 15:25

The same calls on Android work fine, I’ll do some tests but everything seems good there.
I’ll try to test the basic scene on other Android devices, but I don’t think it will make a difference.
EDIT: same crash on android 6.0.1, 7 and 8.1.
I could also open an issue on the Unity bug reporting.

giovannibedetti · 14 January 2021 16:01

I had a look at the csound code, could the size of MYFLT be the cause of the crash?

github.com

csound/csound/blob/0aa988656f144bde8022218b72ff3cfd0bd706fa/Top/csound.c#L1728


if (UNLIKELY(--(csound->evt_poll_cnt) < 0)) {
  csound->evt_poll_cnt = csound->evt_poll_maxcnt;
  if (UNLIKELY(!csoundYield(csound))) csound->LongJmp(csound, 1);
}


/* for one kcnt: */
if (csound->oparms_.sfread)         /*   if audio_infile open  */
  csound->spinrecv(csound);         /*      fill the spin buf  */
csound->spoutactive = 0;            /*   make spout inactive   */
/* clear spout */
memset(csound->spout, 0, csound->nspout*sizeof(MYFLT));
memset(csound->spraw, 0, csound->nspout*sizeof(MYFLT));
ip = csound->actanchor.nxtact;


if (ip != NULL) {
  /* There are 2 partitions of work: 1st by inso,
     2nd by inso count / thread count. */
  if (csound->multiThreadedThreadInfo != NULL) {
    if (csound->dag_changed) dag_build(csound, ip);
    else dag_reinit(csound);     /* set to initial state */

github.com

csound/csound/blob/0aa988656f144bde8022218b72ff3cfd0bd706fa/Top/csound.c#L1832


      }
      /*else csound->Message(csound, "time %f\n",
                             csound->kcounter/csound->ekr);*/
      ip->ksmps_offset = 0; /* reset sample-accuracy offset */
      ip->ksmps_no_end = 0; /* reset end of loop samples */
      ip = nxt; /* but this does not allow for all deletions */
    }
  }
}


if (!csound->spoutactive) { /* results now in spout? */
  memset(csound->spout, 0, csound->nspout * sizeof(MYFLT));
  memset(csound->spraw, 0, csound->nspout * sizeof(MYFLT));
}
make_interleave(csound, lksmps);
csound->spoutran(csound); /* send to audio_out */
//#ifdef ANDROID
//struct timespec ts;
//clock_gettime(CLOCK_MONOTONIC, &ts);
//csound->Message(csound, "kperf kcount, %d,%d.%06d\n",
//                csound->kcounter, ts.tv_sec, ts.tv_nsec/1000);

rorywalsh · 14 January 2021 16:12

It should be 32bit float on Android. That’s definitely something to check.

giovannibedetti · 18 January 2021 13:03

Here is a post on the Csound forum:

giovannibedetti · 19 January 2021 14:35

So the good news is that everything works perfectly on 64 bit devices!
The bad news is that is not clear why it doesn’t work on 32 bit devices
I should open a ticket in Unity issue tracker

giovannibedetti · 15 February 2021 15:12

Good news! We discovered a Unity bug!
So sooner or later the Csound macOS .framework will work as expected on Unity
You can vote for it to be solved here: https://issuetracker.unity3d.com/issues/macos-dll-inside-a-custom-plugin-cannot-be-found-when-using-a-dot-framework-extension

rorywalsh · 15 February 2021 16:58

Voted, and nice work! Fair play for seeing this through to the bitter end

giovannibedetti · 15 March 2021 10:11

We have a working macOS build now! big thanks to the Unity Desktop Editor Team for the support!
For now it works on 2019.4 and later, I just asked if they can fix older versions.
The solution suggested by them was to convert the .framework into a .bundle.
I already uploaded the .bundle to the repo.
Here is the shell script that converts a macOS .framework into a .bundle (to be run in the folder where CsoundLib64.framework is):

#!/bin/bash
cp CsoundLib64.framework.meta CsoundLib64.bundle.meta
mkdir -p CsoundLib64.bundle/Contents/MacOS
cp CsoundLib64.framework/Versions/Current/CsoundLib64* CsoundLib64.bundle/Contents/MacOS
cp CsoundLib64.framework/libs/* CsoundLib64.bundle/Contents/MacOS
install_name_tool -change @loader_path/../../libs/libsndfile.1.dylib @loader_path/libsndfile.1.dylib CsoundLib64.bundle/Contents/MacOS/CsoundLib64
install_name_tool -id CsoundLib64 CsoundLib64.bundle/Contents/MacOS/CsoundLib64
rm CsoundLib64.framework.meta
rm -rf CsoundLib64.framework

cat > CsoundLib64.bundle/Contents/Info.plist << EOL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>CFBundleDevelopmentRegion</key>
	<string>en</string>
	<key>CFBundleExecutable</key>
	<string>CsoundLib64</string>
	<key>CFBundleIdentifier</key>
	<string>com.csound.CsoundLib64</string>
	<key>CFBundleInfoDictionaryVersion</key>
	<string>6.0</string>
	<key>CFBundleName</key>
	<string>CsoundLib64</string>
	<key>CFBundlePackageType</key>
	<string>BNDL</string>
	<key>CFBundleShortVersionString</key>
	<string>1.0</string>
	<key>CFBundleSupportedPlatforms</key>
	<array>
		<string>MacOSX</string>
	</array>
	<key>CFBundleVersion</key>
	<string>1</string>
</dict>
</plist>
EOL

rorywalsh · 15 March 2021 11:41

Nice one. So that’s Windows. MacOS and Unity now working out of the box? I’ve not been using Unity at all since the late summer. I find myself leaning towards BablyonJS at the moment. But that might change in the new year as I might have to teach some Unity. That would be nice!