[FFmpeg-devel] [PATCH] RTSP-MS 10/15: ASF header parsing

[Ronald S. Bultje]

On Wed, Feb 4, 2009 at 3:28 AM, Michael Niedermayer <michaelni at gmx.at> wrote:
> On Tue, Feb 03, 2009 at 09:43:49PM -0500, Ronald S. Bultje wrote:
> > Can you tell me what code you'd like documented?
>
> all that isnt documented

How about we take your suggested approach: after all fields in rtsp.h
and rtp.h are documented (Luca, I'll wait for you to do your split and
document rtp*.h, unless you think it'll take long, please let me
know.), I'll submit code and every time it touches code that is
(according to you) poorly documented or unclear, I'll fix it.

>>      int server_port_min, server_port_max; /**< RTP ports */
>>      int ttl; /**< ttl value */
>>      uint32_t destination; /**< destination IP address */
>> -    int transport;
>> -    enum RTSPLowerTransport lower_transport;
>
>> +    int transport;                           /**< RTP or RDT (Real) */
>
> an int holds integers "RTP" "RDT (Real)" are not integers
> thats the kind of comment that i do not need

Hm, that's antique crapness. Attached patch fixes that. I know, it
doesn't add comments, I'll do that in a separate post.

Ronald
-------------- next part --------------
Index: ffmpeg-svn/libavformat/rtsp.h
===================================================================
--- ffmpeg-svn.orig/libavformat/rtsp.h	2009-02-04 08:16:16.000000000 -0500
+++ ffmpeg-svn/libavformat/rtsp.h	2009-02-04 08:18:06.000000000 -0500
@@ -37,6 +37,15 @@
     RTSP_LOWER_TRANSPORT_LAST
 };
 
+enum RTSPTransport {
+    RTSP_TRANSPORT_RTP,
+    RTSP_TRANSPORT_RDT,
+    /**
+     * This is not part of the public API and shouldn't be used outside ffmpeg.
+     */
+    RTSP_TRANSPORT_LAST
+};
+
 #define RTSP_DEFAULT_PORT   554
 #define RTSP_MAX_TRANSPORTS 8
 #define RTSP_TCP_MAX_PACKET_SIZE 1472
@@ -52,7 +61,7 @@
     int server_port_min, server_port_max; /**< RTP ports */
     int ttl; /**< ttl value */
     uint32_t destination; /**< destination IP address */
-    int transport;
+    enum RTSPTransport transport;
     enum RTSPLowerTransport lower_transport;
 } RTSPTransportField;
 
@@ -82,12 +91,6 @@
     RTSP_SERVER_LAST
 };
 
-enum RTSPTransport {
-    RTSP_TRANSPORT_RTP,
-    RTSP_TRANSPORT_RDT,
-    RTSP_TRANSPORT_LAST
-};
-
 typedef struct RTSPState {
     URLContext *rtsp_hd; /* RTSP TCP connexion handle */
     int nb_rtsp_streams;