Add siprec extension #4132

sorooshm78 · 2024-11-05T15:45:49Z

I had a Session Record Client (SRC) that utilized the SIPREC module from the OpenSIPS SIP server, and I intended to develop a Session Record Server (SRS) capable of supporting SIPREC. The goal was for the SRS to handle requests effectively. However, since PJSIP does not support the SIPREC extension, I added SIPREC extension support to PJSIP.

Senario with siprec extension:

INVITE Request

Request-Line: INVITE sip:192.168.10.20 SIP/2.0

Message Headers:
    Via: SIP/2.0/UDP 192.168.10.20:5060;branch=z9hG4bK656b.7f03f537.0
    To: <sip:192.168.10.20>
    From: <sip:192.168.10.20>;tag=85c717edf7d282027df52a83293e4957-ce21
    User-Agent: OpenSIPS (3.5.0-dev (x86_64/linux))
    Require: siprec  
    Content-Type: multipart/mixed; boundary=OSS-unique-boundary-42
    Contact: <sip:192.168.21.89:5060>; +sip.src
    ...

Session Description Protocol (SDP):
    Version: 0
    Media Description (m): audio 35001 RTP/AVP 8 0 101
    Media Attributes (a): 
        sendonly
        label:0
    ...
    Media Description (m): audio 35002 RTP/AVP 8 101
    Media Attributes (a): 
        sendonly
        label:1
    ...

420 Bad Extension Response

Status-Line: SIP/2.0 420 Bad Extension

Message Header
    ...
    Unsupported: siprec
    Supported: replaces, 100rel, timer, norefersub, trickle-ice
    Content-Length:  0

Senario with siprec extension:

In the SIPREC module of PJSIP, when an INVITE is received with the header Require: siprec and two media attribute labels in the offer SDP, it can generate an appropriate 200 OK response that includes those two media attribute labels in the SDP answer.

INVITE Request

Request-Line: INVITE sip:192.168.10.20 SIP/2.0

Message Headers:
    Via: SIP/2.0/UDP 192.168.10.20:5060;branch=z9hG4bK656b.7f03f537.0
    To: <sip:192.168.10.20>
    From: <sip:192.168.10.20>;tag=85c717edf7d282027df52a83293e4957-ce21
    User-Agent: OpenSIPS (3.5.0-dev (x86_64/linux))
    Require: siprec  
    Content-Type: multipart/mixed; boundary=OSS-unique-boundary-42
    Contact: <sip:192.168.21.89:5060>; +sip.src
    ...

Session Description Protocol (SDP):
    Version: 0
    Media Description (m): audio 35001 RTP/AVP 8 0 101
    Media Attributes (a): 
        sendonly
        label:0
    ...
    Media Description (m): audio 35002 RTP/AVP 8 101
    Media Attributes (a): 
        sendonly
        label:1
    ...

200 OK Response

Message Headers:
    Via: SIP/2.0/UDP 192.168.10.20:5060; received=192.168.10.20; branch=z9hG4bK656b.7f03f537.0
    From: <sip:192.168.10.20>; tag=85c717edf7d282027df52a83293e4957-ce21
    To: <sip:192.168.10.20>; tag=7de0bfd1-94b6-4462-929f-53955d386d91
    Allow: PRACK, INVITE, ACK, BYE, CANCEL, UPDATE, INFO, SUBSCRIBE, NOTIFY, REFER, MESSAGE, OPTIONS
    Supported: replaces, 100rel, timer, siprec, norefersub
    ...

Session Description Protocol (SDP):
    Version: 0
    Session Name (s): pjmedia
    Media Description (m): audio 4000 RTP/AVP 8 101
    Media Attributes (a): 
        label:0
        recvonly
    ...

    Media Description (m): audio 4002 RTP/AVP 8 101
    Media Attributes (a): 
        label:1
        recvonly
    ...

CLAassistant · 2024-11-05T15:45:58Z

All committers have signed the CLA.

sorooshm78 · 2024-11-09T03:25:26Z

I couldn't debug the Bitrise error and figure out where the issue in my code is. Please guide me to resolve the problem.

sauwming · 2024-11-12T04:31:14Z

Thank you for the submission.

The support seems to be pretty basic, i.e. it allows incoming request with siprec to be accepted (instead of declined). There are a few concerns though:

The setting enable_multimedia seems misleading. PJSIP already supports multimedia, i.e. audio and video, even multiple audio and multiple video.
The patch seems to assume that only audio is supported.

sorooshm78 · 2024-11-18T06:13:55Z

I have added more checks based on RFC 7866 , but my code lacks appropriate comments, which I will add in the next commit.

sorooshm78 · 2024-11-20T16:38:52Z

I added the comment.

sauwming · 2024-11-22T01:49:19Z

Just to give you a heads up, we are preparing for 2.15 release within a few weeks time, so we won't be able to merge this until then.
But I will give you some preliminary comments about the current patch.

build.symbian/pjsip_ua.mmp

pjsip/include/pjsip-ua/sip_siprec.h

sauwming · 2024-11-22T01:55:39Z

pjsip/src/pjsua-lib/pjsua_call.c

+     * set the number of call active streams to the number of media in the SDP offer.
+     */
+    if(options & PJSIP_INV_REQUIRE_SIPREC){
+        call->opt.aud_cnt = offer->media_count;


This is what I mentioned about the patch assuming audio only. For example, if you check the example in the RFC 7866: https://www.rfc-editor.org/rfc/rfc7866.html#section-7.1.1, there are two videos and two audios in the incoming offer, so this code is obviously incorrect.

I will fix the issue within the next few days.

Resolved the issue

sorooshm78 · 2024-11-25T08:21:55Z

Resolved the audio count issue and added video support. Successfully tested with a video call using MicroSIP.

sorooshm78 · 2024-12-02T17:59:34Z

In the SIPREC protocol, it is now possible to send information in the body in XML format with the Content-Type: application/rs-metadata+xml. This feature has been added.

andreas-wehrmann · 2024-12-03T14:51:57Z

Just out of curiosity: Why didn't you implement this on top of PJSUA? Or do you not use PJSUA but rather pjsip?

I'm asking because I implemented an SRC on top of PJSUA and a little SRS test tool as well.
That way PJSUA handles all the "annoying low level" media stuff and I just have to inspect the media parameters (and the XML in case of an SRS) in the callbacks.
As for setting/manipulating SDP, this can be done in the existing callbacks also.

This also cleanly separates the different tasks and concerns of each module
(i.e. the SIPREC module is able to understand and handle snapshot requests).

sorooshm78 · 2024-12-04T17:34:49Z

Just out of curiosity: Why didn't you implement this on top of PJSUA? Or do you not use PJSUA but rather pjsip?

I'm asking because I implemented an SRC on top of PJSUA and a little SRS test tool as well. That way PJSUA handles all the "annoying low level" media stuff and I just have to inspect the media parameters (and the XML in case of an SRS) in the callbacks. As for setting/manipulating SDP, this can be done in the existing callbacks also.

This also cleanly separates the different tasks and concerns of each module (i.e. the SIPREC module is able to understand and handle snapshot requests).

I initially tried to do the same thing, but it didn’t work. I was using OpenSIPS for the SRC, and in the INVITE message that OpenSIPS sent, there was a "Require: siprec" header, which caused a "bad extension" error since PJSIP didn’t support SIPREC. I didn’t want to make any changes in OpenSIPS.

andreas-wehrmann · 2024-12-04T19:06:15Z

I see; didn't adding "siprec" with pjsip_endpt_add_capability() work for you?

sorooshm78 added 23 commits November 3, 2024 13:08

add siprec extension

ec478f2

add enableMultimedia

748ea35

add pjsip reference

d0aa099

add comment

feff73b

add comment

2712066

add comment

7eb320b

add comment

6743e75

add comment

ef75332

add comment

d6e41de

add comment

282c14b

add comment

74d400d

add comment

f894272

add comment

2853fc5

add comment

5e00d55

add comment

0b3e3e5

refactor

adb6f7d

refactor

b12eff8

refactor

a861ad0

refactor

6be8941

refactor

434fd23

refactor

8bbadff

refactor

b4035cb

refactor

085b0e5

add siprec extension reference

7514edd

fix error

9d5eee4

sauwming added type: enhancement component: pjsip labels Nov 11, 2024

sorooshm78 added 3 commits November 19, 2024 10:46

add comment

9cecec1

add comment

8498bee

add comment

6d54ca4

sorooshm78 added 2 commits November 21, 2024 15:02

add SIPREC INVITE without SDP is not supported

a2a9b88

add comment

f74742c

sauwming reviewed Nov 22, 2024

View reviewed changes

sorooshm78 added 7 commits November 23, 2024 07:13

add metadata

9e017b6

Merge branch 'Feature/siprec-extension' into Feature/siprec-metadata

a403848

add comment

ad4b4f6

remove deprecated code

6e90bbf

add PJ_DECL for all functions

2bad02f

add video support

ab02307

use pjsua_call attribute for audio and video count

636104c

sorooshm78 added 6 commits December 2, 2024 07:08

refactor code

72862e7

fix error

ff2fae0

refactor code

12583e6

add comment

d26b520

Merge branch 'Feature/siprec-extension' into Feature/siprec-metadata

5bb8144

add PJ_DECL for all functions

b175948

sauwming requested review from sauwming and nanangizz December 4, 2024 01:33

sauwming added this to the release-2.16 milestone Dec 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add siprec extension #4132

Add siprec extension #4132

sorooshm78 commented Nov 5, 2024

CLAassistant commented Nov 5, 2024 •

edited

Loading

sorooshm78 commented Nov 9, 2024

sauwming commented Nov 12, 2024

sorooshm78 commented Nov 18, 2024

sorooshm78 commented Nov 20, 2024 •

edited

Loading

sauwming commented Nov 22, 2024

sauwming Nov 22, 2024

sorooshm78 Nov 24, 2024

sorooshm78 Nov 25, 2024

sorooshm78 commented Nov 25, 2024

sorooshm78 commented Dec 2, 2024

andreas-wehrmann commented Dec 3, 2024

sorooshm78 commented Dec 4, 2024

andreas-wehrmann commented Dec 4, 2024

Add siprec extension #4132

Are you sure you want to change the base?

Add siprec extension #4132

Conversation

sorooshm78 commented Nov 5, 2024

Senario with siprec extension:

INVITE Request

420 Bad Extension Response

Senario with siprec extension:

INVITE Request

200 OK Response

CLAassistant commented Nov 5, 2024 • edited Loading

sorooshm78 commented Nov 9, 2024

sauwming commented Nov 12, 2024

sorooshm78 commented Nov 18, 2024

sorooshm78 commented Nov 20, 2024 • edited Loading

sauwming commented Nov 22, 2024

sauwming Nov 22, 2024

Choose a reason for hiding this comment

sorooshm78 Nov 24, 2024

Choose a reason for hiding this comment

sorooshm78 Nov 25, 2024

Choose a reason for hiding this comment

sorooshm78 commented Nov 25, 2024

sorooshm78 commented Dec 2, 2024

andreas-wehrmann commented Dec 3, 2024

sorooshm78 commented Dec 4, 2024

andreas-wehrmann commented Dec 4, 2024

CLAassistant commented Nov 5, 2024 •

edited

Loading

sorooshm78 commented Nov 20, 2024 •

edited

Loading