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