path: root/examples/monitor.c

/*
 * Copyright (C) 2014 Michal Ratajsky <michal.ratajsky@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the licence, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */

#include <glib.h>
#include <glib-object.h>
#include <string.h>
#include <locale.h>

#ifdef G_OS_UNIX
#include <glib-unix.h>
#endif

#include <libmatemixer/matemixer.h>

static MateMixerContext *context;
static GMainLoop *mainloop;

static gchar *
create_app_string (const gchar *app_name,
                   const gchar *app_id,
                   const gchar *app_version)
{
    GString *string;

    string = g_string_new ("");

    if (app_name != NULL) {
        g_string_append (string, app_name);

        if (app_version != NULL)
            g_string_append_printf (string, " %s", app_version);
        if (app_id != NULL)
            g_string_append_printf (string, " (%s)", app_id);
    }
    else if (app_id != NULL) {
        g_string_append (string, app_id);

        if (app_version != NULL)
            g_string_append_printf (string, " %s", app_version);
    }

    return g_string_free (string, FALSE);
}

static const gchar *
get_stream_control_role_string (MateMixerStreamControlRole role)
{
    switch (role) {
    case MATE_MIXER_STREAM_CONTROL_ROLE_UNKNOWN:
        return "Unknown";
    case MATE_MIXER_STREAM_CONTROL_ROLE_MASTER:
        return "Master";
    case MATE_MIXER_STREAM_CONTROL_ROLE_PCM:
        return "PCM";
    case MATE_MIXER_STREAM_CONTROL_ROLE_BASS:
        return "Bass";
    case MATE_MIXER_STREAM_CONTROL_ROLE_TREBLE:
        return "Treble";
    case MATE_MIXER_STREAM_CONTROL_ROLE_CD:
        return "CD";
    case MATE_MIXER_STREAM_CONTROL_ROLE_SPEAKER:
        return "PC Speaker";
    case MATE_MIXER_STREAM_CONTROL_ROLE_PORT:
        return "Port";
    }
    return "Unknown";
}

static const gchar *
create_role_string (MateMixerClientStreamRole role)
{
    switch (role) {
    case MATE_MIXER_CLIENT_STREAM_ROLE_NONE:
        return "None";
    case MATE_MIXER_CLIENT_STREAM_ROLE_VIDEO:
        return "Video";
    case MATE_MIXER_CLIENT_STREAM_ROLE_MUSIC:
        return "Music";
    case MATE_MIXER_CLIENT_STREAM_ROLE_GAME:
        return "Game";
    case MATE_MIXER_CLIENT_STREAM_ROLE_EVENT:
        return "Event";
    case MATE_MIXER_CLIENT_STREAM_ROLE_PHONE:
        return "Phone";
    case MATE_MIXER_CLIENT_STREAM_ROLE_ANIMATION:
        return "Animation";
    case MATE_MIXER_CLIENT_STREAM_ROLE_PRODUCTION:
        return "Production";
    case MATE_MIXER_CLIENT_STREAM_ROLE_A11Y:
        return "A11y";
    case MATE_MIXER_CLIENT_STREAM_ROLE_TEST:
        return "Test";
    case MATE_MIXER_CLIENT_STREAM_ROLE_ABSTRACT:
        return "Abstract";
    case MATE_MIXER_CLIENT_STREAM_ROLE_FILTER:
        return "Filter";
    }
    return "Unknown";
}

static gchar *
create_volume_bar (MateMixerStreamControl *ctl, double *percent)
{
    GString *string;
    gint64   volume;
    gint64   volume_min;
    gint64   volume_max;
    double   p;
    int      i;
    int      length = 30;
    int      stars;

    volume     = mate_mixer_stream_control_get_volume (ctl);
    volume_min = mate_mixer_stream_control_get_min_volume (ctl);
    volume_max = mate_mixer_stream_control_get_normal_volume (ctl);

    string = g_string_new ("[");

    p = (double) (volume - volume_min) / (volume_max - volume_min) * 100;
    if (percent != NULL)
        *percent = p;

    stars = (int) ((p / 100) * length);

    for (i = 0; i < length; i++)
        g_string_append_c (string, (i < stars) ? '*' : '.');

    return g_string_free (g_string_append_c (string, ']'), FALSE);
}

static void
print_devices (void)
{
    const GList            *devices;
    const GList            *profiles;
    MateMixerDeviceProfile *active_profile;

    devices = mate_mixer_context_list_devices (context);

    while (devices) {
        MateMixerDevice *device = MATE_MIXER_DEVICE (devices->data);

        g_print ("Device %s\n"
                 "       |-| Label     : %s\n"
                 "       |-| Icon Name : %s\n\n",
                 mate_mixer_device_get_name (device),
                 mate_mixer_device_get_label (device),
                 mate_mixer_device_get_icon (device));

        profiles = mate_mixer_device_list_profiles (device);

        active_profile = mate_mixer_device_get_active_profile (device);
        while (profiles) {
            MateMixerDeviceProfile *profile = MATE_MIXER_DEVICE_PROFILE (profiles->data);

            g_print ("       |%c| Profile %s\n"
                     "                |-| Label    : %s\n"
                     "                |-| Priority : %u\n"
                     "                |-| Inputs   : %u\n"
                     "                |-| Outputs  : %u\n\n",
                     (profile == active_profile)
                        ? 'A'
                        : '-',
                     mate_mixer_device_profile_get_name (profile),
                     mate_mixer_device_profile_get_label (profile),
                     mate_mixer_device_profile_get_priority (profile),
                     mate_mixer_device_profile_get_num_input_streams (profile),
                     mate_mixer_device_profile_get_num_output_streams (profile));

            profiles = profiles->next;
        }
        g_print ("\n");

        const GList *switches = mate_mixer_device_list_switches (device);

        while (switches != NULL) {
            MateMixerSwitch *swtch = MATE_MIXER_SWITCH (switches->data);
            MateMixerSwitchOption *active = mate_mixer_switch_get_active_option (swtch);

            const GList *options;

            options = mate_mixer_switch_list_options (swtch);

            g_print ("Switch %s\n",
                     mate_mixer_switch_get_name (swtch));

            while (options != NULL) {
                MateMixerSwitchOption *option = MATE_MIXER_SWITCH_OPTION (options->data);

                g_print ("       |%c| %s\n",
                         (option == active)
                            ? '*'
                            : '-',
                         mate_mixer_switch_option_get_label (option));

                options = options->next;
            }

            switches = switches->next;
        }
        g_print ("\n");

        devices = devices->next;
    }
}

static void
print_streams (void)
{
    const GList *streams;

    streams = mate_mixer_context_list_streams (context);

    while (streams) {
        MateMixerStream        *stream = MATE_MIXER_STREAM (streams->data);
        MateMixerStreamControl *ctl;
        MateMixerSwitch        *swtch;
        MateMixerClientStream  *client = NULL;
        gchar                  *volume_bar;
        gdouble                 volume;

        const GList *controls;
        const GList *switches;

        if (mate_mixer_stream_get_flags (stream) & MATE_MIXER_STREAM_CLIENT) {
            /* The application-specific details are accessible through the client
             * interface, which all client streams implement */
            client = MATE_MIXER_CLIENT_STREAM (stream);
        }

        controls = mate_mixer_stream_list_controls (stream);

        while (controls != NULL) {
            ctl = MATE_MIXER_STREAM_CONTROL (controls->data);

            const gchar *role;

            role = get_stream_control_role_string (mate_mixer_stream_control_get_role (ctl));

            // XXX volume is sometimes -nan, use flags
            volume_bar = create_volume_bar (ctl, &volume);

            g_print ("Stream %s control %s / %s\n"
                     "       |-| Volume      : %s %.1f %% (%.1f dB)\n"
                     "       |-| Muted       : %s\n"
                     "       |-| Channels    : %d\n"
                     "       |-| Balance     : %.1f\n"
                     "       |-| Fade        : %.1f\n"
                     "       |-| Role        : %s\n",
                     mate_mixer_stream_get_name (stream),
                     mate_mixer_stream_control_get_name (ctl),
                     mate_mixer_stream_control_get_label (ctl),
                     volume_bar,
                     volume,
                     mate_mixer_stream_control_get_decibel (ctl),
                     mate_mixer_stream_control_get_mute (ctl) ? "Yes" : "No",
                     mate_mixer_stream_control_get_num_channels (ctl),
                     mate_mixer_stream_control_get_balance (ctl),
                     mate_mixer_stream_control_get_fade (ctl),
                     role);

            g_free (volume_bar);

            controls = controls->next;
        }

        switches = mate_mixer_stream_list_switches (stream);

        while (switches != NULL) {
            swtch = MATE_MIXER_SWITCH (switches->data);
            const GList *options;

            options = mate_mixer_switch_list_options (swtch);

            g_print ("Switch %s\n",
                     mate_mixer_switch_get_name (swtch));

            while (options != NULL) {
                MateMixerSwitchOption *option = MATE_MIXER_SWITCH_OPTION (options->data);

                g_print ("       |%c| %s\n",
                         '-',
                         mate_mixer_switch_option_get_label (option));

                options = options->next;
            }

            options = options->next;
        }

        if (client != NULL) {
            MateMixerClientStreamFlags client_flags;

            client_flags = mate_mixer_client_stream_get_flags (client);

            if (client_flags & MATE_MIXER_CLIENT_STREAM_APPLICATION) {
                gchar *app = create_app_string (mate_mixer_client_stream_get_app_name (client),
                                                mate_mixer_client_stream_get_app_id (client),
                                                mate_mixer_client_stream_get_app_version (client));

                g_print ("       |-| Application : %s\n", app);
                g_free (app);
            }
        }

        g_print ("\n");

        streams = streams->next;
    }
}

static void
print_stored_streams (void)
{
    const GList *streams;

    streams = mate_mixer_context_list_stored_streams (context);

    while (streams) {
        MateMixerStream           *stream = MATE_MIXER_STREAM (streams->data);
        MateMixerStreamControl    *ctl;
        MateMixerClientStream     *client;
        MateMixerClientStreamFlags client_flags;
        MateMixerClientStreamRole  client_role;
        gchar                     *volume_bar;
        gdouble                    volume;

        ctl = mate_mixer_stream_get_default_control (stream);

        client       = MATE_MIXER_CLIENT_STREAM (stream);
        client_flags = mate_mixer_client_stream_get_flags (client);
        client_role  = mate_mixer_client_stream_get_role (client);

        volume_bar = create_volume_bar (ctl, &volume);

        g_print ("Stored stream %s\n"
                 "       |-| Role        : %s\n"
                 "       |-| Volume      : %s %.1f %%\n"
                 "       |-| Muted       : %s\n"
                 "       |-| Channels    : %d\n"
                 "       |-| Balance     : %.1f\n"
                 "       |-| Fade        : %.1f\n",
                 mate_mixer_stream_get_name (stream),
                 create_role_string (client_role),
                 volume_bar,
                 volume,
                 mate_mixer_stream_control_get_mute (ctl) ? "Yes" : "No",
                 mate_mixer_stream_control_get_num_channels (ctl),
                 mate_mixer_stream_control_get_balance (ctl),
                 mate_mixer_stream_control_get_fade (ctl));

        if (client_flags & MATE_MIXER_CLIENT_STREAM_APPLICATION) {
            gchar *app = create_app_string (mate_mixer_client_stream_get_app_name (client),
                                            mate_mixer_client_stream_get_app_id (client),
                                            mate_mixer_client_stream_get_app_version (client));

            g_print ("       |-| Application : %s\n", app);
            g_free (app);
        }

        g_print ("\n");
        g_free (volume_bar);

        streams = streams->next;
    }
}

static void
connected (void)
{
    g_print ("Connected using the %s backend.\n\n",
             mate_mixer_context_get_backend_name (context));

    print_devices ();
    print_streams ();
    print_stored_streams ();

    g_print ("Waiting for events. Hit CTRL+C to quit.\n");
}

static void
state_cb (void)
{
    MateMixerState state;

    state = mate_mixer_context_get_state (context);

    switch (state) {
    case MATE_MIXER_STATE_READY:
        connected ();
        break;
    case MATE_MIXER_STATE_FAILED:
        g_printerr ("Connection failed.\n");
        g_main_loop_quit (mainloop);
        break;
    default:
        break;
    }
}

static void
device_added_cb (MateMixerContext *context, const gchar *name)
{
    g_print ("Device added: %s\n", name);
}

static void
device_removed_cb (MateMixerContext *context, const gchar *name)
{
    g_print ("Device removed: %s\n", name);
}

static void
stream_added_cb (MateMixerContext *context, const gchar *name)
{
    g_print ("Stream added: %s\n", name);
}

static void
stream_removed_cb (MateMixerContext *context, const gchar *name)
{
    g_print ("Stream removed: %s\n", name);
}

#ifdef G_OS_UNIX
static gboolean
signal_cb (gpointer mainloop)
{
    g_idle_add ((GSourceFunc) g_main_loop_quit, mainloop);
    return FALSE;
}
#endif

int main (int argc, char *argv[])
{
    MateMixerState  state;
    GOptionContext *ctx;
    gchar          *backend = NULL;
    gchar          *server = NULL;
    GError         *error = NULL;

    GOptionEntry    entries[] = {
        { "backend", 'b', 0, G_OPTION_ARG_STRING, &backend, "Sound system to use (pulseaudio, alsa, oss, null)", NULL },
        { "server",  's', 0, G_OPTION_ARG_STRING, &server,  "Sound server address", NULL },
        { NULL }
    };

    ctx = g_option_context_new ("- libmatemixer monitor");

    g_option_context_add_main_entries (ctx, entries, NULL);

    if (!g_option_context_parse (ctx, &argc, &argv, &error)) {
        g_printerr ("%s\n", error->message);
        g_error_free (error);
        return 1;
    }

    /* Initialize the library, if the function returns FALSE, it is not usable */
    if (!mate_mixer_init ())
        return 1;

    setlocale (LC_ALL, "");

    /* Set up the contextler, through which we access the main functionality */
    context = mate_mixer_context_new ();

    /* Some details about our application, only used with the PulseAudio backend */
    mate_mixer_context_set_app_name (context, "MateMixer Monitor");
    mate_mixer_context_set_app_id (context, "org.mate-desktop.libmatemixer-monitor");
    mate_mixer_context_set_app_version (context, "1.0");
    mate_mixer_context_set_app_icon (context, "multimedia-volume-context");

    if (backend) {
        if (!strcmp (backend, "pulseaudio"))
            mate_mixer_context_set_backend_type (context, MATE_MIXER_BACKEND_PULSEAUDIO);
        else if (!strcmp (backend, "alsa"))
            mate_mixer_context_set_backend_type (context, MATE_MIXER_BACKEND_ALSA);
        else if (!strcmp (backend, "oss"))
            mate_mixer_context_set_backend_type (context, MATE_MIXER_BACKEND_OSS);
        else if (!strcmp (backend, "null"))
            mate_mixer_context_set_backend_type (context, MATE_MIXER_BACKEND_NULL);
        else
            g_printerr ("Sound system backend '%s' is unknown, it will be auto-detected.\n",
                        backend);

        g_free (backend);
    }

    if (server) {
        mate_mixer_context_set_server_address (context, server);
        g_free (server);
    }

    /* Initiate connection to the sound server */
    if (!mate_mixer_context_open (context)) {
        g_object_unref (context);
        return 1;
    }

    g_signal_connect (G_OBJECT (context),
                      "device-added",
                      G_CALLBACK (device_added_cb),
                      NULL);
    g_signal_connect (G_OBJECT (context),
                      "device-removed",
                      G_CALLBACK (device_removed_cb),
                      NULL);
    g_signal_connect (G_OBJECT (context),
                      "stream-added",
                      G_CALLBACK (stream_added_cb),
                      NULL);
    g_signal_connect (G_OBJECT (context),
                      "stream-removed",
                      G_CALLBACK (stream_removed_cb),
                      NULL);

    /* If mate_mixer_context_open() returns TRUE, the state will be either
     * MATE_MIXER_STATE_READY or MATE_MIXER_STATE_CONNECTING.
     *
     * In case mate_mixer_context_open() returned FALSE, the current state
     * would be MATE_MIXER_STATE_FAILED */
    state = mate_mixer_context_get_state (context);

    switch (state) {
    case MATE_MIXER_STATE_READY:
        connected ();
        break;
    case MATE_MIXER_STATE_CONNECTING:
        g_print ("Waiting for connection...\n");

        /* Wait for the state transition */
        g_signal_connect (context,
                          "notify::state",
                          G_CALLBACK (state_cb),
                          NULL);
        break;
    default:
        g_assert_not_reached ();
        break;
    }

    mainloop = g_main_loop_new (NULL, FALSE);

#ifdef G_OS_UNIX
    g_unix_signal_add (SIGTERM, signal_cb, mainloop);
    g_unix_signal_add (SIGINT,  signal_cb, mainloop);
#endif

    g_main_loop_run (mainloop);

    g_object_unref (context);

    return 0;
}