![logo](https://raw.githubusercontent.com/zlmediakit/ZLMediaKit/master/www/logo.png) # A lightweight ,high performance and stable stream server and client framework based on C++11. [![license](http://img.shields.io/badge/license-MIT-green.svg)](https://github.com/xia-chu/ZLMediaKit/blob/master/LICENSE) [![C++](https://img.shields.io/badge/language-c++-red.svg)](https://en.cppreference.com/) [![platform](https://img.shields.io/badge/platform-linux%20|%20macos%20|%20windows-blue.svg)](https://github.com/xia-chu/ZLMediaKit) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-yellow.svg)](https://github.com/xia-chu/ZLMediaKit/pulls) [![Build Status](https://travis-ci.org/xia-chu/ZLMediaKit.svg?branch=master)](https://travis-ci.org/xia-chu/ZLMediaKit) ## Why ZLMediaKit? - Developed based on C++ 11, the code is stable and reliable, avoiding the use of raw pointers, cross-platform porting is simple and convenient, and the code is clear and concise. - Support rich streaming media protocols(`RTSP/RTMP/HLS/HTTP-FLV/WebSocket-flv/HTTP-TS/WebSocket-TS`),and support Inter-protocol conversion. - Multiplexing asynchronous network IO based on epoll and multi thread，extreme performance. - Well performance and stable test,can be used commercially. - Support linux, macos, ios, android, Windows Platforms. - Very low latency(lower then one second), video opened immediately. ## Features - RTSP[S] - RTSP[S] server,support rtsp push. - RTSP[S] player and pusher. - RTP Transport : `rtp over udp` `rtp over tcp` `rtp over http` `rtp udp multicast` . - Basic/Digest/Url Authentication. - H265/H264/AAC/G711/OPUS codec. - Recorded as mp4. - Vod of mp4. - RTMP[S] - RTMP[S] server,support player and pusher. - RTMP[S] player and pusher. - Support HTTP-FLV/WebSocket-FLV sever. - H265/H264/AAC/G711/OPUS codec. - Recorded as flv or mp4. - Vod of mp4. - support [RTMP-H265](https://github.com/ksvc/FFmpeg/wiki) - HLS - RTSP RTMP can be converted into HLS,built-in HTTP server. - Play authentication based on cookie. - Support HLS player, support streaming HLS proxy to RTSP / RTMP / MP4. - TS - Support HTTP-TS/WebSocket-TS sever. - HTTP[S] - HTTP server,suppor directory meun、RESTful http api. - HTTP client,downloader,uploader,and http api requester. - Cookie supported. - WebSocket Server and Client. - File access authentication. - Others - Support stream proxy by ffmpeg. - RESTful http api and http hook event api. - Config file hot loading. - Vhost supported. - Auto close stream when nobody played. - Play and push authentication. - Pull stream on Demand. - Support TS / PS streaming push through RTP,and it can be converted to RTSP / RTMP / HLS / FLV. - Support real-time online screenshot http api. ## System Requirements - Compiler support c++11，GCC4.8/Clang3.3/VC2015 or above. - cmake3.1 or above. - All Linux , both 32 and 64 bits - Apple OSX(Darwin), both 32 and 64bits. - All hardware with x86/x86_64/arm/mips cpu. - Windows. ## How to build It is recommended to compile on Ubuntu or MacOS，compiling on windows is cumbersome, and some features are not compiled by default. ### Before build - **You must use git to clone the complete code. Do not download the source code by downloading zip package. Otherwise, the sub-module code will not be downloaded by default.You can do it like this:** ``` git clone https://github.com/xiongziliang/ZLMediaKit.git cd ZLMediaKit git submodule update --init ``` ### Build on linux - My environment - Ubuntu16.04 64 bit and gcc5.4 - cmake 3.5.1 - Guidance ``` # If it is on centos6.x, you need to install the newer version of GCC and cmake first, # and then compile manually according to the script "build_for_linux.sh". # If it is on a newer version of a system such as Ubuntu or Debain, # step 4 can be manipulated directly. # 1、Install GCC5.2 (this step can be skipped if the GCC version is higher than 4.7) sudo yum install centos-release-scl -y sudo yum install devtoolset-4-toolchain -y scl enable devtoolset-4 bash # 2、Install cmake (this step can be skipped if the cmake version is higher than 3.1) tar -xvf cmake-3.10.0-rc4.tar.gz #you need download cmake source file manually cd cmake-3.10.0-rc4 ./configure make -j4 sudo make install # 3、Switch to high version GCC scl enable devtoolset-4 bash # 4、build cd ZLMediaKit ./build_for_linux.sh ``` ### Build on macOS - My environment - macOS Sierra(10.12.1) + xcode8.3.1 - Homebrew 1.1.3 - cmake 3.8.0 - Guidance ``` cd ZLMediaKit ./build_for_mac.sh ``` ### Build on iOS - You can generate Xcode projects and recompile them , [learn more](https://github.com/leetal/ios-cmake): ``` cd ZLMediaKit mkdir -p build cd build # Generate Xcode project, project file is in build directory cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../cmake/ios.toolchain.cmake -DPLATFORM=OS64COMBINED ``` ### Build on Android Now you can open android sudio project in `Android` folder,this is a `aar library` and damo project. - My environment - 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) - Guidance ``` cd ZLMediaKit export ANDROID_NDK_ROOT=/path/to/ndk ./build_for_android.sh ``` ### Build on Windows - My environment - windows 10 - visual studio 2017 - [cmake-gui](https://cmake.org/files/v3.10/cmake-3.10.0-rc1-win32-x86.msi) - Guidance ``` 1 Enter the ZLMediaKit directory and execute git submodule update -- init downloads the code for ZLToolKit 2 Open the project with cmake-gui and generate the vs project file. 3 Find the project file (ZLMediaKit.sln), double-click to open it with vs2017. 4 Choose to compile Release version. Find the target file and run the test case. ``` ## Usage - As server： ```cpp TcpServer::Ptr rtspSrv(new TcpServer()); TcpServer::Ptr rtmpSrv(new TcpServer()); TcpServer::Ptr httpSrv(new TcpServer()); TcpServer::Ptr httpsSrv(new TcpServer()); 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]); ``` - As player： ```cpp MediaPlayer::Ptr player(new MediaPlayer()); weak_ptr weakPlayer = player; player->setOnPlayResult([weakPlayer](const SockException &ex) { InfoL << "OnPlayResult:" << ex.what(); auto strongPlayer = weakPlayer.lock(); if (ex || !strongPlayer) { return; } auto viedoTrack = strongPlayer->getTrack(TrackVideo); if (!viedoTrack) { WarnL << "none video Track!"; return; } viedoTrack->addDelegate(std::make_shared([](const Frame::Ptr &frame) { //please decode video here })); }); player->setOnShutdown([](const SockException &ex) { ErrorL << "OnShutdown:" << ex.what(); }); //rtp transport over tcp (*player)[Client::kRtpType] = Rtsp::RTP_TCP; player->play("rtsp://admin:jzan123456@192.168.0.122/"); ``` - As proxy server： ```cpp //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 proxyMap; int i=0; for(auto url : urlList){ PlayerProxy::Ptr player(new PlayerProxy("live",to_string(i++).data())); player->play(url); proxyMap.emplace(string(url),player); } ``` - As puser： ```cpp PlayerProxy::Ptr player(new PlayerProxy("app","stream")); player->play("rtmp://live.hkstv.hk.lxdns.com/live/hks"); RtmpPusher::Ptr pusher; NoticeCenter::Instance().addListener(nullptr,Config::Broadcast::kBroadcastRtmpSrcRegisted, [&pusher](BroadcastRtmpSrcRegistedArgs){ const_cast(pusher).reset(new RtmpPusher(app,stream)); pusher->publish("rtmp://jizan.iok.la/live/test"); }); ``` ## Docker Image You can pull a pre-built docker image from Docker Hub and run with ```bash docker run -id -p 1935:1935 -p 8080:80 -p 8554:554 -p 10000:10000 -p 10000:10000/udp panjjo/zlmediakit ``` Dockerfile is also supplied to build images on Ubuntu 16.04 ```bash cd docker docker build -t zlmediakit . ``` ## Contact - Email：<1213642868@qq.com> - QQ chat group：542509000