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
27extern const char * const ff_rm_metadata[4];
28extern const unsigned char ff_sipr_subpk_size[4];
29
30typedef struct RMStream RMStream;
31
32RMStream *ff_rm_alloc_rmstream (void);
33void      ff_rm_free_rmstream  (RMStream *rms);
34
35/*< input format for Realmedia-style RTSP streams */
36extern AVInputFormat rdt_demuxer;
37
38/**
39 * Read the MDPR chunk, which contains stream-specific codec initialization
40 * parameters.
41 *
42 * @param s context containing RMContext and ByteIOContext for stream reading
43 * @param pb context to read the data from
44 * @param st the stream that the MDPR chunk belongs to and where to store the
45 *           parameters read from the chunk into
46 * @param rst real-specific stream information
47 * @param codec_data_size size of the MDPR chunk
48 * @return 0 on success, errno codes on error
49 */
50int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
51                               AVStream *st, RMStream *rst,
52                               int codec_data_size);
53
54/**
55 * Parse one rm-stream packet from the input bytestream.
56 *
57 * @param s context containing RMContext and ByteIOContext for stream reading
58 * @param pb context to read the data from
59 * @param st stream to which the packet to be read belongs
60 * @param rst Real-specific stream information
61 * @param len packet length to read from the input
62 * @param pkt packet location to store the parsed packet data
63 * @param seq pointer to an integer containing the sequence number, may be
64 *            updated
65 * @param flags the packet flags
66 * @param ts timestamp of the current packet
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
69 *         data is available by calling ff_rm_retrieve_cache().
70 */
71int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
72                        AVStream *st, RMStream *rst, int len,
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
84 * @param pb context to read the data from
85 * @param st stream that this packet belongs to
86 * @param rst Real-specific stream information
87 * @param pkt location to store the packet data
88 * @return the number of samples left for subsequent calls to this same
89 *          function, or 0 if all samples have been retrieved.
90 */
91int ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
92                          AVStream *st, RMStream *rst, AVPacket *pkt);
93
94/**
95 * Perform 4-bit block reordering for SIPR data.
96 *
97 * @param buf SIPR data
98 */
99void ff_rm_reorder_sipr_data(uint8_t *buf, int sub_packet_h, int framesize);
100
101#endif /* AVFORMAT_RM_H */
102