Changeset 1379 for pjproject

Timestamp:

Jun 20, 2007 10:03:46 AM (17 years ago)

Author:

bennylp

Message:

More on ticket #399: a)send full offer on 200/OK response when re-INVITE does not have SDP, b) added on_create_offer() callback, c) handle some error cases

Location:

pjproject/trunk

Files:

• pjmedia/include/pjmedia/sdp_neg.h (modified) (3 diffs)
• pjmedia/src/pjmedia/sdp_neg.c (modified) (1 diff)
• pjsip-apps/src/samples/invtester.c (added)
• pjsip/include/pjsip-ua/sip_inv.h (modified) (2 diffs)
• pjsip/src/pjsip-ua/sip_inv.c (modified) (5 diffs)
• pjsip/src/pjsua-lib/pjsua_call.c (modified) (3 diffs)

pjproject/trunk/pjmedia/include/pjmedia/sdp_neg.h

@@ -51 +51 @@
  *     create_w_local_offer()  +-------------+  send_local_offer()
  *     ----------------------->| LOCAL_OFFER |<-----------------------
- *    |                        +-------------+                        |
- *    |                               |                               |
- *    |           set_remote_answer() |                               |
- *    |                               V                               |
- * +--+---+                     +-----------+     negotiate()     +------+
+ *    |                        +-------------+______                  |
+ *    |                               |             \______ cancel()  |
+ *    |           set_remote_answer() |                    \______    |
+ *    |                               V                            \  |
+ * +--+---+                     +-----------+     negotiate()     +-~----+
  * | NULL |                     | WAIT_NEGO |-------------------->| DONE |
  * +------+                     +-----------+                     +------+
@@ -173 +173 @@
  * the negotiator state will move to PJMEDIA_SDP_NEG_STATE_DONE.
  * 
+ *
+ * \subsection sdpneg_cancel_offer Cancelling an Offer
+ *
+ * In other case, after an offer is generated (negotiator state is in
+ * PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER), the answer may not be received, and
+ * application wants the negotiator to reset itself to its previous state.
+ * Consider this example:
+ *
+ *  - media has been established, and negotiator state is
+ *    PJMEDIA_SDP_NEG_STATE_DONE.
+ *  - application generates a new offer for re-INVITE, so in this case
+ *    it would either call #pjmedia_sdp_neg_send_local_offer() or
+ *    #pjmedia_sdp_neg_modify_local_offer()
+ *  - the negotiator state moves to PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER
+ *  - the re-INVITE was rejected with an error
+ *
+ * Since an answer is not received, it is necessary to reset the negotiator
+ * state back to PJMEDIA_SDP_NEG_STATE_DONE so that the negotiator can
+ * create or receive new offer.
+ *
+ * This can be accomplished by calling #pjmedia_sdp_neg_cancel_offer(),
+ * to reset the negotiator state back to PJMEDIA_SDP_NEG_STATE_DONE. In
+ * this case, both active local and active remote will not be modified.
  *
  * \subsection sdpneg_create_answer Generating SDP Answer
@@ -599 +622 @@
 
 /**
+ * Cancel previously sent offer, and move negotiator state back to
+ * previous stable state (PJMEDIA_SDP_NEG_STATE_DONE). The negotiator
+ * must be in PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER state.
+ *
+ * @param neg           The negotiator.
+ *
+ * @return              PJ_SUCCESS or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pjmedia_sdp_neg_cancel_offer(pjmedia_sdp_neg *neg);
+
+
+/**
  * Negotiate local and remote answer. Before calling this function, the
  * SDP negotiator must be in PJMEDIA_SDP_NEG_STATE_WAIT_NEGO state.

pjproject/trunk/pjmedia/src/pjmedia/sdp_neg.c

@@ -986 +986 @@
 }
 
+/* Cancel offer */
+PJ_DEF(pj_status_t) pjmedia_sdp_neg_cancel_offer(pjmedia_sdp_neg *neg)
+{
+    PJ_ASSERT_RETURN(neg, PJ_EINVAL);
+
+    /* Must be in LOCAL_OFFER state. */
+    PJ_ASSERT_RETURN(neg->state == PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER,
+                     PJMEDIA_SDPNEG_EINSTATE);
+
+    /* Reset state to done */
+    neg->state = PJMEDIA_SDP_NEG_STATE_DONE;
+
+    /* Clear temporary SDP */
+    neg->neg_local_sdp = neg->neg_remote_sdp = NULL;
+    neg->has_remote_answer = PJ_FALSE;
+
+    return PJ_SUCCESS;
+}
+
+
 /* The best bit: SDP negotiation function! */
 PJ_DEF(pj_status_t) pjmedia_sdp_neg_negotiate( pj_pool_t *pool,

pjproject/trunk/pjsip/include/pjsip-ua/sip_inv.h

@@ -150 +150 @@
      * This callback is called when the invite session has received 
      * new offer from peer. Application can inspect the remote offer 
-     * in "offer". 
+     * in "offer", and set the SDP answer with #pjsip_inv_set_sdp_answer().
+     * When the application sends a SIP message to send the answer, 
+     * this SDP answer will be negotiated with the offer, and the result
+     * will be sent with the SIP message.
      *
      * @param inv       The invite session.
@@ -157 +160 @@
     void (*on_rx_offer)(pjsip_inv_session *inv,
                         const pjmedia_sdp_session *offer);
+
+    /**
+     * This callback is optional, and it is used to ask the application
+     * to create a fresh offer, when the invite session has received 
+     * re-INVITE without offer. This offer then will be sent in the
+     * 200/OK response to the re-INVITE request.
+     *
+     * If application doesn't implement this callback, the invite session
+     * will send the currently active SDP as the offer.
+     *
+     * @param inv       The invite session.
+     * @param p_offer   Pointer to receive the SDP offer created by
+     *                  application.
+     */
+    void (*on_create_offer)(pjsip_inv_session *inv,
+                            pjmedia_sdp_session **p_offer);
 
     /**

pjproject/trunk/pjsip/src/pjsip-ua/sip_inv.c

@@ -1226 +1226 @@
      */
 
-    if (tsx_inv_data->sdp_done)
+    if (tsx_inv_data->sdp_done) {
+        if (rdata->msg_info.msg->body) {
+            PJ_LOG(4,(inv->obj_name, "SDP negotiation done, message "
+                      "body is ignored"));
+        }
         return PJ_SUCCESS;
+    }
 
     /* Check if SDP is present in the message. */
@@ -1384 +1389 @@
                    pjmedia_sdp_neg_has_local_answer(inv->neg) )
         {
+            struct tsx_inv_data *tsx_inv_data;
+
+            /* Get invite session's transaction data */
+            tsx_inv_data = (struct tsx_inv_data*) 
+                           inv->invite_tsx->mod_data[mod_inv.mod.id];
 
             status = inv_negotiate_sdp(inv);
@@ -1389 +1399 @@
                 return status;
             
+            /* Mark this transaction has having SDP offer/answer done. */
+            tsx_inv_data->sdp_done = 1;
+
             status = pjmedia_sdp_neg_get_active_local(inv->neg, &sdp);
         }
@@ -2504 +2517 @@
                 status = process_answer(inv, 200, tdata, NULL);
             } else {
-                const pjmedia_sdp_session *active_sdp;
-                status = pjmedia_sdp_neg_send_local_offer(dlg->pool, 
-                                                          inv->neg, 
-                                                          &active_sdp);
-                if (status == PJ_SUCCESS) {
-                    tdata->msg->body = create_sdp_body(tdata->pool, active_sdp);
+                /* INVITE does not have SDP. 
+                 * If on_create_offer() callback is implemented, ask app.
+                 * to generate an offer, otherwise just send active local
+                 * SDP to signal that nothing gets modified.
+                 */
+                pjmedia_sdp_session *sdp = NULL;
+
+                if (mod_inv.cb.on_create_offer)  {
+                    (*mod_inv.cb.on_create_offer)(inv, &sdp);
+                    if (sdp) {
+                        status = pjmedia_sdp_neg_modify_local_offer(dlg->pool,
+                                                                    inv->neg,
+                                                                    sdp);
+                    }
+                } 
+                
+                if (sdp == NULL) {
+                    const pjmedia_sdp_session *active_sdp = NULL;
+                    status = pjmedia_sdp_neg_send_local_offer(dlg->pool, 
+                                                              inv->neg, 
+                                                              &active_sdp);
+                    if (status == PJ_SUCCESS)
+                        sdp = (pjmedia_sdp_session*) active_sdp;
+                }
+
+                if (sdp) {
+                    tdata->msg->body = create_sdp_body(tdata->pool, sdp);
                 }
             }
@@ -2605 +2639 @@
             inv_set_cause(inv, tsx->status_code, &tsx->status_text);
             inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
+
+        } else if (tsx->status_code >= 300 && tsx->status_code < 700) {
+
+            pjmedia_sdp_neg_state neg_state;
+
+            /* Outgoing INVITE transaction has failed, cancel SDP nego */
+            neg_state = pjmedia_sdp_neg_get_state(inv->neg);
+            if (neg_state == PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER) {
+                pjmedia_sdp_neg_cancel_offer(inv->neg);
+            }
         }
     }

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_call.c

@@ -51 +51 @@
 
 /*
+ * Called to generate new offer.
+ */
+static void pjsua_call_on_create_offer(pjsip_inv_session *inv,
+                                       pjmedia_sdp_session **offer);
+
+/*
  * This callback is called when transaction state has changed in INVITE
  * session. We use this to trap:
@@ -119 +125 @@
     inv_cb.on_media_update = &pjsua_call_on_media_update;
     inv_cb.on_rx_offer = &pjsua_call_on_rx_offer;
+    inv_cb.on_create_offer = &pjsua_call_on_create_offer;
     inv_cb.on_tsx_state_changed = &pjsua_call_on_tsx_state_changed;
 
@@ -2296 +2303 @@
 
 /*
+ * Called to generate new offer.
+ */
+static void pjsua_call_on_create_offer(pjsip_inv_session *inv,
+                                       pjmedia_sdp_session **offer)
+{
+    pjsua_call *call;
+    pj_status_t status;
+
+    PJSUA_LOCK();
+
+    call = (pjsua_call*) inv->dlg->mod_data[pjsua_var.mod.id];
+
+    /* See if we've put call on hold. */
+    if (call->media_st == PJSUA_CALL_MEDIA_LOCAL_HOLD) {
+        PJ_LOG(4,(THIS_FILE, 
+                  "Call %d: call is on-hold locally, creating inactive SDP ",
+                  call->index));
+        status = create_inactive_sdp( call, offer );
+    } else {
+
+        PJ_LOG(4,(THIS_FILE, "Call %d: asked to send a new offer",
+                  call->index));
+
+        /* Init media channel */
+        status = pjsua_media_channel_init(call->index, PJSIP_ROLE_UAC);
+        if (status != PJ_SUCCESS) {
+            pjsua_perror(THIS_FILE, "Error initializing media channel", status);
+            PJSUA_UNLOCK();
+            return;
+        }
+
+        status = pjsua_media_channel_create_sdp(call->index, call->inv->pool, offer);
+    }
+
+    if (status != PJ_SUCCESS) {
+        pjsua_perror(THIS_FILE, "Unable to create local SDP", status);
+        PJSUA_UNLOCK();
+        return;
+    }
+
+
+    PJSUA_UNLOCK();
+}
+
+
+/*
  * Callback called by event framework when the xfer subscription state
  * has changed.