xref: /third_party/alsa-utils/axfer/xfer-libasound.h (revision c72fcc34)

// SPDX-License-Identifier: GPL-2.0
//
// xfer-libasound.h - a header for receiver/transmitter of frames by alsa-lib.
//
// Copyright (c) 2018 Takashi Sakamoto <o-takashi@sakamocchi.jp>
//
// Licensed under the terms of the GNU General Public License, version 2.

#ifndef __ALSA_UTILS_AXFER_XFER_LIBASOUND__H_
#define __ALSA_UTILS_AXFER_XFER_LIBASOUND__H_

#include "xfer.h"
#include "waiter.h"

#define logging(state, ...) \
	snd_output_printf(state->log, __VA_ARGS__)

enum sched_model {
	SCHED_MODEL_IRQ = 0,
	SCHED_MODEL_TIMER,
	SCHED_MODEL_COUNT,
};

struct xfer_libasound_ops;

struct libasound_state {
	snd_pcm_t *handle;

	snd_output_t *log;
	snd_pcm_hw_params_t *hw_params;
	snd_pcm_sw_params_t *sw_params;

	const struct xfer_libasound_ops *ops;
	void *private_data;

	bool verbose;

	char *node_literal;
	char *waiter_type_literal;
	char *sched_model_literal;

	unsigned int msec_per_period;
	unsigned int msec_per_buffer;
	unsigned int frames_per_period;
	unsigned int frames_per_buffer;

	unsigned int msec_for_avail_min;
	unsigned int msec_for_start_threshold;
	unsigned int msec_for_stop_threshold;

	bool finish_at_xrun:1;
	bool nonblock:1;
	bool mmap:1;
	bool test_nowait:1;
	bool no_auto_resample:1;
	bool no_auto_channels:1;
	bool no_auto_format:1;
	bool no_softvol:1;

	bool use_waiter:1;

	enum waiter_type waiter_type;
	struct waiter_context *waiter;

	// For scheduling type.
	enum sched_model sched_model;
};

// For internal use in 'libasound' module.

struct xfer_libasound_ops {
	int (*pre_process)(struct libasound_state *state);
	int (*process_frames)(struct libasound_state *state,
			      unsigned int *frame_count,
			      struct mapper_context *mapper,
			      struct container_context *cntrs);
	void (*post_process)(struct libasound_state *state);
	unsigned int private_size;
};

int xfer_libasound_wait_event(struct libasound_state *state, int timeout_msec,
			      unsigned short *revents);

extern const struct xfer_libasound_ops xfer_libasound_irq_rw_ops;

extern const struct xfer_libasound_ops xfer_libasound_irq_mmap_r_ops;
extern const struct xfer_libasound_ops xfer_libasound_irq_mmap_w_ops;

extern const struct xfer_libasound_ops xfer_libasound_timer_mmap_w_ops;
extern const struct xfer_libasound_ops xfer_libasound_timer_mmap_r_ops;

#endif