Return to abuf.h CVS log

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

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

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