Return to abuf.h CVS log

Up to [local] / src / usr.bin / aucat

Annotation of src/usr.bin/aucat/abuf.h, Revision 1.15

1.15    ! ratchov     1: /*     $OpenBSD: abuf.h,v 1.14 2008/11/16 16:30:22 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,
1.15    ! ratchov    30:         * each aproc must have it's own specific data. Thus we cannot
1.4       ratchov    31:         * use an union. The only exception is the xrun field, because
1.15    ! ratchov    32:         * there can be only one aproc that absorbs xruns in any
1.4       ratchov    33:         * intput->output path.
1.1       ratchov    34:         */
1.14      ratchov    35:        int mixweight;          /* dynamic range for the source stream */
                     36:        int mixmaxweight;       /* max dynamic range allowed */
                     37:        unsigned mixvol;        /* volume within the dynamic range */
1.11      ratchov    38:        unsigned mixodone;      /* bytes done on the dest stream */
                     39:        unsigned mixitodo;      /* bytes to do on the source stream */
                     40:        unsigned subidone;      /* bytes copied from the source stream */
1.4       ratchov    41: #define XRUN_IGNORE    0       /* on xrun silently insert/discard samples */
                     42: #define XRUN_SYNC      1       /* catchup to sync to the mix/sub */
                     43: #define XRUN_ERROR     2       /* xruns are errors, eof/hup buffer */
                     44:        unsigned xrun;          /* common to mix and sub */
1.1       ratchov    45:        LIST_ENTRY(abuf) ient;  /* for mix inputs list */
                     46:        LIST_ENTRY(abuf) oent;  /* for sub outputs list */
1.15    ! ratchov    47:
1.1       ratchov    48:        /*
                     49:         * fifo parameters
                     50:         */
                     51:        unsigned bpf;           /* bytes per frame */
1.10      ratchov    52:        unsigned cmin, cmax;    /* channel range of this buf */
1.1       ratchov    53:        unsigned start;         /* offset where data starts */
                     54:        unsigned used;          /* valid data */
                     55:        unsigned len;           /* size of the ring */
1.7       ratchov    56:        unsigned abspos;        /* frame number of the start position */
1.6       ratchov    57:        unsigned silence;       /* silence to insert on next write */
1.8       ratchov    58:        unsigned drop;          /* bytes to drop on next read */
1.1       ratchov    59:        struct aproc *rproc;    /* reader */
                     60:        struct aproc *wproc;    /* writer */
1.9       ratchov    61:        struct abuf *duplex;    /* link to buffer of the other direction */
                     62:        unsigned inuse;         /* in abuf_{flush,fill,run}() */
1.6       ratchov    63:        unsigned char *data;    /* actual data (immediately following) */
1.1       ratchov    64: };
                     65:
                     66: /*
                     67:  * the buffer contains at least one frame. This macro should
                     68:  * be used to check if the buffer can be flushed
                     69:  */
                     70: #define ABUF_ROK(b) ((b)->used >= (b)->bpf)
                     71:
                     72: /*
                     73:  * there's room for at least one frame
                     74:  */
                     75: #define ABUF_WOK(b) ((b)->len - (b)->used >= (b)->bpf)
                     76:
                     77: /*
                     78:  * the buffer is empty and has no more writer
                     79:  */
                     80: #define ABUF_EOF(b) (!ABUF_ROK(b) && (b)->wproc == NULL)
                     81:
                     82: /*
1.9       ratchov    83:  * the buffer is empty and has no more writer
                     84:  */
                     85: #define ABUF_HUP(b) (!ABUF_WOK(b) && (b)->rproc == NULL)
                     86:
                     87: /*
1.1       ratchov    88:  * similar to !ABUF_WOK, but is used for file i/o, where
                     89:  * operation may not involve an integer number of frames
                     90:  */
                     91: #define ABUF_FULL(b) ((b)->used == (b)->len)
                     92:
                     93: /*
                     94:  * same as !ABUF_ROK, but used for files, where
                     95:  * operations are byte orientated, not frame-oriented
                     96:  */
                     97: #define ABUF_EMPTY(b) ((b)->used == 0)
                     98:
1.10      ratchov    99: struct abuf *abuf_new(unsigned, struct aparams *);
1.1       ratchov   100: void abuf_del(struct abuf *);
1.12      ratchov   101: void abuf_clear(struct abuf *);
1.1       ratchov   102: unsigned char *abuf_rgetblk(struct abuf *, unsigned *, unsigned);
                    103: unsigned char *abuf_wgetblk(struct abuf *, unsigned *, unsigned);
1.5       ratchov   104: void abuf_rdiscard(struct abuf *, unsigned);
                    105: void abuf_wcommit(struct abuf *, unsigned);
1.9       ratchov   106: int abuf_fill(struct abuf *);
                    107: int abuf_flush(struct abuf *);
1.1       ratchov   108: void abuf_eof(struct abuf *);
                    109: void abuf_hup(struct abuf *);
                    110: void abuf_run(struct abuf *);
1.9       ratchov   111: void abuf_ipos(struct abuf *, int);
                    112: void abuf_opos(struct abuf *, int);
1.1       ratchov   113:
                    114: #endif /* !defined(ABUF_H) */