git.sesse.net Git - ffmpeg/blob - 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 /*< input format for Realmedia-style RTSP streams */
  28 extern AVInputFormat rdt_demuxer;
  29
  30 /**
  31  * Read the MDPR chunk, which contains stream-specific codec initialization
  32  * parameters.
  33  *
  34  * @param s context containing RMContext and ByteIOContext for stream reading
  35  * @param pb context to read the data from
  36  * @param st the stream that the MDPR chunk belongs to and where to store the
  37  *           parameters read from the chunk into
  38  * @param codec_data_size size of the MDPR chunk
  39  * @return 0 on success, errno codes on error
  40  */
  41 int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
  42                                AVStream *st, int codec_data_size);
  43
  44 /**
  45  * Parse one rm-stream packet from the input bytestream.
  46  *
  47  * @param s context containing RMContext and ByteIOContext for stream reading
  48  * @param pb context to read the data from
  49  * @param st stream to which the packet to be read belongs
  50  * @param len packet length to read from the input
  51  * @param pkt packet location to store the parsed packet data
  52  * @param seq pointer to an integer containing the sequence number, may be
  53  *            updated
  54  * @param flags pointer to an integer containing the packet flags, may be
  55                 updated
  56  * @param ts pointer to timestamp, may be updated
  57  * @return >=0 on success (where >0 indicates there are cached samples that
  58  *         can be retrieved with subsequent calls to ff_rm_retrieve_cache()),
  59  *         errno codes on error
  60  */
  61 int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
  62                         AVStream *st, int len,
  63                         AVPacket *pkt, int *seq, int *flags, int64_t *ts);
  64
  65 /**
  66  * Retrieve one cached packet from the rm-context. The real container can
  67  * store several packets (as interpreted by the codec) in a single container
  68  * packet, which means the demuxer holds some back when the first container
  69  * packet is parsed and returned. The result is that rm->audio_pkt_cnt is
  70  * a positive number, the amount of cached packets. Using this function, each
  71  * of those packets can be retrieved sequentially.
  72  *
  73  * @param s context containing RMContext and ByteIOContext for stream reading
  74  * @param pb context to read the data from
  75  * @param st stream that this packet belongs to
  76  * @param pkt location to store the packet data
  77  */
  78 void ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
  79                            AVStream *st, AVPacket *pkt);
  80
  81 #endif /* AVFORMAT_RM_H */