Fix 'make checkheaders', based on a patch by Diego Pettenò, flameeyes gmail com.
[libav.git] / libavformat / rdt.h
1 /*
2 * Realmedia RTSP (RDT) definitions
3 * Copyright (c) 2007 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #ifndef AVFORMAT_RDT_H
23 #define AVFORMAT_RDT_H
24
25 #include <stdint.h>
26 #include "avformat.h"
27 #include "rtp.h"
28
29 typedef struct RDTDemuxContext RDTDemuxContext;
30
31 RDTDemuxContext *ff_rdt_parse_open(AVFormatContext *ic, AVStream *st,
32 void *priv_data,
33 RTPDynamicProtocolHandler *handler);
34 void ff_rdt_parse_close(RDTDemuxContext *s);
35
36 /**
37 * Calculate the response (RealChallenge2 in the RTSP header) to the
38 * challenge (RealChallenge1 in the RTSP header from the Real/Helix
39 * server), which is used as some sort of client validation.
40 *
41 * @param response pointer to response buffer, it should be at least 41 bytes
42 * (40 data + 1 zero) bytes long.
43 * @param chksum pointer to buffer containing a checksum of the response,
44 * it should be at least 9 (8 data + 1 zero) bytes long.
45 * @param challenge pointer to the RealChallenge1 value provided by the
46 * server.
47 */
48 void ff_rdt_calc_response_and_checksum(char response[41], char chksum[9],
49 const char *challenge);
50
51 /**
52 * Register RDT-related dynamic payload handlers with our cache.
53 */
54 void av_register_rdt_dynamic_payload_handlers(void);
55
56 /**
57 * Add subscription information to Subscribe parameter string.
58 *
59 * @param cmd string to write the subscription information into.
60 * @param size size of cmd.
61 * @param stream_nr stream number.
62 * @param rule_nr rule number to conform to.
63 */
64 void ff_rdt_subscribe_rule(char *cmd, int size,
65 int stream_nr, int rule_nr);
66 // FIXME this will be removed ASAP
67 void ff_rdt_subscribe_rule2(RDTDemuxContext *s, char *cmd, int size,
68 int stream_nr, int rule_nr);
69
70 /**
71 * Parse RDT-style packet header.
72 *
73 * @param buf input buffer
74 * @param len length of input buffer
75 * @param sn will be set to the stream number this packet belongs to
76 * @param seq will be set to the sequence number this packet belongs to
77 * @param rn will be set to the rule number this packet belongs to
78 * @param ts will be set to the timestamp of the packet
79 * @return the amount of bytes consumed, or <0 on error
80 */
81 int ff_rdt_parse_header(const uint8_t *buf, int len,
82 int *sn, int *seq, int *rn, uint32_t *ts);
83
84 /**
85 * Parse RDT-style packet data (header + media data).
86 * Usage similar to rtp_parse_packet().
87 */
88 int ff_rdt_parse_packet(RDTDemuxContext *s, AVPacket *pkt,
89 const uint8_t *buf, int len);
90
91 #endif /* AVFORMAT_RDT_H */