天天看点

RTMPdump(libRTMP) 源代码分析 8: 发送消息(Message)

=====================================================

RTMPdump(libRTMP) 源代码分析系列文章:

RTMPdump 源代码分析 1: main()函数

RTMPDump (libRTMP) 源代码分析2:解析RTMP地址——RTMP_ParseURL()

RTMPdump (libRTMP) 源代码分析3: AMF编码

RTMPdump (libRTMP) 源代码分析4: 连接第一步——握手 (HandShake)

RTMPdump (libRTMP) 源代码分析5: 建立一个流媒体连接  (NetConnection部分)

RTMPdump (libRTMP) 源代码分析6: 建立一个流媒体连接  (NetStream部分 1)

RTMPdump (libRTMP) 源代码分析7: 建立一个流媒体连接  (NetStream部分 2)

RTMPdump (libRTMP) 源代码分析8: 发送消息 (Message)

RTMPdump (libRTMP) 源代码分析9: 接收消息 (Message)  (接收视音频数据)

RTMPdump (libRTMP) 源代码分析10: 处理各种消息 (Message)

=====================================================

函数调用结构图

RTMPDump (libRTMP)的整体的函数调用结构图如下图所示。

RTMPdump(libRTMP) 源代码分析 8: 发送消息(Message)

单击查看大图

详细分析

之前写了一系列的文章介绍RTMPDump各种函数。比如怎么建立网络连接(NetConnection),怎么建立网络流(NetStream)之类的,唯独没有介绍这些发送或接收的数据,在底层到底是怎么实现的。本文就是要剖析一下其内部的实现。即这些消息(Message)到底是怎么发送和接收的。

先来看看发送消息吧。

  • 发送connect命令使用函数SendConnectPacket()
  • 发送createstream命令使用RTMP_SendCreateStream()
  • 发送realeaseStream命令使用SendReleaseStream()
  • 发送publish命令使用SendPublish()
  • 发送deleteStream的命令使用SendDeleteStream()
  • 发送pause命令使用RTMP_SendPause()

不再一一例举,发现函数命名有两种规律:RTMP_Send***()或者Send***(),其中*号代表命令的名称。

SendConnectPacket()这个命令是每次程序开始运行的时候发送的第一个命令消息,内容比较多,包含了很多AMF编码的内容,在此不多做分析,贴上代码:

[cpp] 

view plain

 copy

  1. //发送“connect”命令  
  2. static int  
  3. SendConnectPacket(RTMP *r, RTMPPacket *cp)  
  4. {  
  5.   RTMPPacket packet;  
  6.   char pbuf[4096], *pend = pbuf + sizeof(pbuf);  
  7.   char *enc;  
  8.   if (cp)  
  9.     return RTMP_SendPacket(r, cp, TRUE);  
  10.   packet.m_nChannel = 0x03; /* control channel (invoke) */  
  11.   packet.m_headerType = RTMP_PACKET_SIZE_LARGE;  
  12.   packet.m_packetType = 0x14;   /* INVOKE */  
  13.   packet.m_nTimeStamp = 0;  
  14.   packet.m_nInfoField2 = 0;  
  15.   packet.m_hasAbsTimestamp = 0;  
  16.   packet.m_body = pbuf + RTMP_MAX_HEADER_SIZE;  
  17.   enc = packet.m_body;  
  18.   enc = AMF_EncodeString(enc, pend, &av_connect);  
  19.   enc = AMF_EncodeNumber(enc, pend, ++r->m_numInvokes);  
  20.   *enc++ = AMF_OBJECT;  
  21.   enc = AMF_EncodeNamedString(enc, pend, &av_app, &r->Link.app);  
  22.   if (!enc)  
  23.     return FALSE;  
  24.   if (r->Link.protocol & RTMP_FEATURE_WRITE)  
  25.     {  
  26.       enc = AMF_EncodeNamedString(enc, pend, &av_type, &av_nonprivate);  
  27.       if (!enc)  
  28.     }  
  29.   if (r->Link.flashVer.av_len)  
  30.       enc = AMF_EncodeNamedString(enc, pend, &av_flashVer, &r->Link.flashVer);  
  31.   if (r->Link.swfUrl.av_len)  
  32.       enc = AMF_EncodeNamedString(enc, pend, &av_swfUrl, &r->Link.swfUrl);  
  33.   if (r->Link.tcUrl.av_len)  
  34.       enc = AMF_EncodeNamedString(enc, pend, &av_tcUrl, &r->Link.tcUrl);  
  35.   if (!(r->Link.protocol & RTMP_FEATURE_WRITE))  
  36.       enc = AMF_EncodeNamedBoolean(enc, pend, &av_fpad, FALSE);  
  37.       enc = AMF_EncodeNamedNumber(enc, pend, &av_capabilities, 15.0);  
  38.       enc = AMF_EncodeNamedNumber(enc, pend, &av_audioCodecs, r->m_fAudioCodecs);  
  39.       enc = AMF_EncodeNamedNumber(enc, pend, &av_videoCodecs, r->m_fVideoCodecs);  
  40.       enc = AMF_EncodeNamedNumber(enc, pend, &av_videoFunction, 1.0);  
  41.       if (r->Link.pageUrl.av_len)  
  42.       enc = AMF_EncodeNamedString(enc, pend, &av_pageUrl, &r->Link.pageUrl);  
  43.         return FALSE;  
  44.   if (r->m_fEncoding != 0.0 || r->m_bSendEncoding)  
  45.     {   /* AMF0, AMF3 not fully supported yet */  
  46.       enc = AMF_EncodeNamedNumber(enc, pend, &av_objectEncoding, r->m_fEncoding);  
  47.   if (enc + 3 >= pend)  
  48.   *enc++ = 0;  
  49.   *enc++ = 0;           /* end of object - 0x00 0x00 0x09 */  
  50.   *enc++ = AMF_OBJECT_END;  
  51.   /* add auth string */  
  52.   if (r->Link.auth.av_len)  
  53.       enc = AMF_EncodeBoolean(enc, pend, r->Link.lFlags & RTMP_LF_AUTH);  
  54.       enc = AMF_EncodeString(enc, pend, &r->Link.auth);  
  55.   if (r->Link.extras.o_num)  
  56.       int i;  
  57.       for (i = 0; i < r->Link.extras.o_num; i++)  
  58.       enc = AMFProp_Encode(&r->Link.extras.o_props[i], enc, pend);  
  59.   packet.m_nBodySize = enc - packet.m_body;  
  60.   //----------------  
  61.   r->dlg->AppendMLInfo(20,1,"命令消息","Connect");  
  62.   //-----------------------------  
  63.   return RTMP_SendPacket(r, &packet, TRUE);  
  64. }  

RTMP_SendCreateStream()命令相对而言比较简单,代码如下:

  1. //发送“createstream”命令  
  2. int  
  3. RTMP_SendCreateStream(RTMP *r)  
  4.   char pbuf[256], *pend = pbuf + sizeof(pbuf);  
  5.   packet.m_headerType = RTMP_PACKET_SIZE_MEDIUM;  
  6.   enc = AMF_EncodeString(enc, pend, &av_createStream);  
  7.   *enc++ = AMF_NULL;        /* NULL */  
  8.   r->dlg->AppendMLInfo(20,1,"命令消息","CreateStream");  

同样,SendReleaseStream()内容也比较简单,我对其中部分内容作了注释:

  1. //发送RealeaseStream命令  
  2. SendReleaseStream(RTMP *r)  
  3.   char pbuf[1024], *pend = pbuf + sizeof(pbuf);  
  4.  enc = packet.m_body;  
  5.   //对“releaseStream”字符串进行AMF编码  
  6.   enc = AMF_EncodeString(enc, pend, &av_releaseStream);  
  7.   //对传输ID(0)进行AMF编码?  
  8.   //命令对象  
  9.   *enc++ = AMF_NULL;  
  10.   //对播放路径字符串进行AMF编码  
  11.   enc = AMF_EncodeString(enc, pend, &r->Link.playpath);  
  12.   r->dlg->AppendMLInfo(20,1,"命令消息","ReleaseStream");  
  13.   return RTMP_SendPacket(r, &packet, FALSE);  

再来看一个SendPublish()函数,用于发送“publish”命令

  1. //发送Publish命令  
  2. SendPublish(RTMP *r)  
  3.   //块流ID为4  
  4.   packet.m_nChannel = 0x04; /* source channel (invoke) */  
  5.   //命令消息,类型20  
  6.   //流ID  
  7.   packet.m_nInfoField2 = r->m_stream_id;  
  8.   //指向Chunk的负载  
  9.    //对“publish”字符串进行AMF编码  
  10.   enc = AMF_EncodeString(enc, pend, &av_publish);  
  11.   //命令对象为空  
  12.   /* FIXME: should we choose live based on Link.lFlags & RTMP_LF_LIVE? */  
  13.   enc = AMF_EncodeString(enc, pend, &av_live);  
  14.   r->dlg->AppendMLInfo(20,1,"命令消息","Pulish");  

其他的命令不再一一例举,总体的思路是声明一个RTMPPacket类型的结构体,然后设置各种属性值,最后交给RTMP_SendPacket()进行发送。

RTMPPacket类型的结构体定义如下,一个RTMPPacket对应RTMP协议规范里面的一个块(Chunk)。

  1. //Chunk信息  
  2.   typedef struct RTMPPacket  
  3.   {  
  4.     uint8_t m_headerType;//ChunkMsgHeader的类型(4种)  
  5.     uint8_t m_packetType;//Message type ID(1-7协议控制;8,9音视频;10以后为AMF编码消息)  
  6.     uint8_t m_hasAbsTimestamp;  /* Timestamp 是绝对值还是相对值? */  
  7.     int m_nChannel;         //块流ID  
  8.     uint32_t m_nTimeStamp;  // Timestamp  
  9.     int32_t m_nInfoField2;  /* last 4 bytes in a long header,消息流ID */  
  10.     uint32_t m_nBodySize;   //消息长度  
  11.     uint32_t m_nBytesRead;  
  12.     RTMPChunk *m_chunk;  
  13.     char *m_body;  
  14.   } RTMPPacket;  

下面我们来看看RTMP_SendPacket()吧,各种的RTMPPacket(即各种Chunk)都需要用这个函数进行发送。

  1. //自己编一个数据报发送出去!  
  2. //非常常用  
  3. RTMP_SendPacket(RTMP *r, RTMPPacket *packet, int queue)  
  4.   const RTMPPacket *prevPacket = r->m_vecChannelsOut[packet->m_nChannel];  
  5.   uint32_t last = 0;  
  6.   int nSize;  
  7.   int hSize, cSize;  
  8.   char *header, *hptr, *hend, hbuf[RTMP_MAX_HEADER_SIZE], c;  
  9.   uint32_t t;  
  10.   char *buffer, *tbuf = NULL, *toff = NULL;  
  11.   int nChunkSize;  
  12.   int tlen;  
  13.   //不是完整ChunkMsgHeader  
  14.   if (prevPacket && packet->m_headerType != RTMP_PACKET_SIZE_LARGE)  
  15.       /* compress a bit by using the prev packet's attributes */  
  16.     //获取ChunkMsgHeader的类型  
  17.     //前一个Chunk和这个Chunk对比  
  18.       if (prevPacket->m_nBodySize == packet->m_nBodySize  
  19.       && prevPacket->m_packetType == packet->m_packetType  
  20.       && packet->m_headerType == RTMP_PACKET_SIZE_MEDIUM)  
  21.     packet->m_headerType = RTMP_PACKET_SIZE_SMALL;  
  22.       if (prevPacket->m_nTimeStamp == packet->m_nTimeStamp  
  23.       && packet->m_headerType == RTMP_PACKET_SIZE_SMALL)  
  24.     packet->m_headerType = RTMP_PACKET_SIZE_MINIMUM;  
  25.       //上一个packet的TimeStamp  
  26.       last = prevPacket->m_nTimeStamp;  
  27.   if (packet->m_headerType > 3)   /* sanity */  
  28.       RTMP_Log(RTMP_LOGERROR, "sanity failed!! trying to send header of type: 0x%02x.",  
  29.       (unsigned char)packet->m_headerType);  
  30.       return FALSE;  
  31.   //chunk包头大小;packetSize[] = { 12, 8, 4, 1 }  
  32.   nSize = packetSize[packet->m_headerType];  
  33.   hSize = nSize; cSize = 0;  
  34.   //相对的TimeStamp  
  35.   t = packet->m_nTimeStamp - last;  
  36.   if (packet->m_body)  
  37.     //Header的Start  
  38.     //m_body是指向负载数据首地址的指针;“-”号用于指针前移  
  39.       header = packet->m_body - nSize;  
  40.     //Header的End  
  41.       hend = packet->m_body;  
  42.   else  
  43.       header = hbuf + 6;  
  44.       hend = hbuf + sizeof(hbuf);  
  45.   //当ChunkStreamID大于319时  
  46.   if (packet->m_nChannel > 319)  
  47.     //ChunkBasicHeader是3个字节  
  48.     cSize = 2;  
  49.   //当ChunkStreamID大于63时  
  50.   else if (packet->m_nChannel > 63)  
  51.     //ChunkBasicHeader是2个字节  
  52.     cSize = 1;  
  53.   if (cSize)  
  54.     //header指针指向ChunkMsgHeader  
  55.       header -= cSize;  
  56.     //hsize加上ChunkBasicHeader的长度  
  57.       hSize += cSize;  
  58.   //相对TimeStamp大于0xffffff,此时需要使用ExtendTimeStamp  
  59.   if (nSize > 1 && t >= 0xffffff)  
  60.       header -= 4;  
  61.       hSize += 4;  
  62.   hptr = header;  
  63.   //把ChunkBasicHeader的Fmt类型左移6位  
  64.   c = packet->m_headerType << 6;  
  65.   switch (cSize)  
  66.     //把ChunkBasicHeader的低6位设置成ChunkStreamID  
  67.     case 0:  
  68.       c |= packet->m_nChannel;  
  69.       break;  
  70.     //同理,但低6位设置成000000  
  71.     case 1:  
  72.     //同理,但低6位设置成000001  
  73.     case 2:  
  74.       c |= 1;  
  75.   //可以拆分成两句*hptr=c;hptr++,此时hptr指向第2个字节  
  76.   *hptr++ = c;  
  77.   //CSize>0,即ChunkBasicHeader大于1字节  
  78.     //将要放到第2字节的内容tmp  
  79.       int tmp = packet->m_nChannel - 64;  
  80.     //获取低位存储与第2字节  
  81.       *hptr++ = tmp & 0xff;  
  82.     //ChunkBasicHeader是最大的3字节时  
  83.       if (cSize == 2)  
  84.     //获取高位存储于最后1个字节(注意:排序使用大端序列,和主机相反)  
  85.     *hptr++ = tmp >> 8;  
  86.   //ChunkMsgHeader。注意一共有4种,包含的字段数不同。  
  87.   //TimeStamp(3B)  
  88.   if (nSize > 1)  
  89.     //相对TimeStamp和绝对TimeStamp?  
  90.       hptr = AMF_EncodeInt24(hptr, hend, t > 0xffffff ? 0xffffff : t);  
  91.   //MessageLength+MessageTypeID(4B)  
  92.   if (nSize > 4)  
  93.     //MessageLength  
  94.       hptr = AMF_EncodeInt24(hptr, hend, packet->m_nBodySize);  
  95.     //MessageTypeID  
  96.       *hptr++ = packet->m_packetType;  
  97.   //MessageStreamID(4B)  
  98.   if (nSize > 8)  
  99.     hptr += EncodeInt32LE(hptr, packet->m_nInfoField2);  
  100.   //ExtendedTimeStamp  
  101.     hptr = AMF_EncodeInt32(hptr, hend, t);  
  102.   //负载长度,指向负载的指针  
  103.   nSize = packet->m_nBodySize;  
  104.   buffer = packet->m_body;  
  105.   //Chunk大小,默认128字节  
  106.   nChunkSize = r->m_outChunkSize;  
  107.   RTMP_Log(RTMP_LOGDEBUG2, "%s: fd=%d, size=%d", __FUNCTION__, r->m_sb.sb_socket,  
  108.       nSize);  
  109.   /* send all chunks in one HTTP request */  
  110.   //使用HTTP  
  111.   if (r->Link.protocol & RTMP_FEATURE_HTTP)  
  112.     //nSize:Message负载长度;nChunkSize:Chunk长度;  
  113.     //例nSize:307,nChunkSize:128;  
  114.     //可分为(307+128-1)/128=3个  
  115.     //为什么+nChunkSize-1?因为除法会只取整数部分!  
  116.       int chunks = (nSize+nChunkSize-1) / nChunkSize;  
  117.     //Chunk个数超过一个  
  118.       if (chunks > 1)  
  119.         {  
  120.     //注意:CSize=1表示ChunkBasicHeader是2字节  
  121.     //消息分n块后总的开销:  
  122.     //n个ChunkBasicHeader,1个ChunkMsgHeader,1个Message负载  
  123.     //实际中只有第一个Chunk是完整的,剩下的只有ChunkBasicHeader  
  124.       tlen = chunks * (cSize + 1) + nSize + hSize;  
  125.     //分配内存  
  126.       tbuf = (char *) malloc(tlen);  
  127.       if (!tbuf)  
  128.       toff = tbuf;  
  129.     //消息的负载+头  
  130.   while (nSize + hSize)  
  131.       int wrote;  
  132.       //消息负载<Chunk大小(不用分块)  
  133.       if (nSize < nChunkSize)  
  134.     //Chunk可能小于设定值  
  135.     nChunkSize = nSize;  
  136.       RTMP_LogHexString(RTMP_LOGDEBUG2, (uint8_t *)header, hSize);  
  137.       RTMP_LogHexString(RTMP_LOGDEBUG2, (uint8_t *)buffer, nChunkSize);  
  138.       if (tbuf)  
  139.     //void *memcpy(void *dest, const void *src, int n);  
  140.     //由src指向地址为起始地址的连续n个字节的数据复制到以dest指向地址为起始地址的空间内  
  141.       memcpy(toff, header, nChunkSize + hSize);  
  142.       toff += nChunkSize + hSize;  
  143.       else  
  144.       wrote = WriteN(r, header, nChunkSize + hSize);  
  145.       if (!wrote)  
  146.       //消息负载长度-Chunk负载长度  
  147.       nSize -= nChunkSize;  
  148.       //Buffer指针前移1个Chunk负载长度  
  149.       buffer += nChunkSize;  
  150.       hSize = 0;  
  151.       //如果消息没有发完  
  152.       if (nSize > 0)  
  153.     //ChunkBasicHeader  
  154.       header = buffer - 1;  
  155.       hSize = 1;  
  156.       if (cSize)  
  157.           header -= cSize;  
  158.           hSize += cSize;  
  159.         }  
  160.       //ChunkBasicHeader第1个字节  
  161.       *header = (0xc0 | c);  
  162.       //ChunkBasicHeader大于1字节  
  163.           int tmp = packet->m_nChannel - 64;  
  164.           header[1] = tmp & 0xff;  
  165.           if (cSize == 2)  
  166.         header[2] = tmp >> 8;  
  167.   if (tbuf)  
  168.     //  
  169.       int wrote = WriteN(r, tbuf, toff-tbuf);  
  170.       free(tbuf);  
  171.       tbuf = NULL;  
  172.   /* we invoked a remote method */  
  173.   if (packet->m_packetType == 0x14)  
  174.       AVal method;  
  175.       char *ptr;  
  176.       ptr = packet->m_body + 1;  
  177.       AMF_DecodeString(ptr, &method);  
  178.       RTMP_Log(RTMP_LOGDEBUG, "Invoking %s", method.av_val);  
  179.       /* keep it in call queue till result arrives */  
  180.       if (queue) {  
  181.         int txn;  
  182.         ptr += 3 + method.av_len;  
  183.         txn = (int)AMF_DecodeNumber(ptr);  
  184.     AV_queue(&r->m_methodCalls, &r->m_numCalls, &method, txn);  
  185.       }  
  186.   if (!r->m_vecChannelsOut[packet->m_nChannel])  
  187.     r->m_vecChannelsOut[packet->m_nChannel] = (RTMPPacket *) malloc(sizeof(RTMPPacket));  
  188.   memcpy(r->m_vecChannelsOut[packet->m_nChannel], packet, sizeof(RTMPPacket));  
  189.   return TRUE;  

这个函数乍一看好像非常复杂,其实不然,他只是按照RTMP规范将数据编码成符合规范的块(Chunk),规范可以参考相关的文档。

具体怎么编码成块(Chunk)就不多分析了,在这里需要注意一个函数:WriteN()。该函数完成了将数据发送出去的功能。

来看一下WriteN()函数:

  1. //发送数据报的时候调用(连接,buffer,长度)  
  2. WriteN(RTMP *r, const char *buffer, int n)  
  3.   const char *ptr = buffer;  
  4. #ifdef CRYPTO  
  5.   char *encrypted = 0;  
  6.   char buf[RTMP_BUFFER_CACHE_SIZE];  
  7.   if (r->Link.rc4keyOut)  
  8.       if (n > sizeof(buf))  
  9.     encrypted = (char *)malloc(n);  
  10.     encrypted = (char *)buf;  
  11.       ptr = encrypted;  
  12.       RC4_encrypt2((RC4_KEY *)r->Link.rc4keyOut, n, buffer, ptr);  
  13. #endif  
  14.   while (n > 0)  
  15.       int nBytes;  
  16.       //因方式的不同而调用不同函数  
  17.       //如果使用的是HTTP协议进行连接  
  18.       if (r->Link.protocol & RTMP_FEATURE_HTTP)  
  19.         nBytes = HTTP_Post(r, RTMPT_SEND, ptr, n);  
  20.         nBytes = RTMPSockBuf_Send(&r->m_sb, ptr, n);  
  21.       /*RTMP_Log(RTMP_LOGDEBUG, "%s: %d\n", __FUNCTION__, nBytes); */  
  22.       //成功发送字节数<0  
  23.       if (nBytes < 0)  
  24.       int sockerr = GetSockError();  
  25.       RTMP_Log(RTMP_LOGERROR, "%s, RTMP send error %d (%d bytes)", __FUNCTION__,  
  26.           sockerr, n);  
  27.       if (sockerr == EINTR && !RTMP_ctrlC)  
  28.         continue;  
  29.       RTMP_Close(r);  
  30.       n = 1;  
  31.       if (nBytes == 0)  
  32.     break;  
  33.       n -= nBytes;  
  34.       ptr += nBytes;  
  35.   if (encrypted && encrypted != buf)  
  36.     free(encrypted);  
  37.   return n == 0;  

该函数中,RTMPSockBuf_Send()完成了数据发送的功能,再来看看这个函数(函数调用真是好多啊。。。。)

  1. //Socket发送(指明套接字,buffer缓冲区,数据长度)  
  2. //返回所发数据量  
  3. RTMPSockBuf_Send(RTMPSockBuf *sb, const char *buf, int len)  
  4.   int rc;  
  5. #ifdef _DEBUG  
  6.   fwrite(buf, 1, len, netstackdump);  
  7. #if defined(CRYPTO) && !defined(NO_SSL)  
  8.   if (sb->sb_ssl)  
  9.       rc = TLS_write((SSL *)sb->sb_ssl, buf, len);  
  10.     //向一个已连接的套接口发送数据。  
  11.     //int send( SOCKET s, const char * buf, int len, int flags);  
  12.     //s:一个用于标识已连接套接口的描述字。  
  13.     //buf:包含待发送数据的缓冲区。     
  14.     //len:缓冲区中数据的长度。  
  15.     //flags:调用执行方式。  
  16.     //rc:所发数据量。  
  17.       rc = send(sb->sb_socket, buf, len, 0);  
  18.   return rc;  
  19. RTMPSockBuf_Close(RTMPSockBuf *sb)  
  20.       TLS_shutdown((SSL *)sb->sb_ssl);  
  21.       TLS_close((SSL *)sb->sb_ssl);  
  22.       sb->sb_ssl = NULL;  
  23.   return closesocket(sb->sb_socket);  

到这个函数的时候,发现一层层的调用终于完成了,最后调用了系统Socket的send()函数完成了数据的发送功能。

之前贴过一张图总结这个过程,可能理解起来要方便一些:RTMPDump源代码分析 0: 主要函数调用分析

继续阅读