Annotation of src/usr.bin/aucat/aproc.h, Revision 1.39
1.39 ! ratchov 1: /* $OpenBSD: aproc.h,v 1.38 2010/11/04 17:55:28 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 APROC_H
18: #define APROC_H
19:
20: #include <sys/queue.h>
21:
22: #include "aparams.h"
1.17 ratchov 23: #include "file.h"
1.1 ratchov 24:
25: struct abuf;
26: struct aproc;
27: struct file;
28:
29: struct aproc_ops {
30: /*
31: * Name of the ops structure, ie type of the unit.
32: */
33: char *name;
34:
35: /*
36: * The state of the given input abuf changed (eg. an input block
37: * is ready for processing). This function must get the block
38: * from the input, process it and remove it from the buffer.
39: *
40: * Processing the block will result in a change of the state of
41: * OTHER buffers that are attached to the aproc (eg. the output
42: * buffer was filled), thus this routine MUST notify ALL aproc
43: * structures that are waiting on it; most of the time this
44: * means just calling abuf_flush() on the output buffer.
45: */
46: int (*in)(struct aproc *, struct abuf *);
47:
48: /*
49: * The state of the given output abuf changed (eg. space for a
50: * new output block was made available) so processing can
51: * continue. This function must process more input in order to
52: * fill the output block.
53: *
54: * Producing a block will result in the change of the state of
55: * OTHER buffers that are attached to the aproc, thus this
56: * routine MUST notify ALL aproc structures that are waiting on
57: * it; most of the time this means calling abuf_fill() on the
58: * source buffers.
59: *
60: * Before filling input buffers (using abuf_fill()), this
61: * routine must ALWAYS check for eof condition, and if needed,
62: * handle it appropriately and call abuf_hup() to free the input
63: * buffer.
64: */
65: int (*out)(struct aproc *, struct abuf *);
66:
67: /*
68: * The input buffer is empty and we can no more receive data
69: * from it. The buffer will be destroyed as soon as this call
70: * returns so the abuf pointer will stop being valid after this
71: * call returns. There's no need to drain the buffer because the
72: * in() call-back was just called before.
73: *
74: * If this call reads and/or writes data on other buffers,
75: * abuf_flush() and abuf_fill() must be called appropriately.
76: */
77: void (*eof)(struct aproc *, struct abuf *);
78:
79: /*
80: * The output buffer can no more accept data (it should be
81: * considered as full). After this function returns, it will be
82: * destroyed and the "abuf" pointer will be no more valid.
83: */
84: void (*hup)(struct aproc *, struct abuf *);
85:
86: /*
87: * A new input was connected.
88: */
89: void (*newin)(struct aproc *, struct abuf *);
90:
91: /*
92: * A new output was connected
93: */
94: void (*newout)(struct aproc *, struct abuf *);
1.3 ratchov 95:
96: /*
1.6 ratchov 97: * Real-time record position changed (for input buffer),
1.18 ratchov 98: * by the given amount of _frames_.
1.6 ratchov 99: */
100: void (*ipos)(struct aproc *, struct abuf *, int);
101:
102: /*
103: * Real-time play position changed (for output buffer),
1.18 ratchov 104: * by the given amount of _frames_.
1.6 ratchov 105: */
106: void (*opos)(struct aproc *, struct abuf *, int);
107:
108: /*
1.18 ratchov 109: * Destroy the aproc, called just before to free the
110: * aproc structure.
1.3 ratchov 111: */
112: void (*done)(struct aproc *);
1.1 ratchov 113: };
114:
115: /*
116: * The aproc structure represents a simple audio processing unit; they are
117: * interconnected by abuf structures and form a kind of "circuit". The circuit
118: * cannot have loops.
119: */
120: struct aproc {
121: char *name; /* for debug purposes */
122: struct aproc_ops *ops; /* call-backs */
1.35 ratchov 123: LIST_HEAD(, abuf) ins; /* list of inputs */
124: LIST_HEAD(, abuf) outs; /* list of outputs */
1.15 ratchov 125: unsigned refs; /* extern references */
1.27 ratchov 126: #define APROC_ZOMB 1 /* destroyed but not freed */
127: #define APROC_QUIT 2 /* try to terminate if unused */
128: #define APROC_DROP 4 /* xrun if capable */
129: unsigned flags;
1.1 ratchov 130: union { /* follow type-specific data */
131: struct { /* file/device io */
132: struct file *file; /* file to read/write */
1.32 ratchov 133: unsigned partial; /* bytes of partial frame */
1.1 ratchov 134: } io;
135: struct {
1.12 ratchov 136: unsigned idle; /* frames since idleing */
1.32 ratchov 137: unsigned round; /* block size, for xruns */
1.6 ratchov 138: int lat; /* current latency */
1.27 ratchov 139: int maxlat; /* max latency allowed */
1.32 ratchov 140: unsigned abspos; /* frames produced */
141: struct aproc *ctl; /* MIDI control/sync */
142: struct aproc *mon; /* snoop output */
1.39 ! ratchov 143: unsigned autovol; /* adjust volume dynamically */
1.2 ratchov 144: } mix;
145: struct {
1.12 ratchov 146: unsigned idle; /* frames since idleing */
1.32 ratchov 147: unsigned round; /* block size, for xruns */
1.6 ratchov 148: int lat; /* current latency */
1.27 ratchov 149: int maxlat; /* max latency allowed */
1.32 ratchov 150: unsigned abspos; /* frames consumed */
1.27 ratchov 151: struct aproc *ctl;
1.2 ratchov 152: } sub;
1.7 ratchov 153: struct {
1.32 ratchov 154: int delta; /* time position */
155: unsigned bufsz; /* buffer size (latency) */
156: unsigned pending; /* uncommited samples */
157: } mon;
158: struct {
1.14 ratchov 159: #define RESAMP_NCTX 2
160: unsigned ctx_start;
1.38 ratchov 161: adata_t ctx[NCHAN_MAX * RESAMP_NCTX];
1.13 ratchov 162: unsigned iblksz, oblksz;
1.14 ratchov 163: int diff;
1.32 ratchov 164: int idelta, odelta; /* remainder of resamp_xpos */
1.7 ratchov 165: } resamp;
1.9 ratchov 166: struct {
1.11 ratchov 167: int bfirst; /* bytes to skip at startup */
168: unsigned bps; /* bytes per sample */
169: unsigned shift; /* shift to get 32bit MSB */
170: int sigbit; /* sign bits to XOR */
171: int bnext; /* to reach the next byte */
172: int snext; /* to reach the next sample */
173: } conv;
1.17 ratchov 174: struct {
175: struct abuf *owner; /* current input stream */
176: struct timo timo; /* timout for throtteling */
177: } thru;
1.19 ratchov 178: struct {
1.37 ratchov 179: struct dev *dev; /* controlled device */
1.19 ratchov 180: #define CTL_NSLOT 8
181: #define CTL_NAMEMAX 8
1.21 ratchov 182: unsigned serial;
1.27 ratchov 183: #define CTL_OFF 0 /* ignore MMC messages */
184: #define CTL_STOP 1 /* stopped, can't start */
185: #define CTL_START 2 /* attempting to start */
186: #define CTL_RUN 3 /* started */
187: unsigned tstate;
188: unsigned origin; /* MTC start time */
189: unsigned fps; /* MTC frames per second */
190: #define MTC_FPS_24 0
191: #define MTC_FPS_25 1
192: #define MTC_FPS_30 3
193: unsigned fps_id; /* one of above */
194: unsigned hr; /* MTC hours */
195: unsigned min; /* MTC minutes */
196: unsigned sec; /* MTC seconds */
197: unsigned fr; /* MTC frames */
198: unsigned qfr; /* MTC quarter frames */
199: int delta; /* rel. to the last MTC tick */
1.19 ratchov 200: struct ctl_slot {
1.26 ratchov 201: struct ctl_ops {
202: void (*vol)(void *, unsigned);
1.27 ratchov 203: void (*start)(void *);
1.32 ratchov 204: void (*stop)(void *);
205: void (*loc)(void *, unsigned);
1.37 ratchov 206: void (*quit)(void *);
1.26 ratchov 207: } *ops;
1.20 ratchov 208: void *arg;
1.19 ratchov 209: unsigned unit;
210: char name[CTL_NAMEMAX];
1.21 ratchov 211: unsigned serial;
1.22 ratchov 212: unsigned vol;
1.27 ratchov 213: unsigned tstate;
1.19 ratchov 214: } slot[CTL_NSLOT];
215: } ctl;
1.1 ratchov 216: } u;
217: };
218:
1.32 ratchov 219: /*
220: * Check if the given pointer is a valid aproc structure.
221: *
222: * aproc structures are not free()'d immediately, because
223: * there may be pointers to them, instead the APROC_ZOMB flag
224: * is set which means that they should not be used. When
225: * aprocs reference counter reaches zero, they are actually
226: * freed
227: */
228: #define APROC_OK(p) ((p) && !((p)->flags & APROC_ZOMB))
229:
230:
1.3 ratchov 231: struct aproc *aproc_new(struct aproc_ops *, char *);
1.1 ratchov 232: void aproc_del(struct aproc *);
1.23 ratchov 233: void aproc_dbg(struct aproc *);
1.1 ratchov 234: void aproc_setin(struct aproc *, struct abuf *);
235: void aproc_setout(struct aproc *, struct abuf *);
1.17 ratchov 236: int aproc_depend(struct aproc *, struct aproc *);
1.1 ratchov 237:
1.32 ratchov 238: void aproc_ipos(struct aproc *, struct abuf *, int);
239: void aproc_opos(struct aproc *, struct abuf *, int);
240:
1.28 ratchov 241: struct aproc *rfile_new(struct file *);
242: struct aproc *wfile_new(struct file *);
1.39 ! ratchov 243: struct aproc *mix_new(char *, int, unsigned, unsigned);
1.36 ratchov 244: struct aproc *sub_new(char *, int, unsigned);
1.13 ratchov 245: struct aproc *resamp_new(char *, unsigned, unsigned);
1.11 ratchov 246: struct aproc *enc_new(char *, struct aparams *);
247: struct aproc *dec_new(char *, struct aparams *);
1.34 ratchov 248: struct aproc *join_new(char *);
1.32 ratchov 249: struct aproc *mon_new(char *, unsigned);
250:
251: int rfile_in(struct aproc *, struct abuf *);
252: int rfile_out(struct aproc *, struct abuf *);
253: void rfile_eof(struct aproc *, struct abuf *);
254: void rfile_hup(struct aproc *, struct abuf *);
255: void rfile_done(struct aproc *);
256: int rfile_do(struct aproc *, unsigned, unsigned *);
257:
258: int wfile_in(struct aproc *, struct abuf *);
259: int wfile_out(struct aproc *, struct abuf *);
260: void wfile_eof(struct aproc *, struct abuf *);
261: void wfile_hup(struct aproc *, struct abuf *);
262: void wfile_done(struct aproc *);
263: int wfile_do(struct aproc *, unsigned, unsigned *);
1.5 ratchov 264:
265: void mix_setmaster(struct aproc *);
1.12 ratchov 266: void mix_clear(struct aproc *);
1.29 ratchov 267: void mix_prime(struct aproc *);
1.36 ratchov 268: void mix_quit(struct aproc *);
1.32 ratchov 269: void mix_drop(struct abuf *, int);
270: void sub_silence(struct abuf *, int);
1.12 ratchov 271: void sub_clear(struct aproc *);
1.32 ratchov 272: void mon_snoop(struct aproc *, struct abuf *, unsigned, unsigned);
273: void mon_clear(struct aproc *);
1.1 ratchov 274:
1.11 ratchov 275: #endif /* !defined(APROC_H) */