Kurento应用开发指南(以Kurento 5.0为模板) 之中的一个：简单介绍，安装与卸载

文件夹
1. Kurento是什么               3
2. Kurento简单介绍                       3
2.1 WebRTC媒体server               3
2.2 Kurento 媒体server               4
2.3 Kurento API, client和协议       5
2.4  使用Kurento建立应用程序       7
3. Kurento Media Server的安装与卸载    8
3.1  Kurento Media Server的安装       8
3.2 kurento Media Server的启动与中止   8
3.3. kurento Media Server的卸载 8
4.  STUN和TURN服务配置 9
4.1.  STUNserver配置 9
4.2.  TURNserver配置 10
5. Kurento教程 11
5.1  Node.js 教程1 - Hello world 11
5.1.1 执行演示样例程序 11
5.1.2 执行时的出错 12
5.1.3 演示样例程序的分析 14
5.1.4 应用程序服务端逻辑 16
5.1.5  client逻辑 19
5.1.6 依赖库 20
5.2  教程3一对多的视频呼叫 21
5.2.1 执行演示样例程序 21
5.2.2  理解这个演示样例程序 21
5.2.3 应用程序服务端逻辑 24
5.2.4  client 29
5.2.5 依赖库 30
5.3 教程四-一对一的视频呼叫 31
5.3.1 执行演示样例程序 31
5.3.2 Understanding this example 31
5.3.3 应用程序服务端逻辑 33
5.3.4 client 40
5.3.5 依赖库 43
11. Kurento 架构 43
11.1 Kurento API和接口 44
11.2 Kurento 模块 45
11.3 使用Kurento建立应用程序 46
11.4 client，服务端和Kurento的通讯 47
11.5 使用kurento实现实时WebRTC应用 49
11.6 Kurento 设计原则 51

1. Kurento是什么

Kurento是一个WebRTC媒体server，并且包括一个clientAPI集合，
用以简化WWW和移动平台上的高级视频应用程序的开发。
Kurento的功能包含组通讯，转码，记录。混音。广播和routing of audiovisual flows。
Kurento相同提供高级的媒体处理能力，包含计算机视觉。视频检索。虚拟现实和语音分析。
Kurento模块化的架构使得其集成第三方媒体处理算法(如语音识别，场景分析，人脸识别等)很是easy。
而且它可以被应用程序开发人员视为透明。
Kurento的核心组成是Kurento媒体server，它用来负责媒体传输，处理，载入和记录。
它是基于GStreamer。优化了资源消耗来实现的。它提供的功能例如如下:
• 网络流协议，包含HTTP(做为client和服务端工做)，RTP和WebRTC.
• 组通讯(MCU和SFU功能)，支持媒体混合和媒体路由/分发
• 原生支持计算机视觉和虚拟现实滤镜
• 媒体存储，支持WebM和MP4的写操做。能播放GStreamer支持的所有格式
• 本身主动的媒体转换。支持GStreamer提供的所有codec，包含VP8, H.264, H.263, , AMR, OPUS, Speex, G.711,等。

它还提供的不少基于Java和Javascript的Kurentoclient库，用来提供给应用程序控制Kurento媒体server。
假设你喜欢其余的编程语言。可以使用基于WebSocket和JSON-RPC的Kurento协议来实现。
Kurento是开源的，它基于 LGPL version 2.1许可协议，它的源代码位于GitHub。.
假设你想高速上手。最好的方式是安装Kurento媒体server并学习官方提供的演示样例教程。
假设想利用好Kurento，可以看本指南的高级部分。

2. Kurento简单介绍

2.1 WebRTC媒体server

WebRTC是一项开源技术，它能够经过JavaScript API实现网页浏览器间的实时通讯。
它被以为是一种P2P技术，能实现浏览器间的实时通讯，而不用经过不论什么类型的媒体中继。

这样的方式能足以实现一些主要的应用。但是有些功能。如组通讯，媒体流录制，
媒体广播或媒体转码是很是难实现的。

基于这个缘由，很是多应用仍是需要有媒体server。

 
Figure 1.1: Peer-to-peer WebRTC approach vs. WebRTC through a media server
在概念上。WebRTC媒体server是一种多媒体中继(它位于两个通讯端的中间)。

媒体server能处理媒体流。并有各类功能，包含组通讯(分发一个端生成的媒体流到多个接收端，
如像Multi-Conference Unit, MCU的工做方式)。混合(转换多个输入流合成一个组合流)。
转码(在不兼容的client间选择codec和格式)， 录制等
 
Figure 1.2: Typical WebRTC Media Server capabilities

2.2 Kurento 媒体server

Kurento架构的核心是媒体server，它被命名为Kurento媒体server(KMS)。

Kurento媒体server的媒体处理能力是插件式的，意思是它的功能都是插件模块，
可以被激活和关闭。而且，开发人员可以无缝地建立额外的模块来扩展Kurento媒体server并动态插入。
Kurento媒体server提供即时可用的组通讯。混合，转码，录制和播放。
另外，它还提供一些高级的媒体处理模块。包含有计算机视觉，虚拟现实，透镜等；
 
Figure 2.1: Kurento Media Server capabilities

2.3 Kurento API, client和协议

Kurento媒体server的能力是经过Kurento API呈现给应用开发人员的。

这些API是经过叫作Kurento Client库实现的。
Kurento提供了两种类型的client库: Java和JavaScript。

假设你但愿使用其余的语言，可以经过Kurento 协议来直接操做Kurento。

这个协议可以控制Kurento媒体server。它是基于标准的网络协议如WebSocket和JSON-RPC。
下图显示了Kurentoclient的三种应用场景:
• 在兼容WebRTC的浏览器上直接使用Kurento JavaScript Client
• 在Java EE Application Server上使用Kurento Java Client 
• 在Node.js server上使用Kurento JavaScript Client
这三种场景在教程中都有完整的演示样例程序。
 
Figure 3.1: Connection of Kurento Clients (Java and JavaScript) to Kuento Media Server


Kurento Client的API是基于Media Element的概念，每个Media Element都有特定的媒体能力。
好比。WebRtcEndpoint有发送和接收WebRTC媒体流的能力。
RecorderEndpoint 有将接收到的媒体流存储到文件的能力。
FaceOverlayFilter 能检測视频流中的人脸并加入一个特定的图片在人脸之上。

Kurento拥有丰富的媒体元素工具箱来作为它的API的一部分。
 
Figure 3.2: Some Media Elements provided out of the box by Kurento


更好的理解这些概念需要參见本文档中关于Kurento API和Kurento Protocol的章节.
你相同还需要看看Java文档和JS文档:
• kurento-client-java : JavaDoc of Kurento Java Client.
• kurento-client-js : JsDoc of Kurento JavaScript Client.
• kurento-utils-js : JsDoc of an utility JavaScript library aimed to simplify the development of WebRTC applications.

2.4  使用Kurento建立应用程序

从应用程序开发者的角度来看，媒体元素就像是乐高积木：
你仅仅需选择应用程序想要的元素，而后再它链接到想要的拓扑结构中。

在Kurento的术语中。媒体元素的链接图被称做媒体管道。

所以，当你想建立一个管道时，开发者需要肯定想要使用的媒体元素的能力。
并肯定媒体元素间怎样链接的拓扑图。这些链接是经过链接原语控制(以Kurento Client APIs方式显现)。
这些原语以拓扑上兴许的元素做为參数。激活本元素做为源:
sourceMediaElement.connect(sinkMediaElement)


好比，假设你想建立一个录制WebRTC流到文件的应用程序，
你需要两个媒体元素:WebRtcEndpoint 和 RecorderEndpoint。当一个client链接到这个应用程序时，
你需要实例化这两个媒体元素。并使用 WebRtcEndpoint 
(它用来接收WebRTC流)来接收流后输送给RecorderEndpoint (它用来将媒体流录制到文件)。

最后。你需要链接它们，这样就能实现将前一个媒体元素接收到的流输送给后一年媒体元素。
像如下这样:
WebRtcEndpoint.connect(RecorderEndpoint)


为了简化在client的WebRTC流的处理。Kurento提供了一个叫WebRtcPeer的实体，
而且，标准的WebRTC API (getUserMedia, RTCPeerConnection,and so on) 
相同能链接到WebRtcEndpoints。

不少其它的信息可以參见演示样例程序的章节
 
Figure 4.1: Simple Example of a Media Pipeline

3. Kurento Media Server的安装与卸载

3.1  Kurento Media Server的安装

Kurento Media Server必须安装在Ubuntu 14.04 LTS (32 or 64 bits)下。

考虑到在Ubuntu Server 14.04下安装Kurento Media Server时，
工具add-apt-repository默认是没有安装的。可以用如下的命令安装。
# sudo apt-get install software-properties-common


使用如下的命令可以安装 Kurento Media Server的最新版本号，根据如下的顺序，一次一个命令。

安装过程当中有问答时。回复确定就能够:
# sudo add-apt-repository ppa:kurento/kurento
# sudo apt-get update
# sudo apt-get install kurento-media-server

3.2 kurento Media Server的启动与中止

现在，Kurento Media Server安装并已启动了。

可以使用如下的命令启动和中止。
# sudo service kurento-media-server start
# sudo service kurento-media-server stop
Kurento Media Server 的日志文件位于 /var/log/kurento-media-server/media-server.log。

3.3. kurento Media Server的卸载

卸载使用例如如下命令:
# sudo apt-get remove kurento-media-server
# sudo apt-get purge kurento-media-server
或者完全卸载:
# sudo apt-get remove kurento*
# sudo apt-get autoremove
# sudo apt-get update
# sudo apt-get dist-upgrade

3.4 Kurento Media Server的手动编译安装

Kurento Media Server
To build Kurento Media Server you need an Ubuntu 14.04 LTS operating system.
First you have to install all needed development tools and dependencies executing the following commands:
# sudo add-apt-repository ppa:kurento/kurento
# sudo apt-get update
# sudo apt-get install git
# sudo apt-get install libthrift-dev thrift-compiler libjsoncpp-dev
# sudo apt-get install gstreamer1.0* libgstreamer1.0-dev
# sudo apt-get install libgstreamer-plugins-base1.0-dev libnice-dev gtk-doc-tools
# sudo apt-get install cmake libglibmm-2.4-dev uuid-dev libevent-dev libboost-dev
# sudo apt-get install libboost-system-dev libboost-filesystem-dev
# sudo apt-get install libboost-test-dev libsctp-dev
# sudo apt-get install libopencv-dev autoconf git libjsoncpp-dev
# sudo apt-get install libtool libsoup2.4-dev tesseract-ocr-dev tesseract-ocr-eng
# sudo apt-get install libgnutls28-dev gnutls-bin libvpx-dev
​
Plase take care that the list of dependencies changes as dependencies change and new features are added, 
​you can check the actual packages that the Ubuntu PPA needs for building from sources in the Build-Depends of the latest release debian/control file.
Second you have to get the source code clonning git repository:
# git clone https://github.com/Kurento/kurento-media-server.git
Then you can compile Kurento Media Server:
# mkdir build
# cd build
# cmake ..
# make
Finally, install it into the system as a service:
# git submodule update --recursive --init
# dpkg-buildpackage -us -uc
# sudo dpkg -i ../kurento_<version>_<arch>.deb
And start and stop it:
# sudo service kurento-media-server start
# sudo service kurento-media-server stop

4.  STUN和TURN服务配置

假设Kurento Media Server位于NAT以后，这时就需要使用 STUN or TURN来实现NAT穿透。
在大多数状况下，STUNserver可以知足需要。仅仅有在NAT是对称的时，才需要TURNserver。

4.1.  STUNserver配置

为了安装STUNserver，需要取消Kurento Media Server配置文件里的如下两行的凝视。
配置文件位于 /etc/kurento/kurento.conf.json  :
"stunServerAddress" : "stun ip address",
"stunServerPort" : 3478


參数 stunServerAddress  应当是一个IP地址。不能是域名。
而且需要注意它的JSON格式，假设 stunServerPort 行是WebRtcEndpoint  区域的最后一行，
那么它不能以逗号(,)结束。

如下是一些可用的公共的STUNserver，好比:
173.194.66.127:19302
173.194.71.127:19302
74.125.200.127:19302
74.125.204.127:19302
173.194.72.127:19302
74.125.23.127:3478
77.72.174.163:3478
77.72.174.165:3478
77.72.174.167:3478
77.72.174.161:3478
208.97.25.20:3478
62.71.2.168:3478
212.227.67.194:3478
212.227.67.195:3478
107.23.150.92:3478
77.72.169.155:3478
77.72.169.156:3478
77.72.169.164:3478
77.72.169.166:3478
77.72.174.162:3478
77.72.174.164:3478
77.72.174.166:3478
77.72.174.160:3478
54.172.47.69:3478

4.2.  TURNserver配置

为了安装TURNserver，需要取消Kurento Media Server配置文件(/etc/kurento/kurento.conf.json)
如下这行的凝视:
"turnURL" : "user:password@address:port"
和前面的同样。TURN地址也必须是IP地址(不能是域名)。相同也要注意JSON格式的最后一行的逗号。TURN配置的示比例如如下:
"turnURL" : "kurento:kurento@193.147.51.36:3478"
或使用免费的numb STUN/TURNserver例如如下:
"turnURL" : "user:password@66.228.45.110:3478"
有一个TURNserver的开源实现:coturn.(https://code.google.com/p/coturn/).