Changeset 3435 for pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia/jbuf.h

Timestamp:

Mar 2, 2011 8:37:31 AM (13 years ago)

Author:

nanang

Message:

Re #1182:

• Added remote frame-rate detection in to video stream.
• Fixed bitrate settings in ffmpeg codec.
• Fixed SDL dev to update internal SDL info when format changed.
• Minor fixes/updates, e.g:
  • added cleanup steps, fixed logs, etc, in sample app simpleua.c and vid_streamutil.c
  • fixed/added docs of the new APIs in the jitter buffer.

File:

• pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia/jbuf.h (modified) (2 diffs)

pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia/jbuf.h

@@ -327 +327 @@
 
 
+/**
+ * Get a frame from the jitter buffer. The jitter buffer will return the
+ * oldest frame from it's buffer, when it is available.
+ *
+ * @param jb            The jitter buffer.
+ * @param frame         Buffer to receive the payload from the jitter buffer.
+ *                      @see pjmedia_jbuf_get_frame().    
+ * @param size          Pointer to receive frame size.
+ * @param p_frm_type    Pointer to receive frame type.
+ *                      @see pjmedia_jbuf_get_frame().    
+ * @param bit_info      Bit precise info of the frame, e.g: a frame may not 
+ *                      exactly start and end at the octet boundary, so this
+ *                      field may be used for specifying start & end bit offset.
+ * @param ts            Frame timestamp.
+ * @param seq           Frame sequence number.
+ */
 PJ_DECL(void) pjmedia_jbuf_get_frame3(pjmedia_jbuf *jb, 
                                       void *frame, 
@@ -332 +348 @@
                                       char *p_frm_type,
                                       pj_uint32_t *bit_info,
-                                      pj_uint32_t *ts);
-
+                                      pj_uint32_t *ts,
+                                      int *seq);
+
+
+/**
+ * Peek a frame from the jitter buffer. The jitter buffer state will not be
+ * modified.
+ *
+ * @param jb            The jitter buffer.
+ * @param offset        Offset from the oldest frame to be peeked.
+ * @param frame         Buffer to receive the payload from the jitter buffer.
+ *                      @see pjmedia_jbuf_get_frame().    
+ * @param size          Pointer to receive frame size.
+ * @param p_frm_type    Pointer to receive frame type.
+ *                      @see pjmedia_jbuf_get_frame().    
+ * @param bit_info      Bit precise info of the frame, e.g: a frame may not 
+ *                      exactly start and end at the octet boundary, so this
+ *                      field may be used for specifying start & end bit offset.
+ * @param ts            Frame timestamp.
+ * @param seq           Frame sequence number.
+ */
 PJ_DECL(void) pjmedia_jbuf_peek_frame(pjmedia_jbuf *jb,
-                                      unsigned idx,
+                                      unsigned offset,
                                       const void **frame, 
                                       pj_size_t *size, 
                                       char *p_frm_type,
                                       pj_uint32_t *bit_info,
-                                      pj_uint32_t *ts);
-
+                                      pj_uint32_t *ts,
+                                      int *seq);
+
+
+/**
+ * Remove frames from the jitter buffer.
+ *
+ * @param jb            The jitter buffer.
+ * @param frame_cnt     Number of frames to be removed.
+ *
+ * @return              The number of frame successfully removed.
+ */
 PJ_DECL(unsigned) pjmedia_jbuf_remove_frame(pjmedia_jbuf *jb, 
                                             unsigned frame_cnt);