]> sigrok.org Git - libsigrok.git/blobdiff - hardware/alsa/api.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / hardware / alsa / api.c
index 22611ca82973cf2c9ee597911d0c801000e20c96..82af3d0ed70111127312780c26f21e1c7ad1f1ff 100644 (file)
@@ -1,8 +1,9 @@
 /*
- * This file is part of the sigrok project.
+ * 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
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "protocol.h"
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+#include "protocol.h"
 
-#define DEFAULT_PROBES         2
-#define SAMPLE_WIDTH           16
-#define DEFAULT_SAMPLERATE     44100
-// #define AUDIO_DEV           "plughw:0,0"
-#define AUDIO_DEV              "default"
-
-static const int hwcaps[] = {
-       SR_HWCAP_SAMPLERATE,
-       SR_HWCAP_LIMIT_SAMPLES,
-       SR_HWCAP_CONTINUOUS,
-       0,
-};
-
-static const char *probe_names[] = {
-       "Channel 0", "Channel 1",
-       NULL,
+static const int32_t hwcaps[] = {
+       SR_CONF_SAMPLERATE,
+       SR_CONF_LIMIT_SAMPLES,
+       SR_CONF_CONTINUOUS,
 };
 
 SR_PRIV struct sr_dev_driver alsa_driver_info;
 static struct sr_dev_driver *di = &alsa_driver_info;
 
-static int clear_instances(void)
+static void clear_helper(void *priv)
 {
-       /* TODO */
-
-       return SR_OK;
-}
+       struct dev_context *devc;
 
-static int hw_init(struct sr_context *sr_ctx)
-{
-       struct drv_context *drvc;
+       devc = priv;
 
-       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;
+       snd_pcm_hw_params_free(devc->hw_params);
+       devc->hw_params = NULL;
 
-       return SR_OK;
+       g_free((void *)devc->samplerates);
+       devc->samplerates = NULL;
 }
 
-static GSList *hw_scan(GSList *options)
+static int dev_clear(void)
 {
-       struct drv_context *drvc;
-       struct dev_context *devc;
-       struct sr_dev_inst *sdi;
-       struct sr_probe *probe;
-       GSList *devices;
-       int i;
-
-       (void)options;
-
-       drvc = di->priv;
-       drvc->instances = NULL;
-
-       devices = NULL;
-
-       if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
-               sr_err("Device context malloc failed.");
-               return NULL;
-       }
-
-       if (!(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, "alsa", NULL, NULL))) {
-               sr_err("Failed to create device instance.");
-               return NULL;
-       }
-
-       /* Set the samplerate to a default value for now. */
-       devc->cur_samplerate = DEFAULT_SAMPLERATE;
-       devc->num_probes = DEFAULT_PROBES;
-
-       sdi->priv = devc;
-       sdi->driver = di;
-
-       for (i = 0; probe_names[i]; i++) {
-               if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
-                                          probe_names[i]))) {
-                       sr_err("Failed to create probe.");
-                       return NULL;
-               }
-               sdi->probes = g_slist_append(sdi->probes, probe);
-       }
-
-       drvc->instances = g_slist_append(drvc->instances, sdi);
-       devices = g_slist_append(devices, sdi);
-
-       return devices;
+       return std_dev_clear(di, clear_helper);
 }
 
-static GSList *hw_dev_list(void)
+static int init(struct sr_context *sr_ctx)
 {
-       struct drv_context *drvc;
+       return std_init(sr_ctx, di, LOG_PREFIX);
+}
 
-       drvc = di->priv;
+static GSList *scan(GSList *options)
+{
+       return alsa_scan(options, di);
+}
 
-       return drvc->instances;
+static GSList *dev_list(void)
+{
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
-static int hw_dev_open(struct sr_dev_inst *sdi)
+static int dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        int ret;
 
        devc = sdi->priv;
 
-       sr_dbg("Opening audio device '%s' for stream capture.", AUDIO_DEV);
-       ret = snd_pcm_open(&devc->capture_handle, AUDIO_DEV,
+       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("Allocating hardware parameter structure.");
-       ret = snd_pcm_hw_params_malloc(&devc->hw_params);
-       if (ret < 0) {
-               sr_err("Can't allocate hardware parameter structure: %s.",
-                      snd_strerror(ret));
-               return SR_ERR_MALLOC;
-       }
-
        sr_dbg("Initializing hardware parameter structure.");
        ret = snd_pcm_hw_params_any(devc->capture_handle, devc->hw_params);
        if (ret < 0) {
@@ -158,31 +97,25 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
                return SR_ERR;
        }
 
+       sdi->status = SR_ST_ACTIVE;
+
        return SR_OK;
 }
 
-static int hw_dev_close(struct sr_dev_inst *sdi)
+static int dev_close(struct sr_dev_inst *sdi)
 {
        int ret;
        struct dev_context *devc;
 
        devc = sdi->priv;
 
-       sr_dbg("Closing device.");
-
-       if (devc->hw_params) {
-               sr_dbg("Freeing hardware parameters.");
-               snd_pcm_hw_params_free(devc->hw_params);
-       } else {
-               sr_dbg("No hardware parameters, no need to free.");
-       }
-
        if (devc->capture_handle) {
                sr_dbg("Closing PCM device.");
-               if ((ret = snd_pcm_close(devc->capture_handle)) < 0) {
+               if ((ret = snd_pcm_close(devc->capture_handle)) < 0)
                        sr_err("Failed to close device: %s.",
                               snd_strerror(ret));
-               }
+               devc->capture_handle = NULL;
+               sdi->status = SR_ST_INACTIVE;
        } else {
                sr_dbg("No capture handle, no need to close audio device.");
        }
@@ -190,75 +123,106 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int hw_cleanup(void)
+static int cleanup(void)
 {
-       clear_instances();
+       return dev_clear();
+}
+
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
+{
+       struct dev_context *devc;
+
+       (void)cg;
+
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
+               devc = sdi->priv;
+               *data = g_variant_new_uint64(devc->cur_samplerate);
+               break;
+       default:
+               return SR_ERR_NA;
+       }
 
        return SR_OK;
 }
 
-static int hw_info_get(int info_id, const void **data,
-                      const struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
 
-       if (info_id != SR_DI_HWCAPS) /* For SR_DI_HWCAPS sdi will be NULL. */
-               devc = sdi->priv;
+       (void)cg;
 
-       switch (info_id) {
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               break;
-       case SR_DI_NUM_PROBES:
-               *data = GINT_TO_POINTER(DEFAULT_PROBES);
-               break;
-       case SR_DI_PROBE_NAMES:
-               *data = probe_names;
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
+
+       devc = sdi->priv;
+
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
+               alsa_set_samplerate(sdi, g_variant_get_uint64(data));
                break;
-       case SR_DI_CUR_SAMPLERATE:
-               *data = &devc->cur_samplerate;
+       case SR_CONF_LIMIT_SAMPLES:
+               devc->limit_samples = g_variant_get_uint64(data);
                break;
        default:
-               sr_err("Invalid info_id: %d.", info_id);
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-                            const void *value)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
+       GVariant *gvar;
+       GVariantBuilder gvb;
+       int i;
 
-       devc = sdi->priv;
+       (void)cg;
 
-       switch (hwcap) {
-       case SR_HWCAP_SAMPLERATE:
-               devc->cur_samplerate = *(const uint64_t *)value;
+       switch (key) {
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
                break;
-       case SR_HWCAP_LIMIT_SAMPLES:
-               devc->limit_samples = *(const uint64_t *)value;
+       case SR_CONF_SAMPLERATE:
+               if (!sdi || !sdi->priv)
+                       return SR_ERR_ARG;
+               devc = sdi->priv;
+               if (!devc->samplerates) {
+                       sr_err("Instance did not contain a samplerate list.");
+                       return SR_ERR_ARG;
+               }
+               for (i = 0; devc->samplerates[i]; i++)
+                       ;
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
+               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
+                               devc->samplerates, i, sizeof(uint64_t));
+               g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
+               *data = g_variant_builder_end(&gvb);
                break;
        default:
-               sr_err("Unknown capability: %d.", hwcap);
-               return SR_ERR;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
-       struct sr_datafeed_packet packet;
-       struct sr_datafeed_header header;
-       struct sr_datafeed_meta_analog meta;
        struct dev_context *devc;
        int count, ret;
+       char *endianness;
+
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
 
        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,
@@ -269,9 +233,14 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        }
 
        /* FIXME: Hardcoded for 16bits. */
-       sr_dbg("Setting audio sample format to signed 16bit (little endian).");
+       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_LE);
+                                          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;
@@ -286,9 +255,9 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR;
        }
 
-       sr_dbg("Setting audio channel count to %d.", devc->num_probes);
+       sr_dbg("Setting audio channel count to %d.", devc->num_channels);
        ret = snd_pcm_hw_params_set_channels(devc->capture_handle,
-                                            devc->hw_params, devc->num_probes);
+                                            devc->hw_params, devc->num_channels);
        if (ret < 0) {
                sr_err("Can't set channel count: %s.", snd_strerror(ret));
                return SR_ERR;
@@ -314,14 +283,13 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                sr_err("Unable to obtain poll descriptors count.");
                return SR_ERR;
        }
-       sr_spew("Obtained poll descriptor count: %d.", count);
 
        if (!(devc->ufds = g_try_malloc(count * sizeof(struct pollfd)))) {
                sr_err("Failed to malloc ufds.");
                return SR_ERR_MALLOC;
        }
 
-       sr_err("Getting %d poll descriptors.", count);
+       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.",
@@ -331,19 +299,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        }
 
        /* 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);
-
-       /* Send metadata about the SR_DF_ANALOG packets to come. */
-       sr_dbg("Sending SR_DF_META_ANALOG packet.");
-       packet.type = SR_DF_META_ANALOG;
-       packet.payload = &meta;
-       meta.num_probes = devc->num_probes;
-       sr_session_send(devc->cb_data, &packet);
+       std_session_send_df_header(cb_data, LOG_PREFIX);
 
        /* Poll every 10ms, or whenever some data comes in. */
        sr_source_add(devc->ufds[0].fd, devc->ufds[0].events, 10,
@@ -354,7 +310,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        struct sr_datafeed_packet packet;
        struct dev_context *devc;
@@ -376,16 +332,17 @@ 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,
+       .init = init,
+       .cleanup = cleanup,
+       .scan = scan,
+       .dev_list = dev_list,
+       .dev_clear = dev_clear,
+       .config_get = config_get,
+       .config_set = config_set,
+       .config_list = config_list,
+       .dev_open = dev_open,
+       .dev_close = dev_close,
+       .dev_acquisition_start = dev_acquisition_start,
+       .dev_acquisition_stop = dev_acquisition_stop,
        .priv = NULL,
 };