xref: /illumos-gate/usr/src/uts/common/io/audio/impl/audio_impl.h (revision 2c30fa45)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (C) 4Front Technologies 1996-2008.
 *
 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
 */

#ifndef	_AUDIO_IMPL_H
#define	_AUDIO_IMPL_H

#include <sys/types.h>
#include <sys/list.h>
#include <sys/poll.h>

#include <sys/audio/audio_driver.h>
#include "audio_client.h"

#define	AUDIO_MAX_OPENS		256
#define	AUDIO_MAX_CHANNELS	16
#define	AUDIO_UNIT_EXPAND	1024
#define	AUDIO_CHBUFS		2048	/* samples for mixing */
#define	AUDIO_VOL_SCALE		256
#define	AUDIO_DB_SIZE		50

#define	AUDIO_INTRHZ		100
#define	AUDIO_INTRHZ_MIN	50	/* 20 msec max */
#define	AUDIO_INTRHZ_MAX	500

struct audio_parms {
	int		p_format;
	int		p_rate;
	int		p_nchan;
};

typedef int (*audio_cnv_func_t)(audio_stream_t *, int);

struct audio_buffer {
	caddr_t			b_data;
	uint64_t		b_head;
	uint64_t		b_tail;
	uint_t			b_hidx;		/* head % nframes */
	uint_t			b_tidx;		/* tail % nframes */
	uint_t			b_nframes;	/* total frames */
	uint_t			b_framesz;	/* bytes per frame  */
};

/*
 * struct audio_stream: This structure represents a virtual stream exposed
 * to a single client.  Each client will have at most two of these (one for
 * record, one for playback.)
 */
struct audio_stream {
	audio_buffer_t		s_buf;
#define	s_data			s_buf.b_data
#define	s_bufsz			s_buf.b_size
#define	s_head			s_buf.b_head
#define	s_tail			s_buf.b_tail
#define	s_framesz		s_buf.b_framesz
#define	s_nframes		s_buf.b_nframes
#define	s_tidx			s_buf.b_tidx
#define	s_hidx			s_buf.b_hidx
	uint_t			s_nfrags;
	uint_t			s_fragfr;
	uint_t			s_nbytes;
	uint_t			s_fragbytes;
	ddi_umem_cookie_t	s_cookie;
	uint32_t		s_allocsz;
	uint32_t		s_hintsz;	/* latency hints */
	uint16_t		s_hintfrags;

	/*
	 * Various counters.
	 */
	uint64_t		s_samples;
	uint64_t		s_errors;	/* underrun or overrun count */

	boolean_t		s_running;
	boolean_t		s_paused;	/* stream paused */
	boolean_t		s_draining;	/* stream draining */

	/*
	 * Sample rate conversion (SRC) and format conversion details.
	 */
	struct grc3state	*s_src_state[AUDIO_MAX_CHANNELS];
	uint_t			s_src_quality;
	int			s_cnv_max;
	audio_cnv_func_t	s_converter;
	uint32_t		*s_cnv_buf0;
	uint32_t		*s_cnv_buf1;
	void			*s_cnv_src;
	void			*s_cnv_dst;
	audio_parms_t		s_cnv_src_parms;
#define	s_cnv_src_nchan		s_cnv_src_parms.p_nchan
#define	s_cnv_src_rate		s_cnv_src_parms.p_rate
#define	s_cnv_src_format	s_cnv_src_parms.p_format

	audio_parms_t		s_cnv_dst_parms;
#define	s_cnv_dst_nchan		s_cnv_dst_parms.p_nchan
#define	s_cnv_dst_rate		s_cnv_dst_parms.p_rate
#define	s_cnv_dst_format	s_cnv_dst_parms.p_format

	size_t			s_cnv_cnt;
	int32_t			*s_cnv_ptr;

	audio_parms_t		*s_user_parms;
	audio_parms_t		*s_phys_parms;

	/*
	 * Volume.
	 */
	uint8_t			s_gain_master;
	uint8_t			s_gain_pct;
	uint16_t		s_gain_scaled;
	uint16_t		s_gain_eff;
	boolean_t		s_muted;

	/*
	 * Callbacks.
	 */
	uint64_t		s_drain_idx;	/* engine index */

	/*
	 * Other per stream details, e.g. channel offset, etc.
	 */
	kmutex_t		s_lock;
	kcondvar_t		s_cv;