Return to abuf.h CVS log

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

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

1.3     ! ratchov     1: /*     $OpenBSD: abuf.h,v 1.2 2008/05/25 21:16:37 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:        /*
                     27:         * misc aproc-specific per-buffer parameters
                     28:         */
                     29:        int mixvol;             /* input gain */
                     30:        unsigned mixdone;       /* input of mixer */
                     31:        unsigned mixtodo;       /* output of mixer */
1.3     ! ratchov    32:        unsigned mixdrop;       /* frames mix_in() will discard */
1.1       ratchov    33:        unsigned subdone;       /* output if sub */
1.3     ! ratchov    34:        unsigned subdrop;       /* silence frames sub_out() will insert */
1.1       ratchov    35:        LIST_ENTRY(abuf) ient;  /* for mix inputs list */
                     36:        LIST_ENTRY(abuf) oent;  /* for sub outputs list */
                     37:
                     38:        /*
                     39:         * fifo parameters
                     40:         */
                     41:        unsigned bpf;           /* bytes per frame */
                     42:        unsigned start;         /* offset where data starts */
                     43:        unsigned used;          /* valid data */
                     44:        unsigned len;           /* size of the ring */
                     45:        struct aproc *rproc;    /* reader */
                     46:        struct aproc *wproc;    /* writer */
1.2       ratchov    47:        unsigned char *data;    /* pointer to actual data (immediately following) */
1.1       ratchov    48: };
                     49:
                     50: /*
                     51:  * the buffer contains at least one frame. This macro should
                     52:  * be used to check if the buffer can be flushed
                     53:  */
                     54: #define ABUF_ROK(b) ((b)->used >= (b)->bpf)
                     55:
                     56: /*
                     57:  * there's room for at least one frame
                     58:  */
                     59: #define ABUF_WOK(b) ((b)->len - (b)->used >= (b)->bpf)
                     60:
                     61: /*
                     62:  * the buffer is empty and has no more writer
                     63:  */
                     64: #define ABUF_EOF(b) (!ABUF_ROK(b) && (b)->wproc == NULL)
                     65:
                     66: /*
                     67:  * similar to !ABUF_WOK, but is used for file i/o, where
                     68:  * operation may not involve an integer number of frames
                     69:  */
                     70: #define ABUF_FULL(b) ((b)->used == (b)->len)
                     71:
                     72: /*
                     73:  * same as !ABUF_ROK, but used for files, where
                     74:  * operations are byte orientated, not frame-oriented
                     75:  */
                     76: #define ABUF_EMPTY(b) ((b)->used == 0)
                     77:
                     78: struct abuf *abuf_new(unsigned, unsigned);
                     79: void abuf_del(struct abuf *);
                     80: unsigned char *abuf_rgetblk(struct abuf *, unsigned *, unsigned);
                     81: unsigned char *abuf_wgetblk(struct abuf *, unsigned *, unsigned);
                     82: void abuf_fill(struct abuf *);
                     83: void abuf_flush(struct abuf *);
                     84: void abuf_eof(struct abuf *);
                     85: void abuf_hup(struct abuf *);
                     86: void abuf_run(struct abuf *);
                     87:
                     88: #endif /* !defined(ABUF_H) */