return EOF in image2 demuxer
[libav.git] / libavformat / rm.h
CommitLineData
7b2a2ce5
AJ
1/*
2 * "Real" compatible muxer and demuxer.
406792e7 3 * Copyright (c) 2000, 2001 Fabrice Bellard
7b2a2ce5
AJ
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
98790382
SS
22#ifndef AVFORMAT_RM_H
23#define AVFORMAT_RM_H
7b2a2ce5
AJ
24
25#include "avformat.h"
26
7379d5bc
AJ
27extern const char *ff_rm_metadata[4];
28
ba614729
RB
29typedef struct RMStream RMStream;
30
31RMStream *ff_rm_alloc_rmstream (void);
32void ff_rm_free_rmstream (RMStream *rms);
33
ff13ba92
RB
34/*< input format for Realmedia-style RTSP streams */
35extern AVInputFormat rdt_demuxer;
36
0fd36362
RB
37/**
38 * Read the MDPR chunk, which contains stream-specific codec initialization
39 * parameters.
40 *
41 * @param s context containing RMContext and ByteIOContext for stream reading
fcc995a5 42 * @param pb context to read the data from
0fd36362
RB
43 * @param st the stream that the MDPR chunk belongs to and where to store the
44 * parameters read from the chunk into
886e89d0 45 * @param rst real-specific stream information
79d5045d 46 * @param codec_data_size size of the MDPR chunk
0fd36362
RB
47 * @return 0 on success, errno codes on error
48 */
fcc995a5 49int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
886e89d0
RB
50 AVStream *st, RMStream *rst,
51 int codec_data_size);
0fd36362
RB
52
53/**
54 * Parse one rm-stream packet from the input bytestream.
55 *
56 * @param s context containing RMContext and ByteIOContext for stream reading
fcc995a5 57 * @param pb context to read the data from
0fd36362 58 * @param st stream to which the packet to be read belongs
886e89d0 59 * @param rst Real-specific stream information
0fd36362
RB
60 * @param len packet length to read from the input
61 * @param pkt packet location to store the parsed packet data
62 * @param seq pointer to an integer containing the sequence number, may be
63 * updated
64 * @param flags pointer to an integer containing the packet flags, may be
65 updated
66 * @param ts pointer to timestamp, may be updated
bf7e799c
SS
67 * @return <0 on error, 0 if a packet was placed in the pkt pointer. A
68 * value >0 means that no data was placed in pkt, but that cached
c5efef7b 69 * data is available by calling ff_rm_retrieve_cache().
0fd36362 70 */
fcc995a5 71int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
886e89d0 72 AVStream *st, RMStream *rst, int len,
0fd36362
RB
73 AVPacket *pkt, int *seq, int *flags, int64_t *ts);
74
75/**
76 * Retrieve one cached packet from the rm-context. The real container can
77 * store several packets (as interpreted by the codec) in a single container
78 * packet, which means the demuxer holds some back when the first container
79 * packet is parsed and returned. The result is that rm->audio_pkt_cnt is
80 * a positive number, the amount of cached packets. Using this function, each
81 * of those packets can be retrieved sequentially.
82 *
83 * @param s context containing RMContext and ByteIOContext for stream reading
fcc995a5 84 * @param pb context to read the data from
0fd36362 85 * @param st stream that this packet belongs to
886e89d0 86 * @param rst Real-specific stream information
0fd36362 87 * @param pkt location to store the packet data
a9f84821
RB
88 * @returns the number of samples left for subsequent calls to this same
89 * function, or 0 if all samples have been retrieved.
0fd36362 90 */
a9f84821 91int ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
ade8fb4d 92 AVStream *st, RMStream *rst, AVPacket *pkt);
0fd36362 93
98790382 94#endif /* AVFORMAT_RM_H */