alsa-lib/test/playmidi1.c

/*
 *   MIDI file player for ALSA sequencer 
 *   (type 0 only!, the library that is used doesn't support merging of tracks)
 *
 *   Copyright (c) 1998 by Frank van de Pol <F.K.W.van.de.Pol@inter.nl.net>
 *
 *   Modified so that this uses alsa-lib
 *   1999 Jan. by Isaku Yamahata <yamahata@kusm.kyoto-u.ac.jp>
 *
 *   19990604	Takashi Iwai <iwai@ww.uni-erlangen.de>
 *	- use blocking mode
 *	- fix tempo event bug
 *	- add command line options
 *
 *   19990827	Takashi Iwai <iwai@ww.uni-erlangen.de>
 *	- use snd_seq_alloc_queue()
 *
 *   19990916	Takashi Iwai <iwai@ww.uni-erlangen.de>
 *	- use middle-level sequencer routines and macros
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

#include <stdio.h>
#include <ctype.h>
#include <fcntl.h>
#include <stdlib.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>

#include "midifile.h"		/* SMF library header */
#include "midifile.c"		/* SMF library code */

#include "../include/asoundlib.h"

/* send real-time time stamps instead of midi ticks to the ALSA sequencer */
static int use_realtime = 0;

/* control event buffering by blocking mode */
static int use_blocking_mode = 1;

/* default destination queue, client and port numbers */
#define DEST_CLIENT_NUMBER	65
#define DEST_PORT_NUMBER	0

/* event pool size */
#define WRITE_POOL_SIZE		200
#define WRITE_POOL_SPACE	10
#define READ_POOL_SIZE		10	/* we need read pool only for echoing */

static FILE *F;
static snd_seq_t *seq_handle = NULL;
static int ppq = 96;
static int slave_ppq = 96;

static double local_secs = 0;
static int local_ticks = 0;
static int local_tempo = 500000;

static int dest_queue = -1;
static int dest_client = DEST_CLIENT_NUMBER;
static int dest_port = DEST_PORT_NUMBER;
static int my_port = 0;

static int verbose = 0;
static int slave   = 0;		/* allow external sync */

#define VERB_INFO	1
#define VERB_MUCH	2
#define VERB_EVENT	3

static void alsa_start_timer(void);
static void alsa_stop_timer(void);
static void wait_start(void);


static inline double tick2time_dbl(int tick)
{
	return local_secs + ((double) (tick - local_ticks) * (double) local_tempo * 1.0E-6 / (double) ppq);
}

static void tick2time(snd_seq_real_time_t * tm, int tick)
{
	double secs = tick2time_dbl(tick);
	tm->tv_sec = secs;
	tm->tv_nsec = (secs - tm->tv_sec) * 1.0E9;
}

static void write_ev(snd_seq_event_t *ev)
{
	int rc;

	if (use_blocking_mode) {
		rc = snd_seq_event_output(seq_handle, ev);
		if (rc < 0) {
			printf("written = %i (%s)\n", rc, snd_strerror(rc));
			exit(1);
		}
		return;
	}
	while ((rc = snd_seq_event_output(seq_handle, ev)) < 0) {
		int seqfd;
		fd_set fds;
		seqfd = snd_seq_file_descriptor(seq_handle);
		FD_ZERO(&fds);
		FD_SET(seqfd, &fds);
		if ((rc = select(seqfd + 1, NULL, &fds, NULL, NULL)) < 0) {
			printf("select error = %i (%s)\n", rc, snd_strerror(rc));
			exit(1);
		}
	}
}

/* read byte */
static int mygetc(void)
{
	return getc(F);
}

/* print out text */
static void mytext(int type, int leng, char *msg)
{
	char *p;
	char *ep = msg + leng;

	if (verbose >= VERB_INFO) {
		for (p = msg; p < ep; p++)
			putchar(isprint(*p) ? *p : '?');
		putchar('\n');
	}
}

static void do_header(int format, int ntracks, int division)
{
	snd_seq_queue_tempo_t	tempo;

	if (verbose >= VERB_INFO)
		printf("smf format %d, %d tracks, %d ppq\n", format, ntracks, division);
	ppq = division;

	if (format != 0 || ntracks != 1) {
		printf("This player does not support merging of tracks.\n");
		alsa_stop_timer();
		exit(1);
	}
	/* set ppq */
	/* ppq must be set before starting timer */
	if (snd_seq_get_queue_tempo(seq_handle, dest_queue, &tempo) < 0) {
    		perror("get_queue_tempo");
    		exit(1);
	}
	if (tempo.ppq != ppq) {
		slave_ppq = tempo.ppq;
		tempo.ppq = ppq;
		if (snd_seq_set_queue_tempo(seq_handle, dest_queue, &tempo) < 0) {
    			perror("set_queue_tempo");
    			if (!slave)
    				exit(1);
			else
				printf("different PPQ %d in SMF from queue PPQ %d\n", ppq, slave_ppq);
		} else
			slave_ppq = ppq;
		if (verbose >= VERB_INFO)
			printf("ALSA Timer updated, PPQ = %d\n", tempo.ppq);
	}

	/* start playing... */
	if (slave) {
		if (verbose >= VERB_INFO)
			printf("Wait till timer starts...\n");	
		wait_start();
		if (verbose >= VERB_INFO)
			printf("Go!\n");	
	} else
		alsa_start_timer();
}

/* fill time */
static void set_event_time(snd_seq_event_t *ev, unsigned int currtime)
{
	if (use_realtime) {
		snd_seq_real_time_t rtime;
		if (ppq != slave_ppq)
			currtime = (currtime * slave_ppq) / ppq;
		tick2time(&rtime, currtime);
		snd_seq_ev_schedule_real(ev, dest_queue, 0, &rtime);
	} else {
		if (ppq != slave_ppq)
			currtime = (currtime * slave_ppq) / ppq;
		snd_seq_ev_schedule_tick(ev, dest_queue, 0, currtime);
	}
}

/* fill normal event header */
static void set_event_header(snd_seq_event_t *ev)
{
	snd_seq_ev_clear(ev);
	snd_seq_ev_set_dest(ev, dest_client, dest_port);
	snd_seq_ev_set_source(ev, my_port);
	set_event_time(ev, Mf_currtime);
}

/* start timer */
static void alsa_start_timer(void)
{
	snd_seq_start_queue(seq_handle, dest_queue, NULL);
}

/* stop timer */
static void alsa_stop_timer(void)
{
	snd_seq_event_t ev;
	set_event_header(&ev);
	snd_seq_stop_queue(seq_handle, dest_queue, &ev);
}

/* change tempo */
static void do_tempo(int us)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_MUCH) {
		double bpm;
		bpm = 60.0E6 / (double) us;
		printf("Tempo %d us/beat, %.2f bpm\n", us, bpm);
	}

	/* store new tempo and timestamp of tempo change */
	local_secs = tick2time_dbl(Mf_currtime);
	local_ticks = Mf_currtime;
	local_tempo = us;

	set_event_header(&ev);
	if (!slave)
		snd_seq_change_queue_tempo(seq_handle, dest_queue, us, &ev);
}

static void do_noteon(int chan, int pitch, int vol)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("NoteOn (%d) %d %d\n", chan, pitch, vol);
	set_event_header(&ev);
	snd_seq_ev_set_noteon(&ev, chan, pitch, vol);
	write_ev(&ev);
}


static void do_noteoff(int chan, int pitch, int vol)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("NoteOff (%d) %d %d\n", chan, pitch, vol);
	set_event_header(&ev);
	snd_seq_ev_set_noteoff(&ev, chan, pitch, vol);
	write_ev(&ev);
}


static void do_program(int chan, int program)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("Program (%d) %d\n", chan, program);
	set_event_header(&ev);
	snd_seq_ev_set_pgmchange(&ev, chan, program);
	write_ev(&ev);
}


static void do_parameter(int chan, int control, int value)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("Control (%d) %d %d\n", chan, control, value);
	set_event_header(&ev);
	snd_seq_ev_set_controller(&ev, chan, control, value);
	write_ev(&ev);
}


static void do_pitchbend(int chan, int lsb, int msb)
{	/* !@#$% lsb & msb are in wrong order in docs */
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("Pitchbend (%d) %d %d\n", chan, lsb, msb);
	set_event_header(&ev);
	snd_seq_ev_set_pitchbend(&ev, chan, (lsb + (msb << 7)) - 8192);
	write_ev(&ev);
}

static void do_pressure(int chan, int pitch, int pressure)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("KeyPress (%d) %d %d\n", chan, pitch, pressure);
	set_event_header(&ev);
	snd_seq_ev_set_keypress(&ev, chan, pitch, pressure);
	write_ev(&ev);
}

static void do_chanpressure(int chan, int pressure)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_EVENT)
		printf("ChanPress (%d) %d\n", chan, pressure);
	set_event_header(&ev);
	snd_seq_ev_set_chanpress(&ev, chan, pressure);
	write_ev(&ev);
}

static void do_sysex(int len, char *msg)
{
	snd_seq_event_t ev;

	if (verbose >= VERB_MUCH) {
		int c;
		printf("Sysex, len=%d\n", len);
		for (c = 0; c < len; c++) {
			printf(" %02x", (unsigned char)msg[c]);
			if (c % 16 == 15)
				putchar('\n');
		}
		if (c % 16 != 15)
			putchar('\n');
	}

	set_event_header(&ev);
	snd_seq_ev_set_sysex(&ev, len, msg);
	write_ev(&ev);
}

static snd_seq_event_t *wait_for_event(void)
{
	int left;
	snd_seq_event_t *input_event;
  
	if (use_blocking_mode) {
		/* read event - blocked until any event is read */
		left = snd_seq_event_input(seq_handle, &input_event);
	} else {
		/* read event - using select syscall */
		while ((left = snd_seq_event_input(seq_handle, &input_event)) >= 0 &&
		       input_event == NULL) {
			int seqfd;
			fd_set fds;
			seqfd = snd_seq_file_descriptor(seq_handle);
			FD_ZERO(&fds);
			FD_SET(seqfd, &fds);
			if ((left = select(seqfd + 1, &fds, NULL, NULL, NULL)) < 0) {
				printf("select error = %i (%s)\n", left, snd_strerror(left));
				exit(1);
			}
		}
	}

	if (left < 0) {
		printf("alsa_sync error!:%s\n", snd_strerror(left));
		return NULL;
	}

	return input_event;
}

/* synchronize to the end of event */
static void alsa_sync(void)
{
	int left;
	snd_seq_event_t *input_event;
	snd_seq_event_t ev;
  
	/* send echo event to self client. */
	if (verbose >= VERB_MUCH)
		printf("alsa_sync syncing... send ECHO(%d) event to myself. time=%f\n",
		       SND_SEQ_EVENT_ECHO, (double) Mf_currtime+1);
	snd_seq_ev_clear(&ev);
	/* redirect to itself */
	snd_seq_ev_set_dest(&ev, snd_seq_client_id(seq_handle), my_port);
	snd_seq_ev_set_source(&ev, my_port);
	set_event_time(&ev, Mf_currtime+1);
	ev.type = SND_SEQ_EVENT_ECHO;
	write_ev(&ev);
  
	/* dump buffer */
	left = snd_seq_flush_output(seq_handle);

	/* wait for the timer start event */
	for (;;) {
		input_event = wait_for_event();
		if (input_event) {
			if (verbose >= VERB_MUCH)
				printf("alsa_sync got event. type=%d, flags=%d\n",
				       input_event->type, input_event->flags);
			if (input_event->type == SND_SEQ_EVENT_ECHO &&
			    input_event->source.client == snd_seq_client_id(seq_handle)) {
				snd_seq_free_event(input_event);
				break;
			}
			snd_seq_free_event(input_event);
		}
	}
	if (verbose >= VERB_MUCH)
		printf("alsa_sync synced\n");
}


/* wait for start of the queue */
static void wait_start(void)
{
	snd_seq_event_t *input_event;

	/* wait the start event from the system timer */
	for (;;) {
		input_event = wait_for_event();
		if (input_event) {
			if (verbose >= VERB_MUCH)
				printf("wait_start got event. type=%d, flags=%d\n",
				       input_event->type, input_event->flags);
			if (input_event->type == SND_SEQ_EVENT_START &&
			    input_event->data.queue.queue == dest_queue) {
				snd_seq_free_event(input_event);
				break;
			}
			snd_seq_free_event(input_event);
		}
	}
	if (verbose >= VERB_MUCH)
		printf("start received\n");
}


/* print usage */
static void usage(void)
{
	fprintf(stderr, "usage: playmidi1 [options] [file]\n");
	fprintf(stderr, "  options:\n");
	fprintf(stderr, "  -v: verbose mode\n");
	fprintf(stderr, "  -a client:port : set destination address (default=%d:%d)\n",
		DEST_CLIENT_NUMBER, DEST_PORT_NUMBER);
	fprintf(stderr, "  -q queue: use the specified queue\n");
	fprintf(stderr, "  -s queue: slave mode (allow external clock synchronisation)\n");
	fprintf(stderr, "  -r : play on real-time mode\n");
	fprintf(stderr, "  -b : play on non-blocking mode\n");
}

/* parse destination address (-a option) */
void parse_address(char *arg, int *clientp, int *portp)
{
	char *next;

	*clientp = atoi(arg);
	if ((next = strchr(arg, ':')) != NULL)
		*portp = atoi(next + 1);
}

int main(int argc, char *argv[])
{
	int tmp;
	int c;

	while ((c = getopt(argc, argv, "s:a:q:vrb")) != -1) {
		switch (c) {
		case 'v':
			verbose++;
			break;
		case 'a':
			parse_address(optarg, &dest_client, &dest_port);
			break;
		case 'q':
			dest_queue = atoi(optarg);
			if (dest_queue < 0) {
				fprintf(stderr, "invalid queue number %d\n", dest_queue);
				exit(1);
			}
			break;
		case 's':
			slave = 1;
			dest_queue = atoi(optarg);
			if (dest_queue < 0) {
				fprintf(stderr, "invalid queue number %d\n", dest_queue);
				exit(1);
			}
			break;
		case 'r':
			use_realtime = 1;
			break;
		case 'b':
			use_blocking_mode = 0;
			break;
		default:
			usage();
			exit(1);
		}
	}

	if (verbose >= VERB_INFO) {
		if (use_realtime)
			printf("ALSA MIDI Player, feeding events to real-time queue\n");
		else
			printf("ALSA MIDI Player, feeding events to song queue\n");
	}

	/* open sequencer device */
	/* Here we open the device read/write mode. */
	/* Because we write SND_SEQ_EVENT_ECHO to myself to sync. */
	tmp = snd_seq_open(&seq_handle, SND_SEQ_OPEN);
	if (tmp < 0) {
		perror("open /dev/snd/seq");
		exit(1);
	}
	
	tmp = snd_seq_block_mode(seq_handle, use_blocking_mode);
	if (tmp < 0) {
		perror("block_mode");
		exit(1);
	}
			
	/* set name */
	/* set event filter to recieve only echo event */
	/* if running in slave mode also listen for START event */
	snd_seq_set_client_event_filter(seq_handle, SND_SEQ_EVENT_ECHO);
	if (slave)
		snd_seq_set_client_event_filter(seq_handle, SND_SEQ_EVENT_START);
	snd_seq_set_client_name(seq_handle, "MIDI file player");

	/* create port */
	my_port = snd_seq_create_simple_port(seq_handle, "Port 0",
					     SND_SEQ_PORT_CAP_WRITE |
					     SND_SEQ_PORT_CAP_READ,
					     SND_SEQ_PORT_TYPE_MIDI_GENERIC);
	if (my_port < 0) {
		perror("creat port");
		exit(1);
	}
	
	/* setup queue */
	if (dest_queue >= 0) {
		if (snd_seq_use_queue(seq_handle, dest_queue, 1) < 0) {
			perror("use queue");
			exit(1);
		}
	} else {
		dest_queue = snd_seq_alloc_queue(seq_handle);
		if (dest_queue < 0) {
			perror("alloc queue");
			exit(1);
		}
	}

	/* setup subscriber */
	tmp = snd_seq_connect_to(seq_handle, my_port, dest_client, dest_port);
	if (tmp < 0) {
		perror("subscribe");
		exit(1);
	}

	/* subscribe for timer START event */	
	if (slave) {	
		tmp = snd_seq_connect_from(seq_handle, my_port,
					   SND_SEQ_CLIENT_SYSTEM,
					   snd_seq_queue_sync_port(dest_queue));
		if (tmp < 0) {
			perror("subscribe");
			exit(1);
		}	
	}
	
	/* change pool size */
	if (snd_seq_set_client_pool_output(seq_handle, WRITE_POOL_SIZE) < 0 ||
	    snd_seq_set_client_pool_input(seq_handle, READ_POOL_SIZE) < 0 ||
	    snd_seq_set_client_pool_output_room(seq_handle, WRITE_POOL_SPACE) < 0) {
		perror("pool");
		exit(1);
	}
	
	if (optind < argc) {
		F = fopen(argv[optind], "r");
		if (F == NULL) {
			fprintf(stderr, "playmidi1: can't open file %s\n", argv[optind]);
			exit(1);
		}
	} else
		F = stdin;

	Mf_header = do_header;
	Mf_tempo = do_tempo;
	Mf_getc = mygetc;
	Mf_text = mytext;

	Mf_noteon = do_noteon;
	Mf_noteoff = do_noteoff;
	Mf_program = do_program;
	Mf_parameter = do_parameter;
	Mf_pitchbend = do_pitchbend;
	Mf_pressure = do_pressure;
	Mf_chanpressure = do_chanpressure;
	Mf_sysex = do_sysex;

	/* go.. go.. go.. */
	mfread();

	alsa_sync();
	alsa_stop_timer();

	snd_seq_close(seq_handle);

	if (verbose >= VERB_INFO) {
		printf("Stopping at %f s,  tick %f\n",
		       tick2time_dbl(Mf_currtime + 1), (double) (Mf_currtime + 1));
	}

	exit(0);
}