ZLMediaKit/README.md

204 lines
6.7 KiB
Markdown
Raw Normal View History

2017-04-22 21:45:58 +08:00
# 一个基于C++11简单易用的轻量级流媒体库
2017-05-03 00:00:15 +08:00
平台|编译状态
----|-------
Linux | [![Build Status](https://travis-ci.org/xiongziliang/ZLMediaKit.svg?branch=master)](https://travis-ci.org/xiongziliang/ZLMediaKit)
2017-05-11 23:20:31 +08:00
macOS | [![Build Status](https://travis-ci.org/xiongziliang/ZLMediaKit_build_for_mac.svg?branch=master)](https://travis-ci.org/xiongziliang/ZLMediaKit_build_for_mac)
iOS | [![Build Status](https://travis-ci.org/xiongziliang/ZLMediaKit-build_for_ios.svg?branch=master)](https://travis-ci.org/xiongziliang/ZLMediaKit-build_for_ios)
2017-06-03 11:14:27 +08:00
Android | [![Build Status](https://travis-ci.org/xiongziliang/ZLMediaKit_build_for_android.svg?branch=master)](https://travis-ci.org/xiongziliang/ZLMediaKit_build_for_android)
2017-05-03 00:00:15 +08:00
2017-05-06 00:07:32 +08:00
## 项目特点
2017-04-22 21:45:58 +08:00
- 基于C++11开发避免使用裸指针代码稳定可靠同时跨平台移植简单方便代码清晰简洁。
- 打包多种流媒体协议(RTSP/RTMP/HLS支持协议间的互相转换提供一站式的服务。
- 使用epoll+线程池+异步网络IO模式开发并发性能优越。
2017-04-22 21:47:03 +08:00
- 只实现主流的的H264+AAC流媒体方案代码精简,脉络清晰,适合学习。
2017-04-01 16:42:00 +08:00
2017-04-22 21:45:58 +08:00
## 功能清单
- RTSP
- RTSP 服务器支持RTMP/MP4转RTSP。
- RTSP 播放器支持RTSP代理。
- 支持 `rtp over udp` `rtp over tcp` `rtp over http` `rtp组播` 四种RTP传输方式 。
2017-04-01 16:42:00 +08:00
2017-04-22 21:45:58 +08:00
- RTMP
- RTMP 播放服务器支持RTSP/MP4转RTMP。
- RTMP 发布服务器,支持录制发布流。
- RTMP 播放器支持RTMP代理。
- RTMP 推流客户端。
2017-04-01 16:42:00 +08:00
2017-04-22 21:45:58 +08:00
- HLS
2017-04-22 21:48:02 +08:00
- 支持HLS文件生成自带HTTP文件服务器。
2017-05-06 00:07:32 +08:00
- HTTP[S]
- 服务器支持`目录索引生成`,`文件下载`,`表单提交请求`。
- 客户端提供`文件下载器(支持断点续传)`,`接口请求器`。
2017-04-01 16:42:00 +08:00
2017-04-22 21:45:58 +08:00
- 其他
2017-04-22 21:48:02 +08:00
- 支持输入YUV+PCM自动生成RTSP/RTMP/HLS/MP4.
- 支持简单的telnet调试。
- 支持H264的解析支持B帧的POC计算排序。
2017-04-22 21:45:58 +08:00
## 后续任务
- 提供更多的示例代码
2017-04-01 16:42:00 +08:00
2017-04-22 22:57:43 +08:00
## 编译(Linux)
2017-04-22 21:45:58 +08:00
- 我的编译环境
- Ubuntu16.04 64 bit + gcc5.4(最低gcc4.7)
2017-05-03 00:00:15 +08:00
- cmake 3.5.1
2017-05-11 23:20:31 +08:00
- 编译
2017-05-03 00:16:53 +08:00
2017-05-11 23:20:31 +08:00
```
cd ZLMediaKit
2017-05-16 17:08:15 +08:00
./build_for_linux.sh
2017-05-11 23:20:31 +08:00
```
2017-05-03 00:00:15 +08:00
2017-05-11 23:20:31 +08:00
## 编译(macOS)
- 我的编译环境
- macOS Sierra(10.12.1) + xcode8.3.1
- Homebrew 1.1.3
- cmake 3.8.0
- 编译
2017-05-03 00:16:53 +08:00
2017-05-11 23:20:31 +08:00
```
cd ZLMediaKit
./build_for_mac.sh
```
## 编译(iOS)
- 编译环境:`请参考macOS的编译指导。`
2017-05-03 00:00:15 +08:00
- 编译
2017-05-11 23:20:31 +08:00
```
cd ZLMediaKit
./build_for_ios.sh
```
- 你也可以生成Xcode工程再编译
2017-05-03 00:00:15 +08:00
```
cd ZLMediaKit
mkdir -p build
cd build
2017-05-11 23:20:31 +08:00
# 生成Xcode工程工程文件在build目录下
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/iOS.cmake -DIOS_PLATFORM=SIMULATOR64 -G "Xcode"
```
2017-06-03 11:14:27 +08:00
## 编译(Android)
- 我的编译环境
- macOS Sierra(10.12.1) + xcode8.3.1
- Homebrew 1.1.3
- cmake 3.8.0
- [android-ndk-r14b](https://dl.google.com/android/repository/android-ndk-r14b-darwin-x86_64.zip)
- 编译
2017-04-22 21:45:58 +08:00
2017-06-03 11:14:27 +08:00
```
cd ZLMediaKit
export ANDROID_NDK_ROOT=/path/to/ndk
./build_for_android.sh
```
2017-06-05 17:53:58 +08:00
## 使用方法
- 作为服务器:
```
TcpServer<RtspSession>::Ptr rtspSrv(new TcpServer<RtspSession>());
TcpServer<RtmpSession>::Ptr rtmpSrv(new TcpServer<RtmpSession>());
TcpServer<HttpSession>::Ptr httpSrv(new TcpServer<HttpSession>());
TcpServer<HttpsSession>::Ptr httpsSrv(new TcpServer<HttpsSession>());
rtspSrv->start(mINI::Instance()[Config::Rtsp::kPort]);
rtmpSrv->start(mINI::Instance()[Config::Rtmp::kPort]);
httpSrv->start(mINI::Instance()[Config::Http::kPort]);
httpsSrv->start(mINI::Instance()[Config::Http::kSSLPort]);
EventPoller::Instance().runLoop();
```
- 作为播放器:
```
MediaPlayer::Ptr player(new MediaPlayer());
player->setOnPlayResult([](const SockException &ex) {
InfoL << "OnPlayResult:" << ex.what();
});
player->setOnShutdown([](const SockException &ex) {
ErrorL << "OnShutdown:" << ex.what();
});
player->setOnVideoCB([&](const H264Frame &frame){
//在这里解码H264并显示
});
player->setOnAudioCB([&](const AdtsFrame &frame){
//在这里解码AAC并播放
});
//支持rtmp、rtsp
2017-06-05 17:55:32 +08:00
player->play("rtsp://192.168.0.122/","admin","123456",PlayerBase::RTP_TCP);
2017-06-05 17:53:58 +08:00
EventPoller::Instance().runLoop();
```
- 作为代理服务器:
```
//support rtmp and rtsp url
//just support H264+AAC
auto urlList = {"rtmp://live.hkstv.hk.lxdns.com/live/hks",
"rtsp://184.72.239.149/vod/mp4://BigBuckBunny_175k.mov"};
map<string , PlayerProxy::Ptr> proxyMap;
int i=0;
for(auto url : urlList){
//PlayerProxy构造函数前两个参数分别为应用名app,流idstreamId
//比如说应用为live流id为0那么直播地址为
//http://127.0.0.1/live/0/hls.m3u8
//rtsp://127.0.0.1/live/0
//rtmp://127.0.0.1/live/0
//录像地址为:
//http://127.0.0.1/record/live/0/2017-04-11/11-09-38.mp4
//rtsp://127.0.0.1/record/live/0/2017-04-11/11-09-38.mp4
//rtmp://127.0.0.1/record/live/0/2017-04-11/11-09-38.mp4
PlayerProxy::Ptr player(new PlayerProxy("live",to_string(i++).data()));
player->play(url);
proxyMap.emplace(string(url),player);
}
```
## 为什么VLC播放一段时间就停止了
2017-06-05 17:58:37 +08:00
由于ZLMediaKit在实现RTSP协议时采用OPTIONS命令作为心跳包在RTP over UDP时有效如果播放器不持续发送OPTIONS指令那么ZLMediaKit会断开连接。如果你要用第三方播放器测试你可以改RTP over TCP方式或者修改ZLMediaKit的源码修改位置位置为src/Rtsp/RtspSession.cpp RtspSession::onManager函数,修改成如下所示:
2017-06-05 17:53:58 +08:00
```
void RtspSession::onManager() {
if (m_ticker.createdTime() > 10 * 1000) {
if (m_strSession.size() == 0) {
WarnL << "非法链接:" << getPeerIp();
shutdown();
return;
}
if (m_bListenPeerUdpPort) {
UDPServer::Instance().stopListenPeer(getPeerIp().data(), this);
m_bListenPeerUdpPort = false;
}
}
/*if (m_rtpType != PlayerBase::RTP_TCP && m_ticker.elapsedTime() > 15 * 1000) {
WarnL << "RTSP会话超时:" << getPeerIp();
shutdown();
return;
/*}
}
```
## 怎么测试服务器性能?
2017-06-05 17:58:37 +08:00
ZLMediaKit提供了测试性能的示例代码在tests/test_benchmark.cpp。由于ZLToolKit默认关闭了tcp客户端多线程的支持如果需要提高测试并发量需要在编译ZLToolKit时启用ENABLE_ASNC_TCP_CLIENT宏具体操作如下
2017-06-05 17:53:58 +08:00
```
#编译ZLToolKit
cd ZLToolKit
mkdir -p build
cd build -DENABLE_ASNC_TCP_CLIENT
cmake ..
make -j4
sudo make install
```
## github下载太慢了有其他下载方式吗
你可以在通过开源中国获取最新的代码,地址为:
[ZLToolKit](http://git.oschina.net/xiahcu/ZLToolKit)
2017-06-03 11:14:27 +08:00
2017-06-05 17:53:58 +08:00
[ZLMediaKit](http://git.oschina.net/xiahcu/ZLMediaKit)
2017-04-22 21:45:58 +08:00
## 联系方式
2017-05-03 00:00:15 +08:00
- 邮箱:<771730766@qq.com>
2017-04-22 21:45:58 +08:00
- QQ群542509000
2017-04-22 22:52:29 +08:00