nginx-rtmp-module之ngx_rtmp.c代码详解

1. ngx_rtmp.c --- RTMP模块的主逻辑实现

这个文件是 RTMP 模块的核心，包含了 RTMP 协议模块的初始化、配置解析和服务端口的管理等功能。它的主要职责是处理 RTMP 配置、初始化模块、配置事件、初始化 RTMP 端口等。

主要功能和逻辑：

1. 模块初始化 (ngx_rtmp_init_process):

   • ngx_rtmp_init_process 函数用于初始化 RTMP 模块的进程级别的配置，主要作用是初始化 RTMP 模块的事件队列。它的实现非常简单，调用了 ngx_queue_init 来初始化一个队列用于存储相关的初始化事件。

2. 配置块解析 (ngx_rtmp_block):

   • ngx_rtmp_block 函数用于解析 rtmp {} 配置块中的内容。首先，它会分配内存创建 RTMP 模块所需的上下文 ngx_rtmp_conf_ctx_t，并为各个模块的配置创建内存空间（如 main_conf、srv_conf 和 app_conf）​。

   • 该函数还会统计和设置 RTMP 模块的数量，并设置各个模块的 ctx_index。此外，还会解析配置并调用每个模块的 preconfiguration 和 postconfiguration 进行预配置和后配置。

   • 最终，函数会调用 ngx_conf_parse 来解析配置文件中的实际内容，完成配置的加载​。

3. 事件初始化 (ngx_rtmp_init_events):

   • ngx_rtmp_init_events 函数用于初始化 RTMP 协议处理的事件。RTMP 协议有多种消息类型和事件，例如 NGX_RTMP_MSG_ACK、NGX_RTMP_MSG_AUDIO 等，这些事件会在 ngx_rtmp_core_main_conf_t 中进行初始化。

4. 事件处理 (ngx_rtmp_init_event_handlers):

   • 该函数将 RTMP 协议的各类事件与处理函数进行绑定。例如，将 NGX_RTMP_MSG_ACK 类型的消息绑定到 ngx_rtmp_protocol_message_handler 处理函数，将 NGX_RTMP_MSG_AMF_CMD 绑定到 ngx_rtmp_amf_message_handler 处理函数。

5. 端口和地址管理 (ngx_rtmp_add_ports、ngx_rtmp_optimize_servers):

   • ngx_rtmp_add_ports 用于将 RTMP 服务器的端口信息添加到配置中，支持 IPv4 和 IPv6 地址。

   • ngx_rtmp_optimize_servers 用于优化配置的端口和地址绑定，确保正确地处理 *:port 类型的地址绑定，并根据需要选择性地进行绑定​​。

6. 模块与服务器配置合并 (ngx_rtmp_merge_applications):

   • ngx_rtmp_merge_applications 函数用于将不同服务器的配置合并。它通过递归方式将每个应用的配置与模块的配置进行合并，确保每个 RTMP 服务的配置一致。

7. 数据结构：

   • ngx_rtmp_conf_ctx_t：用来存储 RTMP 配置的上下文，包含了主配置、服务器配置和应用配置的指针。

   • ngx_rtmp_listen_t：描述 RTMP 服务监听的地址和端口等信息，支持 IPv4 和 IPv6 地址配置​。

   • ngx_rtmp_session_t：每个 RTMP 会话的上下文，包含了关于客户端连接的信息，例如连接状态、流数据、缓冲区、RTMP 消息等​。

2. ngx_rtmp.h --- 数据结构和常量定义

这个文件定义了 RTMP 模块所需的常量、数据结构和一些宏，主要包括 RTMP 协议相关的消息类型、事件类型以及网络连接配置的数据结构。

主要功能和设计：

1. RTMP 消息类型定义：

   • RTMP 协议定义了多种消息类型，例如：

     • NGX_RTMP_MSG_AUDIO：音频消息

     • NGX_RTMP_MSG_VIDEO：视频消息

     • NGX_RTMP_MSG_ACK：确认消息

     • NGX_RTMP_MSG_AMF_CMD：AMF 命令消息等​。

   • 每个消息类型对应一个整数值，表示 RTMP 协议中的不同类型的消息。

2. RTMP 控制消息类型：

   • 定义了一些 RTMP 控制消息类型，例如：

     • NGX_RTMP_USER_STREAM_BEGIN：流开始

     • NGX_RTMP_USER_STREAM_EOF：流结束

     • NGX_RTMP_USER_SET_BUFLEN：设置缓冲区长度​。

3. 数据结构：

   • ngx_rtmp_conf_ctx_t ：这是 RTMP 配置上下文，存储了每个 RTMP 模块的配置，主要包含 main_conf、srv_conf 和 app_conf 三个指针​。

   • ngx_rtmp_listen_t：该结构描述了 RTMP 服务的监听地址，包括地址类型（IPv4 或 IPv6）、端口、绑定信息等​。

   • ngx_rtmp_session_t：表示一个 RTMP 会话，存储与该会话相关的所有信息，包括连接状态、缓冲区、流数据等​。

4. 宏和常量：

   • RTMP 版本和日志级别：

     • NGX_RTMP_VERSION 定义了 RTMP 协议的版本，NGX_LOG_DEBUG_RTMP 用于指定 RTMP 模块的日志级别。

   • NGX_RTMP_MAX_EVENT：定义了 RTMP 事件的最大值，用于标识不同的事件类型​。

5. 函数指针和处理函数：

   • ngx_rtmp_handler_pt：这是一个函数指针类型，指向处理 RTMP 消息的函数。它接收 ngx_rtmp_session_t 和 ngx_rtmp_header_t 等作为参数，处理来自客户端的 RTMP 消息​。

   • ngx_rtmp_amf_handler_t：该结构用于存储 AMF 消息的处理函数，AMF 是 RTMP 协议中的一种消息格式​。

6. RTMP 消息处理：

   • 定义了多个用于处理不同类型消息的函数，如 ngx_rtmp_protocol_message_handler、ngx_rtmp_user_message_handler 和 ngx_rtmp_amf_message_handler 等。

总结

• ngx_rtmp.c：主要负责 RTMP 模块的初始化、配置解析、事件和端口管理等核心功能。它定义了 RTMP 模块的初始化流程，配置文件的解析和处理，以及端口和地址的管理，确保 RTMP 协议的正常工作。

• ngx_rtmp.h：定义了 RTMP 协议所需的各种常量、数据结构和函数指针，提供了 RTMP 协议消息类型、控制消息、事件类型等的定义，同时也定义了 RTMP 会话和网络连接的结构，确保 RTMP 协议的数据传输和处理功能。

这两个文件的设计确保了 RTMP 模块能够在 Nginx 中高效地处理流媒体请求，并为开发者提供了丰富的配置选项和模块化的处理方式。