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