DSP-PROGRAM-INFO(1)

NAME
dsp-program-info - get DSP program information using REST API

SYNOPSIS
dsp-program-info [OPTIONS]

DESCRIPTION
dsp-program-info retrieves comprehensive information about the currently loaded DSP program from a HiFiBerry DSP using the REST API. This tool provides details including program length and checksums, which are useful for verification and debugging.

The tool connects to the DSP's REST API server (sigmatcpserver) and queries the /program-info endpoint to obtain current program information.

OPTIONS

-h, --host HOST
    DSP server hostname or IP address (default: localhost)

-p, --port PORT
    DSP server port (default: 13141)

-t, --timeout SECONDS
    Connection timeout in seconds (default: 30)

-f, --format FORMAT
    Output format: json, text, or brief (default: text)

-v, --verbose
    Enable verbose output for debugging and detailed progress information

-q, --quiet
    Suppress non-error output messages (only show program info)

--help
    Show help message and exit

--version
    Show version information and exit

OUTPUT FORMATS

json
    Raw JSON response from the API, suitable for parsing by other tools

text
    Human-readable formatted output with labeled fields

brief
    Compact single-line output showing program length and SHA-1 checksum

EXAMPLES

Get program info from local DSP:
    dsp-program-info

Get program info from remote DSP in JSON format:
    dsp-program-info -h 192.168.1.100 -f json

Get brief info quietly (suitable for scripts):
    dsp-program-info -q -f brief

Get program info with verbose output:
    dsp-program-info -v

Monitor program length in a script:
    LENGTH=$(dsp-program-info -q -f brief | cut -d' ' -f1)

EXIT STATUS

0   Success

1   General error

2   Invalid arguments or command-line options

4   Connection error - cannot reach DSP API server

5   API error - server returned an error

OUTPUT FIELDS
The program information includes the following fields:

Program Length
    The size of the currently loaded DSP program in words (32-bit). Also displayed in human-readable format (KB/MB).

MD5 Checksum
    MD5 checksum of the DSP program calculated using signature-based detection. Used for compatibility with legacy systems.

SHA-1 Checksum
    SHA-1 checksum of the DSP program calculated using length-based detection. Preferred for modern applications due to better performance.

FILES

/etc/sigmatcp.conf
    SigmaTCP server configuration file

ENVIRONMENT

HTTP_PROXY, HTTPS_PROXY
    Proxy settings for curl (if needed for network access)

DEPENDENCIES

curl
    Required for making HTTP requests to the DSP API server

NOTES

This tool requires the sigmatcpserver to be running on the target DSP system with the REST API enabled. The default configuration listens on localhost:13141.

The checksums are calculated from the currently loaded DSP program in memory, not from any stored profile files.

Program length is reported in DSP words (32-bit units). To convert to bytes, multiply by 4.

Different checksum algorithms may return different values for the same program due to their calculation methods (signature-based vs length-based).

SEE ALSO
dsp-install-profile(1), dsptoolkit(1), sigmatcpserver(1), curl(1)

HiFiBerry DSP documentation: https://www.hifiberry.com/docs/

REST API documentation: /usr/share/doc/hifiberry-dsp/restapi.md

BUGS
Report bugs to: https://github.com/hifiberry/hifiberry-dsp/issues

AUTHOR
HiFiBerry team <info@hifiberry.com>

COPYRIGHT
Copyright © 2025 HiFiBerry. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.