ortp库使用入门

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会话对象
 

三、程序示例

编译及运行环境：VS2008，windows

    编程语言：c/c++，ortp库为c语言封装，我用c++对其进行了进一步封装，如果需要c语言的封装接口，只需要把类中相关函数提取出来即可使用。

    ortp库：ortp-0.9.1（由于是以前写的代码，故用的ortp库比较老，但不影响使用和学习，我附件中的工程中已经把ortp-0.9.1库文件添加进去了）

    整个测试代码在工程的附件中，大家下载后直接编译后，在Debug目录下打开2个本程序，一个选择Client，一个选择Server，即可看到测试效果。

    下面，我的相关代码发布如下（附件中有完整的工程）。

一、ORTP接收端封装类

  
  
//  
//  COPYRIGHT NOTICE  
//  Copyright (c) 2011, 华中科技大学 卢俊（版权声明）  
//  All rights reserved.  
//   
/// @file    CortpClient.h    
/// @brief   ortp客户端类声明文件  
///  
/// 实现和提供ortp的客户端应用接口  
///  
/// @version 1.0     
/// @author  卢俊   
/// @date    2011/11/03  
//  
//  
//  修订说明：  
//  
 
#ifndef CORTPCLIENT_H_  
#define CORTPCLIENT_H_  
 
#include <ortp/ortp.h>  
#include <string>  
 
/**  
 *  COrtpClient ortp客户端管理类   
 *     
 *  负责封装和提供ortp相关接口  
 */ 
class COrtpClient  
{  
public:   
     
    /**  构造函数/析构函数  
     *    
     *  在创建/销毁该类对象时自动调用  
     */ 
    COrtpClient();  
    ~COrtpClient();    
 
    /** ORTP模块的初始化  
     *  
     *  在整个系统最开始调用，负责ORTP库的初始化  
     *  @return: bool  是否成功  
     *  @note:     
     *  @see:      
     */ 
    static bool init();  
 
    /** ORTP模块的逆初始化  
     *  
     *  在系统退出前调用，负责ORTP库的释放  
     *  @return: bool  是否成功  
     *  @note:     
     *  @see:      
     */ 
    static bool deInit();  
 
    /** 创建RTP接收会话  
     *  
     *  负责产生RTP接收端会话，监听服务器端的数据  
     *  @param:  const char * localip 本地ip地址  
     *  @param:  int localport  本地监听端口  
     *  @return: bool  是否成功  
     *  @note:     
     *  @see:      
     */ 
    bool create(const char * localip, int localport );  
 
    /** 获取接收到的rtp包  
     *  
     *  将接收到的rtp数据包取出  
     *  @param:  char * pBuffer  
     *  @param:  int & len  
     *  @return: bool  是否成功  
     *  @note:     
     *  @see:      
     */ 
    bool get_recv_data( char *pBuffer, int &len );  
   
private:  
 
    RtpSession *m_pSession;     /** rtp会话句柄 */   
 
    long        m_curTimeStamp; /** 当前时间戳 */   
    int         m_timeStampInc; /** 时间戳增量 */   
 
};  
   
#endif // CortpClient_H_  
 
//  
//  COPYRIGHT NOTICE  
//  Copyright (c) 2011, 华中科技大学 卢俊（版权声明）  
//  All rights reserved.  
//   
/// @file    CortpClient.cpp    
/// @brief   ortp客户端类实现文件  
///  
/// 实现和提供ortp的客户端应用接口  
///  
/// @version 1.0     
/// @author  lujun   
/// @date    2011/11/03  
//  
//  
//  修订说明：  
//  
 
#include "CortpClient.h"  
 
/* the payload type define */ 
#define PAYLOAD_TYPE_VIDEO 34  
 
/* RTP video Send time stamp increase */ 
#define VIDEO_TIME_STAMP_INC  3600  
 
/** 从rtp接收缓冲区一次读取的字节数 */   
#define READ_RECV_PER_TIME    1024  
 
COrtpClient::COrtpClient()  
{  
    m_pSession = NULL;  
    m_timeStampInc = 0;  
    m_curTimeStamp = 0;  
}  
 
COrtpClient::~COrtpClient()  
{  
    if (!m_pSession)  
    {  
        rtp_session_destroy(m_pSession);  
    }  
}  
 
bool COrtpClient::init()  
{  
    int ret;  
    WSADATA wsaData;  
 
    /** 初始化winsocket */   
    if ( WSAStartup(MAKEWORD(2,2), &wsaData) != 0)  
    {  
        return false;  
    }  
 
    ortp_init();  
    ortp_scheduler_init();  
 
    return true;  
}  
 
bool COrtpClient::deInit()  
{  
    ortp_exit();  
 
    if (WSACleanup() == SOCKET_ERROR)  
    {  
        return false;  
    }  
 
    return true;  
}  
 
bool COrtpClient::create( const char * localip, int localport )  
{  
    if ( m_pSession != NULL)  
    {  
        return false;  
    }  
 
    /** 创建新会话 */   
    m_pSession = rtp_session_new(RTP_SESSION_RECVONLY);  
    if ( !m_pSession)  
    {  
        return false;  
    }  
 
    /** 配置相关参数 */   
    rtp_session_set_scheduling_mode(m_pSession,1);  
    rtp_session_set_blocking_mode(m_pSession,1);  
    rtp_session_set_local_addr(m_pSession,localip,localport);  
    rtp_session_enable_adaptive_jitter_compensation(m_pSession,1);  
    rtp_session_set_jitter_compensation(m_pSession,40);  
 
    rtp_session_set_payload_type(m_pSession,PAYLOAD_TYPE_VIDEO);  
    m_timeStampInc = VIDEO_TIME_STAMP_INC;  
 
    return true;  
}  
 
bool COrtpClient::get_recv_data( char *pBuffer, int &len )  
{  
    int recvBytes  = 0;  
    int totalBytes = 0;  
    int have_more = 1;  
 
    while(have_more)  
    {  
        if ( totalBytes+READ_RECV_PER_TIME > len )  
        {  
            /** 缓冲区大小不够 */   
            return false;  
        }  
        recvBytes = rtp_session_recv_with_ts(m_pSession,pBuffer+totalBytes,READ_RECV_PER_TIME,m_curTimeStamp,&have_more);  
        if (recvBytes <= 0)  
        {  
            break;  
        }  
        totalBytes += recvBytes;  
    }  
 
    /** 判断是否读取到数据 */   
    if (totalBytes == 0)  
    {  
        return false;  
    }  
 
    /** 记录有效字节数 */   
    len = totalBytes;  
 
    /** 时间戳增加 */   
    m_curTimeStamp += m_timeStampInc;  
 
    return true;  
}  
 

二、ORTP发送端封装类

  
  
//  
//  COPYRIGHT NOTICE  
//  Copyright (c) 2011, 华中科技大学 卢俊（版权声明）  
//  All rights reserved.  
//   
/// @file    CortpServer.h  
/// @brief   ortp服务器类声明文件  
///  
/// 实现和提供ortp的服务器端应用接口  
///  
/// @version 1.0     
/// @author  卢俊  
/// @date    2011/11/03  
//  
//  
//  修订说明：  
//  
 
#ifndef CORTPSERVER_H_  
#define CORTPSERVER_H_  
   
#include <ortp/ortp.h>  
 
/**  
 *  COrtpServer RTP发送类   
 *     
 *  负责使用RTP协议进行数据的发送  
 */ 
class COrtpServer  
{  
public:   
     
    /**  构造函数  
     *    
     *  该函数为该类的构造函数，在创建该类对象时自动调用  
     */ 
    COrtpServer();  
 
    /** 析构函数  
     *  
     * 该函数执行析构操作，由系统自动调用  
     */ 
    ~COrtpServer();    
    
    /** ORTP模块的初始化  
    *  
    *  在整个系统最开始调用，负责ORTP库的初始化  
    *  @return: bool  是否成功  
    *  @note:     
    *  @see:      
    */ 
    static bool init();  
 
    /** ORTP模块的逆初始化  
    *  
    *  在系统退出前调用，负责ORTP库的释放  
    *  @return: bool  是否成功  
    *  @note:     
    *  @see:      
    */ 
    static bool deInit();  
 
    /** 创建RTP接收会话  
    *  
    *  负责产生RTP接收端会话，监听服务器端的数据  
    *  @param:  const char * destIP 目的地址的IP  
    *  @param:  int destport 目的地址的监听端口号  
    *  @return: bool  是否成功  
    *  @note:     
    *  @see:      
    */ 
    bool create(const char * destIP, int destport );  
 
    /** 发送RTP数据  
     *  
     *  将指定的buffer中的数据发送到客户端  
     *  @param:  unsigned char * buffer 需要发送的数据  
     *  @param:  int len 有效字节数  
     *  @return: int 实际发送的字节数  
     *  @note:    
     *  @see:     
     */ 
    int send_data( unsigned char *buffer, int len );  
   
private:  
 
    RtpSession *m_pSession;     /** rtp会话句柄 */   
 
    long        m_curTimeStamp; /** 当前时间戳 */   
    int         m_timeStampInc; /** 时间戳增量 */   
 
    char       *m_ssrc;         /** 数据源标识 */   
};  
 
#endif // COrtpServer_H_  
 
//  
//  COPYRIGHT NOTICE  
//  Copyright (c) 2011, 华中科技大学 卢俊（版权声明）  
//  All rights reserved.  
//   
/// @file    CortpServer.cpp  
/// @brief   ortp服务器类实现文件  
///  
/// 实现和提供ortp的服务器端应用接口  
///  
/// @version 1.0     
/// @author  lujun   
/// @date    2011/11/03  
//  
//  
//  修订说明：  
//  
 
#include "COrtpServer.h"  
 
/* the payload type define */ 
#define PAYLOAD_TYPE_VIDEO 34  
 
/* RTP video Send time stamp increase */ 
#define VIDEO_TIME_STAMP_INC  3600  
 
COrtpServer::COrtpServer()  
{  
    m_ssrc     = NULL;  
    m_pSession = NULL;  
    m_timeStampInc = 0;  
    m_curTimeStamp = 0;  
}  
 
COrtpServer::~COrtpServer()  
{  
    if (!m_pSession)  
    {  
        rtp_session_destroy(m_pSession);  
    }  
}  
 
bool COrtpServer::init()  
{  
    int ret;  
    WSADATA wsaData;  
 
    /** 初始化winsocket */   
    if ( WSAStartup(MAKEWORD(2,2), &wsaData) != 0)  
    {  
        return false;  
    }  
 
    ortp_init();  
    ortp_scheduler_init();  
 
    return true;  
}  
 
bool COrtpServer::deInit()  
{  
    ortp_exit();  
 
    if (WSACleanup() == SOCKET_ERROR)  
    {  
        return false;  
    }  
 
    return true;  
}  
 
bool COrtpServer::create( const char * destIP, int destport )  
{  
    m_ssrc = getenv("SSRC");  
 
    m_pSession = rtp_session_new(RTP_SESSION_SENDONLY);   
 
    rtp_session_set_scheduling_mode(m_pSession,1);  
    rtp_session_set_blocking_mode(m_pSession,1);  
    rtp_session_set_remote_addr(m_pSession,destIP,destport);  
 
    if(m_ssrc != NULL)  
    {  
        rtp_session_set_ssrc(m_pSession,atoi(m_ssrc));  
    }  
 
    rtp_session_set_payload_type(m_pSession,PAYLOAD_TYPE_VIDEO);  
    m_timeStampInc = VIDEO_TIME_STAMP_INC;  
 
    return true;  
}  
 
int COrtpServer::send_data( unsigned char *buffer, int len )  
{  
    int sendBytes = 0;  
 
    /** 强转 */   
    const char *sendBuffer = (const char*)buffer;  
 
    sendBytes = rtp_session_send_with_ts(m_pSession,sendBuffer,len,m_curTimeStamp);  
 
    if ( sendBytes > 0)  
    {  
        m_curTimeStamp += m_timeStampInc; /** 增加时间戳 */   
    }     
 
    return sendBytes;  
} 

三、测试程序

  
  
//  
//  COPYRIGHT NOTICE  
//  Copyright (c) 2011, 华中科技大学 卢俊 （版权声明）  
//  All rights reserved.  
//  
/// @file    main.cpp   
/// @brief   ortp测试文件  
///  
/// 测试ortp发送结构体  
///  
/// @version 1.0    
/// @author  卢俊  
/// @e-mail  lujun.hust@gmail.com  
/// @date    2011/10/19  
//  
//  
//  修订说明：  
//  
 
#include <iostream>  
 
#include "COrtpClient.h"  
#include "COrtpServer.h"  
 
/** 本地IP地址 */ 
const char * LOCAL_IP_ADDR = "127.0.0.1";  
 
/** 本地监听端口 */   
const int LOCAL_RTP_PORT = 8000;  
 
/** 目的监听端口 */   
const int DEST_RTP_PORT = 8000;  
 
/** 目的IP地址 */   
const char * DEST_IP_ADDR  = "127.0.0.1";  
 
/** 一次发送的数据长度 */   
const int SEND_LEN_PER_TIME =  8*1024;  
 
/** 接收缓冲区的总大小 */   
const int RECV_BUFFER_LEN   = 10*1024;  
 
/** 一次接收的数据长度 */   
const int RECV_LEN_PER_TIME = 1024;  
 
bool ortpServer()  
{  
    COrtpServer ortpServer;  
 
    COrtpServer::init();  
 
    if (!ortpServer.create(DEST_IP_ADDR,DEST_RTP_PORT))  
    {  
        std::cout << "ortpServer.create fail!\n";  
        getchar();  
        getchar();  
        return false;  
    }  
 
    unsigned char * buffer = new unsigned char[SEND_LEN_PER_TIME];  
 
    while (1)  
    {  
        if ( ortpServer.send_data(buffer,SEND_LEN_PER_TIME) <= 0)  
        {  
            std::cout << "send fail!\n";  
        }  
 
        Sleep(100);  
        std::cout << "send bytes\n";  
    }  
 
    delete [] buffer;  
 
    COrtpClient::deInit();  
 
    return true;  
}  
 
bool ortpClient()  
{  
    COrtpClient ortpClient;  
 
    COrtpClient::init();      
 
    if (!ortpClient.create(LOCAL_IP_ADDR,LOCAL_RTP_PORT))  
    {  
        std::cout << "ortpClient.create fail!\n";  
        getchar();  
        getchar();  
        return false;  
    }  
 
    char *buffer = new char[RECV_BUFFER_LEN];  
 
    while(1)  
    {  
        int len = RECV_BUFFER_LEN;  
        if (!ortpClient.get_recv_data(buffer,len))  
        {  
            Sleep(10);  
            continue;  
        }  
 
        std::cout << "successful recv,data len =" << len << std::endl;  
    }  
 
    COrtpClient::deInit();  
 
    delete [] buffer;  
 
    return true;  
}  
 
void main()  
{  
    std::cout << "enter num,1 ->client, 2->server! \n";  
 
    int num;  
 
    std::cin >> num;  
 
    while(1)  
    {  
        if (num == 1)  
        {  
            ortpClient();  
            break;  
        }  
        else if (num == 2)  
        {  
            ortpServer();  
            break;  
        }  
        else 
        {  
            std::cout << "please input 1 or 2 !\n";  
        }  
    }  
 
    getchar();  
    getchar();  
} 

        有关ORTP的介绍、RTP的介绍、RTP的负载类型和时间戳的含义等理论性的东西，都可以在我博客中的其他文章中找到，以上就是整个工程的代码，注释不是很多，因为有些地方我也不是特别清楚，比如jitter、scheduling什么的，如果有什么其他疑问欢迎留言或者E-mail来信交流。

本文出自 “ 对影成三人” 博客，请务必保留此出处 http://ticktick.blog.51cto.com/823160/704891