RingBuffer.cs 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. /*
  2. * Copyright (c) Meta Platforms, Inc. and affiliates.
  3. * All rights reserved.
  4. *
  5. * This source code is licensed under the license found in the
  6. * LICENSE file in the root directory of this source tree.
  7. */
  8. using System;
  9. using UnityEngine;
  10. namespace Meta.WitAi.Data
  11. {
  12. public class RingBuffer<T>
  13. {
  14. public delegate void OnDataAdded(T[] data, int offset, int length);
  15. public delegate void ByteDataWriter(T[] buffer, int offset, int length);
  16. public OnDataAdded OnDataAddedEvent;
  17. private readonly T[] buffer;
  18. private int bufferIndex;
  19. private long bufferDataLength;
  20. public int Capacity => buffer.Length;
  21. public int GetBufferArrayIndex(long bufferDataIndex)
  22. {
  23. if (bufferDataLength <= bufferDataIndex) return -1;
  24. if (bufferDataLength - bufferDataIndex > buffer.Length) return -1;
  25. var endOffset = bufferDataLength - bufferDataIndex;
  26. var index = bufferIndex - endOffset;
  27. if (index < 0) index = buffer.Length + index;
  28. return (int) index;
  29. }
  30. public T this[long bufferDataIndex] => buffer[GetBufferArrayIndex(bufferDataIndex)];
  31. public void Clear(bool eraseData = false)
  32. {
  33. bufferIndex = 0;
  34. bufferDataLength = 0;
  35. if (eraseData)
  36. {
  37. for (int i = 0; i < buffer.Length; i++)
  38. {
  39. buffer[i] = default;
  40. }
  41. }
  42. }
  43. public class Marker
  44. {
  45. private long bufferDataIndex;
  46. private int index;
  47. private readonly RingBuffer<T> ringBuffer;
  48. public RingBuffer<T> RingBuffer => ringBuffer;
  49. public Marker(RingBuffer<T> ringBuffer, long markerPosition, int bufIndex)
  50. {
  51. this.ringBuffer = ringBuffer;
  52. bufferDataIndex = markerPosition;
  53. index = bufIndex;
  54. }
  55. public bool IsValid => ringBuffer.bufferDataLength - bufferDataIndex <= ringBuffer.Capacity;
  56. public long AvailableByteCount => Math.Min(ringBuffer.Capacity, RequestedByteCount);
  57. public long RequestedByteCount => ringBuffer.bufferDataLength - bufferDataIndex;
  58. public long CurrentBufferDataIndex => bufferDataIndex;
  59. public int Read(T[] buffer, int offset, int length, bool skipToNextValid = false)
  60. {
  61. int read = -1;
  62. if (!IsValid && skipToNextValid && ringBuffer.bufferDataLength > ringBuffer.Capacity)
  63. {
  64. bufferDataIndex = ringBuffer.bufferDataLength - ringBuffer.Capacity;
  65. }
  66. if (IsValid)
  67. {
  68. read = this.ringBuffer.Read(buffer, offset, length, bufferDataIndex);
  69. bufferDataIndex += read;
  70. index += read;
  71. if (index > buffer.Length) index -= buffer.Length;
  72. }
  73. return read;
  74. }
  75. public void ReadIntoWriters(params ByteDataWriter[] writers)
  76. {
  77. if (!IsValid && ringBuffer.bufferDataLength > ringBuffer.Capacity)
  78. {
  79. bufferDataIndex = ringBuffer.bufferDataLength - ringBuffer.Capacity;
  80. }
  81. index = ringBuffer.GetBufferArrayIndex(bufferDataIndex);
  82. var length = (int) (ringBuffer.bufferDataLength - bufferDataIndex);
  83. if (IsValid && length > 0)
  84. {
  85. for (int i = 0; i < writers.Length; i++)
  86. {
  87. ringBuffer.WriteFromBuffer(writers[i], index, length);
  88. }
  89. }
  90. bufferDataIndex += length;
  91. index = ringBuffer.GetBufferArrayIndex(bufferDataIndex);
  92. }
  93. public Marker Clone()
  94. {
  95. return new Marker(ringBuffer, bufferDataIndex, index);
  96. }
  97. public void Offset(int amount)
  98. {
  99. bufferDataIndex += amount;
  100. if (bufferDataIndex < 0) bufferDataIndex = 0;
  101. if (bufferDataIndex > ringBuffer.bufferDataLength)
  102. {
  103. bufferDataIndex = ringBuffer.bufferDataLength;
  104. }
  105. index = ringBuffer.GetBufferArrayIndex(bufferDataIndex);
  106. }
  107. }
  108. public RingBuffer(int capacity)
  109. {
  110. buffer = new T[capacity];
  111. }
  112. private int CopyToBuffer(T[] data, int offset, int length, int bufferIndex)
  113. {
  114. if (length > buffer.Length)
  115. throw new ArgumentException(
  116. "Push data exceeds buffer size.");
  117. if (bufferIndex + length < buffer.Length)
  118. {
  119. Array.Copy(data, offset, buffer, bufferIndex, length);
  120. return bufferIndex + length;
  121. }
  122. else
  123. {
  124. int len = Mathf.Min(length, buffer.Length);
  125. int endChunkLength = buffer.Length - bufferIndex;
  126. int wrappedChunkLength = len - endChunkLength;
  127. try
  128. {
  129. Array.Copy(data, offset, buffer, bufferIndex, endChunkLength);
  130. Array.Copy(data, offset + endChunkLength, buffer, 0, wrappedChunkLength);
  131. return wrappedChunkLength;
  132. }
  133. catch (ArgumentException e)
  134. {
  135. throw e;
  136. }
  137. }
  138. }
  139. public void WriteFromBuffer(ByteDataWriter writer, long bufferIndex, int length)
  140. {
  141. lock (buffer)
  142. {
  143. if (bufferIndex + length < buffer.Length)
  144. {
  145. writer(buffer, (int) bufferIndex, length);
  146. }
  147. else
  148. {
  149. if (length > bufferDataLength)
  150. {
  151. length = (int) (bufferDataLength - bufferIndex);
  152. }
  153. if (length > buffer.Length)
  154. {
  155. length = buffer.Length;
  156. }
  157. var l = Math.Min(buffer.Length, length);
  158. int endChunkLength = (int) (buffer.Length - bufferIndex);
  159. int wrappedChunkLength = l - endChunkLength;
  160. writer(buffer, (int) bufferIndex, endChunkLength);
  161. writer(buffer, 0, wrappedChunkLength);
  162. }
  163. }
  164. }
  165. private int CopyFromBuffer(T[] data, int offset, int length, int bufferIndex)
  166. {
  167. if (length > buffer.Length)
  168. throw new ArgumentException(
  169. $"Push data exceeds buffer size {length} < {buffer.Length}" );
  170. if (bufferIndex + length < buffer.Length)
  171. {
  172. Array.Copy(buffer, bufferIndex, data, offset, length);
  173. return bufferIndex + length;
  174. }
  175. else
  176. {
  177. var l = Mathf.Min(buffer.Length, length);
  178. int endChunkLength = buffer.Length - bufferIndex;
  179. int wrappedChunkLength = l - endChunkLength;
  180. Array.Copy(buffer, bufferIndex, data, offset, endChunkLength);
  181. Array.Copy(buffer, 0, data, offset + endChunkLength, wrappedChunkLength);
  182. return wrappedChunkLength;
  183. }
  184. }
  185. public void Push(T[] data, int offset, int length)
  186. {
  187. lock (buffer)
  188. {
  189. bufferIndex = CopyToBuffer(data, offset, length, bufferIndex);
  190. bufferDataLength += length;
  191. OnDataAddedEvent?.Invoke(data, offset, length);
  192. }
  193. }
  194. public void Push(T data)
  195. {
  196. lock (buffer)
  197. {
  198. buffer[bufferIndex++] = data;
  199. if (bufferIndex >= buffer.Length)
  200. {
  201. bufferIndex = 0;
  202. }
  203. bufferDataLength++;
  204. }
  205. }
  206. public int Read(T[] data, int offset, int length, long bufferDataIndex)
  207. {
  208. if (bufferIndex == 0 && bufferDataLength == 0) // The ring buffer has been cleared.
  209. {
  210. return 0;
  211. }
  212. lock (buffer)
  213. {
  214. int read = (int) (Math.Min(bufferDataIndex + length, bufferDataLength) -
  215. bufferDataIndex);
  216. int bufferIndex = this.bufferIndex - (int) (bufferDataLength - bufferDataIndex);
  217. if (bufferIndex < 0)
  218. {
  219. bufferIndex = buffer.Length + bufferIndex;
  220. }
  221. CopyFromBuffer(data, offset, length, bufferIndex);
  222. return read;
  223. }
  224. }
  225. public Marker CreateMarker(int offset = 0)
  226. {
  227. var markerPosition = bufferDataLength + offset;
  228. if (markerPosition < 0)
  229. {
  230. markerPosition = 0;
  231. }
  232. int bufIndex = bufferIndex + offset;
  233. if (bufIndex < 0)
  234. {
  235. bufIndex = buffer.Length + bufIndex;
  236. }
  237. if (bufIndex > buffer.Length)
  238. {
  239. bufIndex -= buffer.Length;
  240. }
  241. var marker = new Marker(this, markerPosition, bufIndex);
  242. return marker;
  243. }
  244. }
  245. }