Skip to content

SrsLibrtmp

Jump to bottom Edit New page
winlin edited this page Mar 2, 2014 · 40 revisions

SRS提供的librtmp

librtmp是一个客户端库，好像是rtmpdump提供的一个客户端RTMP库：

  • 播放RTMP流：譬如rtmpdump，将服务器的流读取后保存为flv文件。
  • 推流？不知道是否提供推流接口，可能有。
  • 基于同步阻塞socket，客户端用可以了。
  • arm？可能能编译出来给arm-linux用，譬如某些设备上，采集后推送到RTMP服务器。

SRS为何提供librtmp

srs提供的客户端srs-librtmp的定位和librtmp不一样，主要是：

  • librtmp的代码确实很烂，毋庸置疑，典型的代码堆积。
  • librtmp接口定义不良好，这个对比srs就可以看出，使用起来得看实现代码。
  • 没有实例：接口的使用最好提供实例，srs提供了publish/play/rtmpdump实例。
  • 最小依赖关系：srs调整了模块化，只取出了core/kernel/rtmp三个模块，其他代码没有编译到srs-librtmp中，避免了冗余。
  • 最少依赖库：srs-librtmp只依赖c/c++标准库（若需要复杂握手需要依赖openssl，srs也编译出来了，只需要加入链接即可）。
  • 不依赖st：srs-librtmp使用同步阻塞socket，没有使用st（st主要是服务器处理并发需要）。

一句话，srs为何提供客户端开发库？因为rtmp客户端开发不方便，不直观，不简洁。

srs-librtmp结构

srs编译后，在srs当前目录创建objs作为编译的主目录，默认会编译出srs-librtmp和对应的sample，主要文件见下表。

SRS编译选项 编译说明 srs-librtmp文件 说明
./configure --without-ssl 不依赖openssl，
不支持复杂握手，
只支持简单握手		 objs/include/srs_librtmp.h
objs/lib/srs_librtmp.a 		一般客户端使用简单握手即可：
1. 推流：譬如FMLE，也是使用简单握手推流。
2. 播放：一般服务器也支持简单握手后播放，
譬如SRS支持。
./configure --with-ssl 依赖openssl，
支持复杂握手，
支持简单握手		 objs/include/srs_librtmp.h
objs/lib/srs_librtmp.a
objs/openssl/lib/libssl.a
objs/openssl/lib/libcrypto.a 		复杂握手主要应用于：
1. 完全模拟flash客户端，
flash播放vp6+mp3/speex时只需要简单握手，
播放h264+aac时需要复杂握手
（简单握手会从服务器取数据，
但是没有图像和声音）。

SRS编译成功后，用户就可以使用这些库开发

srs-librtmp实例

SRS提供了实例sample，也会在编译srs时自动编译：

  • research/librtmp/srs_play.c：播放RTMP流实例。
  • research/librtmp/srs_publish.c：推送RTMP流实例。

依赖ssl的编译方法（支持复杂握手和简单握手）：

# 编译srs时自动编译这些实例
cd /home/winlin/git/simple-rtmp-server/trunk
./configure --with-ssl && make
#
#实例的单独编译方法为：
cd /home/winlin/git/simple-rtmp-server/trunk/research/librtmp
make ssl

不需要ssl（不支持复杂握手，只支持简单握手）编译方法：

# 编译srs时自动编译这些实例
cd /home/winlin/git/simple-rtmp-server/trunk
./configure --without-ssl && make
#
#实例的单独编译方法为：
cd /home/winlin/git/simple-rtmp-server/trunk/research/librtmp
make nossl

实例编译的二进制文件：

  • research/librtmp/srs_play_nossl：播放RTMP流，没有ssl，只支持简单握手。
  • research/librtmp/srs_play_ssl：播放RTMP流，有ssl，支持简单握手和复杂握手。
  • research/librtmp/srs_publish_nossl：推送RTMP流，没有ssl，只支持简单握手。
  • research/librtmp/srs_publish_ssl：推送RTMP流，有ssl，支持简单握手和复杂握手。

编译srs-librtmp

编译SRS时，会自动编译srs-librtmp，譬如：

[winlin@dev6 srs]$ ./configure --without-ssl && make
[winlin@dev6 srs]$ ll objs/include/
-rw-r--r-- 1 winlin winlin 2891 Mar  2 12:03 srs_librtmp.h
[winlin@dev6 srs]$ ll objs/lib/
-rw-rw-r-- 1 winlin winlin 1540950 Mar  2 12:03 srs_librtmp.a
[winlin@dev6 srs]$ ll research/librtmp/
-rwxrwxr-x 1 winlin winlin 747265 Mar  2 12:03 srs_play_nossl
-rwxrwxr-x 1 winlin winlin 747276 Mar  2 12:03 srs_publish_nossl

主要流程

srs-librtmp的主要逻辑流程如下图：

                                                                srs_play_stream
                                                                +------------+     
                                                             +--+    play    +---+    
  +--------+          +-----------+       +-------------+    |  +------------+   |    +------------+    +-----------+
  | create +------->--+ handshake +----->-+ connect-app +-->-+                   +-->-+ read/write +-->-+  destroy  +
  +--------+          +-----------+       +-------------+    |  +------------+   |    +------------+    +-----------+
 srs_rtmp_create   srs_simple_handshake   srs_connect_app    +--+   publish  +---+    srs_read_packet   srs_rtmp_destroy
                  srs_complex_handshake                         +------------+        srs_write_packet
                     srs_ssl_enabled                           srs_publish_stream

数据格式

数据接口：

  • 读取数据包：int srs_read_packet(int* type, u_int32_t* timestamp, char** data, int* size)
  • 发送数据包：int srs_write_packet(int type, u_int32_t timestamp, char* data, int size)

接口接受的的数据(char* data)，音视频数据，格式为flv的Video/Audio数据。参考srs的doc目录的规范文件video_file_format_spec_v10_1.pdf

  • 音频数据格式参考：E.4.2.1 AUDIODATA，p76，譬如，aac编码的音频数据。
  • 视频数据格式参考：E.4.3.1 VIDEODATA，p78，譬如，h.264编码的视频数据。
  • 脚本数据格式参考：E.4.4.1 SCRIPTDATA，p80，譬如，onMetadata，流的信息（宽高，码率，分辨率等）

数据类型(int type)定义如下（E.4.1 FLV Tag，page 75）：

  • 音频：8 = audio，宏定义：SRS_RTMP_TYPE_AUDIO
  • 视频：9 = video，宏定义：SRS_RTMP_TYPE_VIDEO
  • 脚本数据：18 = script data，宏定义：SRS_RTMP_TYPE_SCRIPT

其他的数据，譬如时间戳，都是通过参数接受和发送。

另外，文档其他重要信息：

  • flv文件头格式：E.2 The FLV header，p74。
  • flv文件主体格式：E.3 The FLV File Body，p74。
  • tag头格式：E.4.1 FLV Tag，p75。

使用flv格式的原因：

  • flv的格式足够简单。
  • ffmpeg也是用的这种格式
  • 收到流后加上flv tag header，就可以直接保存为flv文件
  • 从flv文件解封装数据后，只要将tag的内容给接口就可以，flv的tag头很简单。

srs-librtmp接口说明

srs-librtmp接口参考头文件srs_librtmp.h：

/*
The MIT License (MIT)

Copyright (c) 2013-2014 winlin

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef SRS_LIB_RTMP_HPP
#define SRS_LIB_RTMP_HPP

/*
#include <srs_librtmp.h>
*/

#include <sys/types.h>

/**
* srs-librtmp is a librtmp like library,
* used to play/publish rtmp stream from/to rtmp server.
* socket: use sync and block socket to connect/recv/send data with server.
* depends: no need other libraries; depends on ssl if use srs_complex_handshake.
* thread-safe: no
*/

#ifdef __cplusplus
extern "C"{
#endif

// the output handler.
typedef void* srs_rtmp_t;

/**
* create/destroy a rtmp protocol stack.
* @url rtmp url, for example: 
* 		rtmp://127.0.0.1/live/livestream
* @return a rtmp handler, or NULL if error occured.
*/
srs_rtmp_t srs_rtmp_create(const char* url);
void srs_rtmp_destroy(srs_rtmp_t rtmp);

/**
* handshake with server
* category: publish/play
* previous: rtmp-create
* next: connect-app
* @return 0, success; otherwise, failed.
*/
/**
* simple handshake specifies in rtmp 1.0,
* not depends on ssl.
*/
int srs_simple_handshake(srs_rtmp_t rtmp);
/**
* complex handshake is specified by adobe Flash player,
* depends on ssl, user must compile srs with ssl, then
* link user program libssl.a and libcrypt.a
* @remark user can use srs_ssl_enabled() to detect 
* whether ssl is ok.
*/
int srs_complex_handshake(srs_rtmp_t rtmp);

/**
* connect to rtmp vhost/app
* category: publish/play
* previous: handshake
* next: publish or play
* @return 0, success; otherwise, failed.
*/
int srs_connect_app(srs_rtmp_t rtmp);

/**
* play a live/vod stream.
* category: play
* previous: connect-app
* next: destroy
* @return 0, success; otherwise, failed.
*/
int srs_play_stream(srs_rtmp_t rtmp);

/**
* publish a live stream.
* category: publish
* previous: connect-app
* next: destroy
* @return 0, success; otherwise, failed.
*/
int srs_publish_stream(srs_rtmp_t rtmp);

/**
* E.4.1 FLV Tag, page 75
*/
// 8 = audio
#define SRS_RTMP_TYPE_AUDIO 8
// 9 = video
#define SRS_RTMP_TYPE_VIDEO 9
// 18 = script data
#define SRS_RTMP_TYPE_SCRIPT 18
/**
* read a audio/video/script-data packet from rtmp stream.
* @param type, output the packet type, macros:
*			SRS_RTMP_TYPE_AUDIO, FlvTagAudio
*			SRS_RTMP_TYPE_VIDEO, FlvTagVideo
*			SRS_RTMP_TYPE_SCRIPT, FlvTagScript
* @param timestamp, in ms, overflow in 50days
* @param data, the packet data, according to type:
* 			FlvTagAudio, @see "E.4.2.1 AUDIODATA"
*			FlvTagVideo, @see "E.4.3.1 VIDEODATA"
*			FlvTagScript, @see "E.4.4.1 SCRIPTDATA"
* @param size, size of packet.
* @return the error code. 0 for success; otherwise, error.
*/
int srs_read_packet(int* type, u_int32_t* timestamp, char** data, int* size);
int srs_write_packet(int type, u_int32_t timestamp, char* data, int size);

/**
* whether srs is compiled with ssl,
* that is, compile srs with ssl: ./configure --with-ssl,.
* if no ssl, complex handshake always error.
* @return 0 for false, otherwise, true.
*/
int srs_ssl_enabled();

/**
* get protocol stack version
*/
int srs_version_major();
int srs_version_minor();
int srs_version_revision();

#ifdef __cplusplus
}
#endif

#endif

Winlin

Home | About | Project | Setup Guide v1,v2 | Technical Docs v1,v2 | Copyright © 2013-2015 winlin

Welcome to SRS wiki!

SRS 1.0 wiki

Please select your language:

SRS 2.0 wiki

Please select your language:

SRS 3.0 wiki

Please select your language:

Clone this wiki locally