Initial audio support (#43)

Initial audio support

nx/include/switch.h

@@ -32,6 +32,7 @@ extern "C" {
 #include "switch/services/acc.h"
 #include "switch/services/apm.h"
 #include "switch/services/applet.h"
+#include "switch/services/audout.h"
 #include "switch/services/bsd.h"
 #include "switch/services/fatal.h"
 #include "switch/services/usb.h"

nx/include/switch/services/audout.h

@@ -0,0 +1,61 @@
+/**
+ * @file audout.h
+ * @brief Audio output service.
+ * @author hexkyz
+ * @copyright libnx Authors
+ */
+#pragma once
+
+#include "../types.h"
+
+typedef enum {
+    PcmFormat_Invalid = 0,
+    PcmFormat_INT8 = 1,
+    PcmFormat_INT16 = 2,
+    PcmFormat_INT24 = 3,
+    PcmFormat_INT32 = 4,
+    PcmFormat_FLOAT = 5,
+    PcmFormat_ADPCM = 6,
+} PcmFormat;
+
+typedef enum {
+    AudioOutState_Started = 0,
+    AudioOutState_Stopped = 1,
+} AudioOutState;
+
+/// Audio output buffer format
+typedef struct AudioOutBuffer AudioOutBuffer;
+
+struct AudioOutBuffer
+{
+    AudioOutBuffer* next;       ///< Next buffer.
+    void* buffer;               ///< Sample buffer.
+    u64 buffer_size;            ///< Sample buffer size.
+    u64 data_size;              ///< Size of data inside the buffer.
+    u64 data_offset;            ///< Offset of data inside the buffer.
+};
+
+Result audoutInitialize(void);
+void audoutExit(void);
+
+Result audoutListAudioOuts(char *DeviceNames, u32 *DeviceNamesCount);
+Result audoutOpenAudioOut(const char *DeviceNameIn, char *DeviceNameOut, u32 SampleRateIn, u32 ChannelCountIn, u32 *SampleRateOut, u32 *ChannelCountOut, PcmFormat *Format, AudioOutState *State);
+Result audoutGetAudioOutState(AudioOutState *State);
+Result audoutStartAudioOut(void);
+Result audoutStopAudioOut(void);
+Result audoutAppendAudioOutBuffer(AudioOutBuffer *Buffer);
+Result audoutGetReleasedAudioOutBuffer(AudioOutBuffer *Buffer, u32 *ReleasedBuffersCount);
+Result audoutContainsAudioOutBuffer(AudioOutBuffer *Buffer, bool *ContainsBuffer);
+
+/**
+ * @brief Submits an audio sample data buffer for playing.
+ * @param source AudioOutBuffer containing the source sample data to be played.
+ * @param released AudioOutBuffer to receive the last played buffer.
+ */
+void audoutPlayBuffer(AudioOutBuffer *source, AudioOutBuffer *released);
+
+/// These return the state associated with the currently active audio output device.
+u32 audoutGetSampleRate(void);                      ///< Supported sample rate (48000Hz).
+u32 audoutGetChannelCount(void);                    ///< Supported channel count (2 channels).
+PcmFormat audoutGetPcmFormat(void);                 ///< Supported PCM format (INT16).
+AudioOutState audoutGetDeviceState(void);           ///< Initial device state (stopped).

nx/source/services/audout.c

@@ -0,0 +1,445 @@
+#include <string.h>
+#include "types.h"
+#include "result.h"
+#include "ipc.h"
+#include "services/audout.h"
+#include "services/sm.h"
+
+#define DEVICE_NAME_LENGTH 0x100
+#define DEFAULT_SAMPLE_RATE 0xBB80
+#define DEFAULT_CHANNEL_COUNT 0x00020000
+
+static Service g_audoutSrv;
+static Service g_audoutIAudioOut;
+
+static Handle g_audoutBufferEventHandle = INVALID_HANDLE;
+
+static u32 g_sampleRate = 0;
+static u32 g_channelCount = 0;
+static PcmFormat g_pcmFormat = PcmFormat_Invalid;
+static AudioOutState g_deviceState = AudioOutState_Stopped;
+
+static Result _audoutRegisterBufferEvent(Handle *BufferEvent);
+
+Result audoutInitialize(void)
+{
+    if (serviceIsActive(&g_audoutSrv))
+        return MAKERESULT(Module_Libnx, LibnxError_AlreadyInitialized);
+
+    Result rc = 0;
+    rc = smGetService(&g_audoutSrv, "audout:u");
+    
+    // Setup the default device
+    if (R_SUCCEEDED(rc))
+    {        
+        // Passing an empty device name will open the default "DeviceOut"
+        char DeviceNameIn[DEVICE_NAME_LENGTH] = {0};
+        char DeviceNameOut[DEVICE_NAME_LENGTH] = {0};
+        
+        // Open audio output device
+        rc = audoutOpenAudioOut(DeviceNameIn, DeviceNameOut, DEFAULT_SAMPLE_RATE, DEFAULT_CHANNEL_COUNT, &g_sampleRate, &g_channelCount, &g_pcmFormat, &g_deviceState);
+    }
+    
+    // Register global handle for buffer events
+    if (R_SUCCEEDED(rc))
+        rc = _audoutRegisterBufferEvent(&g_audoutBufferEventHandle);
+    
+    if (R_FAILED(rc))
+        audoutExit();
+
+    return rc;
+}
+
+void audoutExit(void)
+{
+    if (g_audoutBufferEventHandle != INVALID_HANDLE) {
+        svcCloseHandle(g_audoutBufferEventHandle);
+        g_audoutBufferEventHandle = INVALID_HANDLE;
+    }
+
+    g_sampleRate = 0;
+    g_channelCount = 0;
+    g_pcmFormat = PcmFormat_Invalid;
+    g_deviceState = AudioOutState_Stopped;
+
+    serviceClose(&g_audoutIAudioOut);
+    serviceClose(&g_audoutSrv);
+}
+
+u32 audoutGetSampleRate(void) {
+    return g_sampleRate;
+}
+
+u32 audoutGetChannelCount(void) {
+    return g_channelCount;
+}
+
+PcmFormat audoutGetPcmFormat(void) {
+    return g_pcmFormat;
+}
+
+AudioOutState audoutGetDeviceState(void) {
+    return g_deviceState;
+}
+
+void audoutPlayBuffer(AudioOutBuffer *source, AudioOutBuffer *released) {
+    // Try to push the supplied buffer to the audio output device
+    Result do_append = audoutAppendAudioOutBuffer(source);
+    
+    if (R_SUCCEEDED(do_append))
+    {
+        // Wait on the buffer event handle
+        Result do_wait = svcWaitSynchronizationSingle(g_audoutBufferEventHandle, U64_MAX);
+        
+        if (R_SUCCEEDED(do_wait))
+        {
+            svcResetSignal(g_audoutBufferEventHandle);
+            
+            u32 released_count = 0;
+            Result do_release = audoutGetReleasedAudioOutBuffer(released, &released_count);
+            
+            // Ensure that all buffers are released and return the last one only
+            while (R_SUCCEEDED(do_release) && (released_count > 0))
+                do_release = audoutGetReleasedAudioOutBuffer(released, &released_count);
+        }
+    }
+}
+
+Result audoutListAudioOuts(char *DeviceNames, u32 *DeviceNamesCount) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+    } *raw;
+
+    ipcAddRecvBuffer(&c, DeviceNames, DEVICE_NAME_LENGTH, 0);
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 0;
+
+    Result rc = serviceIpcDispatch(&g_audoutSrv);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+            u32 DeviceNamesCount;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+        
+        if (R_SUCCEEDED(rc) && DeviceNamesCount)
+            *DeviceNamesCount = resp->DeviceNamesCount;
+    }
+
+    return rc;
+}
+
+Result audoutOpenAudioOut(const char *DeviceNameIn, char *DeviceNameOut, u32 SampleRateIn, u32 ChannelCountIn, u32 *SampleRateOut, u32 *ChannelCountOut, PcmFormat *Format, AudioOutState *State) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+        u32 sample_rate;
+        u32 channel_count;
+        u64 client_pid;
+    } *raw;
+
+    ipcSendPid(&c);
+    ipcSendHandleCopy(&c, CUR_PROCESS_HANDLE);
+    ipcAddSendBuffer(&c, DeviceNameIn, DEVICE_NAME_LENGTH, 0);
+    ipcAddRecvBuffer(&c, DeviceNameOut, DEVICE_NAME_LENGTH, 0);
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 1;
+    raw->sample_rate = SampleRateIn;
+    raw->channel_count = ChannelCountIn;
+    raw->client_pid = 0;
+
+    Result rc = serviceIpcDispatch(&g_audoutSrv);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+            u32 sample_rate;
+            u32 channel_count;
+            u32 pcm_format;
+            u32 state;
+        } *resp = r.Raw;
+
+        rc = resp->result;
+
+        if (R_SUCCEEDED(rc)) {
+            serviceCreate(&g_audoutIAudioOut, r.Handles[0]);
+            
+            if (SampleRateOut)
+                *SampleRateOut = resp->sample_rate;
+            
+            if (ChannelCountOut)
+                *ChannelCountOut = resp->channel_count;
+            
+            if (Format)
+                *Format = resp->pcm_format;
+            
+            if (State)
+                *State = resp->state;
+        }
+    }
+
+    return rc;
+}
+
+Result audoutGetAudioOutState(AudioOutState *State) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+    } *raw;
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 0;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+            u32 state;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+        
+        if (R_SUCCEEDED(rc) && State)
+            *State = resp->state;
+    }
+
+    return rc;
+}
+
+Result audoutStartAudioOut(void) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+    } *raw;
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 1;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+    }
+
+    return rc;
+}
+
+Result audoutStopAudioOut(void) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+    } *raw;
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 2;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+    }
+
+    return rc;
+}
+
+Result audoutAppendAudioOutBuffer(AudioOutBuffer *Buffer) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+        u64 tag;
+    } *raw;
+
+    ipcAddSendBuffer(&c, Buffer, sizeof(AudioOutBuffer), 0);
+    
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 3;
+    raw->tag = (u64)&Buffer;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+    }
+
+    return rc;
+}
+
+static Result _audoutRegisterBufferEvent(Handle *BufferEvent) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+    } *raw;
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 4;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+        
+        if (R_SUCCEEDED(rc) && BufferEvent)
+            *BufferEvent = r.Handles[0];
+    }
+
+    return rc;
+}
+
+Result audoutGetReleasedAudioOutBuffer(AudioOutBuffer *Buffer, u32 *ReleasedBuffersCount) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+    } *raw;
+
+    ipcAddRecvBuffer(&c, Buffer, sizeof(AudioOutBuffer), 0);
+    
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 5;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+            u32 released_buffers_count;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+        
+        if (R_SUCCEEDED(rc) && ReleasedBuffersCount)
+            *ReleasedBuffersCount = resp->released_buffers_count;
+    }
+
+    return rc;
+}
+
+Result audoutContainsAudioOutBuffer(AudioOutBuffer *Buffer, bool *ContainsBuffer) {
+    IpcCommand c;
+    ipcInitialize(&c);
+
+    struct {
+        u64 magic;
+        u64 cmd_id;
+        u64 tag;
+    } *raw;
+
+    raw = ipcPrepareHeader(&c, sizeof(*raw));
+    
+    raw->magic = SFCI_MAGIC;
+    raw->cmd_id = 6;
+    raw->tag = (u64)&Buffer;
+
+    Result rc = serviceIpcDispatch(&g_audoutIAudioOut);
+
+    if (R_SUCCEEDED(rc)) {
+        IpcParsedCommand r;
+        ipcParse(&r);
+
+        struct {
+            u64 magic;
+            u64 result;
+            u32 contains_buffer;
+        } *resp = r.Raw;
+        
+        rc = resp->result;
+        
+        if (R_SUCCEEDED(rc) && ContainsBuffer)
+            *ContainsBuffer = (resp->contains_buffer & 0x01);
+    }
+
+    return rc;
+}