rtmp.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  1. #ifndef __RTMP_H__
  2. #define __RTMP_H__
  3. /*
  4. * Copyright (C) 2005-2008 Team XBMC
  5. * http://www.xbmc.org
  6. * Copyright (C) 2008-2009 Andrej Stepanchuk
  7. * Copyright (C) 2009-2010 Howard Chu
  8. *
  9. * This file is part of librtmp.
  10. *
  11. * librtmp is free software; you can redistribute it and/or modify
  12. * it under the terms of the GNU Lesser General Public License as
  13. * published by the Free Software Foundation; either version 2.1,
  14. * or (at your option) any later version.
  15. *
  16. * librtmp is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Lesser General Public License
  22. * along with librtmp see the file COPYING. If not, write to
  23. * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24. * Boston, MA 02110-1301, USA.
  25. * http://www.gnu.org/copyleft/lgpl.html
  26. */
  27. #if !defined(NO_CRYPTO) && !defined(CRYPTO)
  28. #define CRYPTO
  29. #endif
  30. #include <errno.h>
  31. #include <stdint.h>
  32. #include <stddef.h>
  33. #include "amf.h"
  34. #ifdef __cplusplus
  35. extern "C"
  36. {
  37. #endif
  38. #define RTMP_LIB_VERSION 0x020300 /* 2.3 */
  39. #define RTMP_FEATURE_HTTP 0x01
  40. #define RTMP_FEATURE_ENC 0x02
  41. #define RTMP_FEATURE_SSL 0x04
  42. #define RTMP_FEATURE_MFP 0x08 /* not yet supported */
  43. #define RTMP_FEATURE_WRITE 0x10 /* publish, not play */
  44. #define RTMP_FEATURE_HTTP2 0x20 /* server-side rtmpt */
  45. #define RTMP_PROTOCOL_UNDEFINED -1
  46. #define RTMP_PROTOCOL_RTMP 0
  47. #define RTMP_PROTOCOL_RTMPE RTMP_FEATURE_ENC
  48. #define RTMP_PROTOCOL_RTMPT RTMP_FEATURE_HTTP
  49. #define RTMP_PROTOCOL_RTMPS RTMP_FEATURE_SSL
  50. #define RTMP_PROTOCOL_RTMPTE (RTMP_FEATURE_HTTP|RTMP_FEATURE_ENC)
  51. #define RTMP_PROTOCOL_RTMPTS (RTMP_FEATURE_HTTP|RTMP_FEATURE_SSL)
  52. #define RTMP_PROTOCOL_RTMFP RTMP_FEATURE_MFP
  53. #define RTMP_DEFAULT_CHUNKSIZE 128
  54. /* needs to fit largest number of bytes recv() may return */
  55. #define RTMP_BUFFER_CACHE_SIZE (16*1024)
  56. #define RTMP_CHANNELS 65600
  57. extern const char RTMPProtocolStringsLower[][7];
  58. extern const AVal RTMP_DefaultFlashVer;
  59. extern int RTMP_ctrlC;
  60. uint32_t RTMP_GetTime(void);
  61. /* RTMP_PACKET_TYPE_... 0x00 */
  62. #define RTMP_PACKET_TYPE_CHUNK_SIZE 0x01
  63. /* RTMP_PACKET_TYPE_... 0x02 */
  64. #define RTMP_PACKET_TYPE_BYTES_READ_REPORT 0x03
  65. #define RTMP_PACKET_TYPE_CONTROL 0x04
  66. #define RTMP_PACKET_TYPE_SERVER_BW 0x05
  67. #define RTMP_PACKET_TYPE_CLIENT_BW 0x06
  68. /* RTMP_PACKET_TYPE_... 0x07 */
  69. #define RTMP_PACKET_TYPE_AUDIO 0x08
  70. #define RTMP_PACKET_TYPE_VIDEO 0x09
  71. /* RTMP_PACKET_TYPE_... 0x0A */
  72. /* RTMP_PACKET_TYPE_... 0x0B */
  73. /* RTMP_PACKET_TYPE_... 0x0C */
  74. /* RTMP_PACKET_TYPE_... 0x0D */
  75. /* RTMP_PACKET_TYPE_... 0x0E */
  76. #define RTMP_PACKET_TYPE_FLEX_STREAM_SEND 0x0F
  77. #define RTMP_PACKET_TYPE_FLEX_SHARED_OBJECT 0x10
  78. #define RTMP_PACKET_TYPE_FLEX_MESSAGE 0x11
  79. #define RTMP_PACKET_TYPE_INFO 0x12
  80. #define RTMP_PACKET_TYPE_SHARED_OBJECT 0x13
  81. #define RTMP_PACKET_TYPE_INVOKE 0x14
  82. /* RTMP_PACKET_TYPE_... 0x15 */
  83. #define RTMP_PACKET_TYPE_FLASH_VIDEO 0x16
  84. #define RTMP_MAX_HEADER_SIZE 18
  85. #define RTMP_PACKET_SIZE_LARGE 0
  86. #define RTMP_PACKET_SIZE_MEDIUM 1
  87. #define RTMP_PACKET_SIZE_SMALL 2
  88. #define RTMP_PACKET_SIZE_MINIMUM 3
  89. typedef struct RTMPChunk
  90. {
  91. int c_headerSize;
  92. int c_chunkSize;
  93. char *c_chunk;
  94. char c_header[RTMP_MAX_HEADER_SIZE];
  95. } RTMPChunk;
  96. typedef struct RTMPPacket
  97. {
  98. uint8_t m_headerType;
  99. uint8_t m_packetType;
  100. uint8_t m_hasAbsTimestamp; /* timestamp absolute or relative? */
  101. int m_nChannel;
  102. uint32_t m_nTimeStamp; /* timestamp */
  103. int32_t m_nInfoField2; /* last 4 bytes in a long header */
  104. uint32_t m_nBodySize;
  105. uint32_t m_nBytesRead;
  106. RTMPChunk *m_chunk;
  107. char *m_body;
  108. } RTMPPacket;
  109. typedef struct RTMPSockBuf
  110. {
  111. int sb_socket;
  112. int sb_size; /* number of unprocessed bytes in buffer */
  113. char *sb_start; /* pointer into sb_pBuffer of next byte to process */
  114. char sb_buf[RTMP_BUFFER_CACHE_SIZE]; /* data read from socket */
  115. int sb_timedout;
  116. void *sb_ssl;
  117. } RTMPSockBuf;
  118. void RTMPPacket_Reset(RTMPPacket *p);
  119. void RTMPPacket_Dump(RTMPPacket *p);
  120. int RTMPPacket_Alloc(RTMPPacket *p, uint32_t nSize);
  121. void RTMPPacket_Free(RTMPPacket *p);
  122. #define RTMPPacket_IsReady(a) ((a)->m_nBytesRead == (a)->m_nBodySize)
  123. typedef struct RTMP_LNK
  124. {
  125. AVal hostname;
  126. AVal sockshost;
  127. AVal playpath0; /* parsed from URL */
  128. AVal playpath; /* passed in explicitly */
  129. AVal tcUrl;
  130. AVal swfUrl;
  131. AVal pageUrl;
  132. AVal app;
  133. AVal auth;
  134. AVal flashVer;
  135. AVal subscribepath;
  136. AVal usherToken;
  137. AVal token;
  138. AVal pubUser;
  139. AVal pubPasswd;
  140. AMFObject extras;
  141. int edepth;
  142. int seekTime;
  143. int stopTime;
  144. #define RTMP_LF_AUTH 0x0001 /* using auth param */
  145. #define RTMP_LF_LIVE 0x0002 /* stream is live */
  146. #define RTMP_LF_SWFV 0x0004 /* do SWF verification */
  147. #define RTMP_LF_PLST 0x0008 /* send playlist before play */
  148. #define RTMP_LF_BUFX 0x0010 /* toggle stream on BufferEmpty msg */
  149. #define RTMP_LF_FTCU 0x0020 /* free tcUrl on close */
  150. #define RTMP_LF_FAPU 0x0040 /* free app on close */
  151. int lFlags;
  152. int swfAge;
  153. int protocol;
  154. int timeout; /* connection timeout in seconds */
  155. int pFlags; /* unused, but kept to avoid breaking ABI */
  156. unsigned short socksport;
  157. unsigned short port;
  158. #ifdef CRYPTO
  159. #define RTMP_SWF_HASHLEN 32
  160. void *dh; /* for encryption */
  161. void *rc4keyIn;
  162. void *rc4keyOut;
  163. uint32_t SWFSize;
  164. uint8_t SWFHash[RTMP_SWF_HASHLEN];
  165. char SWFVerificationResponse[RTMP_SWF_HASHLEN+10];
  166. #endif
  167. } RTMP_LNK;
  168. /* state for read() wrapper */
  169. typedef struct RTMP_READ
  170. {
  171. char *buf;
  172. char *bufpos;
  173. unsigned int buflen;
  174. uint32_t timestamp;
  175. uint8_t dataType;
  176. uint8_t flags;
  177. #define RTMP_READ_HEADER 0x01
  178. #define RTMP_READ_RESUME 0x02
  179. #define RTMP_READ_NO_IGNORE 0x04
  180. #define RTMP_READ_GOTKF 0x08
  181. #define RTMP_READ_GOTFLVK 0x10
  182. #define RTMP_READ_SEEKING 0x20
  183. int8_t status;
  184. #define RTMP_READ_COMPLETE -3
  185. #define RTMP_READ_ERROR -2
  186. #define RTMP_READ_EOF -1
  187. #define RTMP_READ_IGNORE 0
  188. /* if bResume == TRUE */
  189. uint8_t initialFrameType;
  190. uint32_t nResumeTS;
  191. char *metaHeader;
  192. char *initialFrame;
  193. uint32_t nMetaHeaderSize;
  194. uint32_t nInitialFrameSize;
  195. uint32_t nIgnoredFrameCounter;
  196. uint32_t nIgnoredFlvFrameCounter;
  197. } RTMP_READ;
  198. typedef struct RTMP_METHOD
  199. {
  200. AVal name;
  201. int num;
  202. } RTMP_METHOD;
  203. typedef struct RTMP
  204. {
  205. int m_inChunkSize;
  206. int m_outChunkSize;
  207. int m_nBWCheckCounter;
  208. int m_nBytesIn;
  209. int m_nBytesInSent;
  210. int m_nBufferMS;
  211. int m_stream_id; /* returned in _result from createStream */
  212. int m_mediaChannel;
  213. uint32_t m_mediaStamp;
  214. uint32_t m_pauseStamp;
  215. int m_pausing;
  216. int m_nServerBW;
  217. int m_nClientBW;
  218. uint8_t m_nClientBW2;
  219. uint8_t m_bPlaying;
  220. uint8_t m_bSendEncoding;
  221. uint8_t m_bSendCounter;
  222. int m_numInvokes;
  223. int m_numCalls;
  224. RTMP_METHOD *m_methodCalls; /* remote method calls queue */
  225. int m_channelsAllocatedIn;
  226. int m_channelsAllocatedOut;
  227. RTMPPacket **m_vecChannelsIn;
  228. RTMPPacket **m_vecChannelsOut;
  229. int *m_channelTimestamp; /* abs timestamp of last packet */
  230. double m_fAudioCodecs; /* audioCodecs for the connect packet */
  231. double m_fVideoCodecs; /* videoCodecs for the connect packet */
  232. double m_fEncoding; /* AMF0 or AMF3 */
  233. double m_fDuration; /* duration of stream in seconds */
  234. int m_msgCounter; /* RTMPT stuff */
  235. int m_polling;
  236. int m_resplen;
  237. int m_unackd;
  238. AVal m_clientID;
  239. RTMP_READ m_read;
  240. RTMPPacket m_write;
  241. RTMPSockBuf m_sb;
  242. RTMP_LNK Link;
  243. char *bindLocalIp; //本地绑定的IP,用于绑定指定网卡发消息用
  244. } RTMP;
  245. int RTMP_ParseURL(const char *url, int *protocol, AVal *host,
  246. unsigned int *port, AVal *playpath, AVal *app);
  247. void RTMP_ParsePlaypath(AVal *in, AVal *out);
  248. void RTMP_SetBufferMS(RTMP *r, int size);
  249. void RTMP_UpdateBufferMS(RTMP *r);
  250. int RTMP_SetOpt(RTMP *r, const AVal *opt, AVal *arg);
  251. int RTMP_SetupURL(RTMP *r, char *url);
  252. void RTMP_SetupStream(RTMP *r, int protocol,
  253. AVal *hostname,
  254. unsigned int port,
  255. AVal *sockshost,
  256. AVal *playpath,
  257. AVal *tcUrl,
  258. AVal *swfUrl,
  259. AVal *pageUrl,
  260. AVal *app,
  261. AVal *auth,
  262. AVal *swfSHA256Hash,
  263. uint32_t swfSize,
  264. AVal *flashVer,
  265. AVal *subscribepath,
  266. AVal *usherToken,
  267. int dStart,
  268. int dStop, int bLiveStream, long int timeout);
  269. int RTMP_Connect(RTMP *r, RTMPPacket *cp);
  270. struct sockaddr;
  271. int RTMP_Connect0(RTMP *r, struct sockaddr *svc);
  272. int RTMP_Connect1(RTMP *r, RTMPPacket *cp);
  273. int RTMP_Serve(RTMP *r);
  274. int RTMP_TLS_Accept(RTMP *r, void *ctx);
  275. int RTMP_ReadPacket(RTMP *r, RTMPPacket *packet);
  276. int RTMP_SendPacket(RTMP *r, RTMPPacket *packet, int queue);
  277. int RTMP_SendChunk(RTMP *r, RTMPChunk *chunk);
  278. int RTMP_IsConnected(RTMP *r);
  279. int RTMP_Socket(RTMP *r);
  280. int RTMP_IsTimedout(RTMP *r);
  281. double RTMP_GetDuration(RTMP *r);
  282. int RTMP_ToggleStream(RTMP *r);
  283. int RTMP_ConnectStream(RTMP *r, int seekTime);
  284. int RTMP_ReconnectStream(RTMP *r, int seekTime);
  285. void RTMP_DeleteStream(RTMP *r);
  286. int RTMP_GetNextMediaPacket(RTMP *r, RTMPPacket *packet);
  287. int RTMP_ClientPacket(RTMP *r, RTMPPacket *packet);
  288. void RTMP_Init(RTMP *r);
  289. void RTMP_Close(RTMP *r);
  290. RTMP *RTMP_Alloc(void);
  291. void RTMP_Free(RTMP *r);
  292. void RTMP_EnableWrite(RTMP *r);
  293. void *RTMP_TLS_AllocServerContext(const char* cert, const char* key);
  294. void RTMP_TLS_FreeServerContext(void *ctx);
  295. int RTMP_LibVersion(void);
  296. void RTMP_UserInterrupt(void); /* user typed Ctrl-C */
  297. int RTMP_SendCtrl(RTMP *r, short nType, unsigned int nObject,
  298. unsigned int nTime);
  299. /* caller probably doesn't know current timestamp, should
  300. * just use RTMP_Pause instead
  301. */
  302. int RTMP_SendPause(RTMP *r, int DoPause, int dTime);
  303. int RTMP_Pause(RTMP *r, int DoPause);
  304. int RTMP_FindFirstMatchingProperty(AMFObject *obj, const AVal *name,
  305. AMFObjectProperty * p);
  306. int RTMPSockBuf_Fill(RTMPSockBuf *sb);
  307. int RTMPSockBuf_Send(RTMPSockBuf *sb, const char *buf, int len);
  308. int RTMPSockBuf_Close(RTMPSockBuf *sb);
  309. int RTMP_SendCreateStream(RTMP *r);
  310. int RTMP_SendSeek(RTMP *r, int dTime);
  311. int RTMP_SendServerBW(RTMP *r);
  312. int RTMP_SendClientBW(RTMP *r);
  313. void RTMP_DropRequest(RTMP *r, int i, int freeit);
  314. int RTMP_Read(RTMP *r, char *buf, int size);
  315. int RTMP_Write(RTMP *r, const char *buf, int size);
  316. /* hashswf.c */
  317. int RTMP_HashSWF(const char *url, unsigned int *size, unsigned char *hash,
  318. int age);
  319. #ifdef __cplusplus
  320. };
  321. #endif
  322. #endif