ortp庫入門

我們知道， RTP（Real-timeTransportProtocol）是用於Internet上針對多媒體資料流的一種傳輸協議，做流媒體傳輸方面的應用離不開RTP協議的實現及使用，為了更加快速地在專案中應用RTP協議實現流媒體的傳輸，我們一般會選擇使用一些RTP庫，例如使用c++語言編寫的JRTPLIB庫，網上關於RTP協議以及JRTPLIB庫的介紹已經很多了，在此我也不再贅述，文字主要介紹實現了RTP協議的另一種開源庫——ORTP庫，這個庫是純使用c語言編寫，由於我們的專案是基於Linux下的c語言程式設計，故我們選擇了ortp作為我們的第三方庫，在此我也對該庫進行一個簡單地介紹，希望對其他ortp的初學者有所幫助。


一、簡介
ORTP是一個支援RTP以及RFC3550協議的庫，有如下的特性：
（1）使用C語言編寫，可以工作於windows, Linux, 以及 Unix平臺
（2）實現了RFC3550協議，提供簡單易用的API。支援多種配置，RFC3551為預設的配置。
（3）支援單執行緒下的多個RTP會話，支援自適應抖動處理。
（4）基於GPL版權宣告。
ORTP可以在其官方網站上（http://www.linphone.org/index.php/eng/code_review/ortp）下載，下載解壓後得到ORTP的原始碼包和示例程式（tests）。其幫助文件在docs目錄下，也可以在http://download.savannah.gnu.org/releases/linphone/ortp/docs/線上檢視。


關於ORTP的資料並不多，主要是其原始碼、幫助文件以及示例程式，關於示例程式說明如下：
rtprecv.c 和rtpsend.c 展示瞭如何接收和傳送單RTP資料流。
mrtprecv.c mrtpsend.c 展示瞭如何同時接收和傳送多個RTP資料流。


二、主要函式介紹
 rtp_session_init
函式原型：void rtp_session_init (RtpSession * session, int mode)
函式功能：執行rtp會話的一些必要的初始化工作
引數含義：
session： rtp會話結構體，含有一些rtp會話的基本資訊
mode：   傳輸模式，有以下幾種，決定本會話的一些特性。
RTP_SESSION_RECVONLY：只進行rtp資料的接收
RTP_SESSION_SENDONLY：只進行rtp資料的傳送
RTP_SESSION_SENDRECV：可以進行rtp資料的接收和傳送
 
執行的操作：
1.       設定rtp包緩衝佇列的最大長度
2.       根據傳輸模式設定標誌變數的值
3.       隨機產生SSRC和同步源描述資訊
4.       傳入全域性的av_profile，即使用預設的profile配置
5.       初始化rtp包緩衝區佇列
6.       傳送負載型別預設設定為0（pcmu音訊），接收負載型別預設設定為-1（未定義）
7.       將session的其他成員的值均設定一個預設值。
 
rtp_session_set_scheduling_mode
函式原型：void rtp_session_set_scheduling_mode (RtpSession * session, int yesno)
函式功能： RtpScheduler管理多個session的排程和收發的控制，本函式設定是否使用該session排程管理功能。
引數含義：
session： rtp會話結構體
yesno:   是否使用rtp session的系統排程功能
說明：
如果yesno為1，則表明使用系統的session排程管理功能，意味著可以使用以下功能：
1. 可以使用session_set_select在多個rtp會話之間進行選擇，根據時間戳判定某個會話是否到達了收發的時間。
2. 可以使用rtp_session_set_blocking_mode()設定是否使用阻塞模式來進行rtp包的傳送和接收。
如果yesno為0，則表明該會話不受系統管理和排程。
關於rtp session的管理和排程，由全域性的變數RtpScheduler *__ortp_scheduler來負責，該變數必須通過ortp_scheduler_init() 來進行初始化操作。
 
rtp_session_set_blocking_mode
函式原型：void rtp_session_set_blocking_mode (RtpSession * session, int yesno)
函式功能：設定是否使用阻塞模式，
引數含義：
session： rtp會話結構體
yesno:  是否使用阻塞模式
說明：
阻塞模式只有在scheduling mode被開啟的情況下才能使用，本函式決定了rtp_session_recv_with_ts() 和 rtp_session_send_with_ts()兩個函式的行為，如果啟用了阻塞模式，則rtp_session_recv_with_ts()會一直阻塞直到接收RTP包的時間點到達（這個時間點由該函式引數中所定義的時間戳來決定），當接收完RTP資料包後，該函式才會返回。同樣，rtp_session_send_with_ts()也會一直阻塞直到需要被髮送的RTP包的時間點到達，傳送結束後，函式才返回。
 
rtp_session_signal_connect
函式原型：int rtp_session_signal_connect (RtpSession * session, const char *signal,   RtpCallback cb, unsigned long user_data)
函式功能：本函式提供一種方式，用於通知應用程式各種可能發生的RTP事件（訊號）。可能通過註冊回撥函式的形式來實現本功能。
引數含義：
session： rtp會話結構體
signal： 訊號的名稱
cb：     回撥函式
user_data：傳遞給回撥函式的資料
返回值：0表示成功，-EOPNOTSUPP表示訊號名稱不存在，-1表示回撥函式繫結錯誤
說明：
訊號的名稱必須是以下字串中的一種：
"ssrc_changed" : 資料流的同步源標識改變
"payload_type_changed" : 資料流的負載型別改變
"telephone-event_packet" : telephone-event RTP包(RFC2833)被接收
"telephone-event" : telephone event 發生
"network_error" : 網路錯誤產生，傳遞給回撥函式的是描述錯誤的字串（const char *型）或者錯誤碼（int型）
"timestamp_jump" : 接收到的資料包發生了時間戳的跳躍。
要取消事件（訊號）的監聽，可以使用下面這個函式
int rtp_session_signal_disconnect_by_callback ( RtpSession * session, const char * signal_name, RtpCallback cb )
 
rtp_session_set_local_addr
函式原型：int rtp_session_set_local_addr( RtpSession * session, const char * addr,int port)
函式功能：設定本地rtp資料監聽地址
引數含義：
session： rtp會話結構體
addr： 本地IP地址，例如127.0.0.1，如果為NULL，則系統分配0.0.0.0
port：   監聽埠，如果設定為-1，則系統為其自動分配埠
返回值： 0表示成功
說明：
如果是RTP_SESSION_SENDONLY（只傳送）型會話，則不需要進行本設定，而必須設定rtp_session_set_remote_addr() 來設定遠端目的地址。
如果採用了系統自動分配監聽埠，則可以通過int rtp_session_get_local_port(const RtpSession *session) 來獲取系統分配的監聽埠號。
 
rtp_session_set_remote_addr
函式原型：int rtp_session_set_remote_addr (RtpSession * session, const char * addr, int port)
函式功能：設定RTP傳送的目的地址
引數含義：
session： rtp會話結構體
addr： 目的IP地址
port：   目的地址的監聽埠號
返回值： 0表示成功
 
rtp_session_set_send_payload_type
函式原型：int rtp_session_set_send_payload_type (RtpSession * session, int paytype)
函式功能：設定RTP傳送資料的負載型別
引數含義：
session： rtp會話結構體
paytype：負載型別
返回值： 0表示成功，-1表示負載未定義
說明：
負載型別在payloadtype.h檔案中有詳細的定義，RTP接收端有著類似的負載型別設定函式，int rtp_session_set_recv_payload_type ( RtpSession * session, int paytype ) ，注意，傳送的負載型別必須與接收的負載型別一致才能正常完成收發。
 
rtp_session_send_with_ts
函式原型：int rtp_session_send_with_ts (RtpSession * session, const char * buffer, int len,uint32_t userts)
函式功能：傳送RTP資料包
引數含義：
session： rtp會話結構體
buffer： 需要傳送的RTP資料的緩衝區
len：    需要傳送的RTP資料的長度
userts： 本RTP資料包的時間戳
返回值： 成功傳送到網路中的位元組數
說明：
傳送RTP資料需要自己管理時間戳的遞增，每呼叫一次本函式，請根據實際情況對userts進行遞增，具體遞增的規則見RTP協議中的說明。
例如：如果傳送的是取樣率為90000Hz的視訊資料包，每秒25幀，則時間戳的增量為：90000/25 = 3600
時間戳的起始值為隨機值，建議設定為0 。
 
rtp_session_recv_with_ts
函式原型：int rtp_session_recv_with_ts (RtpSession * session, char * buffer,int len, uint32_t time, int * have_more)
函式功能：接收RTP資料包
引數含義：
session： rtp會話結構體
buffer： 存放接收的RTP資料的緩衝區
len：    期望接收的RTP資料的長度
time：   期望接收的RTP資料的時間戳
have_more：標識接收緩衝區是否還有資料沒有傳遞完。當使用者給出的緩衝區不夠大時，為了標識緩衝區資料未取完，則have_more指向的資料為1，期望使用者以同樣的時間戳再次呼叫本函式；否則為0，標識取完。
rtp_session_destroy
【原型】： void rtp_session_destroy(RtpSession *session)
【功能】：摧毀rtp會話物件，釋放資源
【引數】：session已經建立的RTP會話物件
 
三、程式示例
      下面，我簡單地通過程式演示了怎麼使用ortp進行rtp資料包的傳送，接收端的程式待以後有時間再整理出來吧。

 

//////////////////////////////////////////////////////////////////////////      
1   /// COPYRIGHT NOTICE      
2    // Copyright (c) 2009, 華中科技大學ticktick Group      
3   /// All rights reserved.       
4   ///       
5   /// @file    ortpSend.c        
6   /// @brief   ortpSend的測試      
7   ///      
8   /// 本檔案示例使用ortp庫進行rtp資料包的傳送     
9   ///       
10  /// @version 1.0         
11  /// @author  tickTick     
12  /// @date    2010/07/07       
13  /// @E-mail  lujun.hust@gmail.com      
14  ///      
15  /// 修訂說明：建立檔案      
16  //////////////////////////////////////////////////////////////////////////       
17     
18  #include <ortp/ortp.h>   
19  #include <signal.h>   
20  #include <stdlib.h>   
21     
22  #ifndef _WIN32    
23  #include <sys/types.h>   
24  #include <sys/time.h>   
25  #include <stdio.h>   
26  #endif   
27     
28  // 時間戳增量  
29  #define TIME_STAMP_INC  160    
30  #define BYTES_PER_COUNT 65535  
31  // 時間戳    
32  uint32_t g_user_ts;    
33     
34  /**  初始化     
35   *       
36   *   主要用於對ortp以及其它引數進行初始化    
37   *   @param:  char * ipStr 目的端IP地址描述串     
38   *   @param:  iint port 目的端RTP監聽埠     
39   *   @return:  RtpSession * 返回指40   向RtpSession物件的指41   針,如果為NULL，42    則初始化失敗     
43   *   @note:       
44   */     
45  RtpSession * rtpInit(char * ipStr,int port)    
46  {    
47      // Rtp會話物件     
48      RtpSession *session;    
49      char *ssrc;    
50          
51      // 時間戳初始化     
52      g_user_ts = 0;    
53     
54      // ortp的一些基本初始化操作    
55      ortp_init();    
56      ortp_scheduler_init();    
57      // 建立新的rtp會話物件   
58      session=rtp_session_new(RTP_SESSION_SENDONLY);      
59          
60      rtp_session_set_scheduling_mode(session,1);    
61      rtp_session_set_blocking_mode(session,1);    
62      // 設定遠端RTP客戶端的的IP和監聽埠（即本rtp資料包的傳送目的地址）    
63      rtp_session_set_remote_addr(session,ipStr,port);    
64      // 設定負載型別     
65      rtp_session_set_payload_type(session,0);    
66          
67      // 獲取同68    步源標69   識     
70      ssrc=getenv("SSRC");    
71      if (ssrc!=NULL)     
72      {    
73          printf("using SSRC=%i.\n",atoi(ssrc));    
74          rtp_session_set_ssrc(session,atoi(ssrc));    
75      }    
76          
77      return session;    
78     
79  }    
80     
81  /**  傳送rtp資料包     
82   *       
83   *   主要用於傳送rtp資料包     
84   *   @param:  RtpSession *session RTP會話物件的指85   針     
86   *   @param:  const char *buffer 要傳送的資料的緩衝區地址      
87   *   @param: int len 要傳送的資料長度     
88   *   @return:  int 實際傳送的資料包數目     
89   *   @note:     如果要傳送的資料包長度大於BYTES_PER_COUNT，90 本函式內部會進行分包處理     
91   */   
92  int rtpSend(RtpSession *session,const char *buffer, int len)    
93  {    
94      int curOffset = 0;    
95      int sendBytes = 0;    
96      int clockslide=500;     
97      // 傳送包的個數   
98      int sendCount = 0;    
99     
100     ortp_message("send data len %i\n ",len);    
101    
102     // 是否全部傳送完畢     
103     while(curOffset < len )    
104     {    
105     // 如果需要傳送的資料長度小於等於闕值，106    則直接傳送   
107         if( len <= BYTES_PER_COUNT )    
108         {    
109             sendBytes = len;    
110         }    
111         else   
112         {    
113             // 如果當前偏移 + 閾值 小於等於 總長度，114 則傳送閾值大小的資料   
115             if( curOffset + BYTES_PER_COUNT <= len )    
116             {    
117                 sendBytes = BYTES_PER_COUNT;    
118             }    
119             // 否則就傳送剩餘長度的資料   
120             else   
121             {    
122                 sendBytes = len - curOffset;    
123             }    
124         }    
125             
126         ortp_message("send data bytes %i\n ",sendBytes);    
127             
128         rtp_session_send_with_ts(session,(char *)(buffer+curOffset),sendBytes,g_user_ts);    
129             
130         // 累加   
131         sendCount ++;    
132         curOffset += sendBytes;                     
133         g_user_ts += TIME_STAMP_INC;    
134         
135         // 傳送一定資料包後休眠一會   
136         if (sendCount%10==0)     
137         {    
138             usleep(20000);    
139         }       
140     }    
141     return 0;    
142 }    
143    
144 /**  結束ortp的傳送，145  釋放資源     
146  *      
147  *   @param:  RtpSession *session RTP會話物件的指148  針     
149  *   @return:  0表示成功     
150  *   @note:         
151  */   
152 int rtpExit(RtpSession *session)    
153 {    
154     g_user_ts = 0;    
155         
156     rtp_session_destroy(session);    
157     ortp_exit();    
158     ortp_global_stats_display();    
159    
160     return 0;    
161 }    
162    
163 // 主函式，164  進行測試   
165 int main()    
166 {    
167     // 待傳送的資料緩衝區   
168     char * pBuffer = "123445356234134234532523654323413453425236244123425234";    
169         
170     RtpSession * pRtpSession = NULL;    
171     // 向（192.201.0.51，172   8000）目的地址傳送rtp包   
173     pRtpSession = rtpInit("192.201.0.51",8000);    
174     if(pRtpSession==NULL)    
175     {    
176         printf("error rtpInit");    
177         return 0;    
178     }    
179         
180     // 迴圈傳送   
181     while(1)    
182     {    
183         if( rtpSend(pRtpSession,pBuffer,20) != 0)    
184         {    
185             printf("error rtpInit");    
186             break;    
187         }    
188         usleep(10000);    
189         printf("sleep");    
190     }    
191         
192     // 退出   
193     rtpExit(pRtpSession);    
194         
195     return 0;    
196 }
//////////////////////////////////////////////////////////////////////////
1   /// COPYRIGHT NOTICE
2    // Copyright (c) 2009, 華中科技大學ticktick Group
3   /// All rights reserved.
4   ///
5   /// @file    ortpSend.c
6   /// @brief   ortpSend的測試
7   ///
8   /// 本檔案示例使用ortp庫進行rtp資料包的傳送
9   ///
10  /// @version 1.0
11  /// @author  tickTick
12  /// @date    2010/07/07
13  /// @E-mail  lujun.hust@gmail.com
14  ///
15  /// 修訂說明：建立檔案
16  //////////////////////////////////////////////////////////////////////////
17
18  #include <ortp/ortp.h>
19  #include <signal.h>
20  #include <stdlib.h>
21
22  #ifndef _WIN32
23  #include <sys/types.h>
24  #include <sys/time.h>
25  #include <stdio.h>
26  #endif
27
28  // 時間戳增量
29  #define TIME_STAMP_INC  160
30  #define BYTES_PER_COUNT 65535
31  // 時間戳
32  uint32_t g_user_ts;
33
34  /**  初始化
35   *
36   *   主要用於對ortp以及其它引數進行初始化
37   *   @param:  char * ipStr 目的端IP地址描述串
38   *   @param:  iint port 目的端RTP監聽埠
39   *   @return:  RtpSession * 返回指40   向RtpSession物件的指41   針,如果為NULL，42    則初始化失敗
43   *   @note:
44   */
45  RtpSession * rtpInit(char * ipStr,int port)
46  {
47      // Rtp會話物件
48      RtpSession *session;
49      char *ssrc;
50
51      // 時間戳初始化
52      g_user_ts = 0;
53
54      // ortp的一些基本初始化操作
55      ortp_init();
56      ortp_scheduler_init();
57      // 建立新的rtp會話物件
58      session=rtp_session_new(RTP_SESSION_SENDONLY);
59
60      rtp_session_set_scheduling_mode(session,1);
61      rtp_session_set_blocking_mode(session,1);
62      // 設定遠端RTP客戶端的的IP和監聽埠（即本rtp資料包的傳送目的地址）
63      rtp_session_set_remote_addr(session,ipStr,port);
64      // 設定負載型別
65      rtp_session_set_payload_type(session,0);
66
67      // 獲取同68    步源標69   識
70      ssrc=getenv("SSRC");
71      if (ssrc!=NULL)
72      {
73          printf("using SSRC=%i.\n",atoi(ssrc));
74          rtp_session_set_ssrc(session,atoi(ssrc));
75      }
76
77      return session;
78
79  }
80
81  /**  傳送rtp資料包
82   *
83   *   主要用於傳送rtp資料包
84   *   @param:  RtpSession *session RTP會話物件的指85   針
86   *   @param:  const char *buffer 要傳送的資料的緩衝區地址
87   *   @param: int len 要傳送的資料長度
88   *   @return:  int 實際傳送的資料包數目
89   *   @note:     如果要傳送的資料包長度大於BYTES_PER_COUNT，90 本函式內部會進行分包處理
91   */
92  int rtpSend(RtpSession *session,const char *buffer, int len)
93  {
94      int curOffset = 0;
95      int sendBytes = 0;
96      int clockslide=500;
97      // 傳送包的個數
98      int sendCount = 0;
99
100     ortp_message("send data len %i\n ",len);
101
102     // 是否全部傳送完畢
103     while(curOffset < len )
104     {
105     // 如果需要傳送的資料長度小於等於闕值，106    則直接傳送
107         if( len <= BYTES_PER_COUNT )
108         {
109             sendBytes = len;
110         }
111         else
112         {
113             // 如果當前偏移 + 閾值 小於等於 總長度，114 則傳送閾值大小的資料
115             if( curOffset + BYTES_PER_COUNT <= len )
116             {
117                 sendBytes = BYTES_PER_COUNT;
118             }
119             // 否則就傳送剩餘長度的資料
120             else
121             {
122                 sendBytes = len - curOffset;
123             }
124         }
125
126         ortp_message("send data bytes %i\n ",sendBytes);
127
128         rtp_session_send_with_ts(session,(char *)(buffer+curOffset),sendBytes,g_user_ts);
129
130         // 累加
131         sendCount ++;
132         curOffset += sendBytes;
133         g_user_ts += TIME_STAMP_INC;
134
135         // 傳送一定資料包後休眠一會
136         if (sendCount%10==0)
137         {
138             usleep(20000);
139         }
140     }
141     return 0;
142 }
143
144 /**  結束ortp的傳送，145  釋放資源
146  *
147  *   @param:  RtpSession *session RTP會話物件的指148  針
149  *   @return:  0表示成功
150  *   @note:
151  */
152 int rtpExit(RtpSession *session)
153 {
154     g_user_ts = 0;
155
156     rtp_session_destroy(session);
157     ortp_exit();
158     ortp_global_stats_display();
159
160     return 0;
161 }
162
163 // 主函式，164  進行測試
165 int main()
166 {
167     // 待傳送的資料緩衝區
168     char * pBuffer = "123445356234134234532523654323413453425236244123425234";
169
170     RtpSession * pRtpSession = NULL;
171     // 向（192.201.0.51，172   8000）目的地址傳送rtp包
173     pRtpSession = rtpInit("192.201.0.51",8000);
174     if(pRtpSession==NULL)
175     {
176         printf("error rtpInit");
177         return 0;
178     }
179
180     // 迴圈傳送
181     while(1)
182     {
183         if( rtpSend(pRtpSession,pBuffer,20) != 0)
184         {
185             printf("error rtpInit");
186             break;
187         }
188         usleep(10000);
189         printf("sleep");
190     }
191
192     // 退出
193     rtpExit(pRtpSession);
194
195     return 0;
196 }