OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 4 * Use of this source code is governed by a BSD-style license |
5 * that can be found in the LICENSE file in the root of the source | 5 * that can be found in the LICENSE file in the root of the source |
6 * tree. An additional intellectual property rights grant can be found | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 | 10 |
(...skipping 13 matching lines...) Expand all Loading... |
24 | 24 |
25 typedef struct RingBuffer { | 25 typedef struct RingBuffer { |
26 size_t read_pos; | 26 size_t read_pos; |
27 size_t write_pos; | 27 size_t write_pos; |
28 size_t element_count; | 28 size_t element_count; |
29 size_t element_size; | 29 size_t element_size; |
30 enum Wrap rw_wrap; | 30 enum Wrap rw_wrap; |
31 char* data; | 31 char* data; |
32 } RingBuffer; | 32 } RingBuffer; |
33 | 33 |
34 // Creates and initializes the buffer. Returns NULL on failure. | 34 // Creates and initializes the buffer. Returns null on failure. |
35 RingBuffer* WebRtc_CreateBuffer(size_t element_count, size_t element_size); | 35 RingBuffer* WebRtc_CreateBuffer(size_t element_count, size_t element_size); |
36 void WebRtc_InitBuffer(RingBuffer* handle); | 36 void WebRtc_InitBuffer(RingBuffer* handle); |
37 void WebRtc_FreeBuffer(void* handle); | 37 void WebRtc_FreeBuffer(void* handle); |
38 | 38 |
39 // Reads data from the buffer. The |data_ptr| will point to the address where | 39 // Reads data from the buffer. The |data_ptr| will point to the address where |
40 // it is located. If all |element_count| data are feasible to read without | 40 // it is located. If all |element_count| data are feasible to read without |
41 // buffer wrap around |data_ptr| will point to the location in the buffer. | 41 // buffer wrap around |data_ptr| will point to the location in the buffer. |
42 // Otherwise, the data will be copied to |data| (memory allocation done by the | 42 // Otherwise, the data will be copied to |data| (memory allocation done by the |
43 // user) and |data_ptr| points to the address of |data|. |data_ptr| is only | 43 // user) and |data_ptr| points to the address of |data|. |data_ptr| is only |
44 // guaranteed to be valid until the next call to WebRtc_WriteBuffer(). | 44 // guaranteed to be valid until the next call to WebRtc_WriteBuffer(). |
45 // | 45 // |
46 // To force a copying to |data|, pass a NULL |data_ptr|. | 46 // To force a copying to |data|, pass a null |data_ptr|. |
47 // | 47 // |
48 // Returns number of elements read. | 48 // Returns number of elements read. |
49 size_t WebRtc_ReadBuffer(RingBuffer* handle, | 49 size_t WebRtc_ReadBuffer(RingBuffer* handle, |
50 void** data_ptr, | 50 void** data_ptr, |
51 void* data, | 51 void* data, |
52 size_t element_count); | 52 size_t element_count); |
53 | 53 |
54 // Writes |data| to buffer and returns the number of elements written. | 54 // Writes |data| to buffer and returns the number of elements written. |
55 size_t WebRtc_WriteBuffer(RingBuffer* handle, const void* data, | 55 size_t WebRtc_WriteBuffer(RingBuffer* handle, const void* data, |
56 size_t element_count); | 56 size_t element_count); |
57 | 57 |
58 // Moves the buffer read position and returns the number of elements moved. | 58 // Moves the buffer read position and returns the number of elements moved. |
59 // Positive |element_count| moves the read position towards the write position, | 59 // Positive |element_count| moves the read position towards the write position, |
60 // that is, flushing the buffer. Negative |element_count| moves the read | 60 // that is, flushing the buffer. Negative |element_count| moves the read |
61 // position away from the the write position, that is, stuffing the buffer. | 61 // position away from the the write position, that is, stuffing the buffer. |
62 // Returns number of elements moved. | 62 // Returns number of elements moved. |
63 int WebRtc_MoveReadPtr(RingBuffer* handle, int element_count); | 63 int WebRtc_MoveReadPtr(RingBuffer* handle, int element_count); |
64 | 64 |
65 // Returns number of available elements to read. | 65 // Returns number of available elements to read. |
66 size_t WebRtc_available_read(const RingBuffer* handle); | 66 size_t WebRtc_available_read(const RingBuffer* handle); |
67 | 67 |
68 // Returns number of available elements for write. | 68 // Returns number of available elements for write. |
69 size_t WebRtc_available_write(const RingBuffer* handle); | 69 size_t WebRtc_available_write(const RingBuffer* handle); |
70 | 70 |
71 #ifdef __cplusplus | 71 #ifdef __cplusplus |
72 } | 72 } |
73 #endif | 73 #endif |
74 | 74 |
75 #endif // WEBRTC_COMMON_AUDIO_RING_BUFFER_H_ | 75 #endif // WEBRTC_COMMON_AUDIO_RING_BUFFER_H_ |
OLD | NEW |