alsa-utils/bat/bat.c

/*
 * Copyright (C) 2013-2015 Intel Corporation
 *
 * 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.
 *
 */

#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <string.h>
#include <errno.h>
#include <pthread.h>
#include <getopt.h>
#include <math.h>
#include <limits.h>
#include <locale.h>
#include <math.h>

#include "aconfig.h"
#include "gettext.h"
#include "version.h"

#include "common.h"

#ifdef HAVE_LIBTINYALSA
#include "tinyalsa.h"
#else
#include "alsa.h"
#endif
#include "convert.h"
#ifdef HAVE_LIBFFTW3F
#include "analyze.h"
#endif
#include "latencytest.h"

/* get snr threshold in dB */
static void get_snr_thd_db(struct bat *bat, char *thd)
{
	int err;
	float thd_db;
	char *ptrf;

	thd_db = strtof(thd, &ptrf);
	err = -errno;
	if (!snr_is_valid(thd_db)) {
		fprintf(bat->err, _("Invalid threshold '%s':%d\n"), thd, err);
		exit(EXIT_FAILURE);
	}
	bat->snr_thd_db = thd_db;
}

/* get snr threshold in %, and convert to dB */
static void get_snr_thd_pc(struct bat *bat, char *thd)
{
	int err;
	float thd_pc;
	char *ptrf;

	thd_pc = strtof(thd, &ptrf);
	err = -errno;
	if (thd_pc <= 0.0 || thd_pc >= 100.0) {
		fprintf(bat->err, _("Invalid threshold '%s':%d\n"), thd, err);
		exit(EXIT_FAILURE);
	}
	bat->snr_thd_db = 20.0 * log10f(100.0 / thd_pc);
}

static int get_duration(struct bat *bat)
{
	int err;
	float duration_f;
	long duration_i;
	char *ptrf, *ptri;

	duration_f = strtof(bat->narg, &ptrf);
	err = -errno;
	if (duration_f == HUGE_VALF || duration_f == -HUGE_VALF
			|| (duration_f == 0.0 && err != 0))
		goto err_exit;

	duration_i = strtol(bat->narg, &ptri, 10);
	if (duration_i == LONG_MAX || duration_i == LONG_MIN)
		goto err_exit;

	if (*ptrf == 's')
		bat->frames = duration_f * bat->rate;
	else if (*ptri == 0)
		bat->frames = duration_i;
	else
		bat->frames = -1;

	if (bat->frames <= 0 || bat->frames > MAX_FRAMES) {
		fprintf(bat->err, _("Invalid duration. Range: (0, %d(%fs))\n"),
				MAX_FRAMES, (float)MAX_FRAMES / bat->rate);
		return -EINVAL;
	}

	return 0;

err_exit:
	fprintf(bat->err, _("Duration overflow/underflow: %d\n"), err);

	return err;
}

static void get_sine_frequencies(struct bat *bat, char *freq)
{
	char *tmp1;

	tmp1 = strchr(freq, ':');
	if (tmp1 == NULL) {
		bat->target_freq[1] = bat->target_freq[0] = atof(optarg);
	} else {
		*tmp1 = '\0';
		bat->target_freq[0] = atof(optarg);
		bat->target_freq[1] = atof(tmp1 + 1);
	}
}

static void get_format(struct bat *bat, char *optarg)
{
	if (strcasecmp(optarg, "cd") == 0) {
		bat->format = BAT_PCM_FORMAT_S16_LE;
		bat->rate = 44100;
		bat->channels = 2;
		bat->sample_size = 2;
	} else if (strcasecmp(optarg, "dat") == 0) {
		bat->format = BAT_PCM_FORMAT_S16_LE;
		bat->rate = 48000;
		bat->channels = 2;
		bat->sample_size = 2;
	} else if (strcasecmp(optarg, "U8") == 0) {
		bat->format = BAT_PCM_FORMAT_U8;
		bat->sample_size = 1;
	} else if (strcasecmp(optarg, "S16_LE") == 0) {
		bat->format = BAT_PCM_FORMAT_S16_LE;
		bat->sample_size = 2;
	} else if (strcasecmp(optarg, "S24_3LE") == 0) {
		bat->format = BAT_PCM_FORMAT_S24_3LE;
		bat->sample_size = 3;
	} else if (strcasecmp(optarg, "S32_LE") == 0) {
		bat->format = BAT_PCM_FORMAT_S32_LE;
		bat->sample_size = 4;
	} else {
		bat->format = BAT_PCM_FORMAT_UNKNOWN;
		fprintf(bat->err, _("wrong extended format '%s'\n"), optarg);
		exit(EXIT_FAILURE);
	}
}

static inline int thread_wait_completion(struct bat *bat ATTRIBUTE_UNUSED,
					 pthread_t id, int **val)
{
	int err;

	err = pthread_join(id, (void **) val);
	if (err)
		pthread_cancel(id);

	return err;
}

/* loopback test where we play sine wave and capture the same sine wave */
static void test_loopback(struct bat *bat)
{
	pthread_t capture_id, playback_id;
	int err;
	int *thread_result_capture, *thread_result_playback;

	/* start playback */
	err = pthread_create(&playback_id, NULL,
			(void *) bat->playback.fct, bat);
	if (err != 0) {
		fprintf(bat->err, _("Cannot create playback thread: %d\n"),
				err);
		exit(EXIT_FAILURE);
	}

	/* TODO: use a pipe to signal stream start etc - i.e. to sync threads */
	/* Let some time for playing something before capturing */
	usleep(CAPTURE_DELAY * 1000);

	/* start capture */
	err = pthread_create(&capture_id, NULL, (void *) bat->capture.fct, bat);
	if (err != 0) {
		fprintf(bat->err, _("Cannot create capture thread: %d\n"), err);
		pthread_cancel(playback_id);
		exit(EXIT_FAILURE);
	}

	/* wait for playback to complete */
	err = thread_wait_completion(bat, playback_id, &thread_result_playback);
	if (err != 0) {
		fprintf(bat->err, _("Cannot join playback thread: %d\n"), err);
		free(thread_result_playback);
		pthread_cancel(capture_id);
		exit(EXIT_FAILURE);
	}

	/* check playback status */
	if (*thread_result_playback != 0) {
		fprintf(bat->err, _("Exit playback thread fail: %d\n"),
				*thread_result_playback);
		pthread_cancel(capture_id);
		exit(EXIT_FAILURE);
	} else {
		fprintf(bat->log, _("Playback completed.\n"));
	}

	/* now stop and wait for capture to finish */
	pthread_cancel(capture_id);
	err = thread_wait_completion(bat, capture_id, &thread_result_capture);
	if (err != 0) {
		fprintf(bat->err, _("Cannot join capture thread: %d\n"), err);
		free(thread_result_capture);
		exit(EXIT_FAILURE);
	}

	/* check if capture thread is canceled or not */
	if (thread_result_capture == PTHREAD_CANCELED) {
		fprintf(bat->log, _("Capture canceled.\n"));
		return;
	}

	/* check capture status */
	if (*thread_result_capture != 0) {
		fprintf(bat->err, _("Exit capture thread fail: %d\n"),
				*thread_result_capture);
		exit(EXIT_FAILURE);
	} else {
		fprintf(bat->log, _("Capture completed.\n"));
	}
}

/* single ended playback only test */
static void test_playback(struct bat *bat)
{
	pthread_t playback_id;
	int err;
	int *thread_result;

	/* start playback */
	err = pthread_create(&playback_id, NULL,
			(void *) bat->playback.fct, bat);
	if (err != 0) {
		fprintf(bat->err, _("Cannot create playback thread: %d\n"),
				err);
		exit(EXIT_FAILURE);
	}

	/* wait for playback to complete */
	err = thread_wait_completion(bat, playback_id, &thread_result);
	if (err != 0) {
		fprintf(bat->err, _("Cannot join playback thread: %d\n"), err);
		free(thread_result);
		exit(EXIT_FAILURE);
	}

	/* check playback status */
	if (*thread_result != 0) {
		fprintf(bat->err, _("Exit playback thread fail: %d\n"),
				*thread_result);
		exit(EXIT_FAILURE);
	} else {
		fprintf(bat->log, _("Playback completed.\n"));
	}
}

/* single ended capture only test */
static void test_capture(struct bat *bat)
{
	pthread_t capture_id;
	int err;
	int *thread_result;

	/* start capture */
	err = pthread_create(&capture_id, NULL, (void *) bat->capture.fct, bat);
	if (err != 0) {
		fprintf(bat->err, _("Cannot create capture thread: %d\n"), err);
		exit(EXIT_FAILURE);
	}

	/* TODO: stop capture */

	/* wait for capture to complete */
	err = thread_wait_completion(bat, capture_id, &thread_result);
	if (err != 0) {
		fprintf(bat->err, _("Cannot join capture thread: %d\n"), err);
		free(thread_result);
		exit(EXIT_FAILURE);
	}

	/* check playback status */
	if (*thread_result != 0) {
		fprintf(bat->err, _("Exit capture thread fail: %d\n"),
				*thread_result);
		exit(EXIT_FAILURE);
	} else {
		fprintf(bat->log, _("Capture completed.\n"));
	}
}

static void usage(struct bat *bat)
{
	fprintf(bat->log,
_("Usage: alsabat [-options]...\n"
"\n"
"  -h, --help             this help\n"
"  -D                     pcm device for both playback and capture\n"
"  -P                     pcm device for playback\n"
"  -C                     pcm device for capture\n"
"  -f                     sample format\n"
"  -c                     number of channels\n"
"  -r                     sampling rate\n"
"  -n                     frames to playback or capture\n"
"  -k                     parameter for frequency detecting threshold\n"
"  -F                     target frequency\n"
"  -p                     total number of periods to play/capture\n"
"  -B                     buffer size in frames\n"
"  -E                     period size in frames\n"
"      --log=#            file that both stdout and strerr redirecting to\n"
"      --file=#           file for playback\n"
"      --saveplay=#       file that storing playback content, for debug\n"
"      --readcapture=#    file with previously captured content.  File data\n"
"                         is used for analysis instead of capturing it.\n"
"      --local            internal loop, set to bypass pcm hardware devices\n"
"      --standalone       standalone mode, to bypass analysis\n"
"      --roundtriplatency round trip latency mode\n"
"      --snr-db=#         noise detect threshold, in SNR(dB)\n"
"      --snr-pc=#         noise detect threshold, in noise percentage(%%)\n"
));
	fprintf(bat->log, _("Recognized sample formats are: "));
	fprintf(bat->log, _("U8 S16_LE S24_3LE S32_LE\n"));
	fprintf(bat->log, _("The available format shotcuts are:\n"));
	fprintf(bat->log, _("-f cd (16 bit little endian, 44100, stereo)\n"));
	fprintf(bat->log, _("-f dat (16 bit little endian, 48000, stereo)\n"));
}

static void set_defaults(struct bat *bat)
{
	memset(bat, 0, sizeof(struct bat));

	/* Set default values */
	bat->rate = 44100;
	bat->frame_size = 2;
	bat->sample_size = 2;
	bat->format = BAT_PCM_FORMAT_S16_LE;
	bat->convert_float_to_sample = convert_float_to_int16;
	bat->convert_sample_to_float = convert_int16_to_float;
	bat->frames = bat->rate * 2;
	bat->target_freq[0] = 997.0;
	bat->target_freq[1] = 997.0;
	bat->sigma_k = 3.0;
	bat->snr_thd_db = SNR_DB_INVALID;
	bat->playback.device = NULL;
	bat->capture.device = NULL;
	bat->buf = NULL;
	bat->local = false;
	bat->buffer_size = 0;
	bat->period_size = 0;
	bat->roundtriplatency = false;
#ifdef HAVE_LIBTINYALSA
	bat->channels = 2;
	bat->playback.fct = &playback_tinyalsa;
	bat->capture.fct = &record_tinyalsa;
#else
	bat->channels = 1;
	bat->playback.fct = &playback_alsa;
	bat->capture.fct = &record_alsa;
#endif
	bat->playback.mode = MODE_LOOPBACK;
	bat->capture.mode = MODE_LOOPBACK;
	bat->period_is_limited = false;
	bat->log = stdout;
	bat->err = stderr;
}

static void parse_arguments(struct bat *bat, int argc, char *argv[])
{
	int c, option_index, err;
	static const char short_options[] = "D:P:C:f:n:F:c:r:s:k:p:B:E:lth";
	static const struct option long_options[] = {
		{"help",     0, 0, 'h'},
		{"log",      1, 0, OPT_LOG},
		{"file",     1, 0, OPT_READFILE},
		{"saveplay", 1, 0, OPT_SAVEPLAY},
		{"local",    0, 0, OPT_LOCAL},
		{"standalone", 0, 0, OPT_STANDALONE},
		{"roundtriplatency", 0, 0, OPT_ROUNDTRIPLATENCY},
		{"snr-db",   1, 0, OPT_SNRTHD_DB},
		{"snr-pc",   1, 0, OPT_SNRTHD_PC},
		{"readcapture", 1, 0, OPT_READCAPTURE},
		{0, 0, 0, 0}
	};

	while ((c = getopt_long(argc, argv, short_options, long_options,
					&option_index)) != -1) {
		switch (c) {
		case OPT_LOG:
			bat->logarg = optarg;
			break;
		case OPT_READFILE:
			bat->playback.file = optarg;
			break;
		case OPT_SAVEPLAY:
			bat->debugplay = optarg;
			break;
		case OPT_READCAPTURE:
			bat->capturefile = optarg;
			bat->capture.mode = MODE_ANALYZE_ONLY;
			bat->playback.mode = MODE_ANALYZE_ONLY;
			break;
		case OPT_LOCAL:
			bat->local = true;
			break;
		case OPT_STANDALONE:
			bat->standalone = true;
			break;
		case OPT_ROUNDTRIPLATENCY:
			bat->roundtriplatency = true;
			break;
		case OPT_SNRTHD_DB:
			get_snr_thd_db(bat, optarg);
			break;
		case OPT_SNRTHD_PC:
			get_snr_thd_pc(bat, optarg);
			break;
		case 'D':
			if (bat->playback.device == NULL)
				bat->playback.device = optarg;
			if (bat->capture.device == NULL)
				bat->capture.device = optarg;
			break;
		case 'P':
			if (bat->capture.mode == MODE_SINGLE)
				bat->capture.mode = MODE_LOOPBACK;
			else
				bat->playback.mode = MODE_SINGLE;
			bat->playback.device = optarg;
			break;
		case 'C':
			if (bat->playback.mode == MODE_SINGLE)
				bat->playback.mode = MODE_LOOPBACK;
			else
				bat->capture.mode = MODE_SINGLE;
			bat->capture.device = optarg;
			break;
		case 'n':
			bat->narg = optarg;
			break;
		case 'F':
			get_sine_frequencies(bat, optarg);
			break;
		case 'c':
			bat->channels = atoi(optarg);
			break;
		case 'r':
			bat->rate = atoi(optarg);
			break;
		case 'f':
			get_format(bat, optarg);
			break;
		case 'k':
			bat->sigma_k = atof(optarg);
			break;
		case 'p':
			bat->periods_total = atoi(optarg);
			bat->period_is_limited = true;
			break;
		case 'B':
			err = atoi(optarg);
			bat->buffer_size = err >= MIN_BUFFERSIZE
					&& err < MAX_BUFFERSIZE ? err : 0;
			break;
		case 'E':
			err = atoi(optarg);
			bat->period_size = err >= MIN_PERIODSIZE
					&& err < MAX_PERIODSIZE ? err : 0;
			break;
		case 'h':
		default:
			usage(bat);
			exit(EXIT_SUCCESS);
		}
	}
}

static int validate_options(struct bat *bat)
{
	int c;
	float freq_low, freq_high;

	/* check if we have an input file for local mode */
	if ((bat->local == true) && (bat->capture.file == NULL)) {
		fprintf(bat->err, _("no input file for local testing\n"));
		return -EINVAL;
	}

	/* check supported channels */
	if (bat->channels > MAX_CHANNELS || bat->channels < MIN_CHANNELS) {
		fprintf(bat->err, _("%d channels not supported\n"),
				bat->channels);
		return -EINVAL;
	}

	/* check single ended is in either playback or capture - not both */
	if ((bat->playback.mode == MODE_SINGLE)
			&& (bat->capture.mode == MODE_SINGLE)) {
		fprintf(bat->err, _("single ended mode is simplex\n"));
		return -EINVAL;
	}

	/* check sine wave frequency range */
	freq_low = DC_THRESHOLD;
	freq_high = bat->rate * RATE_FACTOR;
	for (c = 0; c < bat->channels; c++) {
		if (bat->target_freq[c] < freq_low
				|| bat->target_freq[c] > freq_high) {
			fprintf(bat->err, _("sine wave frequency out of"));
			fprintf(bat->err, _(" range: (%.1f, %.1f)\n"),
				freq_low, freq_high);
			return -EINVAL;
		}
	}

	return 0;
}

static int bat_init(struct bat *bat)
{
	int err = 0;
	int fd = 0;
	char name[] = TEMP_RECORD_FILE_NAME;

	/* Determine logging to a file or stdout and stderr */
	if (bat->logarg) {
		bat->log = NULL;
		bat->log = fopen(bat->logarg, "wb");
		if (bat->log == NULL) {
			err = -errno;
			fprintf(bat->err, _("Cannot open file: %s %d\n"),
					bat->logarg, err);
			return err;
		}
		bat->err = bat->log;
	}

	/* Determine duration of playback and/or capture */
	if (bat->narg) {
		err = get_duration(bat);
		if (err < 0)
			return err;
	}

	/* Set default playback and capture devices */
	if (bat->playback.device == NULL && bat->capture.device == NULL)
		bat->playback.device = bat->capture.device = DEFAULT_DEV_NAME;

	/* Determine capture file */
	if (bat->local) {
		bat->capture.file = bat->playback.file;
	} else {
		/* create temp file for sound record and analysis */
		fd = mkstemp(name);
		if (fd == -1) {
			err = -errno;
			fprintf(bat->err, _("Fail to create record file: %d\n"),
					err);
			return err;
		}
		/* store file name which is dynamically created */
		bat->capture.file = strdup(name);
		if (bat->capture.file == NULL)
			return -ENOMEM;
		/* close temp file */
		close(fd);
	}

	/* Initial for playback */
	if (bat->playback.file == NULL) {
		/* No input file so we will generate our own sine wave */
		if (bat->frames) {
			if (bat->playback.mode == MODE_SINGLE) {
				/* Play nb of frames given by -n argument */
				bat->sinus_duration = bat->frames;
			} else {
				/* Play CAPTURE_DELAY msec +
				 * 150% of the nb of frames to be analyzed */
				bat->sinus_duration = bat->rate *
						CAPTURE_DELAY / 1000;
				bat->sinus_duration +=
						(bat->frames + bat->frames / 2);
			}
		} else {
			/* Special case where we want to generate a sine wave
			 * endlessly without capturing */
			bat->sinus_duration = 0;
			bat->playback.mode = MODE_SINGLE;
		}
	} else {
		bat->fp = fopen(bat->playback.file, "rb");
		if (bat->fp == NULL) {
			err = -errno;
			fprintf(bat->err, _("Cannot open file: %s %d\n"),
					bat->playback.file, err);
			return err;
		}
		err = read_wav_header(bat, bat->playback.file, bat->fp, false);
		fclose(bat->fp);
		if (err != 0)
			return err;
	}

	bat->frame_size = bat->sample_size * bat->channels;

	/* Set conversion functions */
	switch (bat->sample_size) {
	case 1:
		bat->convert_float_to_sample = convert_float_to_uint8;
		bat->convert_sample_to_float = convert_uint8_to_float;
		break;
	case 2:
		bat->convert_float_to_sample = convert_float_to_int16;
		bat->convert_sample_to_float = convert_int16_to_float;
		break;
	case 3:
		bat->convert_float_to_sample = convert_float_to_int24;
		bat->convert_sample_to_float = convert_int24_to_float;
		break;
	case 4:
		bat->convert_float_to_sample = convert_float_to_int32;
		bat->convert_sample_to_float = convert_int32_to_float;
		break;
	default:
		fprintf(bat->err, _("Invalid PCM format: size=%d\n"),
				bat->sample_size);
		return -EINVAL;
	}

	return err;
}

int main(int argc, char *argv[])
{
	struct bat bat;
	int err = 0;

	set_defaults(&bat);

#ifdef ENABLE_NLS
	setlocale(LC_ALL, "");
	textdomain(PACKAGE);
#endif

	fprintf(bat.log, _("%s version %s\n\n"), PACKAGE_NAME, PACKAGE_VERSION);

	parse_arguments(&bat, argc, argv);

	err = bat_init(&bat);
	if (err < 0)
		goto out;

	err = validate_options(&bat);
	if (err < 0)
		goto out;

	/* round trip latency test thread */
	if (bat.roundtriplatency) {
		while (1) {
			fprintf(bat.log,
				_("\nStart round trip latency\n"));
			roundtrip_latency_init(&bat);
			test_loopback(&bat);

			if (bat.latency.xrun_error == false)
				break;
			else {
				/* Xrun error in playback or capture,
				increase period size and try again */
				bat.period_size += bat.rate / 1000;
				bat.buffer_size =
					bat.period_size * DIV_BUFFERSIZE;

				/* terminate the test if period_size is
				large enough */
				if (bat.period_size > bat.rate * 0.2)
					break;
			}

			/* Waiting 500ms and start the next round */
			usleep(CAPTURE_DELAY * 1000);
		}
		goto out;
	}

	/* single line playback thread: playback only, no capture */
	if (bat.playback.mode == MODE_SINGLE) {
		test_playback(&bat);
		goto out;
	}

	/* single line capture thread: capture only, no playback */
	if (bat.capture.mode == MODE_SINGLE) {
		test_capture(&bat);
		goto analyze;
	}

	if (bat.capture.mode == MODE_ANALYZE_ONLY && bat.capturefile) {
		bat.capture.file = strdup(bat.capturefile);
		fprintf(bat.log,
			_("Using data from file %s for analysis\n"),
			bat.capture.file);
		fprintf(bat.log, _("Skipping playback and capture\n"));
		goto analyze;
	}

	/* loopback thread: playback and capture in a loop */
	if (bat.local == false)
		test_loopback(&bat);

analyze:
#ifdef HAVE_LIBFFTW3F
	if (!bat.standalone || snr_is_valid(bat.snr_thd_db))
		err = analyze_capture(&bat);
#else
	fprintf(bat.log, _("No libfftw3 library. Exit without analysis.\n"));
#endif
out:
	fprintf(bat.log, _("\nReturn value is %d\n"), err);

	if (bat.logarg)
		fclose(bat.log);
	if (!bat.local)
		free(bat.capture.file);

	return err;
}