summaryrefslogtreecommitdiffstats
path: root/polyp/memblockq.h
diff options
context:
space:
mode:
Diffstat (limited to 'polyp/memblockq.h')
-rw-r--r--polyp/memblockq.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/polyp/memblockq.h b/polyp/memblockq.h
new file mode 100644
index 00000000..e6ad01db
--- /dev/null
+++ b/polyp/memblockq.h
@@ -0,0 +1,82 @@
+#ifndef foomemblockqhfoo
+#define foomemblockqhfoo
+
+/* $Id$ */
+
+/***
+ This file is part of polypaudio.
+
+ polypaudio is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published
+ by the Free Software Foundation; either version 2 of the License,
+ or (at your option) any later version.
+
+ polypaudio is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with polypaudio; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+ USA.
+***/
+
+#include <sys/types.h>
+
+#include "memblock.h"
+#include "memchunk.h"
+
+struct pa_memblockq;
+
+/* Parameters:
+ - maxlength: maximum length of queue. If more data is pushed into the queue, data from the front is dropped
+ - length: the target length of the queue.
+ - base: a base value for all metrics. Only multiples of this value are popped from the queue
+ - prebuf: before passing the first byte out, make sure that enough bytes are in the queue
+ - minreq: pa_memblockq_missing() will only return values greater than this value
+*/
+struct pa_memblockq* pa_memblockq_new(size_t maxlength,
+ size_t tlength,
+ size_t base,
+ size_t prebuf,
+ size_t minreq);
+void pa_memblockq_free(struct pa_memblockq*bq);
+
+/* Push a new memory chunk into the queue. Optionally specify a value for future cancellation. This is currently not implemented, however! */
+void pa_memblockq_push(struct pa_memblockq* bq, const struct pa_memchunk *chunk, size_t delta);
+
+/* Same as pa_memblockq_push(), however chunks are filtered through a mcalign object, and thus aligned to multiples of base */
+void pa_memblockq_push_align(struct pa_memblockq* bq, const struct pa_memchunk *chunk, size_t delta);
+
+/* Return a copy of the next memory chunk in the queue. It is not removed from the queue */
+int pa_memblockq_peek(struct pa_memblockq* bq, struct pa_memchunk *chunk);
+
+/* Drop the specified bytes from the queue */
+void pa_memblockq_drop(struct pa_memblockq *bq, size_t length);
+
+/* Shorten the pa_memblockq to the specified length by dropping data at the end of the queue */
+void pa_memblockq_shorten(struct pa_memblockq *bq, size_t length);
+
+/* Empty the pa_memblockq */
+void pa_memblockq_empty(struct pa_memblockq *bq);
+
+/* Test if the pa_memblockq is currently readable, that is, more data than base */
+int pa_memblockq_is_readable(struct pa_memblockq *bq);
+
+/* Test if the pa_memblockq is currently writable for the specified amount of bytes */
+int pa_memblockq_is_writable(struct pa_memblockq *bq, size_t length);
+
+/* The time memory chunks stay in the queue until they are removed completely in usecs */
+uint32_t pa_memblockq_get_delay(struct pa_memblockq *bq);
+
+/* Return the length of the queue in bytes */
+uint32_t pa_memblockq_get_length(struct pa_memblockq *bq);
+
+/* Return how many bytes are missing in queue to the specified fill amount */
+uint32_t pa_memblockq_missing(struct pa_memblockq *bq);
+
+
+uint32_t pa_memblockq_get_minreq(struct pa_memblockq *bq);
+
+#endif