Changeset 631 for pjproject/trunk

Timestamp:

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

Author:

bennylp

Message:

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

Location:

pjproject/trunk/pjmedia

Files:

• build/Makefile (modified) (1 diff)
• build/pjmedia.dsp (modified) (1 diff)
• include/pjmedia/port.h (modified) (3 diffs)
• include/pjmedia/splitcomb.h (modified) (5 diffs)
• src/pjmedia/port.c (modified) (1 diff)
• src/pjmedia/splitcomb.c (added)

pjproject/trunk/pjmedia/build/Makefile

@@ -69 +69 @@
                         g711.o jbuf.o master_port.o mem_capture.o mem_player.o \
                         null_port.o plc_common.o plc_g711.o \
-                        port.o resample.o \
+                        port.o splitcomb.o resample.o \
                         resample_port.o rtcp.o rtp.o sdp.o sdp_cmp.o sdp_neg.o \
                         session.o silencedet.o sound_port.o stream.o \

pjproject/trunk/pjmedia/build/pjmedia.dsp

@@ -200 +200 @@
 # Begin Source File
 
+SOURCE=..\src\pjmedia\splitcomb.c
+# End Source File
+# Begin Source File
+
 SOURCE=..\src\pjmedia\stream.c
 # End Source File

pjproject/trunk/pjmedia/include/pjmedia/port.h

@@ -357 +357 @@
 
 /**
+ * This is an auxiliary function to initialize port info for
+ * ports which deal with PCM audio.
+ *
+ * @param info              The port info to be initialized.
+ * @param name              Port name.
+ * @param signature         Port signature.
+ * @param channel_count     Number of channels.
+ * @param bits_per_sample   Bits per sample.
+ * @param samples_per_frame Number of samples per frame.
+ *
+ * @return                  PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_port_info_init( pjmedia_port_info *info,
+                                             const pj_str_t *name,
+                                             unsigned signature,
+                                             unsigned clock_rate,
+                                             unsigned channel_count,
+                                             unsigned bits_per_sample,
+                                             unsigned samples_per_frame);
+
+
+/**
  * Get a frame from the port (and subsequent downstream ports).
+ *
+ * @param port      The media port.
+ * @param frame     Frame to store samples.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_port_get_frame( pjmedia_port *port,
@@ -364 +391 @@
 /**
  * Put a frame to the port (and subsequent downstream ports).
+ *
+ * @param port      The media port.
+ * @param frame     Frame to the put to the port.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_port_put_frame( pjmedia_port *port,
@@ -371 +403 @@
 /**
  * Destroy port (and subsequent downstream ports)
+ *
+ * @param port      The media port.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjmedia_port_destroy( pjmedia_port *port );

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.

pjproject/trunk/pjmedia/src/pjmedia/port.c

@@ -23 +23 @@
 
 #define THIS_FILE       "port.c"
+
+
+/**
+ * This is an auxiliary function to initialize port info for
+ * ports which deal with PCM audio.
+ */
+PJ_DEF(pj_status_t) pjmedia_port_info_init( pjmedia_port_info *info,
+                                            const pj_str_t *name,
+                                            unsigned signature,
+                                            unsigned clock_rate,
+                                            unsigned channel_count,
+                                            unsigned bits_per_sample,
+                                            unsigned samples_per_frame)
+{
+    pj_bzero(info, sizeof(*info));
+
+    info->name = *name;
+    info->signature = signature;
+    info->type = PJMEDIA_TYPE_AUDIO;
+    info->has_info = PJ_TRUE;
+    info->need_info = PJ_FALSE;
+    info->pt = 0xFF;
+    info->encoding_name = pj_str("pcm");
+    info->clock_rate = clock_rate;
+    info->channel_count = channel_count;
+    info->bits_per_sample = bits_per_sample;
+    info->samples_per_frame = samples_per_frame;
+    info->bytes_per_frame = samples_per_frame * bits_per_sample / 8;
+
+    return PJ_SUCCESS;
+}