pipewire/spa/plugins/alsa/alsa-utils.h

/* Spa ALSA Sink
 *
 * Copyright © 2018 Wim Taymans
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef SPA_ALSA_UTILS_H
#define SPA_ALSA_UTILS_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <math.h>

#include <asoundlib.h>

#include <spa/support/loop.h>
#include <spa/support/log.h>
#include <spa/utils/list.h>

#include <spa/node/node.h>
#include <spa/node/io.h>
#include <spa/param/param.h>
#include <spa/param/audio/format-utils.h>

#define DEFAULT_RATE		48000u
#define DEFAULT_CHANNELS	2u

struct props {
	char device[64];
	char device_name[128];
	char card_name[128];
	uint32_t min_latency;
	uint32_t max_latency;
};

#define MAX_BUFFERS 32

struct buffer {
	uint32_t id;
	uint32_t flags;
	struct spa_buffer *buf;
	struct spa_meta_header *h;
#define BUFFER_FLAG_OUT	(1<<0)
	struct spa_list link;
};

#define DLL_BW_MAX	0.256
#define DLL_BW_MIN	0.05
#define DLL_BW_PERIOD	4.0

struct dll {
	double w1, w2;
	double base, t0, dt;
	double bw;
	int count;
};

struct state {
	struct spa_handle handle;
	struct spa_node node;

	uint32_t seq;

	struct spa_log *log;
	struct spa_loop *main_loop;
	struct spa_loop *data_loop;

	snd_pcm_stream_t stream;
	snd_output_t *output;

	const struct spa_node_callbacks *callbacks;
	void *callbacks_data;

	struct props props;

	bool opened;
	snd_pcm_t *hndl;

	bool have_format;
	struct spa_audio_info current_format;
	struct dll dll;

	snd_pcm_uframes_t buffer_frames;
	snd_pcm_uframes_t period_frames;
	snd_pcm_format_t format;
	int rate;
	int channels;
	size_t frame_size;

	struct spa_port_info info;
	struct spa_io_buffers *io;
	struct spa_io_range *range;
	struct spa_io_clock *clock;
	struct spa_io_position *position;
	struct spa_io_sequence *notify;

	struct buffer buffers[MAX_BUFFERS];
	unsigned int n_buffers;

	struct spa_list free;
	struct spa_list ready;

	size_t ready_offset;

	bool started;
	struct spa_source source;
	int timerfd;
	bool alsa_started;
	bool slaved;
	uint32_t threshold;

	snd_htimestamp_t now;
	int64_t sample_count;

	int64_t sample_time;
	uint64_t last_time;
	uint64_t next_time;

	uint64_t underrun;
	double old_dt;
	double safety;
};

int
spa_alsa_enum_format(struct state *state, int seq,
		     uint32_t start, uint32_t num,
		     const struct spa_pod *filter);

int spa_alsa_set_format(struct state *state, struct spa_audio_info *info, uint32_t flags);

int spa_alsa_start(struct state *state);
int spa_alsa_pause(struct state *state);
int spa_alsa_close(struct state *state);

int spa_alsa_write(struct state *state, snd_pcm_uframes_t silence, bool start);


static inline void dll_bandwidth(struct dll *dll, double bandwidth)
{
	double w = 2 * M_PI * bandwidth;
	dll->w1 = w * M_SQRT2;
	dll->w2 = w * w;
	dll->bw = bandwidth;
	dll->base = dll->t0;
}

static inline void dll_init(struct dll *dll, double bandwidth)
{
	dll->dt = 1.0;
	dll->count = 0;
	dll_bandwidth(dll, bandwidth);
}

static inline double dll_update(struct dll *dll, double tw, double period)
{
	double e;

	if (dll->count++ == 0) {
		dll->t0 = dll->base = tw;
	} else {
		dll->t0 += dll->dt * period;
		e = (tw - dll->t0) * period;
		dll->t0 += dll->w1 * e;
		dll->dt += dll->w2 * e;
	}
	return dll->t0;
}

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* SPA_ALSA_UTILS_H */