Annotation of src/usr.bin/aucat/abuf.h, Revision 1.23
1.23 ! ratchov 1: /* $OpenBSD: abuf.h,v 1.22 2010/04/06 20:07:01 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 aproc;
1.16 ratchov 23: struct aparams;
1.1 ratchov 24:
25: struct abuf {
1.19 ratchov 26: LIST_ENTRY(abuf) ient; /* reader's list of inputs entry */
27: LIST_ENTRY(abuf) oent; /* writer's list of outputs entry */
1.15 ratchov 28:
1.1 ratchov 29: /*
30: * fifo parameters
31: */
32: unsigned bpf; /* bytes per frame */
1.10 ratchov 33: unsigned cmin, cmax; /* channel range of this buf */
1.1 ratchov 34: unsigned start; /* offset where data starts */
35: unsigned used; /* valid data */
36: unsigned len; /* size of the ring */
37: struct aproc *rproc; /* reader */
38: struct aproc *wproc; /* writer */
1.9 ratchov 39: struct abuf *duplex; /* link to buffer of the other direction */
40: unsigned inuse; /* in abuf_{flush,fill,run}() */
1.19 ratchov 41: unsigned tickets; /* max data to (if throttling) */
42:
43: /*
44: * Misc reader aproc-specific per-buffer parameters.
45: */
46: union {
47: struct {
48: int weight; /* dynamic range */
49: int maxweight; /* max dynamic range allowed */
50: unsigned vol; /* volume within the dynamic range */
1.22 ratchov 51: unsigned done; /* frames ready */
1.19 ratchov 52: unsigned xrun; /* underrun policy */
1.22 ratchov 53: int drop; /* frames to drop on next read */
1.19 ratchov 54: } mix;
55: struct {
56: unsigned st; /* MIDI running status */
57: unsigned used; /* bytes used from ``msg'' */
58: unsigned idx; /* actual MIDI message size */
59: unsigned len; /* MIDI message length */
1.23 ! ratchov 60: #define MIDI_MSGMAX 16 /* max size of MIDI messaage */
1.19 ratchov 61: unsigned char msg[MIDI_MSGMAX];
62: } midi;
63: } r;
64:
65: /*
66: * Misc reader aproc-specific per-buffer parameters.
67: */
68: union {
69: struct {
1.22 ratchov 70: unsigned todo; /* frames to process */
1.19 ratchov 71: } mix;
72: struct {
1.22 ratchov 73: unsigned done; /* frames copied */
1.23 ! ratchov 74: unsigned xrun; /* overrun policy, one of XRUN_XXX */
1.22 ratchov 75: int silence; /* silence to add on next write */
1.19 ratchov 76: } sub;
77: } w;
1.1 ratchov 78: };
79:
80: /*
81: * the buffer contains at least one frame. This macro should
82: * be used to check if the buffer can be flushed
83: */
1.22 ratchov 84: #define ABUF_ROK(b) ((b)->used > 0)
1.1 ratchov 85:
86: /*
87: * there's room for at least one frame
88: */
1.22 ratchov 89: #define ABUF_WOK(b) ((b)->len - (b)->used > 0)
1.1 ratchov 90:
91: /*
1.17 ratchov 92: * the buffer is empty and has no writer anymore
1.1 ratchov 93: */
94: #define ABUF_EOF(b) (!ABUF_ROK(b) && (b)->wproc == NULL)
95:
96: /*
1.17 ratchov 97: * the buffer has no reader anymore, note that it's not
98: * enough the buffer to be disconnected, because it can
99: * be not yet connected buffer (eg. socket play buffer)
1.9 ratchov 100: */
101: #define ABUF_HUP(b) (!ABUF_WOK(b) && (b)->rproc == NULL)
1.1 ratchov 102:
1.10 ratchov 103: struct abuf *abuf_new(unsigned, struct aparams *);
1.1 ratchov 104: void abuf_del(struct abuf *);
1.18 ratchov 105: void abuf_dbg(struct abuf *);
1.12 ratchov 106: void abuf_clear(struct abuf *);
1.1 ratchov 107: unsigned char *abuf_rgetblk(struct abuf *, unsigned *, unsigned);
108: unsigned char *abuf_wgetblk(struct abuf *, unsigned *, unsigned);
1.5 ratchov 109: void abuf_rdiscard(struct abuf *, unsigned);
110: void abuf_wcommit(struct abuf *, unsigned);
1.9 ratchov 111: int abuf_fill(struct abuf *);
112: int abuf_flush(struct abuf *);
1.1 ratchov 113: void abuf_eof(struct abuf *);
114: void abuf_hup(struct abuf *);
115: void abuf_run(struct abuf *);
1.9 ratchov 116: void abuf_ipos(struct abuf *, int);
117: void abuf_opos(struct abuf *, int);
1.1 ratchov 118:
119: #endif /* !defined(ABUF_H) */
![[BACK]](/icons/back.gif){kind=icon}
Return to abuf.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / aucat