[libsigrok.git] / hardware / alsa / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

static const int hwcaps[] = {
	SR_CONF_SAMPLERATE,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_CONTINUOUS,
	0,
};

SR_PRIV struct sr_dev_driver alsa_driver_info;
static struct sr_dev_driver *di = &alsa_driver_info;

static int clear_instances(void)
{
	struct drv_context *drvc;

	if (!(drvc = di->priv))
		return SR_OK;

	g_slist_free_full(drvc->instances, (GDestroyNotify)alsa_dev_inst_clear);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx)
{
	struct drv_context *drvc;

	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
		sr_err("Driver context malloc failed.");
		return SR_ERR_MALLOC;
	}

	drvc->sr_ctx = sr_ctx;
	di->priv = drvc;

	return SR_OK;
}

static GSList *hw_scan(GSList *options)
{
	return alsa_scan(options, di);
}

static GSList *hw_dev_list(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->instances;
}

static int hw_dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int ret;

	devc = sdi->priv;

	if (!(devc->hwdev)) {
		sr_err("devc->hwdev was NULL.");
		return SR_ERR_BUG;
	}

	sr_dbg("Opening audio device '%s' for stream capture.", devc->hwdev);
	ret = snd_pcm_open(&devc->capture_handle, devc->hwdev,
			   SND_PCM_STREAM_CAPTURE, 0);
	if (ret < 0) {
		sr_err("Can't open audio device: %s.", snd_strerror(ret));
		return SR_ERR;
	}

	sr_dbg("Initializing hardware parameter structure.");
	ret = snd_pcm_hw_params_any(devc->capture_handle, devc->hw_params);
	if (ret < 0) {
		sr_err("Can't initialize hardware parameter structure: %s.",
		       snd_strerror(ret));
		return SR_ERR;
	}

	return SR_OK;
}

static int hw_dev_close(struct sr_dev_inst *sdi)
{
	int ret;
	struct dev_context *devc;

	devc = sdi->priv;

	sr_dbg("Closing device.");

	if (devc->capture_handle) {
		sr_dbg("Closing PCM device.");
		if ((ret = snd_pcm_close(devc->capture_handle)) < 0) {
			sr_err("Failed to close device: %s.",
			       snd_strerror(ret));
			devc->capture_handle = NULL;
		}
	} else {
		sr_dbg("No capture handle, no need to close audio device.");
	}

	return SR_OK;
}

static int hw_cleanup(void)
{
	clear_instances();

	return SR_OK;
}

static int hw_info_get(int info_id, const void **data,
		       const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (info_id != SR_DI_HWCAPS) /* For SR_DI_HWCAPS sdi will be NULL. */
		devc = sdi->priv;

	switch (info_id) {
	case SR_DI_HWCAPS:
		*data = hwcaps;
		break;
	case SR_DI_CUR_SAMPLERATE:
		*data = &devc->cur_samplerate;
		break;
	case SR_DI_SAMPLERATES:
		if (!devc->supp_rates.list) {
			sr_err("Instance did not contain a samplerate list.");
			return SR_ERR_ARG;
		}
		*data = &devc->supp_rates;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
			     const void *value)
{
	struct dev_context *devc;

	devc = sdi->priv;

	switch (hwcap) {
	case SR_CONF_SAMPLERATE:
		alsa_set_samplerate(sdi, *(const uint64_t *)value);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		break;
	default:
		sr_err("Unknown capability: %d.", hwcap);
		return SR_ERR;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct dev_context *devc;
	int count, ret;
	char *endianness;

	devc = sdi->priv;
	devc->cb_data = cb_data;
	devc->num_samples = 0;

	sr_dbg("Setting audio access type to RW/interleaved.");
	ret = snd_pcm_hw_params_set_access(devc->capture_handle,
			devc->hw_params, SND_PCM_ACCESS_RW_INTERLEAVED);
	if (ret < 0) {
		sr_err("Can't set audio access type: %s.", snd_strerror(ret));
		return SR_ERR;
	}

	/* FIXME: Hardcoded for 16bits. */
	if (SND_PCM_FORMAT_S16 == SND_PCM_FORMAT_S16_LE)
		endianness = "little endian";
	else
		endianness = "big endian";
	sr_dbg("Setting audio sample format to signed 16bit (%s).", endianness);
	ret = snd_pcm_hw_params_set_format(devc->capture_handle,
					   devc->hw_params,
					   SND_PCM_FORMAT_S16);
	if (ret < 0) {
		sr_err("Can't set audio sample format: %s.", snd_strerror(ret));
		return SR_ERR;
	}

	sr_dbg("Setting audio samplerate to %" PRIu64 "Hz.",
	       devc->cur_samplerate);
	ret = snd_pcm_hw_params_set_rate(devc->capture_handle, devc->hw_params,
					 (unsigned int)devc->cur_samplerate, 0);
	if (ret < 0) {
		sr_err("Can't set audio sample rate: %s.", snd_strerror(ret));
		return SR_ERR;
	}

	sr_dbg("Setting audio channel count to %d.", devc->num_probes);
	ret = snd_pcm_hw_params_set_channels(devc->capture_handle,
					     devc->hw_params, devc->num_probes);
	if (ret < 0) {
		sr_err("Can't set channel count: %s.", snd_strerror(ret));
		return SR_ERR;
	}

	sr_dbg("Setting audio parameters.");
	ret = snd_pcm_hw_params(devc->capture_handle, devc->hw_params);
	if (ret < 0) {
		sr_err("Can't set parameters: %s.", snd_strerror(ret));
		return SR_ERR;
	}

	sr_dbg("Preparing audio interface for use.");
	ret = snd_pcm_prepare(devc->capture_handle);
	if (ret < 0) {
		sr_err("Can't prepare audio interface for use: %s.",
		       snd_strerror(ret));
		return SR_ERR;
	}

	count = snd_pcm_poll_descriptors_count(devc->capture_handle);
	if (count < 1) {
		sr_err("Unable to obtain poll descriptors count.");
		return SR_ERR;
	}

	if (!(devc->ufds = g_try_malloc(count * sizeof(struct pollfd)))) {
		sr_err("Failed to malloc ufds.");
		return SR_ERR_MALLOC;
	}

	sr_spew("Getting %d poll descriptors.", count);
	ret = snd_pcm_poll_descriptors(devc->capture_handle, devc->ufds, count);
	if (ret < 0) {
		sr_err("Unable to obtain poll descriptors: %s.",
		       snd_strerror(ret));
		g_free(devc->ufds);
		return SR_ERR;
	}

	/* Send header packet to the session bus. */
	sr_dbg("Sending SR_DF_HEADER packet.");
	packet.type = SR_DF_HEADER;
	packet.payload = (uint8_t *)&header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(devc->cb_data, &packet);

	/* Poll every 10ms, or whenever some data comes in. */
	sr_source_add(devc->ufds[0].fd, devc->ufds[0].events, 10,
		      alsa_receive_data, (void *)sdi);

	// g_free(devc->ufds); /* FIXME */

	return SR_OK;
}

static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct dev_context *devc;

	devc = sdi->priv;
	devc->cb_data = cb_data;

	sr_source_remove(devc->ufds[0].fd);

	/* Send end packet to the session bus. */
	sr_dbg("Sending SR_DF_END packet.");
	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver alsa_driver_info = {
	.name = "alsa",
	.longname = "ALSA driver",
	.api_version = 1,
	.init = hw_init,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.info_get = hw_info_get,
	.dev_config_set = hw_dev_config_set,
	.dev_acquisition_start = hw_dev_acquisition_start,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
	5	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	6	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	21	*/
	22
	23	#include <stdlib.h>
	24	#include <unistd.h>
	25	#include <string.h>
	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28	#include "protocol.h"
	29
	30	static const int hwcaps[] = {
	31	SR_CONF_SAMPLERATE,
	32	SR_CONF_LIMIT_SAMPLES,
	33	SR_CONF_CONTINUOUS,
	34	0,
	35	};
	36
	37	SR_PRIV struct sr_dev_driver alsa_driver_info;
	38	static struct sr_dev_driver *di = &alsa_driver_info;
	39
	40	static int clear_instances(void)
	41	{
	42	struct drv_context *drvc;
	43
	44	if (!(drvc = di->priv))
	45	return SR_OK;
	46
	47	g_slist_free_full(drvc->instances, (GDestroyNotify)alsa_dev_inst_clear);
	48	drvc->instances = NULL;
	49
	50	return SR_OK;
	51	}
	52
	53	static int hw_init(struct sr_context *sr_ctx)
	54	{
	55	struct drv_context *drvc;
	56
	57	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
	58	sr_err("Driver context malloc failed.");
	59	return SR_ERR_MALLOC;
	60	}
	61
	62	drvc->sr_ctx = sr_ctx;
	63	di->priv = drvc;
	64
	65	return SR_OK;
	66	}
	67
	68	static GSList hw_scan(GSList options)
	69	{
	70	return alsa_scan(options, di);
	71	}
	72
	73	static GSList *hw_dev_list(void)
	74	{
	75	struct drv_context *drvc;
	76
	77	drvc = di->priv;
	78
	79	return drvc->instances;
	80	}
	81
	82	static int hw_dev_open(struct sr_dev_inst *sdi)
	83	{
	84	struct dev_context *devc;
	85	int ret;
	86
	87	devc = sdi->priv;
	88
	89	if (!(devc->hwdev)) {
	90	sr_err("devc->hwdev was NULL.");
	91	return SR_ERR_BUG;
	92	}
	93
	94	sr_dbg("Opening audio device '%s' for stream capture.", devc->hwdev);
	95	ret = snd_pcm_open(&devc->capture_handle, devc->hwdev,
	96	SND_PCM_STREAM_CAPTURE, 0);
	97	if (ret < 0) {
	98	sr_err("Can't open audio device: %s.", snd_strerror(ret));
	99	return SR_ERR;
	100	}
	101
	102	sr_dbg("Initializing hardware parameter structure.");
	103	ret = snd_pcm_hw_params_any(devc->capture_handle, devc->hw_params);
	104	if (ret < 0) {
	105	sr_err("Can't initialize hardware parameter structure: %s.",
	106	snd_strerror(ret));
	107	return SR_ERR;
	108	}
	109
	110	return SR_OK;
	111	}
	112
	113	static int hw_dev_close(struct sr_dev_inst *sdi)
	114	{
	115	int ret;
	116	struct dev_context *devc;
	117
	118	devc = sdi->priv;
	119
	120	sr_dbg("Closing device.");
	121
	122	if (devc->capture_handle) {
	123	sr_dbg("Closing PCM device.");
	124	if ((ret = snd_pcm_close(devc->capture_handle)) < 0) {
	125	sr_err("Failed to close device: %s.",
	126	snd_strerror(ret));
	127	devc->capture_handle = NULL;
	128	}
	129	} else {
	130	sr_dbg("No capture handle, no need to close audio device.");
	131	}
	132
	133	return SR_OK;
	134	}
	135
	136	static int hw_cleanup(void)
	137	{
	138	clear_instances();
	139
	140	return SR_OK;
	141	}
	142
	143	static int hw_info_get(int info_id, const void **data,
	144	const struct sr_dev_inst *sdi)
	145	{
	146	struct dev_context *devc;
	147
	148	if (info_id != SR_DI_HWCAPS) /* For SR_DI_HWCAPS sdi will be NULL. */
	149	devc = sdi->priv;
	150
	151	switch (info_id) {
	152	case SR_DI_HWCAPS:
	153	*data = hwcaps;
	154	break;
	155	case SR_DI_CUR_SAMPLERATE:
	156	*data = &devc->cur_samplerate;
	157	break;
	158	case SR_DI_SAMPLERATES:
	159	if (!devc->supp_rates.list) {
	160	sr_err("Instance did not contain a samplerate list.");
	161	return SR_ERR_ARG;
	162	}
	163	*data = &devc->supp_rates;
	164	break;
	165	default:
	166	return SR_ERR_ARG;
	167	}
	168
	169	return SR_OK;
	170	}
	171
	172	static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
	173	const void *value)
	174	{
	175	struct dev_context *devc;
	176
	177	devc = sdi->priv;
	178
	179	switch (hwcap) {
	180	case SR_CONF_SAMPLERATE:
	181	alsa_set_samplerate(sdi, (const uint64_t )value);
	182	break;
	183	case SR_CONF_LIMIT_SAMPLES:
	184	devc->limit_samples = (const uint64_t )value;
	185	break;
	186	default:
	187	sr_err("Unknown capability: %d.", hwcap);
	188	return SR_ERR;
	189	}
	190
	191	return SR_OK;
	192	}
	193
	194	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	195	void *cb_data)
	196	{
	197	struct sr_datafeed_packet packet;
	198	struct sr_datafeed_header header;
	199	struct dev_context *devc;
	200	int count, ret;
	201	char *endianness;
	202
	203	devc = sdi->priv;
	204	devc->cb_data = cb_data;
	205	devc->num_samples = 0;
	206
	207	sr_dbg("Setting audio access type to RW/interleaved.");
	208	ret = snd_pcm_hw_params_set_access(devc->capture_handle,
	209	devc->hw_params, SND_PCM_ACCESS_RW_INTERLEAVED);
	210	if (ret < 0) {
	211	sr_err("Can't set audio access type: %s.", snd_strerror(ret));
	212	return SR_ERR;
	213	}
	214
	215	/* FIXME: Hardcoded for 16bits. */
	216	if (SND_PCM_FORMAT_S16 == SND_PCM_FORMAT_S16_LE)
	217	endianness = "little endian";
	218	else
	219	endianness = "big endian";
	220	sr_dbg("Setting audio sample format to signed 16bit (%s).", endianness);
	221	ret = snd_pcm_hw_params_set_format(devc->capture_handle,
	222	devc->hw_params,
	223	SND_PCM_FORMAT_S16);
	224	if (ret < 0) {
	225	sr_err("Can't set audio sample format: %s.", snd_strerror(ret));
	226	return SR_ERR;
	227	}
	228
	229	sr_dbg("Setting audio samplerate to %" PRIu64 "Hz.",
	230	devc->cur_samplerate);
	231	ret = snd_pcm_hw_params_set_rate(devc->capture_handle, devc->hw_params,
	232	(unsigned int)devc->cur_samplerate, 0);
	233	if (ret < 0) {
	234	sr_err("Can't set audio sample rate: %s.", snd_strerror(ret));
	235	return SR_ERR;
	236	}
	237
	238	sr_dbg("Setting audio channel count to %d.", devc->num_probes);
	239	ret = snd_pcm_hw_params_set_channels(devc->capture_handle,
	240	devc->hw_params, devc->num_probes);
	241	if (ret < 0) {
	242	sr_err("Can't set channel count: %s.", snd_strerror(ret));
	243	return SR_ERR;
	244	}
	245
	246	sr_dbg("Setting audio parameters.");
	247	ret = snd_pcm_hw_params(devc->capture_handle, devc->hw_params);
	248	if (ret < 0) {
	249	sr_err("Can't set parameters: %s.", snd_strerror(ret));
	250	return SR_ERR;
	251	}
	252
	253	sr_dbg("Preparing audio interface for use.");
	254	ret = snd_pcm_prepare(devc->capture_handle);
	255	if (ret < 0) {
	256	sr_err("Can't prepare audio interface for use: %s.",
	257	snd_strerror(ret));
	258	return SR_ERR;
	259	}
	260
	261	count = snd_pcm_poll_descriptors_count(devc->capture_handle);
	262	if (count < 1) {
	263	sr_err("Unable to obtain poll descriptors count.");
	264	return SR_ERR;
	265	}
	266
	267	if (!(devc->ufds = g_try_malloc(count * sizeof(struct pollfd)))) {
	268	sr_err("Failed to malloc ufds.");
	269	return SR_ERR_MALLOC;
	270	}
	271
	272	sr_spew("Getting %d poll descriptors.", count);
	273	ret = snd_pcm_poll_descriptors(devc->capture_handle, devc->ufds, count);
	274	if (ret < 0) {
	275	sr_err("Unable to obtain poll descriptors: %s.",
	276	snd_strerror(ret));
	277	g_free(devc->ufds);
	278	return SR_ERR;
	279	}
	280
	281	/* Send header packet to the session bus. */
	282	sr_dbg("Sending SR_DF_HEADER packet.");
	283	packet.type = SR_DF_HEADER;
	284	packet.payload = (uint8_t *)&header;
	285	header.feed_version = 1;
	286	gettimeofday(&header.starttime, NULL);
	287	sr_session_send(devc->cb_data, &packet);
	288
	289	/* Poll every 10ms, or whenever some data comes in. */
	290	sr_source_add(devc->ufds[0].fd, devc->ufds[0].events, 10,
	291	alsa_receive_data, (void *)sdi);
	292
	293	// g_free(devc->ufds); /* FIXME */
	294
	295	return SR_OK;
	296	}
	297
	298	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	299	{
	300	struct sr_datafeed_packet packet;
	301	struct dev_context *devc;
	302
	303	devc = sdi->priv;
	304	devc->cb_data = cb_data;
	305
	306	sr_source_remove(devc->ufds[0].fd);
	307
	308	/* Send end packet to the session bus. */
	309	sr_dbg("Sending SR_DF_END packet.");
	310	packet.type = SR_DF_END;
	311	sr_session_send(cb_data, &packet);
	312
	313	return SR_OK;
	314	}
	315
	316	SR_PRIV struct sr_dev_driver alsa_driver_info = {
	317	.name = "alsa",
	318	.longname = "ALSA driver",
	319	.api_version = 1,
	320	.init = hw_init,
	321	.cleanup = hw_cleanup,
	322	.scan = hw_scan,
	323	.dev_list = hw_dev_list,
	324	.dev_clear = clear_instances,
	325	.dev_open = hw_dev_open,
	326	.dev_close = hw_dev_close,
	327	.info_get = hw_info_get,
	328	.dev_config_set = hw_dev_config_set,
	329	.dev_acquisition_start = hw_dev_acquisition_start,
	330	.dev_acquisition_stop = hw_dev_acquisition_stop,
	331	.priv = NULL,
	332	};