.net - 在 F# 中编码(marshal)具有 `char` 数组字段的结构数组

Question

Csound API定义 following CS_AUDIODEVICE struct :

   typedef struct {
     char device_name[64];
     char device_id[64];
     char rt_module[64];
     int max_nchnls;
     int isOutput;
   } CS_AUDIODEVICE;

然后有一个API函数叫做csoundGetAudioDevList :

PUBLIC int csoundGetAudioDevList(
    CSOUND* csound,
    CS_AUDIODEVICE* list,
    int isOutput
)   

通常会调用两次。第一次传入空指针来获取设备数量。然后第二次，传入一个大小为设备数量乘以 CS_AUDIODEVICE 大小的指针，以获取实际的设备数组。

我竭尽全力定义我的 DLLImport 声明并正确整理这些数据。

在 F# 中，不透明结构体 Csound 定义为:

[<Struct>]
type CSOUND = struct end

这很好用。

---

尝试 1

[<Struct; StructLayout(LayoutKind.Sequential)>]
type CS_AUDIODEVICE =
    [<MarshalAs(UnmanagedType.ByValTStr, SizeConst = 64)>]
    val device_name: string // char[64]
    [<MarshalAs(UnmanagedType.ByValTStr, SizeConst = 64)>]
    val device_id:   string // char[64]
    [<MarshalAs(UnmanagedType.ByValTStr, SizeConst = 64)>]
    val rt_module:   string // char[64]
    val max_nchnls:  int
    val isOutput:    int

[<DllImport(csoundDLLPath, CallingConvention = CallingConvention.Cdecl)>]
extern int csoundGetAudioDevList(CSOUND* csound, CS_AUDIODEVICE[] devices, int isOutput)

let numberOfDevices = csoundGetAudioDevList(csound, [||], 1)
let mutable devices = [| for _ in 1..numberOfDevices -> CS_AUDIODEVICE() |]
csoundGetAudioDevList(csound, devices, 1) |> ignore
devices

根据Microsoft's own documentation和 https://stackoverflow.com/a/8759368/17800932这应该可行，但事实并非如此。它崩溃了。我不知道它崩溃了什么，因为我刚刚在 FSI(F# 交互式)中检测到 session 终止。

---

尝试 2

我尝试重新定义我的结构:

[<Struct; StructLayout(LayoutKind.Sequential)>]
type CS_AUDIODEVICE =
    [<MarshalAs(UnmanagedType.ByValArray, SizeConst = 64)>]
    val device_name: char[] // char[64]
    [<MarshalAs(UnmanagedType.ByValArray, SizeConst = 64)>]
    val device_id:   char[] // char[64]
    [<MarshalAs(UnmanagedType.ByValArray, SizeConst = 64)>]
    val rt_module:   char[] // char[64]
    val max_nchnls:  int
    val isOutput:    int

其余设置相同。结果是相同的，即崩溃。

---

尝试 3

过去，当我很难以直接的方式整理事物时，我通常会转向 IntPtr。我尝试了各种变化

[<DllImport(csoundDLLPath, CallingConvention = CallingConvention.Cdecl)>]
extern int csoundGetAudioDevList(CSOUND* csound, IntPtr devices, int isOutput)

let numberOfDevices = csoundGetAudioDevList(csound, IntPtr.Zero, 1)
let mutable pointer = IntPtr(numberOfDevices * Marshal.SizeOf(CS_AUDIODEVICE))
let mutable devices = [| for _ in 1..numberOfDevices -> CS_AUDIODEVICE() |]
Marshal.StructureToPtr(devices, pointer, true)
csoundGetAudioDevList(csound, pointer, 1) |> ignore
//for i in 1..numberOfDevices do
//    devices[i-1] <- Marshal.PtrToStructure<CS_AUDIODEVICE>(pointer)
//    pointer <- IntPtr.Add(pointer, Marshal.SizeOf<CS_AUDIODEVICE>())
devices <- Marshal.PtrToStructure<CS_AUDIODEVICE[]>(pointer)
devices

我试图关注 https://stackoverflow.com/a/27483917/17800932这里加上我以前做过的事情。

---

我根本无法弄清楚这一点。大多数事情只是默默地崩溃，有些事情返回我无法理解的堆栈跟踪，有些事情甚至显式地使 CLR 崩溃。

令我感到沮丧的是，我无法找到一种方法来简单地推理这一点并阅读有关 .NET 和/或 Csound API 的文档。我无法控制 API，只能控制上面链接的文档，因此我不能只修改我尝试调用的 DLL 中的函数。

根据我对这些 DLL 绑定(bind)的经验，那些应该工作的东西并不总是有效，而且我发现对于 DLLImport 东西，我只需要尝试明智的事情并最终让一些东西发挥作用。因此，任何不仅提供有效的东西而且解释为什么/如何的解释将非常感激!

主要问题:

1. 应如何定义 CS_AUDIODEVICE 结构？
2. csoundGetAudioDevList 函数的正确 DLLImport 声明是什么？
3. 如何从 DLL 中整理音频设备列表？
4. 这一切为何/如何运作？

谢谢!

---

如果您想尝试并实际重现此代码，这里是其余的代码。您需要 Csound API。在 Windows 上，它位于 Windows 二进制文件下载中的 Csound-6.18.1-windows-x64-binaries\build\Release\csound64.dll。

open System.Runtime.InteropServices

[<Literal>]
let csoundDLLPath = @"<path to Csound DLL>"

[<Struct>]
type CSOUND = struct end

[<Struct; StructLayout(LayoutKind.Sequential)>]
type CS_AUDIODEVICE = ???

[<DllImport(csoundDLLPath, CallingConvention = CallingConvention.Cdecl)>]
extern CSOUND* csoundCreate()

[<DllImport(csoundDLLPath, CallingConvention = CallingConvention.Cdecl)>]
extern int csoundStart(CSOUND* csound)

[<DllImport(csoundDLLPath, CallingConvention = CallingConvention.Cdecl)>]
extern int csoundSetOption(CSOUND* csound, string option)

[<DllImport(csoundDLLPath, CallingConvention = CallingConvention.Cdecl)>]
extern int csoundGetAudioDevList(CSOUND* csound, ???, int isOutput)

let c = csoundCreate()
csoundSetOption(c, "-odac") // this enables using the system's audio devices as the Csound output device
csoundStart c
// This is where csoundGetAudioDevList would be called

Answer 1

正如评论中提到的，以下应该可以从 C# 声明结构:

[StructLayout(LayoutKind.Sequential)]
public unsafe struct CS_AUDIODEVICE
{
    public fixed byte device_name[64];
    public fixed byte device_id[64];
    public fixed byte rt_module[64];
    public int max_nchnls;
    public int isOutput;
}

不幸的是，F# 不支持 fixed声明内联缓冲区的语法。相反，我们可以这样做:

#nowarn "9"
#nowarn "51"

open System
open System.Runtime.InteropServices
open System.Runtime.CompilerServices
open Microsoft.FSharp.NativeInterop
        
type CSOUND = struct end

[<Struct; StructLayout(LayoutKind.Sequential, Size = 64)>]
type Byte64 =
    val mutable first: byte

[<Struct; StructLayout(LayoutKind.Sequential)>]
type CS_AUDIODEVICE =
    [<FixedBuffer(typeof<byte>, 64)>]
    val mutable device_name: Byte64
    [<FixedBuffer(typeof<byte>, 64)>]
    val mutable device_id: Byte64
    [<FixedBuffer(typeof<byte>, 64)>]
    val mutable rt_module: Byte64
    val mutable max_nchnls: int
    val mutable isOutput: int

[<DllImport("csoundDLLPath", CallingConvention = CallingConvention.Cdecl)>]
extern int csoundGetAudioDevList(CSOUND* csound, CS_AUDIODEVICE* devices, int isOutput)

let writeExample () =
    let mutable x = CS_AUDIODEVICE()
    let addr = &&x.device_name.first
    let span = Span<byte>(NativePtr.toVoidPtr addr, 64)
    span[0] <- byte 'a'
    span[1] <- byte 'b'
    span[2] <- 0uy

    printfn "%s" (Marshal.PtrToStringAnsi (NativePtr.toNativeInt addr))

    
let callExample () =
    let xs = GC.AllocateArray<CS_AUDIODEVICE>(3, pinned = true) // Array must be pinned at allocation or with a GCHandle
    let mutable csound = CSOUND()
    let code = csoundGetAudioDevList(&&csound, &&xs[0], 0)
    code

我们必须将字段地址强制转换为 VoidPtr那么我们可以使用Span作为访问保留字节的一种方式。分配pinned数组允许我们将地址传递给 native 函数。

在没有先固定内存的情况下尝试执行此操作可能会导致程序崩溃或损坏。分配有 let mutable 的结构将存在于堆栈中，并且当它们在作用域内时获取它们的地址是安全的。

编辑(附加说明):

FixedBuffer不是必需的，但由 C# 版本发出(如使用 SharpLab 反编译时所见)。我没有测试它，但它应该允许 C# 消费者处理 Byte64作为byte[] .

MarshalAs属性会导致编译器在后台生成额外的编码(marshal)代码，以将 .NET 类型转换为 native 兼容类型。其完成方式为 Byte64结构是 unmanaged ref1 ref2并且不需要额外的编码代码。

Span并不是绝对必要的，您可以在 IntPtr 之间自由转换和nativeptr<_>使用NativePtr module functions 。该模块为您提供了直接进行指针操作的方法。 IntPtr.Zero相当于 NativePtr.nullPtr和nativeptr<_>被删除为IntPtr由 F# 编译器执行。