LMSDeviceModule.usp

/*****************************************************************************
  LMSDeviceModule.usp
  Lyrion Music Server (LMS) - Crestron SIMPL+ Module for CP4N
  Drop-in replacement for RoonDeviceModule v1.0 Build 10
  Uses SIMPL Windows TCP/IP Client for transport (no SIMPL+ sockets)
*****************************************************************************/

#SYMBOL_NAME "LMSDeviceModule"
#DEFAULT_VOLATILE
#ENABLE_STACK_CHECKING
#ENABLE_TRACE
#PRINT_TO_TRACE

STRING_PARAMETER LMS_IP[64];
STRING_PARAMETER DefaultPlayer[64];

// === DIGITAL INPUTS (existing - do not reorder) ===
DIGITAL_INPUT SystemModuleReady;
DIGITAL_INPUT Standby;
DIGITAL_INPUT ConvenienceSwitch;
DIGITAL_INPUT Play;
DIGITAL_INPUT Pause;
DIGITAL_INPUT PlayPause;
DIGITAL_INPUT NextTrack;
DIGITAL_INPUT PreviousTrack;
DIGITAL_INPUT Stop;
DIGITAL_INPUT SetShuffleOn;
DIGITAL_INPUT SetShuffleOff;
DIGITAL_INPUT ToggleShuffle;
DIGITAL_INPUT SetLoop;
DIGITAL_INPUT SetLoopOne;
DIGITAL_INPUT SetLoopOff;
DIGITAL_INPUT ToggleLoop;
DIGITAL_INPUT SetAutoRadioOn;
DIGITAL_INPUT SetAutoRadioOff;
DIGITAL_INPUT ToggleAutoRadio;
DIGITAL_INPUT VolumeUp;
DIGITAL_INPUT VolumeDown;
DIGITAL_INPUT Mute;
DIGITAL_INPUT Unmute;
DIGITAL_INPUT MuteUnmute;
// TCP Client status
DIGITAL_INPUT TCP_Connected;

// === ANALOG INPUTS ===
ANALOG_INPUT Volume;
ANALOG_INPUT VolumeNormalized;
ANALOG_INPUT Seek;
ANALOG_INPUT SeekNormalized;

// === STRING INPUTS ===
STRING_INPUT CRPC[256];
STRING_INPUT From_Device[65534];

// === DIGITAL OUTPUTS (existing - do not reorder) ===
DIGITAL_OUTPUT IsAvailable_fb;
DIGITAL_OUTPUT SupportsStandby_fb;
DIGITAL_OUTPUT SupportsConvenienceSwitch_fb;
DIGITAL_OUTPUT IsPlayAllowed_fb;
DIGITAL_OUTPUT IsPauseAllowed_fb;
DIGITAL_OUTPUT IsNextAllowed_fb;
DIGITAL_OUTPUT IsPreviousAllowed_fb;
DIGITAL_OUTPUT Playing_fb;
DIGITAL_OUTPUT Paused_fb;
DIGITAL_OUTPUT Loading_fb;
DIGITAL_OUTPUT Stopped_fb;
DIGITAL_OUTPUT IsShuffle_fb;
DIGITAL_OUTPUT IsLoop_fb;
DIGITAL_OUTPUT IsLoopOne_fb;
DIGITAL_OUTPUT IsAutoRadio_fb;
DIGITAL_OUTPUT IsSeekAllowed_fb;
DIGITAL_OUTPUT IsVolumeFixed_fb;
DIGITAL_OUTPUT IsMuted_fb;
DIGITAL_OUTPUT ShowSeekPosition_fb;
DIGITAL_OUTPUT ShowLength_fb;
// TCP Client control
DIGITAL_OUTPUT TCP_Connect;
DIGITAL_OUTPUT TCP_Disconnect;

// === ANALOG OUTPUTS ===
ANALOG_OUTPUT VolumeMin_fb;
ANALOG_OUTPUT VolumeMax_fb;
ANALOG_OUTPUT Volume_fb;
ANALOG_OUTPUT VolumeNormalized_fb;
ANALOG_OUTPUT PositionSeconds_fb;
ANALOG_OUTPUT PositionNormalized_fb;
ANALOG_OUTPUT LengthSeconds_fb;

// === STRING OUTPUTS ===
STRING_OUTPUT Name_fb;
STRING_OUTPUT VolumeType_fb;
STRING_OUTPUT PositionSerial_fb;
STRING_OUTPUT LengthSerial_fb;
STRING_OUTPUT OneLine_fb;
STRING_OUTPUT TwoLine_Line1_fb;
STRING_OUTPUT TwoLine_Line2_fb;
STRING_OUTPUT ThreeLine_Line1_fb;
STRING_OUTPUT ThreeLine_Line2_fb;
STRING_OUTPUT ThreeLine_Line3_fb;
STRING_OUTPUT NowPlayingImageUrl_fb;
STRING_OUTPUT PlayBackError_fb;
STRING_OUTPUT CRPC_fb;
// TCP Client send
STRING_OUTPUT To_Device;

// === GLOBAL VARIABLES ===
STRING  gPlayerID[64];
STRING  gPlayerName[64];
STRING  gRxBuffer[65534];
STRING  gPendingRequest[2048];
STRING  gResult[512];
STRING  gCmd[512];
INTEGER gInitialized;
INTEGER gCurrentVol;
INTEGER gLengthSeconds;
INTEGER gRequestPending;

// === HELPER FUNCTIONS ===

FUNCTION Cmd1(STRING c)
{
    gCmd = "[" + Chr(34) + c + Chr(34) + "]";
}

FUNCTION Cmd2(STRING c, STRING a)
{
    gCmd = "[" + Chr(34) + c + Chr(34) + "," + Chr(34) + a + Chr(34) + "]";
}

FUNCTION Cmd3(STRING c, STRING sub, STRING a)
{
    gCmd = "[" + Chr(34) + c + Chr(34) + "," + Chr(34) + sub + Chr(34) + "," + Chr(34) + a + Chr(34) + "]";
}

FUNCTION ExtractStr(STRING json, STRING key)
{
    STRING search[128];
    STRING segment[8192];
    INTEGER pos;
    INTEGER endPos;
    INTEGER segLen;

    gResult = "";
    search = Chr(34) + key + Chr(34) + ":" + Chr(34);
    pos = FIND(search, json);
    if (pos = 0) return;
    pos = pos + LEN(search);
    segLen = LEN(json) - pos + 1;
    if (segLen > 8192) segLen = 8192;
    segment = MID(json, pos, segLen);
    endPos = FIND(Chr(34), segment);
    if (endPos = 0) return;
    gResult = MID(segment, 1, endPos - 1);
}

FUNCTION ExtractNum(STRING json, STRING key)
{
    STRING search[128];
    STRING rest[64];
    INTEGER pos;
    INTEGER endPos;
    INTEGER p;

    gResult = "0";
    search = Chr(34) + key + Chr(34) + ":";
    pos = FIND(search, json);
    if (pos = 0) return;
    pos = pos + LEN(search);
    rest = MID(json, pos, 32);
    endPos = 33;
    p = FIND(",", rest);
    if (p > 0) { if (p < endPos) endPos = p; }
    p = FIND(Chr(125), rest);
    if (p > 0) { if (p < endPos) endPos = p; }
    p = FIND("]", rest);
    if (p > 0) { if (p < endPos) endPos = p; }
    p = FIND(" ", rest);
    if (p > 0) { if (p < endPos) endPos = p; }
    p = FIND(Chr(10), rest);
    if (p > 0) { if (p < endPos) endPos = p; }
    p = FIND(Chr(13), rest);
    if (p > 0) { if (p < endPos) endPos = p; }
    if (endPos > 1)
        gResult = MID(rest, 1, endPos - 1);
    else
        gResult = "0";
}

FUNCTION FormatTime(INTEGER secs)
{
    INTEGER m;
    INTEGER s;
    if (secs < 0) secs = 0;
    m = secs / 60;
    s = secs - (m * 60);
    if (s < 10)
        gResult = ITOA(m) + ":0" + ITOA(s);
    else
        gResult = ITOA(m) + ":" + ITOA(s);
}

// BuildRPC: builds HTTP request into gPendingRequest
FUNCTION BuildRPC(STRING pid, STRING cmdArray)
{
    STRING body[1024];
    STRING lenStr[8];
    INTEGER contentLen;

    body = "{" + Chr(34) + "id" + Chr(34) + ":1," + Chr(34) + "method" + Chr(34) + ":" + Chr(34) + "slim.request" + Chr(34) + "," + Chr(34) + "params" + Chr(34) + ":[" + Chr(34) + pid + Chr(34) + "," + cmdArray + "]}";
    contentLen = LEN(body);
    lenStr = ITOA(contentLen);
    gPendingRequest = "POST /jsonrpc.js HTTP/1.1\r\nHost: " + LMS_IP + "\r\nContent-Type: application/json\r\nContent-Length: " + lenStr + "\r\nConnection: close\r\n\r\n" + body;
}

FUNCTION BuildPlayerCmd(STRING cmdArray)
{
    if (gPlayerID <> "") BuildRPC(gPlayerID, cmdArray);
}

FUNCTION PollPlayers()
{
    STRING cmd[64];
    cmd = "[" + Chr(34) + "players" + Chr(34) + ",0,10]";
    BuildRPC("", cmd);
}

FUNCTION PollStatus()
{
    STRING cmd[128];
    if (gPlayerID = "")
    {
        PollPlayers();
        return;
    }
    cmd = "[" + Chr(34) + "status" + Chr(34) + "," + Chr(34) + "-" + Chr(34) + ",1," + Chr(34) + "tags:cgaldK" + Chr(34) + "]";
    BuildRPC(gPlayerID, cmd);
}

// SendRequest: send on existing connection or connect first
FUNCTION SendRequest()
{
    gRxBuffer = "";
    gRequestPending = 1;
    if (TCP_Connected)
    {
        // Connection already open (keep-alive) - send directly
        To_Device = gPendingRequest;
        gRequestPending = 0;
    }
    else
    {
        // Need to connect first - PUSH handler will send
        TCP_Connect = 1;
    }
}

// === RESPONSE PARSING ===

FUNCTION ParsePlayers(STRING body)
{
    STRING pid[64];
    STRING fragment[512];
    STRING nameSearch[256];
    INTEGER pos;
    INTEGER startPos;

    if (DefaultPlayer <> "")
    {
        nameSearch = Chr(34) + "name" + Chr(34) + ":" + Chr(34) + DefaultPlayer + Chr(34);
        pos = FIND(nameSearch, body);
        if (pos > 0)
        {
            startPos = pos - 200;
            if (startPos < 1) startPos = 1;
            fragment = MID(body, startPos, pos - startPos + 200);
            ExtractStr(fragment, "playerid");
            pid = gResult;
            if (pid <> "")
            {
                gPlayerID = pid;
                gPlayerName = DefaultPlayer;
                Name_fb = gPlayerName;
                IsAvailable_fb = 1;
                Trace("LMS: Found player %s = %s\n", gPlayerName, gPlayerID);
                return;
            }
        }
    }
    ExtractStr(body, "playerid");
    pid = gResult;
    ExtractStr(body, "name");
    if (pid <> "")
    {
        gPlayerID = pid;
        gPlayerName = gResult;
        Name_fb = gPlayerName;
        IsAvailable_fb = 1;
        Trace("LMS: Found player %s = %s\n", gPlayerName, gPlayerID);
    }
}

FUNCTION ParseStatus(STRING body)
{
    STRING mode[16];
    STRING title[256];
    STRING artist[256];
    STRING album[256];
    STRING artUrl[512];
    STRING coverid[64];
    INTEGER trackPos;
    INTEGER trackLen;
    INTEGER vol;
    INTEGER mute;
    INTEGER shuf;
    INTEGER rep;

    ExtractStr(body, "mode");
    mode = gResult;
    Playing_fb = 0;
    Paused_fb = 0;
    Stopped_fb = 0;
    Loading_fb = 0;

    if (mode = "play")
    {
        Playing_fb = 1;
        IsPlayAllowed_fb = 0;
        IsPauseAllowed_fb = 1;
    }
    else if (mode = "pause")
    {
        Paused_fb = 1;
        IsPlayAllowed_fb = 1;
        IsPauseAllowed_fb = 0;
    }
    else
    {
        Stopped_fb = 1;
        IsPlayAllowed_fb = 1;
        IsPauseAllowed_fb = 0;
    }

    IsNextAllowed_fb = 1;
    IsPreviousAllowed_fb = 1;
    IsSeekAllowed_fb = 1;
    ShowSeekPosition_fb = 1;
    ShowLength_fb = 1;
    IsAutoRadio_fb = 0;
    SupportsStandby_fb = 0;
    SupportsConvenienceSwitch_fb = 0;
    IsVolumeFixed_fb = 0;
    VolumeMin_fb = 0;
    VolumeMax_fb = 100;
    VolumeType_fb = "number";

    ExtractStr(body, "title");
    title = gResult;
    if (title = "")
    {
        ExtractStr(body, "current_title");
        title = gResult;
    }
    ExtractStr(body, "artist");
    artist = gResult;
    ExtractStr(body, "album");
    album = gResult;

    ExtractStr(body, "artwork_url");
    artUrl = gResult;
    if (artUrl = "")
    {
        ExtractStr(body, "coverid");
        coverid = gResult;
        if (coverid <> "")
            artUrl = "http://" + LMS_IP + ":9000/music/" + coverid + "/cover_500x500.jpg";
    }

    OneLine_fb = title;
    TwoLine_Line1_fb = title;
    TwoLine_Line2_fb = artist;
    ThreeLine_Line1_fb = title;
    ThreeLine_Line2_fb = artist;
    ThreeLine_Line3_fb = album;
    NowPlayingImageUrl_fb = artUrl;

    ExtractNum(body, "time");
    trackPos = ATOI(gResult);
    ExtractNum(body, "duration");
    trackLen = ATOI(gResult);
    gLengthSeconds = trackLen;
    PositionSeconds_fb = trackPos;
    LengthSeconds_fb = trackLen;
    FormatTime(trackPos);
    PositionSerial_fb = gResult;
    FormatTime(trackLen);
    LengthSerial_fb = gResult;
    if (trackLen > 0)
        PositionNormalized_fb = (trackPos * 65535) / trackLen;
    else
        PositionNormalized_fb = 0;

    ExtractNum(body, "mixer volume");
    vol = ATOI(gResult);
    if (vol < 0) vol = 0;
    gCurrentVol = vol;
    Volume_fb = vol;
    VolumeNormalized_fb = (vol * 65535) / 100;

    ExtractNum(body, "mixer muting");
    mute = ATOI(gResult);
    IsMuted_fb = mute;

    ExtractNum(body, "playlist shuffle");
    shuf = ATOI(gResult);
    if (shuf <> 0) IsShuffle_fb = 1;
    else IsShuffle_fb = 0;

    ExtractNum(body, "playlist repeat");
    rep = ATOI(gResult);
    if (rep = 2) IsLoop_fb = 1;
    else IsLoop_fb = 0;
    if (rep = 1) IsLoopOne_fb = 1;
    else IsLoopOne_fb = 0;
}

FUNCTION ParseResponse(STRING response)
{
    STRING body[65534];
    STRING modeKey[16];
    INTEGER pos;

    pos = FIND("\r\n\r\n", response);
    if (pos > 0)
        body = MID(response, pos + 4, LEN(response));
    else
        body = response;

    modeKey = Chr(34) + "mode" + Chr(34);
    if (FIND("players_loop", body) > 0)
        ParsePlayers(body);
    else if (FIND(modeKey, body) > 0)
        ParseStatus(body);
}

// === TCP CLIENT EVENT HANDLERS ===

// Connected: send pending request (first connect only)
PUSH TCP_Connected
{
    GENERATEUSERERROR("LMS: TCP CONNECTED");
    if (gRequestPending)
    {
        To_Device = gPendingRequest;
        gRequestPending = 0;
    }
}

// Disconnected: unexpected drop - next poll will reconnect
RELEASE TCP_Connected
{
    GENERATEUSERERROR("LMS: TCP DROPPED");
    TCP_Connect = 0;
    gRxBuffer = "";
}

// Data received: accumulate and parse when full HTTP response received
CHANGE From_Device
{
    STRING clStr[16];
    INTEGER hdrEnd;
    INTEGER clPos;
    INTEGER contentLen;
    INTEGER bodyStart;
    INTEGER bodyLen;

    gRxBuffer = gRxBuffer + From_Device;

    // Find end of HTTP headers
    hdrEnd = FIND("\r\n\r\n", gRxBuffer);
    if (hdrEnd = 0) return;

    bodyStart = hdrEnd + 4;

    // Extract Content-Length
    clPos = FIND("Content-Length: ", gRxBuffer);
    if (clPos = 0) return;
    clStr = MID(gRxBuffer, clPos + 16, 10);
    contentLen = ATOI(clStr);
    if (contentLen = 0) return;

    // Check if full body received
    bodyLen = LEN(gRxBuffer) - bodyStart + 1;
    if (bodyLen >= contentLen)
    {
        GENERATEUSERERROR("LMS: RESPONSE %d bytes", LEN(gRxBuffer));
        ParseResponse(gRxBuffer);
        gRxBuffer = "";
        TCP_Connect = 0;
    }
}

// === MAIN ===

Function Main()
{
    WaitForInitializationComplete();
    GENERATEUSERERROR("LMS: Main() started, IP=%s Player=%s", LMS_IP, DefaultPlayer);
    gPlayerID = "";
    gPlayerName = "";
    gRxBuffer = "";
    gPendingRequest = "";
    gRequestPending = 0;
    gInitialized = 0;
    gCurrentVol = 0;
    gLengthSeconds = 0;
    gResult = "";
    gCmd = "";
    IsAvailable_fb = 0;
    VolumeMin_fb = 0;
    VolumeMax_fb = 100;
    VolumeType_fb = "number";
    ShowLength_fb = 1;
    TCP_Connect = 0;
    TCP_Disconnect = 0;

    Trace("LMS: Module started, IP=%s Player=%s\n", LMS_IP, DefaultPlayer);

    // Poll loop - runs forever on Main thread
    WHILE(1)
    {
        DELAY(500);
        if (!gRequestPending)
        {
            PollStatus();
            SendRequest();
        }
    }
}

// === PUSH HANDLERS ===

PUSH SystemModuleReady
{
    if (!gInitialized)
    {
        gInitialized = 1;
        Trace("LMS: SystemModuleReady\n");
        // Don't call SendRequest here - WHILE loop handles all polling
        // This prevents collision with the WHILE loop's first poll
    }
}

PUSH Play
{
    Cmd1("play");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH Pause
{
    Cmd2("pause", "1");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH PlayPause
{
    Cmd1("pause");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH NextTrack
{
    Cmd3("playlist", "index", "+1");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH PreviousTrack
{
    Cmd3("playlist", "index", "-1");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH Stop
{
    Cmd1("stop");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH SetShuffleOn
{
    Cmd3("playlist", "shuffle", "1");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH SetShuffleOff
{
    Cmd3("playlist", "shuffle", "0");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH ToggleShuffle
{
    Cmd2("playlist", "shuffle");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH SetLoop
{
    Cmd3("playlist", "repeat", "2");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH SetLoopOne
{
    Cmd3("playlist", "repeat", "1");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH SetLoopOff
{
    Cmd3("playlist", "repeat", "0");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH ToggleLoop
{
    Cmd2("playlist", "repeat");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH VolumeUp
{
    Cmd3("mixer", "volume", "+5");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH VolumeDown
{
    Cmd3("mixer", "volume", "-5");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH Mute
{
    Cmd3("mixer", "muting", "1");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH Unmute
{
    Cmd3("mixer", "muting", "0");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

PUSH MuteUnmute
{
    Cmd3("mixer", "muting", "toggle");
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

CHANGE Volume
{
    Cmd3("mixer", "volume", ITOA(Volume));
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

CHANGE VolumeNormalized
{
    INTEGER vol;
    vol = (VolumeNormalized * 100) / 65535;
    Cmd3("mixer", "volume", ITOA(vol));
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

CHANGE Seek
{
    Cmd2("time", ITOA(Seek));
    BuildPlayerCmd(gCmd);
    if (gPlayerID <> "") SendRequest();
}

CHANGE SeekNormalized
{
    INTEGER seekPos;
    if (gLengthSeconds > 0)
    {
        seekPos = (SeekNormalized * gLengthSeconds) / 65535;
        Cmd2("time", ITOA(seekPos));
        BuildPlayerCmd(gCmd);
        if (gPlayerID <> "") SendRequest();
    }
}