music_cmd.c

/*
  SDL_mixer:  An audio mixer library based on the SDL library
  Copyright (C) 1997-2017 Sam Lantinga <slouken@libsdl.org>

  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.

  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
#include "SDL_config.h"

/* This file supports an external command for playing music */

#ifdef MUSIC_CMD

#include <sys/types.h>
#include <sys/wait.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <signal.h>
#include <ctype.h>
#include <limits.h>
#if defined(__linux__) && defined(__arm__)
# include <linux/limits.h>
#endif

#include "music_cmd.h"


typedef struct {
    char *file;
    char *cmd;
    pid_t pid;
    int play_count;
} MusicCMD;


/* Load a music stream from the given file */
static void *MusicCMD_CreateFromFile(const char *file)
{
    MusicCMD *music;

    if (!music_cmd) {
        Mix_SetError("You must call Mix_SetMusicCMD() first");
        return NULL;
    }

    /* Allocate and fill the music structure */
    music = (MusicCMD *)SDL_calloc(1, sizeof *music);
    if (music == NULL) {
        Mix_SetError("Out of memory");
        return NULL;
    }
    music->file = SDL_strdup(file);
    music->cmd = SDL_strdup(music_cmd);
    music->pid = 0;

    /* We're done */
    return music;
}

/* Parse a command line buffer into arguments */
static int ParseCommandLine(char *cmdline, char **argv)
{
    char *bufp;
    int argc;

    argc = 0;
    for (bufp = cmdline; *bufp;) {
        /* Skip leading whitespace */
        while (isspace(*bufp)) {
            ++bufp;
        }
        /* Skip over argument */
        if (*bufp == '"') {
            ++bufp;
            if (*bufp) {
                if (argv) {
                    argv[argc] = bufp;
                }
                ++argc;
            }
            /* Skip over word */
            while (*bufp && (*bufp != '"')) {
                ++bufp;
            }
        } else {
            if (*bufp) {
                if (argv) {
                    argv[argc] = bufp;
                }
                ++argc;
            }
            /* Skip over word */
            while (*bufp && ! isspace(*bufp)) {
                ++bufp;
            }
        }
        if (*bufp) {
            if (argv) {
                *bufp = '\0';
            }
            ++bufp;
        }
    }
    if (argv) {
        argv[argc] = NULL;
    }
    return(argc);
}

static char **parse_args(char *command, char *last_arg)
{
    int argc;
    char **argv;

    /* Parse the command line */
    argc = ParseCommandLine(command, NULL);
    if (last_arg) {
        ++argc;
    }
    argv = (char **)SDL_malloc((argc+1)*(sizeof *argv));
    if (argv == NULL) {
        return(NULL);
    }
    argc = ParseCommandLine(command, argv);

    /* Add last command line argument */
    if (last_arg) {
        argv[argc++] = last_arg;
    }
    argv[argc] = NULL;

    /* We're ready! */
    return(argv);
}

/* Start playback of a given music stream */
static int MusicCMD_Play(void *context, int play_count)
{
    MusicCMD *music = (MusicCMD *)context;

    music->play_count = play_count;
#ifdef HAVE_FORK
    music->pid = fork();
#else
    music->pid = vfork();
#endif
    switch(music->pid) {
    /* Failed fork() system call */
    case -1:
        Mix_SetError("fork() failed");
        return -1;

    /* Child process - executes here */
    case 0: {
        char **argv;

        /* Unblock signals in case we're called from a thread */
        {
            sigset_t mask;
            sigemptyset(&mask);
            sigprocmask(SIG_SETMASK, &mask, NULL);
        }

        /* Execute the command */
        argv = parse_args(music->cmd, music->file);
        if (argv != NULL) {
            execvp(argv[0], argv);

            /* exec() failed */
            perror(argv[0]);
        }
        _exit(-1);
    }
    break;

    /* Parent process - executes here */
    default:
        break;
    }
    return 0;
}

/* Return non-zero if a stream is currently playing */
static SDL_bool MusicCMD_IsPlaying(void *context)
{
    MusicCMD *music = (MusicCMD *)context;
    int status;

    if (music->pid > 0) {
        waitpid(music->pid, &status, WNOHANG);
        if (kill(music->pid, 0) == 0) {
            return SDL_TRUE;
        }

        /* We might want to loop */
        if (music->play_count != 1) {
            int play_count = -1;
            if (music->play_count > 0) {
                play_count = (music->play_count - 1);
            }
            MusicCMD_Play(music, play_count);
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

/* Pause playback of a given music stream */
static void MusicCMD_Pause(void *context)
{
    MusicCMD *music = (MusicCMD *)context;
    if (music->pid > 0) {
        kill(music->pid, SIGSTOP);
    }
}

/* Resume playback of a given music stream */
static void MusicCMD_Resume(void *context)
{
    MusicCMD *music = (MusicCMD *)context;
    if (music->pid > 0) {
        kill(music->pid, SIGCONT);
    }
}

/* Stop playback of a stream previously started with MusicCMD_Start() */
static void MusicCMD_Stop(void *context)
{
    MusicCMD *music = (MusicCMD *)context;
    int status;

    if (music->pid > 0) {
        while (kill(music->pid, 0) == 0) {
            kill(music->pid, SIGTERM);
            sleep(1);
            waitpid(music->pid, &status, WNOHANG);
        }
        music->pid = 0;
    }
}

/* Close the given music stream */
void MusicCMD_Delete(void *context)
{
    MusicCMD *music = (MusicCMD *)context;
    SDL_free(music->file);
    SDL_free(music);
}

Mix_MusicInterface Mix_MusicInterface_CMD =
{
    "CMD",
    MIX_MUSIC_CMD,
    MUS_CMD,
    SDL_FALSE,
    SDL_FALSE,

    NULL,   /* Load */
    NULL,   /* Open */
    NULL,   /* CreateFromRW */
    MusicCMD_CreateFromFile,
    NULL,   /* SetVolume */
    MusicCMD_Play,
    MusicCMD_IsPlaying,
    NULL,   /* GetAudio */
    NULL,   /* Seek */
    MusicCMD_Pause,
    MusicCMD_Resume,
    MusicCMD_Stop,
    MusicCMD_Delete,
    NULL,   /* Close */
    NULL,   /* Unload */
};

#endif /* MUSIC_CMD */

/* vi: set ts=4 sw=4 expandtab: */