Changeset 904 for pjproject/trunk/pjmedia/include/pjmedia/tonegen.h

Timestamp:

Jan 24, 2007 2:02:09 AM (17 years ago)

Author:

bennylp

Message:

Implement ticket #62: option to play tones continuously, and added --play-tone option in pjsua

File:

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

pjproject/trunk/pjmedia/include/pjmedia/tonegen.h

@@ -99 +99 @@
 
 
+/**
+ * Tone generator options.
+ */
+enum
+{
+    /**
+     * Play the tones in loop, restarting playing the first tone after
+     * the last tone has been played.
+     */
+    PJMEDIA_TONEGEN_LOOP    = 1
+};
+
 
 /**
@@ -112 +124 @@
  * @param bits_per_sample   Number of bits per sample. This version of PJMEDIA
  *                          only supports 16bit per sample.
- * @param options           Option flags, must be zero for now.
+ * @param options           Option flags. Application may specify 
+ *                          PJMEDIA_TONEGEN_LOOP to play the tone in a loop.
  * @param p_port            Pointer to receive the port instance.
  *
@@ -128 +141 @@
 
 /**
+ * Create an instance of tone generator with the specified parameters.
+ * When the tone generator is first created, it will be loaded with the
+ * default digit map.
+ *
+ * @param pool              Pool to allocate memory for the port structure.
+ * @param name              Optional name for the tone generator.
+ * @param clock_rate        Sampling rate.
+ * @param channel_count     Number of channels. Currently only mono and stereo
+ *                          are supported.
+ * @param samples_per_frame Number of samples per frame.
+ * @param bits_per_sample   Number of bits per sample. This version of PJMEDIA
+ *                          only supports 16bit per sample.
+ * @param options           Option flags. Application may specify 
+ *                          PJMEDIA_TONEGEN_LOOP to play the tone in a loop.
+ * @param p_port            Pointer to receive the port instance.
+ *
+ * @return                  PJ_SUCCESS on success, or the appropriate
+ *                          error code.
+ */
+PJ_DECL(pj_status_t) pjmedia_tonegen_create2(pj_pool_t *pool,
+                                             const pj_str_t *name,
+                                             unsigned clock_rate,
+                                             unsigned channel_count,
+                                             unsigned samples_per_frame,
+                                             unsigned bits_per_sample,
+                                             unsigned options,
+                                             pjmedia_port **p_port);
+
+
+/**
  * Check if the tone generator is still busy producing some tones.
  *
@@ -157 +200 @@
  * @param count             The number of tones in the array.
  * @param tones             Array of tones to be played.
- * @param options           Playback options, must be zero for now.
+ * @param options           Option flags. Application may specify 
+ *                          PJMEDIA_TONEGEN_LOOP to play the tone in a loop.
  *
  * @return                  PJ_SUCCESS on success, or PJ_ETOOMANY if
@@ -179 +223 @@
  * @param count             Number of digits in the array.
  * @param digits            Array of MF digits.
- * @param options           Playback options, must be zero for now.
+ * @param options           Option flags. Application may specify 
+ *                          PJMEDIA_TONEGEN_LOOP to play the tone in a loop.
  *
  * @return                  PJ_SUCCESS on success, or PJ_ETOOMANY if