nginx-rtmp模块简介

Posted 2023-03-24

参考技术A 1:  Module Configuration Struct(s)模块配置结构

这个结构的命名规则为ngx_http_[module-name]_[main|srv|loc]_conf_t。

main,srv,loc表示这个模块的作用范围是配置文件中的main/server/location三种范围（这个需要记住，后面会经常用到）

2: Module Directives模块命令结构

static ngx_command_t ngx_http_echo_commands[] =



ngx_string("echo"), //命令名字

NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, //代表是local配置，带一个参数

ngx_http_echo, //组装模块配置结构

NGX_HTTP_LOC_CONF_OFFSET, //上面的组装模块配置获取完参数后存放到 哪里？使用这个和下面的offset参数来进行定位

offsetof(ngx_http_echo_loc_conf_t, ed), //同上 

,

ngx_null_command //必须使用ngx_null_command作为commands的结束标记

;

3: The Module Context模块内容

static ngx_http_module_t   ngx_http_circle_gif_mod ule_ctx

主要是定义了一些钩子函数, nginx会在不同时期会调用

4: The Module Definition模块整合

ngx_module_t ngx_http_<module name>_module =

NGX_MODULE_V1,

&ngx_http__module_ctx, /* module context模块内容 */

ngx_http__commands, /* module directives模块命令*/

NGX_HTTP_MODULE, /* module type模块类型，HTTP模块，或者HTTPS*/

5: Module Installation模块安装

1: ngx_rtmp_live_module

直播模块:推拉流同点, 不涉及回源

2: ngx_rtmp_relay_module

中继模块:  1:回源pull  2: 转推: push

一:  建立rtmp连接, 需要握手

      1: ngx_rtmp_handshake_recv()开始握手

      2: NGX_RTMP_HANDSHAKE_DONE()握手完成

      3: ngx_rtmp_cycle()重新设置读写handler

二:  建立网络连接

    建立rtmp连接之后, ngx_rtmp_recv函数会利用ngx_event_t结构会获取推送过来的原始数据, 接受到的数据会存放到ngx_rtmp_stream_t的in链表结构中.

1:接受chunk数据

2:分析处理chunk数据, 如果message还没接受完, 继续接受数据

3:将chunk组成一个rtmp message, 然后交给ngx_rtmp_receive_message处理, 这个函数根据消息的类型找对应的handle

三:  建立网络流

        在建立网络连接后,就需要建立网络流了, 网络流代表了发送多媒体数据的通道. 服务器和客户端只能建立一个网络连接, 且多个网络流可以复用这一个网络连接

1: ngx_rtmp_recv接受数据后交给ngx_rtmp_receive_handler, 它会根据类型区别处理, 此时客户端发送ngx_rtmp_msg_chunk_size类型的消息

2:接受message后跳转到处理函数ngx_rtmp_amf_message_handler. 处理客户端发送的amf控制消息. 此时连续接受3个amf数据.

3:调用ngx_rtmp_cmd_create_stream_init初始化网络流. 利用ngx_rtmp_receive_amf获取接受的amf数据.

4:调用ngx_rtmp_cmd_create_stream创建网络流, 利用ngx_rtmp_send_amf向客户端发送amf控制消息

四:  传输媒体数据

在客户端和服务端建立网络流之后,接下来就可以传输媒体数据了, 一般来讲, 媒体数据分为两部分, 一部分为meta元信息, 另一部分是音视频数据, 首先传送的是meta元信息. 然后推送媒体. 服务器处理如下:

1:从客户端接受amf命令信息, 然后服务端会利用ngx_rtmp_cmd_publish_init来初始化发布环境.  函数功能: 会读取刚接受端amf信息

2:利用ngx_rtmp_auto_push_publish, ngx_rtmp_notify_publish, ngx_rtmp_exec_publish建立发布环境,

3:如果conf配置了record命令记录媒体文件, 此时会调用ngx_rtmp_record_publish来初始化记录环境;

4:执行ngx_rtmp_access_publish;

[if !supportLists]l [endif]meta信息:

5:接受客户端amf, 并调用ngx_rtmp_codec_meta_data获取meta元信息;

6:结合服务器的参数, 利用ngx_rtmp_codec_reconstruct_meta接口重构meta元信息, 并调用ngx_rtmp_prepare_message组成消息保存

[if !supportLists]l [endif]媒体数据:

7:接受客户端推送, 根据类型转到ngx_rtmp_codec_av来处理音视频数据; 其中利用函数ngx_rtmp_codec_parse_avc_header来处理头部信息

8:调用record模块记录数据, 接口为ngx_rtmp_codec_av;

9:调用live模块来广播发布数据, 接口为ngx_rtmp_live_av, 广播到所有观察者, 第一次调用接口ngx_rtmp_live_start创建广播, 之后直接调用ngx_rtmp_append_shared-bufs

 

rtmp 的 信令交互图:

1: 播放器端发起play

2: ngx_rtmp_relay_play()

3: ngx_rtmp_relay_pull() --主要建立pull请求, 将远程拉流的上下文和本地上下文放到链表中

    ngx_rtmp_relay_create_local_ctx()创建本地上下文

    ngx_rtmp_relay_create_remote_ctx()创建远端上下文

4: ngx_rtmp_relay_create_remote_ctx详解:  创建远端session, 开始rtmp信令交互

       1: ngx_rtmp_relay_create_connection  

        2: ngx_rtmp_init_session

注意:此时session中的flashver为“ngx-local-relay“

5: rtmp信令交互流程

核心函数: ngx_rtmp_relay_on_result主要用来接收对端服务端发送的amf消息包，而后按正常rtmp协议请求进行下一步交互，这个主要是当前服务端做为客户端发起远程rtmp请求流程

例如:   ngx_rtmp_client_handshake(发起握手)

         握手完成后调用回调函数: ngx_rtmp_relay_handshake_done

       ngx_rtmp_relay_send_connect:发起连接请求, 接着参考rtmp信令交互图

        核心功能:向nginx推送一个直播流，该直播流经 nginx-rtmp 的 ngx_rtmp_live_module 模块转发给 application live 应用，然后使用vlc连接 live，播放该直播流。本质上就是1对多的广播

参考: http://nginx.org/en/docs/debugging_log.html

1: Nginx-rtmp-module模块源码学习

https://blog.evanxia.com/2017/02/1264

2: nginx_rtmp_relay_module模块解读

https://www.shangmayuan.com/a/d74b78669f804fb5b12cae5a.html

3:开发手册中文版:包含指令介绍

https://blog.csdn.net/ai2000ai/article/details/55517992

linux搭建nginx-rtmp服务

确认安装编译所需要的环境：

安装前要确定安装了gcc-c++ 和openssl-devel (可以使用yum安装)

yum -y install gcc gcc-c++     yum install openssl-devel 

linux下安装nginx-rtmp需要下面的几个安装包（安装包版本没有硬性要求 ，选择适合自己的即可）：

1.nginx-1.13.6.tar.gz

2.nginx_mod_h264_streaming-2.27.zip

3.openss1-1.0.1.tar.gz

4.pcre-8.41.zip

将下载的安装包解压

使用mkdir命令建立nginx_rtmp目录，此目录是rtmp的安装位置

进入解压的nginx-1.13.6根目录下，执行命令：

./configure --prefix=/data/nginx_rtmp  --with-http_ssl_module --with-http_flv_module  --with-http_stub_status_module  --with-pcre=/data/pcre-8.41 --add-module=/data/nginx-rtmp-module-master  --add-module=/data/nginx_mod_h264_streaming-2.2.7  --with-openssl=/data/openssl-1.0.1l

注：--with-pcre --add-module --with-openssl后跟的路径是指这些包所存放的路径，事先在soft下建立的，并不唯一，--prefix后的路径为nginx指定安装路径，若想安装在其他路径，提前在该路径下建立nginx文件夹，安装时直接指定即可，也不唯一

编译并安装：

make

make install

验证nginx_rtmp是否安装成功：

进入创建的nginx_rtmp sbin目录下，执行命令：

./nginx -t

如果安装成功，显示：

nginx: the configuration file /usr/local/nginx/conf/nginx.conf syntax is ok

nginx: configuration file /usr/local/nginx/conf/nginx.conf test is successful

 

执行make命令（编译）过程中可能出现的错误：

1.注意：nginx安装时，报错/HLS/nginx_mod_h264_streaming-2.2.7/src/ngx_http_streaming_module.c: In function ‘ngx_streaming_handler’:，此时需要修改src/ngx_http_streaming_module.c：

 

将红框内的内容注释掉，然后重新编译安装

 

2.编译过程中可能还出现如下图的错误：

解决办法：

直接去掉nginx安装包下/objs/Makefile文件中的-Werror。

然后再次编译安装。

编译后它报的是警告，不是错误了。此时执行make install（安装）命令

注：我当时修改后编译还是报错，然后我重新解压的nginx安装包，修改后编译安装才通过的。