Changeset 452 for pjproject/trunk/pjmedia/include/pjmedia/stream.h

Timestamp:

May 17, 2006 5:17:39 PM (18 years ago)

Author:

bennylp

Message:

Major modification in pjmedia to split stream transport into separate functionality, to allow using custom transports with streams

File:

• pjproject/trunk/pjmedia/include/pjmedia/stream.h (modified) (6 diffs)

pjproject/trunk/pjmedia/include/pjmedia/stream.h

@@ -70 +70 @@
     pjmedia_type        type;       /**< Media type (audio, video)          */
     pjmedia_dir         dir;        /**< Media direction.                   */
-    pjmedia_sock_info   sock_info;  /**< Media transport (RTP/RTCP sockets) */
     pj_sockaddr_in      rem_addr;   /**< Remote RTP address                 */
     pjmedia_codec_info  fmt;        /**< Incoming codec format info.        */
@@ -101 +100 @@
 
 /**
+ * @see pjmedia_transport_op.
+ */
+typedef struct pjmedia_transport pjmedia_transport;
+
+
+/**
+ * This structure describes the operations for the stream transport.
+ */
+struct pjmedia_transport_op
+{
+    /**
+     * This function is called by the stream when the transport is about
+     * to be used by the stream for the first time, and it tells the transport
+     * about remote RTP address to send the packet and some callbacks to be 
+     * called for incoming packets.
+     */
+    pj_status_t (*attach)(pjmedia_transport *tp,
+                          pjmedia_stream *strm,
+                          const pj_sockaddr_t *rem_addr,
+                          unsigned addr_len,
+                          void (*rtp_cb)(pjmedia_stream*,
+                                         const void*,
+                                         pj_ssize_t),
+                          void (*rtcp_cb)(pjmedia_stream*,
+                                          const void*,
+                                          pj_ssize_t));
+
+    /**
+     * This function is called by the stream when the stream is no longer
+     * need the transport (normally when the stream is about to be closed).
+     */
+    void (*detach)(pjmedia_transport *tp,
+                   pjmedia_stream *strm);
+
+    /**
+     * This function is called by the stream to send RTP packet using the 
+     * transport.
+     */
+    pj_status_t (*send_rtp)(pjmedia_transport *tp,
+                            const void *pkt,
+                            pj_size_t size);
+
+    /**
+     * This function is called by the stream to send RTCP packet using the
+     * transport.
+     */
+    pj_status_t (*send_rtcp)(pjmedia_transport *tp,
+                             const void *pkt,
+                             pj_size_t size);
+
+};
+
+
+/**
+ * @see pjmedia_transport_op.
+ */
+typedef struct pjmedia_transport_op pjmedia_transport_op;
+
+
+/**
+ * This structure declares stream transport. A stream transport is called
+ * by the stream to transmit a packet, and will notify stream when
+ * incoming packet is arrived.
+ */
+struct pjmedia_transport
+{
+    char                  name[PJ_MAX_OBJ_NAME];
+
+    pjmedia_transport_op *op;
+};
+
+
+
+/**
  * Create a media stream based on the specified parameter. After the stream
  * has been created, application normally would want to get the media port 
@@ -115 +188 @@
  *                      buffer needs to preallocate some storage.
  * @param info          Stream information.
+ * @param tp            Stream transport instance used to transmit 
+ *                      and receive RTP/RTCP packets to/from the underlying 
+ *                      transport. 
  * @param user_data     Arbitrary user data (for future callback feature).
  * @param p_stream      Pointer to receive the media stream.
@@ -123 +199 @@
                                            pj_pool_t *pool,
                                            const pjmedia_stream_info *info,
+                                           pjmedia_transport *tp,
                                            void *user_data,
                                            pjmedia_stream **p_stream);
@@ -152 +229 @@
 
 /**
+ * Get the media transport object associated with this stream.
+ *
+ * @param st            The media stream.
+ *
+ * @return              The transport object being used by the stream.
+ */
+PJ_DECL(pjmedia_transport*) pjmedia_stream_get_transport(pjmedia_stream *st);
+
+
+/**
  * Start the media stream. This will start the appropriate channels
  * in the media stream, depending on the media direction that was set
@@ -225 +312 @@
 
 /**
- * Retrieve the incoming DTMF digits from the stream. Note that the digits
- * buffer will not be NULL terminated.
+ * Retrieve the incoming DTMF digits from the stream, and remove the digits
+ * from stream's DTMF buffer. Note that the digits buffer will not be NULL 
+ * terminated.
  *
  * @param stream        The media stream.