Annotation of src/usr.bin/aucat/abuf.h, Revision 1.10
1.10 ! ratchov 1: /* $OpenBSD: abuf.h,v 1.9 2008/10/26 08:49:43 ratchov Exp $ */
1.1 ratchov 2: /*
3: * Copyright (c) 2008 Alexandre Ratchov <alex@caoua.org>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #ifndef ABUF_H
18: #define ABUF_H
19:
20: #include <sys/queue.h>
21:
22: struct abuf;
23: struct aproc;
1.10 ! ratchov 24: struct aparam;
1.1 ratchov 25:
26: struct abuf {
27: /*
1.4 ratchov 28: * Misc aproc-specific per-buffer parameters.
29: * since the buffer can connect any pair of aproc structure,
30: * each aproc must have it's own specific data. Thus we cannot
31: * use an union. The only exception is the xrun field, because
32: * there can be only one aproc that absorbs xruns in any
33: * intput->output path.
1.1 ratchov 34: */
35: int mixvol; /* input gain */
1.10 ! ratchov 36: unsigned mixdone; /* input already processed */
! 37: unsigned mixtodo; /* output not yet complete */
! 38: unsigned subdone; /* output already processed */
1.4 ratchov 39: #define XRUN_IGNORE 0 /* on xrun silently insert/discard samples */
40: #define XRUN_SYNC 1 /* catchup to sync to the mix/sub */
41: #define XRUN_ERROR 2 /* xruns are errors, eof/hup buffer */
42: unsigned xrun; /* common to mix and sub */
1.1 ratchov 43: LIST_ENTRY(abuf) ient; /* for mix inputs list */
44: LIST_ENTRY(abuf) oent; /* for sub outputs list */
1.9 ratchov 45:
1.1 ratchov 46: /*
47: * fifo parameters
48: */
49: unsigned bpf; /* bytes per frame */
1.10 ! ratchov 50: unsigned cmin, cmax; /* channel range of this buf */
1.1 ratchov 51: unsigned start; /* offset where data starts */
52: unsigned used; /* valid data */
53: unsigned len; /* size of the ring */
1.7 ratchov 54: unsigned abspos; /* frame number of the start position */
1.6 ratchov 55: unsigned silence; /* silence to insert on next write */
1.8 ratchov 56: unsigned drop; /* bytes to drop on next read */
1.1 ratchov 57: struct aproc *rproc; /* reader */
58: struct aproc *wproc; /* writer */
1.9 ratchov 59: struct abuf *duplex; /* link to buffer of the other direction */
60: unsigned inuse; /* in abuf_{flush,fill,run}() */
1.6 ratchov 61: unsigned char *data; /* actual data (immediately following) */
1.1 ratchov 62: };
63:
64: /*
65: * the buffer contains at least one frame. This macro should
66: * be used to check if the buffer can be flushed
67: */
68: #define ABUF_ROK(b) ((b)->used >= (b)->bpf)
69:
70: /*
71: * there's room for at least one frame
72: */
73: #define ABUF_WOK(b) ((b)->len - (b)->used >= (b)->bpf)
74:
75: /*
76: * the buffer is empty and has no more writer
77: */
78: #define ABUF_EOF(b) (!ABUF_ROK(b) && (b)->wproc == NULL)
79:
80: /*
1.9 ratchov 81: * the buffer is empty and has no more writer
82: */
83: #define ABUF_HUP(b) (!ABUF_WOK(b) && (b)->rproc == NULL)
84:
85: /*
1.1 ratchov 86: * similar to !ABUF_WOK, but is used for file i/o, where
87: * operation may not involve an integer number of frames
88: */
89: #define ABUF_FULL(b) ((b)->used == (b)->len)
90:
91: /*
92: * same as !ABUF_ROK, but used for files, where
93: * operations are byte orientated, not frame-oriented
94: */
95: #define ABUF_EMPTY(b) ((b)->used == 0)
96:
1.10 ! ratchov 97: struct abuf *abuf_new(unsigned, struct aparams *);
1.1 ratchov 98: void abuf_del(struct abuf *);
99: unsigned char *abuf_rgetblk(struct abuf *, unsigned *, unsigned);
100: unsigned char *abuf_wgetblk(struct abuf *, unsigned *, unsigned);
1.5 ratchov 101: void abuf_rdiscard(struct abuf *, unsigned);
102: void abuf_wcommit(struct abuf *, unsigned);
1.9 ratchov 103: int abuf_fill(struct abuf *);
104: int abuf_flush(struct abuf *);
1.1 ratchov 105: void abuf_eof(struct abuf *);
106: void abuf_hup(struct abuf *);
107: void abuf_run(struct abuf *);
1.9 ratchov 108: void abuf_ipos(struct abuf *, int);
109: void abuf_opos(struct abuf *, int);
1.1 ratchov 110:
111: #endif /* !defined(ABUF_H) */