Changeset 631 for pjproject/trunk/pjmedia/include/pjmedia/splitcomb.h

Timestamp:

Jul 27, 2006 10:03:51 PM (17 years ago)

Author:

bennylp

Message:

• Added splitter/combiner port (splitcomb.c)
• Added function to initialize pjmedia_port_info (still unused though)

File:

• pjproject/trunk/pjmedia/include/pjmedia/splitcomb.h (modified) (5 diffs)

pjproject/trunk/pjmedia/include/pjmedia/splitcomb.h

@@ -25 +25 @@
  * @brief Media channel splitter/combiner port.
  */
-#include <pjmedia/types.h>
+#include <pjmedia/port.h>
 
 
@@ -35 +35 @@
  * This section describes media port to split and combine media
  * channels in the stream.
+ *
+ * A splitter/combiner splits a single stereo/multichannels audio frame into
+ * multiple audio frames to each channel when put_frame() is called, 
+ * and combines mono frames from each channel into a stereo/multichannel 
+ * frame when get_frame() is called. A common application for the splitter/
+ * combiner is to split frames from stereo to mono and vise versa.
  */
 
@@ -42 +48 @@
 /**
  * Create a media splitter/combiner with the specified parameters.
- * A splitter/combiner splits a single stereo/multichannel audio frame into
- * multiple mono audio frames to each channel when put_frame() is called, 
- * and combines mono frames from each channel into a stereo/multichannel 
- * frame when get_frame() is called.
- *
  * When the splitter/combiner is created, it creates an instance of
  * pjmedia_port. This media port represents the stereo/multichannel side
@@ -80 +81 @@
  *
  * @param splitcomb         The splitter/combiner.
- * @param ch_num            Audio channel number.
- * @param options           Valid options are:
- *                          - PJMEDIA_SPLITCOMB_AUTO_DESTROY to destroy the
- *                            media port when the splitter is destroyed.
+ * @param ch_num            Audio channel starting number (zero based).
+ * @param options           Must be zero at the moment.
  * @param port              The media port.
  *
@@ -108 +107 @@
  *                          buffers.
  * @param splitcomb         The splitter/combiner.
- * @param ch_num            Audio channel number.
- * @param options           Valid options are:
- *                          - PJMEDIA_SPLITCOMB_AUTO_DESTROY to destroy the
- *                            media port when the splitter is destroyed.
+ * @param ch_num            Audio channel starting number (zero based).
+ * @param options           Normally is zero, but the lower 8-bit of the 
+ *                          options can be used to specify the number of 
+ *                          buffers in the circular buffer. If zero, then
+ *                          default number will be used (default: 8).
  * @param p_chport          The media port created with reverse phase for
  *                          the specified audio channel.