oSIP协议栈及eXoSIPOrtp等使用入门.docx

oSIP协议栈及eXoSIPOrtp等使用入门.docx

《oSIP协议栈及eXoSIPOrtp等使用入门.docx》由会员分享，可在线阅读，更多相关《oSIP协议栈及eXoSIPOrtp等使用入门.docx（24页珍藏版）》请在冰点文库上搜索。

oSIP协议栈及eXoSIPOrtp等使用入门

　一直没空仔细研究下oSIP，最近看到其版本已经到了3.x版本，看到网上的许多帮助说明手册都过于陈旧，且很多文档内容有点误人子弟的嫌疑～～ 

　　Ｌｉｎｕｘ下ｏＳＩＰ的编译使用应该是很简单的，其Ｉｎｓｔａｌｌ说明文档里也介绍的比较清楚，本文主要就ｏＳＩＰ在Ｗｉｎｄｏｗｓ平台下ＶＣ６．０开发环境下的使用作出描述。

　　虽然ｏＳＩＰ的开发人员也说明了，ｏＳＩＰ只使用了标准Ｃ开发库，但许多人在Ｗｉｎｄｏｗｓ下使用ｏＳＩＰ时，第一步就被卡住了，得不到ｏＳＩＰ的ＬＩＢ库和ＤＬＬ库，也就没有办法将ｏＳＩＰ使用到自己的程序中去，所以第一步，我们将学习如何得到ｏＳＩＰ的静态和动态链接库，以便我们自己的程序能够使用它们来成功编译和执行我们的程序。

第一阶段：

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　先创建新工程，网上许多文档都介绍创建一个Ｗｉｎ３２动态链接库工程，我们这里也一样，创建一个空白的工程保存。

　　同样，将ｏＳＩＰ２版本３．０．１src目录下的Ｏｓｉｐｐａｒｓｅｒ２目录下的所有文件都拷到我们刚创建的工程的根目录下，在ＶＣ６上操作：

Ｐｒｏｊｅｃｔ－Ａｄｄ　Ｔｏ　Ｐｒｏｊｅｃｔ－Ｆｉｌｅｓ 

　　将所有的源程序和头文件都加入到工程内，保存工程。

　　这时，我们可以尝试编译一下工程，你会得到许多错误提示信息，其内容无非是找不到osipparser2/xxxxx.h头文件之类。

　　处理：

在Ｌｉｎｕｘ下，我们一般是将头文件，ｌｉｂ库都拷到/usr/inclue;/usr/lib之类的目录下，ｃ源程序里直接写#include时，能直接去找到它们，在ＶＣ里，同样的，最简单的方法就是将ｏＳＩＰ２源码包中的Ｉｎｃｌｕｄｅ目录下的osipparser2目录直接拷到我们的Ｗｉｎｄｏｗｓ下默认包含目录即可，这个目录在ＶＣ６的Ｔｏｏｌ－Ｏｐｔｉｏｎｓ－Ｄｉｒｅｃｔｏｒｉｅｓ里设置，（当然，如果你知道这一步，也可以不用拷贝文件，直接在这里把ｏＳＩＰ源码包所在目录加进来就可以了），默认如果装在Ｃ盘，目录则为C:

/ProgramFiles/MicrosoftVisualStudio/VC98/Include。

　　这时，我们再次编译我们的工程，顺利编译，生成osipparser2.dll，这时，网上很多文档里可能直接就说，这一步也会生成libs目录，里面里osipparser2.lib文件，但我们这里没有生成：

） 

　　最简单的方法，不用深究，直接再创建一个工程，同上述创建动态链接库方法，创建一个Ｗｉｎ３２静态链接库工程，直接编译，即可得到osipparser2.lib。

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　上面，我们得到了Ｏｓｉｐ的解析器开发库，下面再编译完整的Ｏｓｉｐ协议栈开发库，同样照上述方法，分别创建动态链接库工程和静态链接库工程，只是要拷的文件换成src下的osip目录下文件和include下的osip目录，得到osip2.dll和osip2.lib。

　　在编译osip2.dll这一步可能会再次得到错误，内容含义是找不到链接库，所以，我们要把前面编译得到的osipparser2.lib也拷到osip工程目录下，并在ＶＣ６中操作：

　　Ｐｒｏｊｅｃｔ－Ｓｅｔｔｉｎｇ－Ｌｉｎｋ中的Ｏｂｊｅｃｔ／Ｌｉｂｒａｒｙ　Ｍｏｄｕｌｅｓ：

kernel32.libuser32.lib...xxx.lib之类的内容最后增加:

osipparser2.lib 

　　保存工程后再次编译，即可成功编译osip2.dll。

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　至此，我们得到了完整的ｏＳＩＰ开发库，使用时，只需在我们的程序里包含ｏＳＩＰ的头文件，工程的链接参数里增加osipparser2.lib和osip2.lib即可。

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　下面我们验证一下我们得到的开发库，并大概了解一下ＯＳＩＰ的语法规范。

　　在VC里创建win32控制台程序工程，将libosip源码包的SRC目录下的Test目录内的C源程序随便拷一个到工程时，直接编译（工程设置里照前文方法在link选项里增加osip2.lib,osipparser2.lib引用我们之前成功编译得到的静态库文件）就可以运行（带参数运行，参数一般为一个文本文件，同样从Test目录的res目录里拷一个与源文件同名的纯文本文件到工程目录下即可）。

　　该目录下的若干文件基本上是测试了Osip的一些基本功能函数，例如URI解析之类，可以大概了解一下oSIP的语法规范和调用方法，同时也能校验一下之前编译的OSIP开发库能否正常使用，成功完成本项工作后，可以进入下一步具体的oSIP的使用学习了。

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　由于ｏＳＩＰ是比较底层的ＳＩＰ协议栈实现，新手较难上手，而官方的示例大都是一些伪代码，需要有实际的例子程序参考学习，而最好的例子就是同样官方发布的ｏＳＩＰ的扩展开发库exosip２，使用ｅｘｏＳＩＰ可以很方便地快速创建一个完整的ＳＩＰ程序（只针对性地适用于SIP终端开发用，所以我们这里只是用它快速开发一个SIP终端，用来更方便地学习oSIP，要想真正掌握SIP的开发，需要掌握oSIP并熟读RFC文档才行，exoSIP不是我们的最终学习目的），通过成功编译运行一个自己动手开发出的程序，再由浅入深应该是初学都最好的学习方法通过对使用exosip开发库的使用创建自己的ＳＩＰ程序，熟悉后再一个函数一个函数地深入学习exosip提供的接口函数，就可以深入理解osip了，达到间接学习ｏＳＩＰ的目的，同时也能从eXoSIP中学习到正确使用ｏＳＩＰ的良好的编程风格和语法格式。

　　而要成功编译ＥｘｏＳＩＰ，似乎许多人被难住了，直接在ＸＰ－ｓｐ２上，用ＶＣ６，虽然你使用了ｅＸｏＳＩＰ推荐的winsock2.h，但是会得到一个sockaddr_storage结构不能识别的错误，因为vc6自带的开发库太古董了，需要升级系统的Ｐｌａｔｆｏｒｍ　ＳＤＫ，下载地址如下：

 ...PSP2FULLInstall.htm（ＶＣ６的支持已经停止，这是ＶＣ６能使用的最新ＳＤＫ） 

　　成功安装后编译前需加OSIP_MT宏，以启用线程库，否则在程序中使用eXoSIP库时会出错，而编译时也会得到许多函数未定义的Warning提示，编译得到exosip2.lib供我们使用，当然，在此之前需要成功编译了osip2和osipparser2，而在之后的实际使用时，发现ｏＳＩＰ也需要增加ＯＳＩＰ＿ＭＴ宏，否则ＯＳＩＰ＿ＭＴ调用ｏＳＩＰ的线程库时会出错，所以我们需要重新编译ｏＳＩＰ了：

），因为ｅＸｏｓｉｐ是基于ｏＳＩＰ的（同上方式创建静态和动态链接库工程，并需在Ｌｉｎｋ中手工添加ｏＳＩＰ和ｏＳＩＰｐａｒｓｅｒ的lib库）。

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　创建新工程，可以是任意工程，我们从最简单的Ｗｉｎ３２控制台程序开始，为了成功使用ｏＳＩＰ，我们需要引用相关库，调用相关头文件，经过多次试验，发现需要引用如下的库：

exosip2.libosip2.libosipparser2.libWSock32.LibIPHlpApi.LibWS2_32.LibDnsapi.lib 

　　其中，除了我们上面编译得到的三个oSIP库外，其它库都是系统库，其中有一些是新安装的Ｐｌａｔｆｏｒｍ　ＳＤＫ所新提供的。

　　至此，我们有了一个简单的开发环境了，可以充分利用网上大量的以ｏＳＩＰ为基础的代码片段和官方说明文档开始具体函数功能的测试和使用了：

） 

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　我们先进行一个简单的纯ＳＩＰ信令（不带语音连接建立）的ＵＡＣ的ＳＩＰ终端的程序开发的试验（即一个只能作为主叫不能作为被叫的的ＳＩＰ软电话模型），我们创建一个ＭＦＣ应用程序，对话框模式，照上面的说明，设置工程包含我们上面得到的ｏＳＩＰ的相关开发库及ＳＤＫ的一些开发库，并且由于默认ＬＩＢＣ的冲突，需要排除MSVCRT[D]开发库（其中Ｄ代表Ｄｅｂｕｇ模式下，没有Ｄ表示Ｒｅｌｅａｓｅ模式下），直接使用ｅＸｏｓｉｐ的几个主要函数就可以创建一个基本的ＳＩＰ软电话模型。

　　其主要流程为：

　　初始化ｅＸｏｓｉｐ库－启动事件监听线程－向ＳＩＰ　Ｐｒｏｘｙ注册－向某ＳＩＰ终端（电话号码）发起呼叫－建立连接－结束连接

　　初始化代码：

intret=0; 

ret=eXosip_init（）; 

eXosip_set_user_agent（"##YouToo0.1"）; 

if（0!

=ret） 

{ 

AfxMessageBox（"Couldn'tinitializeeXosip!

/n"）; 

returnfalse; 

} 

ret=eXosip_listen_addr（IPPROTO_UDP,NULL,0,AF_INET,0）; 

if（0!

=ret） 

{ 

eXosip_quit（）; 

AfxMessageBox（"Couldn'tinitializetransportlayer!

/n"）; 

returnfalse; 

}

　　启动事件监听线程：

AfxBeginThread（sip_uac,（void*）this）;

　　向ＳＩＰ　Ｐｒｏｘｙ注册：

eXosip_clear_authentication_info（）; 

eXosip_add_authentication_info（uname,uname,upwd,"md5",NULL）; 

real_send_register（30）;　　/*自定义函数代码请见源码*/

　　发起呼叫（构建假的ＳＤＰ描述，实际软电话使用它构建ＲＴＰ媒体连接）：

osip_message_t*invite=NULL;/*呼叫发起消息体*/ 

inti=eXosip_call_build_initial_invite（&invite,dest_call,source_call,NULL,"##YouTootestdemo!

"）; 

if（i!

=0） 

{ 

AfxMessageBox（"IntialINVITEfailed!

/n"）; 

} 

charlocalip[128]; 

eXosip_guess_localip（AF_INET,localip,128）; 

snprintf（tmp,4096, 

"v=0/r/n" 

"o=josua00INIP4%s/r/n" 

"s=conversation/r/n" 

"c=INIP4%s/r/n" 

"t=00/r/n" 

"m=audio%sRTP/AVP08101/r/n" 

"a=rtpmap:

0PCMU/8000/r/n" 

"a=rtpmap:

8PCMA/8000/r/n" 

"a=rtpmap:

101telephone-event/8000/r/n" 

"a=fmtp:

1010-11/r/n",localip,localip,"9900"）; 

osip_message_set_body（invite,tmp,strlen（tmp））; 

osip_message_set_content_type（invite,"application/sdp"）; 

eXosip_lock（）; 

i=eXosip_call_send_initial_invite（invite）; 

eXosip_unlock（）;

　　挂断或取消通话：

intret; 

ret=eXosip_call_terminate（call_id,dialog_id）; 

if（0!

=ret） 

{ 

AfxMessageBox（"hangup/terminateFailed!

"）; 

}

　　可以看到非常简单，再借助于ｏＲＴＰ和Ｍｅｄｉａｓｔｒｅａｍｅｒ开发库，来快速为我们的ＳＩＰ软电话增加ＲＴＰ和与系统语音ＡＰＩ接口交互及语音编码功能，即可以快速开发出一个可用的ＳＩＰ软电话，关于ｏＲＴＰ和Ｍｅｄｉａｓｔｒｅａｍｅｒ的相关介绍不是本文重点，将在有空的时候考虑增加相应使用教程，文章前提到的地方可以下载基本可用的完整ＳＩＰ软电话的ＶＣ源码工程文件供参考使用，完全ＣｏｐｙＬｅｆｔ，欢迎转载，但请在转载时注明作者信息，谢谢！

第二阶段：

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　得到了一个ＳＩＰ软电话模型后，我们可以根据软电话的实际运行表现（结合用Ethereal抓包分析）来进行代码的分析，以达到利用eXoSIP来辅助我们学习ｏＳＩＰ的最终目的（如要快速开发一个可用的ＳＩＰ软电话，请至前面提到的论坛去下载使用ｏＲＴＰ和Ｍｅｄｉａｓｔｒｅａｍｅｒ快速搭建的一个基本完整可用的ＳＩＰ软电话##YouToo0.1版本的ＶＣ源码工程文件作参考）。

　　现在从eXosip的初始化函数开始入手，来分析oSIP的使用，这是第二阶段，第三阶段就是深入学习oSIP的源码了，但大多数情况下应该没有必要了，因为在第二阶段就有部分涉及到第三阶段的工作了，而且ｏＳＩＰ的源码也就大多是一些ＳＩＰ数据的语法解析和状态机的实现，能深入理解了ＳＩＰ协议后，这些只是一种实现方式，没必要完全去接受，而是可以用自己的方式和风格来实现一套，比如，更轻量化更有适用目的性的方式，ｏＳＩＰ则只起参考作用了。

　　eXosip_init（）是ｅＸｏｓｉｐ的初始化函数，我们来看看它的内部实现:

　　首行是定义的　osip_t*osip，这在oSIP的官方手册里我们看到，所有使用oSIP的程序都要在最开始处声明一个osip_t的指针，并使用osip_init（&osip）来初始化这个指针，销毁这个资源使用osip_release（osip）即可。

　　我们可以在代码中看到很多OSIP_TRACE，这是调试输出宏调用了函数osip_trace，可以用ENABLE_TRACE宏来打开调试以方便我们开发调试。

　　其它就是很多的eXosip_t的全局变量eXosip的一些初始化操作，包括最上面的memset（&eXosip,0,sizeof（eXosip））完全清空和下面的类似eXosip.user_agent=osip_strdup（"eXosip/"EXOSIP_VERSION）的exosip变量的一些初始值设置，其中有一个eXosip.j_stop_ua=0应该是一个状态机开关，后面可以看到很多代码检测这个变量来决定是否继续流程处理，默认置成了0表示现在exosip的处理流程是就绪的，即ua是notstop的。

　　osip_set_application_context（osip,&eXosip）是比较有意思的，它让下面的eXosip_set_callbacks（osip）给osip设置大量的回调函数时，能让osip能访问到eXosip这个全局变量中设置的大量程序运行时交互的信息，相当于我们在ＶＣ下开启一个线程时，给线程传入的一个ｖｏｉｄ指针指向我们的ＭＦＣ应用程序的当前dialog对象实例，可以用void*osip_get_application_context（osip_t*osip）这个函数来取出指针来使用，不过好象exosip中并没有用到它，可能是留给个人自已扩展的吧:

） 

　　还能看到初始化代码前面有一段ＷＩＮ３２平台下的ＳＯＣＫ的初始化代码，可以知道eXosip是用的原生的winsockapi函数，也就是我们可能以前学过的用VC和WINAPI写sock程序时（不是ＭＦＣ），用到的那段ＳＯＣＫ初始代码，还有一段有意思的代码，就是jpipe（）函数，它们返回的是一个管道，一个有２个整型数值的数组（一个进一个出），查看其代码发现，非WIN32平台是直接使用的pipe系统函数，而ＷＩＮ３２下则是用一对ＴＣＰ的本地ＳＯＣＫ连接来模拟的管道，一个ＳＯＣＫ写一个ＳＯＣＫ读，这段代码是比较有参考价值的：

） 

j=50; 

while（aport++&&j-->0） 

{ 

　　raddr.sin_port=htons（（short）aport）; 

　　if（bind（s,（structsockaddr*）&raddr,sizeof（raddr））<0） 

　　{ 

　　　　OSIP_TRACE（osip_trace（__FILE__,__LINE__,OSIP_WARNING,NULL, 

　　　　"Failedtobindonelocalsocket%i!

/n",aport））; 

　　}else 

　　break; 

} 

含义即，依次检测５０个端口，从staticintaport=10500;即10500~10550端口找出一个可用的本地端口来绑定listen模拟pipe的一对sock。

　　eXosip_set_callbacks（osip）没有什么好看的，无非是和ｏＳＩＰ官方文档介绍的一样，设置一大堆的回调函数，关键是回调函数的实现，这也是许多初学者使用ｏＳＩＰ被卡壳的主要原因，不知道ｏＳＩＰ构建的程序是怎样跑起来的，随便选几个回调函数看一下eXosip是怎样实现的，有许多是形如下文的函数：

staticvoid 

cb_sndbye（inttype,osip_transaction_t*tr,osip_message_t*sip） 

{ 

　　OSIP_TRACE（osip_trace 

　　（__FILE__,__LINE__,OSIP_INFO3,NULL,"cb_sndbye（id=%i）/r/n", 

　　tr->transactionid））; 

} 

　　即，只是打印一下调试，并没有完整实现什么功能，我们学习时，完全可以用相同的方法，定义一大堆回调函数，并不忙想怎么完全实现，先都是只打印一下调试信息，看具体的应用逻辑根据抓包测试分析和看调试看程序走到了哪一步，调用了哪一个回调，来明白具体回调函数要实现什么用途，再来实现代码就方便多了，当然，如果看透了ＲＦＣ文档，应该从字面就能知道各个回调函数的用途了，这是后话，不是谁都能快速完全看懂ＲＦＣ的，所以我们要参考eXosip：

） 

　　我们对其中的重要的回调函数进行逐个的分析：

　　－－－－－－－－－－－－－－－－－－－－－－－－－－－ 

　　osip_set_cb_send_message（osip,&cb_snd_message）　ＳＩＰ消息发送回调函数 

　　这个函数可能是最重要的回调函数之一，消息发送，包括请求消息和回应消息，一般情况下，状态机的状态就是由它控制的，发起一个消息初始化一个状态机，回应一个消息对状态机修改，终结消息发送结束状态机…… 

　　看cb_snd_message的函数实现，要以发现，其主要代码是对参数中的要发送的消息osip_message_t*sip进行分析，找出消息要发送的真实char*host,intport的值（这些参数可以省略，但要发送消息肯定需要host和port，所以要从sip中解析），最后根据sip中解析出的传输方式是TCP还是UDP选择最终进行消息发送处理的函数cb_udp_snd_message，cb_tcp_snd_message处理（它们的参数一致，即本函数只是补全一些省略的参数并对消息进行合法性检查）。

　　**毕竟eXosip是一个通用的开发库，它考虑了要支持TCP,UDP,TCPs,IPV4,IPV6，WIN32,*nix,WINCE等等多样化的复杂环境，所以，我们可以略过我们暂时不需要的部分，比如，ＩＰＶ６相关的代码实现等。

　　由于我们大多数情况下ＳＩＰ是用的ＵＤＰ，所以先来看一下cb_udp_snd_message的实现，它从全局变量exosip中获取可用的sock，并尽最大能力解析出host和port（？

？

难道前面的函数还不够解析彻底？

？

如最终仍无port信息则默认设置为5060），使用osip_message_to_str（sip,&message,&length）函数将要发送的格式化的ＳＩＰ消息转换成能用ＳＯＣＫ传输的简单数据并发送即完成消息发送，代码中有许多复杂的环境探测和错误控制等等等等，我们可以暂时不用过多关注，可以继续向下，结尾处有一个keeplive相关代码，从代码字面分析，可能是ＳＩＰ的Register消息的自动重发相关代码，可以在后面再细化分析。

　　cb_tcp_snd_essage的函数实现要比上文的udp的实现简单很多，主要是环境探测错误控制方面，因为毕竟tcp是稳定连接的，对比一下代码，可以看到主要流程还是将ＳＩＰ消息转换后，发送到从ＳＩＰ消息中解析出的host和port对应的目标。

　　看完两个函数，可以知道，eXosip需要有两个sock，是一个数组，0是给ＵＤＰ用的，１是给ＴＣＰ用的，要用ＳＯＣＫ当然要初始化，就是下文要介绍的eXosip的网络相关的初始化了，上面的exosip_init可以看成是这个开发库的系统初始化吧：

）　 

　　至些，我们应该知道了ｏＳＩＰ开发的ＳＩＰ应用程序的消息是从哪里发出的吧，对了，就是从这个回调函数里，所谓万事开头难，就象开发ＷＩＮ３２应用程序时，找到了ＷＩＮ３２程序的main函数入口下面的工作就好办了，下面就都是为一些事件消息开发对应的处理函数而已了：

）

　　osip_set_kill_transaction_callback　事务终结回调函数 

　　对应ＩＣＴ，ＩＳＴ，ＮＩＣＴ，ＮＩＳＴ客户/服务器注册/非注册事务状态机的终结，主要是使用osip_remove_transaction（eXosip.j_osip,tr）将当前tr事务删除，再加上一系列的清理工作，其中，NICT即客户端的非Ｉｎｖｉｔｅ事务的清理比较复杂一些，要处理的内容也比较多，可以根据实际应用的情况进行有必要的清理工作：

）

　　cb_transport_error　传输失败处理回调 

　　对应于上面说到的四种事务状态机，如果它们在处理时失败，则在这时进行统一处理。

　　从代码可知，只是在NOTIFY,SUBSCRIBE,OPTION操作失败才进行处理，其它错误可直接忽略。

　　osip_set_message_callback　消息发送处理回调