]> git.sesse.net Git - ffmpeg/blobdiff - libavformat/rtmppkt.h
network: properly declare WSADATA in windows
[ffmpeg] / libavformat / rtmppkt.h
index b40f4fe0617a4353bfb41ccb83fe7b2b5d37a0c9..8372484fbd9fe36ab94228d477f1a06ca023653e 100644 (file)
@@ -2,20 +2,20 @@
  * RTMP packet utilities
  * Copyright (c) 2009 Kostya Shishkov
  *
- * This file is part of FFmpeg.
+ * This file is part of Libav.
  *
- * FFmpeg is free software; you can redistribute it and/or
+ * Libav 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,
+ * Libav 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
+ * License along with Libav; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #define AVFORMAT_RTMPPKT_H
 
 #include "avformat.h"
+#include "url.h"
 
 /** maximum possible number of different RTMP channels */
-#define RTMP_CHANNELS 64
+#define RTMP_CHANNELS 65599
 
 /**
  * channels used to for RTMP packets with different purposes (i.e. data, network
@@ -34,6 +35,7 @@
 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_SOURCE_CHANNEL,        ///< channel for sending a/v to server
     RTMP_VIDEO_CHANNEL = 8,     ///< channel for video data
     RTMP_AUDIO_CHANNEL,         ///< channel for audio data
 };
@@ -72,16 +74,17 @@ enum RTMPPacketSize {
  * structure for holding RTMP packets
  */
 typedef struct RTMPPacket {
-    uint8_t        channel_id; ///< RTMP channel ID (nothing to do with audio/video channels though)
+    int            channel_id; ///< RTMP channel ID (nothing to do with audio/video channels though)
     RTMPPacketType type;       ///< packet payload type
-    uint32_t       timestamp;  ///< packet full timestamp or timestamp increment to the previous one in milliseconds (latter only for media packets)
+    uint32_t       timestamp;  ///< packet full timestamp
+    uint32_t       ts_delta;   ///< timestamp increment to the previous one in milliseconds (latter only for media packets)
     uint32_t       extra;      ///< probably an additional channel ID used during streaming data
     uint8_t        *data;      ///< packet payload
     int            data_size;  ///< packet payload size
 } RTMPPacket;
 
 /**
- * Creates new RTMP packet with given attributes.
+ * Create new RTMP packet with given attributes.
  *
  * @param pkt        packet
  * @param channel_id packet channel ID
@@ -94,46 +97,54 @@ int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
                           int timestamp, int size);
 
 /**
- * Frees RTMP packet.
+ * Free RTMP packet.
  *
  * @param pkt packet
  */
 void ff_rtmp_packet_destroy(RTMPPacket *pkt);
 
 /**
- * Reads RTMP packet sent by the server.
+ * Read 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)
- * @return zero on success, negative value otherwise
+ * @return number of bytes read on success, negative value otherwise
  */
 int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
                         int chunk_size, RTMPPacket *prev_pkt);
 
 /**
- * Sends RTMP packet to the server.
+ * Send RTMP packet to the server.
  *
  * @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)
- * @return zero on success, negative value otherwise
+ * @return number of bytes written on success, negative value otherwise
  */
 int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p,
                          int chunk_size, RTMPPacket *prev_pkt);
 
 /**
- * @defgroup amffuncs functions used to work with AMF format (which is also used in .flv)
+ * Print information and contents of RTMP packet.
+ *
+ * @param ctx        output context
+ * @param p          packet to dump
+ */
+void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p);
+
+/**
+ * @name Functions used to work with the AMF format (which is also used in .flv)
  * @see amf_* funcs in libavformat/flvdec.c
  * @{
  */
 
 /**
- * Calculates number of bytes taken by first AMF entry in data.
+ * Calculate number of bytes taken by first AMF entry in data.
  *
  * @param data input data
  * @param data_end input buffer end
@@ -142,7 +153,7 @@ int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p,
 int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end);
 
 /**
- * Retrieves value of given AMF object field in string form.
+ * Retrieve value of given AMF object field in string form.
  *
  * @param data     AMF object data
  * @param data_end input buffer end
@@ -155,7 +166,7 @@ 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);
 
 /**
- * Writes boolean value in AMF format to buffer.
+ * Write boolean value in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param val value to write
@@ -163,7 +174,7 @@ int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
 void ff_amf_write_bool(uint8_t **dst, int val);
 
 /**
- * Writes number in AMF format to buffer.
+ * Write number in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param num value to write
@@ -171,7 +182,7 @@ void ff_amf_write_bool(uint8_t **dst, int val);
 void ff_amf_write_number(uint8_t **dst, double num);
 
 /**
- * Writes string in AMF format to buffer.
+ * Write string in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param str string to write
@@ -179,21 +190,21 @@ void ff_amf_write_number(uint8_t **dst, double num);
 void ff_amf_write_string(uint8_t **dst, const char *str);
 
 /**
- * Writes AMF NULL value to buffer.
+ * Write AMF NULL value to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
 void ff_amf_write_null(uint8_t **dst);
 
 /**
- * Writes marker for AMF object to buffer.
+ * Write marker for AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
 void ff_amf_write_object_start(uint8_t **dst);
 
 /**
- * Writes string used as field name in AMF object to buffer.
+ * Write string used as field name in AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param str string to write
@@ -201,7 +212,7 @@ void ff_amf_write_object_start(uint8_t **dst);
 void ff_amf_write_field_name(uint8_t **dst, const char *str);
 
 /**
- * Writes marker for end of AMF object to buffer.
+ * Write marker for end of AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */