#!/usr/bin/bash

# heos-favplay  Copyright 2025-2026  Norman Carver

# Script program to Play a particular HEOS Favorites item on a HEOS player/group.
#
# A player is specified with:
# (1) a (sub)string of the player's HEOS name, or
# (2) its IP num (i.e., host portion of its dotted quad IP address).
#
# With the -g option, a group is specified:
# (1) a (sub)string of the group's HEOS name, or
# (2) its Group ID (GID).
#
# Sends commands to the default HEOS master device, but can select alternative
# using the MASTER_IPNUM argument option.


# Source ID (SID) for Favorites (from HEOS Protocol doc):
# (Set to empty string to cause it to be determined from Music Sources.)
sid_favorites=1028


function print_usage()
{
    echo -e "Play a particular HEOS Favorites item on a HEOS Player/Group.\n" >&2
    echo    "Usage: heos-favplay [-g] [-v] PLAYER FAVORITES_ITEM [MASTER_IPNUM]" >&2
    echo    "where:" >&2
    echo    "  PLAYER -- a HEOS Player's Name (substring) or its IPNUM;" >&2
    echo    "  FAVORITES_ITEM -- the 1-based index number of an item in the Favorites list;" >&2
    echo    "  MASTER_IPNUM -- use a non-default HEOS master device;" >&2
    echo -e "  (IPNUM means the last quad of an IP address only: i.e., 0--255.)\n" >&2
    echo    "Options:" >&2
    echo    "  -g -- group: PLAYER is a group Name or GID;" >&2
    echo    "  -v -- verbose: print out name of FAVORITES_ITEM when started;" >&2
}


if [[ "$1" == --help ]]; then
    print_usage
    exit 0
fi

# Process supplied options:
pgopt=--player
verbose=false
pidopt=""
debugopt=""
while [[ "$1" == -* ]]; do
    if [[ "$1" == -g ]]; then
        pgopt=--group
    elif [[ "$1" == -v ]]; then
        verbose=true
    elif [[ "$1" == --pid=?* ]]; then
        pidopt=$1
    elif [[ "$1" == -- ]]; then
        shift;break
    elif [[ "$1" == --debug ]]; then
        debugopt=--debug
    else
        echo "Error: invalid option '$1'" >&2
        echo "(use '--' to signal end of options, with -* arguments)" >&2
        exit 1 
    fi
    shift
done

# Process command arguments:
if [[ $# -lt 2 || $# -gt 3 ]]; then
    print_usage
    exit 1
fi

player=$1
itemnum=$2
if [[ $# == 3 ]]; then
    master=${3}
else
    master=""
fi
heosdir=$(dirname "$0")


# heosutil-run-command error checking function (one json output):
# args: 1) command result variable; 2) error message; [3) error action]
# (default action on error is 'exit 1', use $3 of 'return 1' to continue execution)
function error_check_run_command()
{
    cmdresult=${!1}
    if [[ ($? != 0) || ("$cmdresult" != *'"result": "success"'*) ]]; then
        if [[ "$cmdresult" == Error:* || ($debugopt == --debug && "$cmdresult" == ERROR:*) ]]; then
            echo "$cmdresult" >&2
        fi
        if [[ -n "$2" ]]; then echo "$2" >&2; fi
        if [[ $# == 3 ]]; then $3; else exit 1; fi
    else
        return 0
    fi
}


# heosutil-run-command error checking function (two json outputs):
# args: 1) command result variable; 2) error message; [3) error action]
# (default action on error is 'exit 1', use $3 of 'return 1' to continue execution)
function error_check_run_command_2json()
{
    cmdresult=${!1}
    if [[ ($? != 0) || ("$cmdresult" != *'"result": "success"'*'"result": "success"'*) ]]; then
        if [[ "$cmdresult" == Error:* || ($debugopt == --debug && "$cmdresult" == ERROR:*) ]]; then
            echo "$cmdresult" >&2
        fi
        if [[ -n "$2" ]]; then echo "$2" >&2; fi
        if [[ $# == 3 ]]; then $3; else exit 1; fi
    else
        return 0
    fi
}

if [[ ! ("$itemnum" =~ ^[0-9]+$ && "$itemnum" -ge 1) ]]; then
    echo "Error: FAVORITES_ITEM must be an integer >= 1 ('$itemnum')!" >&2
    exit 1
fi


# Start FAVORITES_ITEM playing (action result in 2nd JSON object):
result=$("$heosdir"/heosutils/heosutil-run-command ${pgopt}="$player" $pidopt --numjson=2 "heos://browse/play_preset?pid=\${pid}&preset=${itemnum}" $master)
error_check_run_command_2json result "Error: failed playing FAVORITES_ITEM ('$itemnum') on PLAYER ('$player')!"

# Print out FAVORITES_ITEM if selected:
if $verbose; then
    # If necessary, determine Favorites SID from Music Sources:
    if [[ -z "$sid_favorites" ]]; then
        # Get Music Sources info so can get Favorites SID:
        sources=$("$heosdir"/heosutils/heosutil-run-command "heos://browse/get_music_sources" $master)
        error_check_run_command sources "Error: failed getting Music Sources listing!"
        sid=${sources#*\{\"name\": \"Favorites\"*\"sid\":\ }
        sid_favorites=${sid%%[,\}]*}
    fi

    # Get Favorites item (action result in 2nd JSON object):
    itemindex=$((itemnum-1))
    browse=$("$heosdir"/heosutils/heosutil-run-command --numjson=2 "heos://browse/browse?sid=${sid_favorites}&range=$itemindex,$itemindex" $master)
    error_check_run_command_2json browse "Error: failed getting Favorites listing!"

    # Use grep to make get item json:
    itemjson=$(grep -Eo '\{[^}]*"container":[^}]+\}' <<<"$browse")

    # Reformat and print out itemjson:
    type=${itemjson#*\"type\":\ \"}
    type=${type%%\",*}
    name=${itemjson##*\"name\":\ \"}
    name=${name%%\",*}
    echo "Playing Favorites item '$type: $name'..."

else
    echo "Playing Favorites item #${itemnum}..."
fi

#EOF
