hardware/alsa/api.c

   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         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  56 }
  57
  58 static GSList *hw_scan(GSList *options)
  59 {
  60         return alsa_scan(options, di);
  61 }
  62
  63 static GSList *hw_dev_list(void)
  64 {
  65         return ((struct drv_context *)(di->priv))->instances;
  66 }
  67
  68 static int hw_dev_open(struct sr_dev_inst *sdi)
  69 {
  70         struct dev_context *devc;
  71         int ret;
  72
  73         devc = sdi->priv;
  74
  75         if (!(devc->hwdev)) {
  76                 sr_err("devc->hwdev was NULL.");
  77                 return SR_ERR_BUG;
  78         }
  79
  80         sr_dbg("Opening audio device '%s' for stream capture.", devc->hwdev);
  81         ret = snd_pcm_open(&devc->capture_handle, devc->hwdev,
  82                            SND_PCM_STREAM_CAPTURE, 0);
  83         if (ret < 0) {
  84                 sr_err("Can't open audio device: %s.", snd_strerror(ret));
  85                 return SR_ERR;
  86         }
  87
  88         sr_dbg("Initializing hardware parameter structure.");
  89         ret = snd_pcm_hw_params_any(devc->capture_handle, devc->hw_params);
  90         if (ret < 0) {
  91                 sr_err("Can't initialize hardware parameter structure: %s.",
  92                        snd_strerror(ret));
  93                 return SR_ERR;
  94         }
  95
  96         return SR_OK;
  97 }
  98
  99 static int hw_dev_close(struct sr_dev_inst *sdi)
 100 {
 101         int ret;
 102         struct dev_context *devc;
 103
 104         devc = sdi->priv;
 105
 106         if (devc->capture_handle) {
 107                 sr_dbg("Closing PCM device.");
 108                 if ((ret = snd_pcm_close(devc->capture_handle)) < 0) {
 109                         sr_err("Failed to close device: %s.",
 110                                snd_strerror(ret));
 111                         devc->capture_handle = NULL;
 112                 }
 113         } else {
 114                 sr_dbg("No capture handle, no need to close audio device.");
 115         }
 116
 117         return SR_OK;
 118 }
 119
 120 static int hw_cleanup(void)
 121 {
 122         clear_instances();
 123
 124         return SR_OK;
 125 }
 126
 127 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
 128 {
 129         struct dev_context *devc;
 130
 131         switch (id) {
 132         case SR_CONF_SAMPLERATE:
 133                 devc = sdi->priv;
 134                 *data = &devc->cur_samplerate;
 135                 break;
 136         default:
 137                 return SR_ERR_ARG;
 138         }
 139
 140         return SR_OK;
 141 }
 142
 143 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 144 {
 145         struct dev_context *devc;
 146
 147         devc = sdi->priv;
 148
 149         switch (id) {
 150         case SR_CONF_SAMPLERATE:
 151                 alsa_set_samplerate(sdi, *(const uint64_t *)value);
 152                 break;
 153         case SR_CONF_LIMIT_SAMPLES:
 154                 devc->limit_samples = *(const uint64_t *)value;
 155                 break;
 156         default:
 157                 sr_err("Unknown capability: %d.", id);
 158                 return SR_ERR;
 159         }
 160
 161         return SR_OK;
 162 }
 163
 164 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 165 {
 166         struct dev_context *devc;
 167
 168         (void)sdi;
 169
 170         switch (key) {
 171         case SR_CONF_DEVICE_OPTIONS:
 172                 *data = hwcaps;
 173                 break;
 174         case SR_CONF_SAMPLERATE:
 175                 if (!sdi || !sdi->priv)
 176                         return SR_ERR_ARG;
 177                 devc = sdi->priv;
 178                 if (!devc->supp_rates.list) {
 179                         sr_err("Instance did not contain a samplerate list.");
 180                         return SR_ERR_ARG;
 181                 }
 182                 *data = &devc->supp_rates;
 183                 break;
 184         default:
 185                 return SR_ERR_ARG;
 186         }
 187
 188         return SR_OK;
 189 }
 190
 191 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 192                                     void *cb_data)
 193 {
 194         struct sr_datafeed_packet packet;
 195         struct sr_datafeed_header header;
 196         struct dev_context *devc;
 197         int count, ret;
 198         char *endianness;
 199
 200         devc = sdi->priv;
 201         devc->cb_data = cb_data;
 202         devc->num_samples = 0;
 203
 204         sr_dbg("Setting audio access type to RW/interleaved.");
 205         ret = snd_pcm_hw_params_set_access(devc->capture_handle,
 206                         devc->hw_params, SND_PCM_ACCESS_RW_INTERLEAVED);
 207         if (ret < 0) {
 208                 sr_err("Can't set audio access type: %s.", snd_strerror(ret));
 209                 return SR_ERR;
 210         }
 211
 212         /* FIXME: Hardcoded for 16bits. */
 213         if (SND_PCM_FORMAT_S16 == SND_PCM_FORMAT_S16_LE)
 214                 endianness = "little endian";
 215         else
 216                 endianness = "big endian";
 217         sr_dbg("Setting audio sample format to signed 16bit (%s).", endianness);
 218         ret = snd_pcm_hw_params_set_format(devc->capture_handle,
 219                                            devc->hw_params,
 220                                            SND_PCM_FORMAT_S16);
 221         if (ret < 0) {
 222                 sr_err("Can't set audio sample format: %s.", snd_strerror(ret));
 223                 return SR_ERR;
 224         }
 225
 226         sr_dbg("Setting audio samplerate to %" PRIu64 "Hz.",
 227                devc->cur_samplerate);
 228         ret = snd_pcm_hw_params_set_rate(devc->capture_handle, devc->hw_params,
 229                                          (unsigned int)devc->cur_samplerate, 0);
 230         if (ret < 0) {
 231                 sr_err("Can't set audio sample rate: %s.", snd_strerror(ret));
 232                 return SR_ERR;
 233         }
 234
 235         sr_dbg("Setting audio channel count to %d.", devc->num_probes);
 236         ret = snd_pcm_hw_params_set_channels(devc->capture_handle,
 237                                              devc->hw_params, devc->num_probes);
 238         if (ret < 0) {
 239                 sr_err("Can't set channel count: %s.", snd_strerror(ret));
 240                 return SR_ERR;
 241         }
 242
 243         sr_dbg("Setting audio parameters.");
 244         ret = snd_pcm_hw_params(devc->capture_handle, devc->hw_params);
 245         if (ret < 0) {
 246                 sr_err("Can't set parameters: %s.", snd_strerror(ret));
 247                 return SR_ERR;
 248         }
 249
 250         sr_dbg("Preparing audio interface for use.");
 251         ret = snd_pcm_prepare(devc->capture_handle);
 252         if (ret < 0) {
 253                 sr_err("Can't prepare audio interface for use: %s.",
 254                        snd_strerror(ret));
 255                 return SR_ERR;
 256         }
 257
 258         count = snd_pcm_poll_descriptors_count(devc->capture_handle);
 259         if (count < 1) {
 260                 sr_err("Unable to obtain poll descriptors count.");
 261                 return SR_ERR;
 262         }
 263
 264         if (!(devc->ufds = g_try_malloc(count * sizeof(struct pollfd)))) {
 265                 sr_err("Failed to malloc ufds.");
 266                 return SR_ERR_MALLOC;
 267         }
 268
 269         sr_spew("Getting %d poll descriptors.", count);
 270         ret = snd_pcm_poll_descriptors(devc->capture_handle, devc->ufds, count);
 271         if (ret < 0) {
 272                 sr_err("Unable to obtain poll descriptors: %s.",
 273                        snd_strerror(ret));
 274                 g_free(devc->ufds);
 275                 return SR_ERR;
 276         }
 277
 278         /* Send header packet to the session bus. */
 279         sr_dbg("Sending SR_DF_HEADER packet.");
 280         packet.type = SR_DF_HEADER;
 281         packet.payload = (uint8_t *)&header;
 282         header.feed_version = 1;
 283         gettimeofday(&header.starttime, NULL);
 284         sr_session_send(devc->cb_data, &packet);
 285
 286         /* Poll every 10ms, or whenever some data comes in. */
 287         sr_source_add(devc->ufds[0].fd, devc->ufds[0].events, 10,
 288                       alsa_receive_data, (void *)sdi);
 289
 290         // g_free(devc->ufds); /* FIXME */
 291
 292         return SR_OK;
 293 }
 294
 295 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 296 {
 297         struct sr_datafeed_packet packet;
 298         struct dev_context *devc;
 299
 300         devc = sdi->priv;
 301         devc->cb_data = cb_data;
 302
 303         sr_source_remove(devc->ufds[0].fd);
 304
 305         /* Send end packet to the session bus. */
 306         sr_dbg("Sending SR_DF_END packet.");
 307         packet.type = SR_DF_END;
 308         sr_session_send(cb_data, &packet);
 309
 310         return SR_OK;
 311 }
 312
 313 SR_PRIV struct sr_dev_driver alsa_driver_info = {
 314         .name = "alsa",
 315         .longname = "ALSA driver",
 316         .api_version = 1,
 317         .init = hw_init,
 318         .cleanup = hw_cleanup,
 319         .scan = hw_scan,
 320         .dev_list = hw_dev_list,
 321         .dev_clear = clear_instances,
 322         .config_get = config_get,
 323         .config_set = config_set,
 324         .config_list = config_list,
 325         .dev_open = hw_dev_open,
 326         .dev_close = hw_dev_close,
 327         .dev_acquisition_start = hw_dev_acquisition_start,
 328         .dev_acquisition_stop = hw_dev_acquisition_stop,
 329         .priv = NULL,
 330 };