Changeset 2114 for pjproject/trunk/pjmedia/include/pjmedia/circbuf.h

Timestamp:

Jul 10, 2008 10:46:34 AM (16 years ago)

Author:

nanang

Message:

Added two APIs to pjmedia circular buffer: copy & pack buffer

File:

• pjproject/trunk/pjmedia/include/pjmedia/circbuf.h (modified) (8 diffs)

pjproject/trunk/pjmedia/include/pjmedia/circbuf.h

@@ -18 +18 @@
  */
 
-#ifndef pjmedia_circ_buf_H
-#define pjmedia_circ_buf_H
+#ifndef __PJMEDIA_CIRC_BUF_H__
+#define __PJMEDIA_CIRC_BUF_H__
 
 /**
@@ -151 +151 @@
  *                          possitive number, in samples.
  *
- * @return                  PJ_SUCCESS when successful, otherwise the appropriate 
- *                          error will be returned.
+ * @return                  PJ_SUCCESS when successful, otherwise 
+ *                          the appropriate error will be returned.
  */
 PJ_INLINE(pj_status_t) pjmedia_circ_buf_adv_read_ptr(pjmedia_circ_buf *circbuf, 
@@ -180 +180 @@
  *                          possitive number, in samples.
  *
- * @return                  PJ_SUCCESS when successful, otherwise the appropriate 
- *                          error will be returned.
+ * @return                  PJ_SUCCESS when successful, otherwise 
+ *                          the appropriate error will be returned.
  */
 PJ_INLINE(pj_status_t) pjmedia_circ_buf_adv_write_ptr(pjmedia_circ_buf *circbuf,
@@ -223 +223 @@
     }
 
-    PJMEDIA_CIRC_BUF_CHECK(*reg1_len != 0 || (*reg1_len == 0 && circbuf->len == 0));
+    PJMEDIA_CIRC_BUF_CHECK(*reg1_len != 0 || (*reg1_len == 0 && 
+                                              circbuf->len == 0));
     PJMEDIA_CIRC_BUF_CHECK(*reg1_len + *reg2_len == circbuf->len);
 }
@@ -258 +259 @@
     }
 
-    PJMEDIA_CIRC_BUF_CHECK(*reg1_len != 0 || (*reg1_len == 0 && circbuf->len == 0));
-    PJMEDIA_CIRC_BUF_CHECK(*reg1_len + *reg2_len == circbuf->capacity - circbuf->len);
+    PJMEDIA_CIRC_BUF_CHECK(*reg1_len != 0 || (*reg1_len == 0 && 
+                                              circbuf->len == 0));
+    PJMEDIA_CIRC_BUF_CHECK(*reg1_len + *reg2_len == circbuf->capacity - 
+                           circbuf->len);
 }
 
@@ -270 +273 @@
  * @param count             Number of samples being read.
  *
- * @return                  PJ_SUCCESS when successful, otherwise the appropriate 
- *                          error will be returned.
+ * @return                  PJ_SUCCESS when successful, otherwise 
+ *                          the appropriate error will be returned.
  */
 PJ_INLINE(pj_status_t) pjmedia_circ_buf_read(pjmedia_circ_buf *circbuf, 
@@ -304 +307 @@
  * @param count             Number of samples being written.
  *
- * @return                  PJ_SUCCESS when successful, otherwise the appropriate 
- *                          error will be returned.
+ * @return                  PJ_SUCCESS when successful, otherwise
+ *                          the appropriate error will be returned.
  */
 PJ_INLINE(pj_status_t) pjmedia_circ_buf_write(pjmedia_circ_buf *circbuf, 
@@ -330 +333 @@
 }
 
+
+/**
+ * Copy audio samples from the circular buffer without changing its state. 
+ *
+ * @param circbuf           The circular buffer.
+ * @param start_idx         Starting sample index to be copied.
+ * @param data              Buffer to store the read audio samples.
+ * @param count             Number of samples being read.
+ *
+ * @return                  PJ_SUCCESS when successful, otherwise 
+ *                          the appropriate error will be returned.
+ */
+PJ_INLINE(pj_status_t) pjmedia_circ_buf_copy(pjmedia_circ_buf *circbuf, 
+                                             unsigned start_idx,
+                                             pj_int16_t *data, 
+                                             unsigned count)
+{
+    pj_int16_t *reg1, *reg2;
+    unsigned reg1cnt, reg2cnt;
+
+    /* Data in the buffer is less than requested */
+    if (count + start_idx > circbuf->len)
+        return PJ_ETOOBIG;
+
+    pjmedia_circ_buf_get_read_regions(circbuf, &reg1, &reg1cnt, 
+                                      &reg2, &reg2cnt);
+    if (reg1cnt > start_idx) {
+        unsigned tmp_len;
+        tmp_len = reg1cnt - start_idx;
+        if (tmp_len > count)
+            tmp_len = count;
+        pjmedia_copy_samples(data, reg1 + start_idx, tmp_len);
+        if (tmp_len < count)
+            pjmedia_copy_samples(data + tmp_len, reg2, count - tmp_len);
+    } else {
+        pjmedia_copy_samples(data, reg2 + start_idx - reg1cnt, count);
+    }
+
+    return PJ_SUCCESS;
+}
+
+
+/**
+ * Pack the buffer so the first sample will be in the beginning of the buffer.
+ * This will also make the buffer contiguous.
+ *
+ * @param circbuf           The circular buffer.
+ *
+ * @return                  PJ_SUCCESS when successful, otherwise 
+ *                          the appropriate error will be returned.
+ */
+PJ_INLINE(pj_status_t) pjmedia_circ_buf_pack_buffer(pjmedia_circ_buf *circbuf)
+{
+    pj_int16_t *reg1, *reg2;
+    unsigned reg1cnt, reg2cnt;
+    unsigned gap;
+
+    pjmedia_circ_buf_get_read_regions(circbuf, &reg1, &reg1cnt, 
+                                      &reg2, &reg2cnt);
+
+    /* Check if not contigue */
+    if (reg2cnt != 0) {
+        /* Check if no space left to roll the buffer 
+         * (or should this function provide temporary buffer?)
+         */
+        gap = circbuf->capacity - pjmedia_circ_buf_get_len(circbuf);
+        if (gap == 0)
+            return PJ_ETOOBIG;
+
+        /* Roll buffer left using the gap until reg2cnt == 0 */
+        do {
+            if (gap > reg2cnt)
+                gap = reg2cnt;
+            pjmedia_move_samples(reg1 - gap, reg1, reg1cnt);
+            pjmedia_copy_samples(reg1 + reg1cnt - gap, reg2, gap);
+            if (gap < reg2cnt)
+                pjmedia_move_samples(reg2, reg2 + gap, reg2cnt - gap);
+            reg1 -= gap;
+            reg1cnt += gap;
+            reg2cnt -= gap;
+        } while (reg2cnt > 0);
+    }
+
+    /* Finally, Shift samples to the left edge */
+    if (reg1 != circbuf->buf)
+        pjmedia_move_samples(circbuf->buf, reg1, 
+                             pjmedia_circ_buf_get_len(circbuf));
+    circbuf->start = circbuf->buf;
+
+    return PJ_SUCCESS;
+}
+
+
 PJ_END_DECL