Merge remote-tracking branch 'qatar/master'
[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 #include "internal.h"
27
28 extern const char * const ff_rm_metadata[4];
29 extern const unsigned char ff_sipr_subpk_size[4];
30 extern const AVCodecTag ff_rm_codec_tags[];
31
32 typedef struct RMStream RMStream;
33
34 RMStream *ff_rm_alloc_rmstream (void);
35 void      ff_rm_free_rmstream  (RMStream *rms);
36
37 /*< input format for Realmedia-style RTSP streams */
38 extern AVInputFormat ff_rdt_demuxer;
39
40 /**
41  * Read the MDPR chunk, which contains stream-specific codec initialization
42  * parameters.
43  *
44  * @param s context containing RMContext and AVIOContext for stream reading
45  * @param pb context to read the data from
46  * @param st the stream that the MDPR chunk belongs to and where to store the
47  *           parameters read from the chunk into
48  * @param rst real-specific stream information
49  * @param codec_data_size size of the MDPR chunk
50  * @return 0 on success, errno codes on error
51  */
52 int ff_rm_read_mdpr_codecdata (AVFormatContext *s, AVIOContext *pb,
53                                AVStream *st, RMStream *rst,
54                                int codec_data_size);
55
56 /**
57  * Parse one rm-stream packet from the input bytestream.
58  *
59  * @param s context containing RMContext and AVIOContext for stream reading
60  * @param pb context to read the data from
61  * @param st stream to which the packet to be read belongs
62  * @param rst Real-specific stream information
63  * @param len packet length to read from the input
64  * @param pkt packet location to store the parsed packet data
65  * @param seq pointer to an integer containing the sequence number, may be
66  *            updated
67  * @param flags the packet flags
68  * @param ts timestamp of the current packet
69  * @return <0 on error, 0 if a packet was placed in the pkt pointer. A
70  *         value >0 means that no data was placed in pkt, but that cached
71  *         data is available by calling ff_rm_retrieve_cache().
72  */
73 int ff_rm_parse_packet (AVFormatContext *s, AVIOContext *pb,
74                         AVStream *st, RMStream *rst, int len,
75                         AVPacket *pkt, int *seq, int flags, int64_t ts);
76
77 /**
78  * Retrieve one cached packet from the rm-context. The real container can
79  * store several packets (as interpreted by the codec) in a single container
80  * packet, which means the demuxer holds some back when the first container
81  * packet is parsed and returned. The result is that rm->audio_pkt_cnt is
82  * a positive number, the amount of cached packets. Using this function, each
83  * of those packets can be retrieved sequentially.
84  *
85  * @param s context containing RMContext and AVIOContext for stream reading
86  * @param pb context to read the data from
87  * @param st stream that this packet belongs to
88  * @param rst Real-specific stream information
89  * @param pkt location to store the packet data
90  * @return the number of samples left for subsequent calls to this same
91  *          function, or 0 if all samples have been retrieved.
92  */
93 int ff_rm_retrieve_cache (AVFormatContext *s, AVIOContext *pb,
94                           AVStream *st, RMStream *rst, AVPacket *pkt);
95
96 /**
97  * Perform 4-bit block reordering for SIPR data.
98  *
99  * @param buf SIPR data
100  */
101 void ff_rm_reorder_sipr_data(uint8_t *buf, int sub_packet_h, int framesize);
102
103 #endif /* AVFORMAT_RM_H */