yading@11: /* yading@11: * RTMP packet utilities yading@11: * Copyright (c) 2009 Kostya Shishkov yading@11: * yading@11: * This file is part of FFmpeg. yading@11: * yading@11: * FFmpeg is free software; you can redistribute it and/or yading@11: * modify it under the terms of the GNU Lesser General Public yading@11: * License as published by the Free Software Foundation; either yading@11: * version 2.1 of the License, or (at your option) any later version. yading@11: * yading@11: * FFmpeg is distributed in the hope that it will be useful, yading@11: * but WITHOUT ANY WARRANTY; without even the implied warranty of yading@11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU yading@11: * Lesser General Public License for more details. yading@11: * yading@11: * You should have received a copy of the GNU Lesser General Public yading@11: * License along with FFmpeg; if not, write to the Free Software yading@11: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA yading@11: */ yading@11: yading@11: #ifndef AVFORMAT_RTMPPKT_H yading@11: #define AVFORMAT_RTMPPKT_H yading@11: yading@11: #include "libavcodec/bytestream.h" yading@11: #include "avformat.h" yading@11: #include "url.h" yading@11: yading@11: /** maximum possible number of different RTMP channels */ yading@11: #define RTMP_CHANNELS 65599 yading@11: yading@11: /** yading@11: * channels used to for RTMP packets with different purposes (i.e. data, network yading@11: * control, remote procedure calls, etc.) yading@11: */ yading@11: enum RTMPChannel { yading@11: RTMP_NETWORK_CHANNEL = 2, ///< channel for network-related messages (bandwidth report, ping, etc) yading@11: RTMP_SYSTEM_CHANNEL, ///< channel for sending server control messages yading@11: RTMP_SOURCE_CHANNEL, ///< channel for sending a/v to server yading@11: RTMP_VIDEO_CHANNEL = 8, ///< channel for video data yading@11: RTMP_AUDIO_CHANNEL, ///< channel for audio data yading@11: }; yading@11: yading@11: /** yading@11: * known RTMP packet types yading@11: */ yading@11: typedef enum RTMPPacketType { yading@11: RTMP_PT_CHUNK_SIZE = 1, ///< chunk size change yading@11: RTMP_PT_BYTES_READ = 3, ///< number of bytes read yading@11: RTMP_PT_PING, ///< ping yading@11: RTMP_PT_SERVER_BW, ///< server bandwidth yading@11: RTMP_PT_CLIENT_BW, ///< client bandwidth yading@11: RTMP_PT_AUDIO = 8, ///< audio packet yading@11: RTMP_PT_VIDEO, ///< video packet yading@11: RTMP_PT_FLEX_STREAM = 15, ///< Flex shared stream yading@11: RTMP_PT_FLEX_OBJECT, ///< Flex shared object yading@11: RTMP_PT_FLEX_MESSAGE, ///< Flex shared message yading@11: RTMP_PT_NOTIFY, ///< some notification yading@11: RTMP_PT_SHARED_OBJ, ///< shared object yading@11: RTMP_PT_INVOKE, ///< invoke some stream action yading@11: RTMP_PT_METADATA = 22, ///< FLV metadata yading@11: } RTMPPacketType; yading@11: yading@11: /** yading@11: * possible RTMP packet header sizes yading@11: */ yading@11: enum RTMPPacketSize { yading@11: RTMP_PS_TWELVEBYTES = 0, ///< packet has 12-byte header yading@11: RTMP_PS_EIGHTBYTES, ///< packet has 8-byte header yading@11: RTMP_PS_FOURBYTES, ///< packet has 4-byte header yading@11: RTMP_PS_ONEBYTE ///< packet is really a next chunk of a packet yading@11: }; yading@11: yading@11: /** yading@11: * structure for holding RTMP packets yading@11: */ yading@11: typedef struct RTMPPacket { yading@11: int channel_id; ///< RTMP channel ID (nothing to do with audio/video channels though) yading@11: RTMPPacketType type; ///< packet payload type yading@11: uint32_t timestamp; ///< packet full timestamp yading@11: uint32_t ts_delta; ///< timestamp increment to the previous one in milliseconds (latter only for media packets) yading@11: uint32_t extra; ///< probably an additional channel ID used during streaming data yading@11: uint8_t *data; ///< packet payload yading@11: int data_size; ///< packet payload size yading@11: } RTMPPacket; yading@11: yading@11: /** yading@11: * Create new RTMP packet with given attributes. yading@11: * yading@11: * @param pkt packet yading@11: * @param channel_id packet channel ID yading@11: * @param type packet type yading@11: * @param timestamp packet timestamp yading@11: * @param size packet size yading@11: * @return zero on success, negative value otherwise yading@11: */ yading@11: int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type, yading@11: int timestamp, int size); yading@11: yading@11: /** yading@11: * Free RTMP packet. yading@11: * yading@11: * @param pkt packet yading@11: */ yading@11: void ff_rtmp_packet_destroy(RTMPPacket *pkt); yading@11: yading@11: /** yading@11: * Read RTMP packet sent by the server. yading@11: * yading@11: * @param h reader context yading@11: * @param p packet yading@11: * @param chunk_size current chunk size yading@11: * @param prev_pkt previously read packet headers for all channels yading@11: * (may be needed for restoring incomplete packet header) yading@11: * @return number of bytes read on success, negative value otherwise yading@11: */ yading@11: int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p, yading@11: int chunk_size, RTMPPacket *prev_pkt); yading@11: /** yading@11: * Read internal RTMP packet sent by the server. yading@11: * yading@11: * @param h reader context yading@11: * @param p packet yading@11: * @param chunk_size current chunk size yading@11: * @param prev_pkt previously read packet headers for all channels yading@11: * (may be needed for restoring incomplete packet header) yading@11: * @param c the first byte already read yading@11: * @return number of bytes read on success, negative value otherwise yading@11: */ yading@11: int ff_rtmp_packet_read_internal(URLContext *h, RTMPPacket *p, int chunk_size, yading@11: RTMPPacket *prev_pkt, uint8_t c); yading@11: yading@11: /** yading@11: * Send RTMP packet to the server. yading@11: * yading@11: * @param h reader context yading@11: * @param p packet to send yading@11: * @param chunk_size current chunk size yading@11: * @param prev_pkt previously sent packet headers for all channels yading@11: * (may be used for packet header compressing) yading@11: * @return number of bytes written on success, negative value otherwise yading@11: */ yading@11: int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p, yading@11: int chunk_size, RTMPPacket *prev_pkt); yading@11: yading@11: /** yading@11: * Print information and contents of RTMP packet. yading@11: * yading@11: * @param ctx output context yading@11: * @param p packet to dump yading@11: */ yading@11: void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p); yading@11: yading@11: /** yading@11: * @name Functions used to work with the AMF format (which is also used in .flv) yading@11: * @see amf_* funcs in libavformat/flvdec.c yading@11: * @{ yading@11: */ yading@11: yading@11: /** yading@11: * Calculate number of bytes taken by first AMF entry in data. yading@11: * yading@11: * @param data input data yading@11: * @param data_end input buffer end yading@11: * @return number of bytes used by first AMF entry yading@11: */ yading@11: int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end); yading@11: yading@11: /** yading@11: * Retrieve value of given AMF object field in string form. yading@11: * yading@11: * @param data AMF object data yading@11: * @param data_end input buffer end yading@11: * @param name name of field to retrieve yading@11: * @param dst buffer for storing result yading@11: * @param dst_size output buffer size yading@11: * @return 0 if search and retrieval succeeded, negative value otherwise yading@11: */ yading@11: int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end, yading@11: const uint8_t *name, uint8_t *dst, int dst_size); yading@11: yading@11: /** yading@11: * Write boolean value in AMF format to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: * @param val value to write yading@11: */ yading@11: void ff_amf_write_bool(uint8_t **dst, int val); yading@11: yading@11: /** yading@11: * Write number in AMF format to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: * @param num value to write yading@11: */ yading@11: void ff_amf_write_number(uint8_t **dst, double num); yading@11: yading@11: /** yading@11: * Write string in AMF format to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: * @param str string to write yading@11: */ yading@11: void ff_amf_write_string(uint8_t **dst, const char *str); yading@11: yading@11: /** yading@11: * Write a string consisting of two parts in AMF format to a buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: * @param str1 first string to write, may be null yading@11: * @param str2 second string to write, may be null yading@11: */ yading@11: void ff_amf_write_string2(uint8_t **dst, const char *str1, const char *str2); yading@11: yading@11: /** yading@11: * Write AMF NULL value to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: */ yading@11: void ff_amf_write_null(uint8_t **dst); yading@11: yading@11: /** yading@11: * Write marker for AMF object to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: */ yading@11: void ff_amf_write_object_start(uint8_t **dst); yading@11: yading@11: /** yading@11: * Write string used as field name in AMF object to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: * @param str string to write yading@11: */ yading@11: void ff_amf_write_field_name(uint8_t **dst, const char *str); yading@11: yading@11: /** yading@11: * Write marker for end of AMF object to buffer. yading@11: * yading@11: * @param dst pointer to the input buffer (will be modified) yading@11: */ yading@11: void ff_amf_write_object_end(uint8_t **dst); yading@11: yading@11: /** yading@11: * Read AMF boolean value. yading@11: * yading@11: *@param[in,out] gbc GetByteContext initialized with AMF-formatted data yading@11: *@param[out] val 0 or 1 yading@11: *@return 0 on success or an AVERROR code on failure yading@11: */ yading@11: int ff_amf_read_bool(GetByteContext *gbc, int *val); yading@11: yading@11: /** yading@11: * Read AMF number value. yading@11: * yading@11: *@param[in,out] gbc GetByteContext initialized with AMF-formatted data yading@11: *@param[out] val read value yading@11: *@return 0 on success or an AVERROR code on failure yading@11: */ yading@11: int ff_amf_read_number(GetByteContext *gbc, double *val); yading@11: yading@11: /** yading@11: * Read AMF string value. yading@11: * yading@11: * Appends a trailing null byte to output string in order to yading@11: * ease later parsing. yading@11: * yading@11: *@param[in,out] gbc GetByteContext initialized with AMF-formatted data yading@11: *@param[out] str read string yading@11: *@param[in] strsize buffer size available to store the read string yading@11: *@param[out] length read string length yading@11: *@return 0 on success or an AVERROR code on failure yading@11: */ yading@11: int ff_amf_read_string(GetByteContext *gbc, uint8_t *str, yading@11: int strsize, int *length); yading@11: yading@11: /** yading@11: * Read AMF NULL value. yading@11: * yading@11: *@param[in,out] gbc GetByteContext initialized with AMF-formatted data yading@11: *@return 0 on success or an AVERROR code on failure yading@11: */ yading@11: int ff_amf_read_null(GetByteContext *gbc); yading@11: yading@11: yading@11: /** @} */ // AMF funcs yading@11: yading@11: #endif /* AVFORMAT_RTMPPKT_H */