Blame src/TPCircularBuffer/README.markdown

Packit Service c56139
A simple, fast circular buffer implementation for audio processing
Packit Service c56139
==================================================================
Packit Service c56139
Packit Service c56139
A simple C implementation for a circular (ring) buffer. Thread-safe with a single producer and a single consumer, using OSAtomic.h primitives, and avoids any need for buffer wrapping logic by using a virtual memory map technique to place a virtual copy of the buffer straight after the end of the real buffer.
Packit Service c56139
Packit Service c56139
Usage
Packit Service c56139
-----
Packit Service c56139
Packit Service c56139
Initialisation and cleanup: `TPCircularBufferInit` and `TPCircularBufferCleanup` to allocate and free resources.
Packit Service c56139
Packit Service c56139
Producing: Use `TPCircularBufferHead` to get a pointer to write to the buffer, followed by `TPCircularBufferProduce` to submit the written data.  `TPCircularBufferProduceBytes` is a convenience routine for writing data straight to the buffer.
Packit Service c56139
Packit Service c56139
Consuming: Use `TPCircularBufferTail` to get a pointer to the next data to read, followed by `TPCircularBufferConsume` to free up the space once processed.
Packit Service c56139
Packit Service c56139
TPCircularBuffer+AudioBufferList.(c,h) contain helper functions to queue and dequeue AudioBufferList
Packit Service c56139
structures. These will automatically adjust the mData fields of each buffer to point to 16-byte aligned
Packit Service c56139
regions within the circular buffer.
Packit Service c56139
Packit Service c56139
Thread safety
Packit Service c56139
-------------
Packit Service c56139
Packit Service c56139
As long as you restrict multithreaded access to just one producer, and just one consumer, this utility should be thread safe. 
Packit Service c56139
Packit Service c56139
Only one shared variable is used (the buffer fill count), and OSAtomic primitives are used to write to this value to ensure atomicity.
Packit Service c56139
Packit Service c56139
License
Packit Service c56139
-------
Packit Service c56139
Packit Service c56139
Copyright (C) 2012-2013 A Tasty Pixel
Packit Service c56139
Packit Service c56139
This software is provided 'as-is', without any express or implied
Packit Service c56139
warranty.  In no event will the authors be held liable for any damages
Packit Service c56139
arising from the use of this software.
Packit Service c56139
Packit Service c56139
Permission is granted to anyone to use this software for any purpose,
Packit Service c56139
including commercial applications, and to alter it and redistribute it
Packit Service c56139
freely, subject to the following restrictions:
Packit Service c56139
Packit Service c56139
1. The origin of this software must not be misrepresented; you must not
Packit Service c56139
   claim that you wrote the original software. If you use this software
Packit Service c56139
   in a product, an acknowledgment in the product documentation would be
Packit Service c56139
   appreciated but is not required.
Packit Service c56139
   
Packit Service c56139
2. Altered source versions must be plainly marked as such, and must not be
Packit Service c56139
   misrepresented as being the original software.
Packit Service c56139
   
Packit Service c56139
3. This notice may not be removed or altered from any source distribution.
Packit Service c56139
Packit Service c56139
Packit Service c56139
-----------------------------------------------------
Packit Service c56139
Packit Service c56139
Virtual memory technique originally proposed by [Philip Howard](http://vrb.slashusr.org/), and [adapted to Darwin](http://www.snoize.com/Code/PlayBufferedSoundFile.tar.gz) by [Kurt Revis](http://www.snoize.com)
Packit Service c56139
Packit Service c56139
See more info at [atastypixel.com](http://atastypixel.com/blog/a-simple-fast-circular-buffer-implementation-for-audio-processing/)
Packit Service c56139