]> code.delx.au - pulseaudio/blobdiff - src/pulsecore/memchunk.h
remap: Change remapping function argument type from void to int16_t / float as approp...
[pulseaudio] / src / pulsecore / memchunk.h
index 2e2f936bbc54a6d46d67d76a202af7751381e086..6dccaed77a58d44edb440c66856521cd93e9da8a 100644 (file)
@@ -1,11 +1,11 @@
 #ifndef foomemchunkhfoo
 #define foomemchunkhfoo
 
-/* $Id$ */
-
 /***
   This file is part of PulseAudio.
 
+  Copyright 2004-2006 Lennart Poettering
+
   PulseAudio is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   USA.
 ***/
 
+typedef struct pa_memchunk pa_memchunk;
+
 #include <pulsecore/memblock.h>
 
 /* A memchunk describes a part of a memblock. In contrast to the memblock, a
  * memchunk is not allocated dynamically or reference counted, instead
  * it is usually stored on the stack and copied around */
 
-typedef struct pa_memchunk {
+struct pa_memchunk {
     pa_memblock *memblock;
     size_t index, length;
-} pa_memchunk;
+};
 
 /* Make a memchunk writable, i.e. make sure that the caller may have
- * exclusive access to the memblock and it is not read_only. If needed
- * the memblock in the structure is replaced by a copy. */
-void pa_memchunk_make_writable(pa_memchunk *c, size_t min);
+ * exclusive access to the memblock and it is not read-only. If needed
+ * the memblock in the structure is replaced by a copy. If min is not
+ * 0 it is made sure that the returned memblock is at least of the
+ * specified size, i.e. is enlarged if necessary. */
+pa_memchunk* pa_memchunk_make_writable(pa_memchunk *c, size_t min);
 
-/* Invalidate a memchunk. This does not free the cotaining memblock,
+/* Invalidate a memchunk. This does not free the containing memblock,
  * but sets all members to zero. */
-void pa_memchunk_reset(pa_memchunk *c);
+pa_memchunk* pa_memchunk_reset(pa_memchunk *c);
+
+/* Map a memory chunk back into memory if it was swapped out */
+pa_memchunk *pa_memchunk_will_need(const pa_memchunk *c);
+
+/* Copy the data in the src memchunk to the dst memchunk */
+pa_memchunk* pa_memchunk_memcpy(pa_memchunk *dst, pa_memchunk *src);
+
+/* Return true if any field is set != 0 */
+bool pa_memchunk_isset(pa_memchunk *c);
 
 #endif