refine examples of srs-librtmp, add srs_print_rtmp_packet. 2.0.28.

trunk/src/libs/srs_librtmp.hpp

@@ -273,9 +273,22 @@ extern int srs_version_revision();
 * utilities
 **************************************************************
 *************************************************************/
+/**
+* get the current system time in ms.
+* use gettimeofday() to get system time.
+*/
 extern int64_t srs_get_time_ms();
+
+/**
+* get the send bytes.
+*/
 extern int64_t srs_get_nsend_bytes(srs_rtmp_t rtmp);
+
+/**
+* get the recv bytes.
+*/
 extern int64_t srs_get_nrecv_bytes(srs_rtmp_t rtmp);
+
 /**
 * parse the dts and pts by time in header and data in tag,
 * or to parse the RTMP packet by srs_read_packet().
@@ -296,10 +309,92 @@ extern int srs_parse_timestamp(
     u_int32_t* ppts
 );
 
+/**
+* get the CodecID of video tag.
+* Codec Identifier. The following values are defined:
+*           2 = Sorenson H.263
+*           3 = Screen video
+*           4 = On2 VP6
+*           5 = On2 VP6 with alpha channel
+*           6 = Screen video version 2
+*           7 = AVC
+* @return the code id. 0 for error.
+*/
+extern char srs_get_codec_id(char* data, int size);
+
+/**
+* get the codec id string.
+*           H.263 = Sorenson H.263
+*           Screen = Screen video
+*           VP6 = On2 VP6
+*           VP6Alpha = On2 VP6 with alpha channel
+*           Screen2 = Screen video version 2
+*           H.264 = AVC
+*           otherwise, "Unknown"
+* @remark user never free the return char*, 
+*   it's static shared const string.
+*/
+extern const char* srs_code_id2string(char codec_id);
+
+/**
+* get the AVCPacketType of video tag.
+* The following values are defined:
+*           0 = AVC sequence header
+*           1 = AVC NALU
+*           2 = AVC end of sequence (lower level NALU sequence ender is
+*               not required or supported)
+* @return the avc packet type. -1(0xff) for error.
+*/
+extern char srs_get_avc_packet_type(char* data, int size);
+
+/**
+* get the avc packet type string.
+*           SpsPps = AVC sequence header
+*           Nalu = AVC NALU
+*           SpsPpsEnd = AVC end of sequence
+*           otherwise, "Unknown"
+* @remark user never free the return char*, 
+*   it's static shared const string.
+*/
+extern const char* srs_avc_packet2string(char avc_packet_type);
+
+/**
+* get the FrameType of video tag.
+* Type of video frame. The following values are defined:
+*           1 = key frame (for AVC, a seekable frame)
+*           2 = inter frame (for AVC, a non-seekable frame)
+*           3 = disposable inter frame (H.263 only)
+*           4 = generated key frame (reserved for server use only)
+*           5 = video info/command frame
+* @return the frame type. 0 for error.
+*/
+extern char srs_get_frame_type(char* data, int size);
+
+/**
+* get the frame type string.
+*           I = key frame (for AVC, a seekable frame)
+*           P/B = inter frame (for AVC, a non-seekable frame)
+*           DI = disposable inter frame (H.263 only)
+*           GI = generated key frame (reserved for server use only)
+*           VI = video info/command frame
+*           otherwise, "Unknown"
+* @remark user never free the return char*, 
+*   it's static shared const string.
+*/
+extern const char* srs_frame_type2string(char frame_type);
+
+/**
+* print the rtmp packet, use srs_lib_trace/srs_lib_verbose for packet,
+* and use srs_raw_trace for script data body.
+* @return an error code for parse the timetstamp to dts and pts.
+*/
+extern int srs_print_rtmp_packet(char type, u_int32_t timestamp, char* data, int size);
+
 // log to console, for use srs-librtmp application.
 extern const char* srs_format_time();
 #define srs_lib_trace(msg, ...) printf("[%s] ", srs_format_time());printf(msg, ##__VA_ARGS__);printf("\n")
 #define srs_lib_verbose(msg, ...) printf("[%s] ", srs_format_time());printf(msg, ##__VA_ARGS__);printf("\n")
+#define srs_raw_trace(msg, ...) printf(msg, ##__VA_ARGS__)
 
 /*************************************************************
 **************************************************************
@@ -412,6 +507,11 @@ extern srs_flv_bool srs_flv_is_keyframe(char* data, int32_t size);
 typedef void* srs_amf0_t;
 typedef int srs_amf0_bool;
 typedef double srs_amf0_number;
+/**
+* parse amf0 from data.
+* @param nparsed, the parsed size, NULL to ignore.
+* @return the parsed amf0 object. NULL for error.
+*/
 extern srs_amf0_t srs_amf0_parse(char* data, int size, int* nparsed);
 extern srs_amf0_t srs_amf0_create_number(srs_amf0_number value);
 extern srs_amf0_t srs_amf0_create_ecma_array();