Implement RMStream stream-specific private data object in the RM demuxer.
[ffmpeg.git] / libavformat / rm.h
1 /*
2  * "Real" compatible muxer and demuxer.
3  * Copyright (c) 2000, 2001 Fabrice Bellard.
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_RM_H
23 #define AVFORMAT_RM_H
24
25 #include "avformat.h"
26
27 typedef struct RMStream RMStream;
28
29 RMStream *ff_rm_alloc_rmstream (void);
30 void      ff_rm_free_rmstream  (RMStream *rms);
31
32 /*< input format for Realmedia-style RTSP streams */
33 extern AVInputFormat rdt_demuxer;
34
35 /**
36  * Read the MDPR chunk, which contains stream-specific codec initialization
37  * parameters.
38  *
39  * @param s context containing RMContext and ByteIOContext for stream reading
40  * @param pb context to read the data from
41  * @param st the stream that the MDPR chunk belongs to and where to store the
42  *           parameters read from the chunk into
43  * @param codec_data_size size of the MDPR chunk
44  * @return 0 on success, errno codes on error
45  */
46 int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
47                                AVStream *st, int codec_data_size);
48
49 /**
50  * Parse one rm-stream packet from the input bytestream.
51  *
52  * @param s context containing RMContext and ByteIOContext for stream reading
53  * @param pb context to read the data from
54  * @param st stream to which the packet to be read belongs
55  * @param len packet length to read from the input
56  * @param pkt packet location to store the parsed packet data
57  * @param seq pointer to an integer containing the sequence number, may be
58  *            updated
59  * @param flags pointer to an integer containing the packet flags, may be
60                 updated
61  * @param ts pointer to timestamp, may be updated
62  * @return >=0 on success (where >0 indicates there are cached samples that
63  *         can be retrieved with subsequent calls to ff_rm_retrieve_cache()),
64  *         errno codes on error
65  */
66 int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
67                         AVStream *st, int len,
68                         AVPacket *pkt, int *seq, int *flags, int64_t *ts);
69
70 /**
71  * Retrieve one cached packet from the rm-context. The real container can
72  * store several packets (as interpreted by the codec) in a single container
73  * packet, which means the demuxer holds some back when the first container
74  * packet is parsed and returned. The result is that rm->audio_pkt_cnt is
75  * a positive number, the amount of cached packets. Using this function, each
76  * of those packets can be retrieved sequentially.
77  *
78  * @param s context containing RMContext and ByteIOContext for stream reading
79  * @param pb context to read the data from
80  * @param st stream that this packet belongs to
81  * @param pkt location to store the packet data
82  */
83 void ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
84                            AVStream *st, AVPacket *pkt);
85
86 #endif /* AVFORMAT_RM_H */