ffmpeg/libavformat/rdt.h
Ronald S. Bultje 108cd24793 Make function comment a bit more linguistically correct.
Originally committed as revision 15835 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-11-15 20:43:57 +00:00

94 lines
3.5 KiB
C

/*
* Realmedia RTSP (RDT) definitions
* Copyright (c) 2007 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
*
* 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_RDT_H
#define AVFORMAT_RDT_H
#include <stdint.h>
#include "avformat.h"
#include "rtp.h"
typedef struct RDTDemuxContext RDTDemuxContext;
RDTDemuxContext *ff_rdt_parse_open(AVFormatContext *ic, AVStream *st,
void *priv_data,
RTPDynamicProtocolHandler *handler);
void ff_rdt_parse_close(RDTDemuxContext *s);
/**
* Calculate the response (RealChallenge2 in the RTSP header) to the
* challenge (RealChallenge1 in the RTSP header from the Real/Helix
* server), which is used as some sort of client validation.
*
* @param response pointer to response buffer, it should be at least 41 bytes
* (40 data + 1 zero) bytes long.
* @param chksum pointer to buffer containing a checksum of the response,
* it should be at least 9 (8 data + 1 zero) bytes long.
* @param challenge pointer to the RealChallenge1 value provided by the
* server.
*/
void ff_rdt_calc_response_and_checksum(char response[41], char chksum[9],
const char *challenge);
/**
* Register RDT-related dynamic payload handlers with our cache.
*/
void av_register_rdt_dynamic_payload_handlers(void);
/**
* Add subscription information to Subscribe parameter string.
*
* @param cmd string to write the subscription information into.
* @param size size of cmd.
* @param stream_nr stream number.
* @param rule_nr rule number to conform to.
*/
void ff_rdt_subscribe_rule(char *cmd, int size,
int stream_nr, int rule_nr);
// FIXME this will be removed ASAP
void ff_rdt_subscribe_rule2(RDTDemuxContext *s, char *cmd, int size,
int stream_nr, int rule_nr);
/**
* Parse RDT-style packet header.
*
* @param buf input buffer
* @param len length of input buffer
* @param set_id will be set to the set ID this packet belongs to
* @param seq_no will be set to the sequence number of the packet
* @param stream_id will be set to the stream ID this packet belongs to
* @param is_keyframe will be whether this packet belongs to a keyframe
* @param timestamp will be set to the timestamp of the packet
* @return the amount of bytes consumed, or <0 on error
*/
int ff_rdt_parse_header(const uint8_t *buf, int len,
int *set_id, int *seq_no, int *stream_id,
int *is_keyframe, uint32_t *timestamp);
/**
* Parse RDT-style packet data (header + media data).
* Usage similar to rtp_parse_packet().
*/
int ff_rdt_parse_packet(RDTDemuxContext *s, AVPacket *pkt,
const uint8_t *buf, int len);
#endif /* AVFORMAT_RDT_H */