1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00

RTSP: Doxygen comment cleanup

Do not use Doxygen for comments that apply to specific implementation
details; merge some duplicated Doxygen comment blocks.
This commit is contained in:
Diego Biurrun 2011-07-03 16:35:10 +02:00
parent c81a2b9b4f
commit f75e3da535
2 changed files with 9 additions and 15 deletions

View File

@ -428,11 +428,6 @@ static void sdp_parse_line(AVFormatContext *s, SDPParseState *s1,
} }
} }
/**
* Parse the sdp description and allocate the rtp streams and the
* pollfd array used for udp ones.
*/
int ff_sdp_parse(AVFormatContext *s, const char *content) int ff_sdp_parse(AVFormatContext *s, const char *content)
{ {
RTSPState *rt = s->priv_data; RTSPState *rt = s->priv_data;
@ -1050,9 +1045,6 @@ retry:
return 0; return 0;
} }
/**
* @return 0 on success, <0 on error, 1 if protocol is unavailable.
*/
int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port, int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
int lower_transport, const char *real_challenge) int lower_transport, const char *real_challenge)
{ {
@ -1078,7 +1070,7 @@ int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
for (j = RTSP_RTP_PORT_MIN, i = 0; i < rt->nb_rtsp_streams; ++i) { for (j = RTSP_RTP_PORT_MIN, i = 0; i < rt->nb_rtsp_streams; ++i) {
char transport[2048]; char transport[2048];
/** /*
* WMS serves all UDP data over a single connection, the RTX, which * WMS serves all UDP data over a single connection, the RTX, which
* isn't necessarily the first in the SDP but has to be the first * isn't necessarily the first in the SDP but has to be the first
* to be set up, else the second/third SETUP will fail with a 461. * to be set up, else the second/third SETUP will fail with a 461.
@ -1151,7 +1143,7 @@ int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
/* RTP/TCP */ /* RTP/TCP */
else if (lower_transport == RTSP_LOWER_TRANSPORT_TCP) { else if (lower_transport == RTSP_LOWER_TRANSPORT_TCP) {
/** For WMS streams, the application streams are only used for /* For WMS streams, the application streams are only used for
* UDP. When trying to set it up for TCP streams, the server * UDP. When trying to set it up for TCP streams, the server
* will return an error. Therefore, we skip those streams. */ * will return an error. Therefore, we skip those streams. */
if (rt->server_type == RTSP_SERVER_WMS && if (rt->server_type == RTSP_SERVER_WMS &&
@ -1482,14 +1474,14 @@ redirect:
cmd[0] = 0; cmd[0] = 0;
if (rt->server_type == RTSP_SERVER_REAL) if (rt->server_type == RTSP_SERVER_REAL)
av_strlcat(cmd, av_strlcat(cmd,
/** /*
* The following entries are required for proper * The following entries are required for proper
* streaming from a Realmedia server. They are * streaming from a Realmedia server. They are
* interdependent in some way although we currently * interdependent in some way although we currently
* don't quite understand how. Values were copied * don't quite understand how. Values were copied
* from mplayer SVN r23589. * from mplayer SVN r23589.
* @param CompanyID is a 16-byte ID in base64 * ClientChallenge is a 16-byte ID in hex
* @param ClientChallenge is a 16-byte ID in hex * CompanyID is a 16-byte ID in base64
*/ */
"ClientChallenge: 9e26d33f2984236010ef6253fb1887f7\r\n" "ClientChallenge: 9e26d33f2984236010ef6253fb1887f7\r\n"
"PlayerStarttime: [28/03/2003:22:50:23 00:00]\r\n" "PlayerStarttime: [28/03/2003:22:50:23 00:00]\r\n"

View File

@ -505,8 +505,9 @@ int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply);
int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr); int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr);
/** /**
* Parse a SDP description of streams by populating an RTSPState struct * Parse an SDP description of streams by populating an RTSPState struct
* within the AVFormatContext. * within the AVFormatContext; also allocate the RTP streams and the
* pollfd array used for UDP streams.
*/ */
int ff_sdp_parse(AVFormatContext *s, const char *content); int ff_sdp_parse(AVFormatContext *s, const char *content);
@ -525,6 +526,7 @@ int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt);
/** /**
* Do the SETUP requests for each stream for the chosen * Do the SETUP requests for each stream for the chosen
* lower transport mode. * lower transport mode.
* @return 0 on success, <0 on error, 1 if protocol is unavailable
*/ */
int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port, int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
int lower_transport, const char *real_challenge); int lower_transport, const char *real_challenge);