cosmetics: Remove pointless period after copyright statement non-sentences.
[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 rst real-specific stream information
44  * @param codec_data_size size of the MDPR chunk
45  * @return 0 on success, errno codes on error
46  */
47 int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
48                                AVStream *st, RMStream *rst,
49                                int codec_data_size);
50
51 /**
52  * Parse one rm-stream packet from the input bytestream.
53  *
54  * @param s context containing RMContext and ByteIOContext for stream reading
55  * @param pb context to read the data from
56  * @param st stream to which the packet to be read belongs
57  * @param rst Real-specific stream information
58  * @param len packet length to read from the input
59  * @param pkt packet location to store the parsed packet data
60  * @param seq pointer to an integer containing the sequence number, may be
61  *            updated
62  * @param flags pointer to an integer containing the packet flags, may be
63                 updated
64  * @param ts pointer to timestamp, may be updated
65  * @return >=0 on success (where >0 indicates there are cached samples that
66  *         can be retrieved with subsequent calls to ff_rm_retrieve_cache()),
67  *         errno codes on error
68  */
69 int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
70                         AVStream *st, RMStream *rst, int len,
71                         AVPacket *pkt, int *seq, int *flags, int64_t *ts);
72
73 /**
74  * Retrieve one cached packet from the rm-context. The real container can
75  * store several packets (as interpreted by the codec) in a single container
76  * packet, which means the demuxer holds some back when the first container
77  * packet is parsed and returned. The result is that rm->audio_pkt_cnt is
78  * a positive number, the amount of cached packets. Using this function, each
79  * of those packets can be retrieved sequentially.
80  *
81  * @param s context containing RMContext and ByteIOContext for stream reading
82  * @param pb context to read the data from
83  * @param st stream that this packet belongs to
84  * @param rst Real-specific stream information
85  * @param pkt location to store the packet data
86  * @returns the number of samples left for subsequent calls to this same
87  *          function, or 0 if all samples have been retrieved.
88  */
89 int ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
90                           AVStream *st, RMStream *rst, AVPacket *pkt);
91
92 #endif /* AVFORMAT_RM_H */