annotate avformat.h @ 2926:a6730b458d6c libavformat

Matroska muxer needs to format all NAL units, not only extradata.
author aurel
date Fri, 11 Jan 2008 23:21:22 +0000
parents 067baa2b8f38
children f5de41d943e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
1 /*
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
2 * copyright (c) 2001 Fabrice Bellard
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
3 *
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1332
diff changeset
4 * This file is part of FFmpeg.
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1332
diff changeset
5 *
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1332
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
8 * License as published by the Free Software Foundation; either
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1332
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
10 *
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1332
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
14 * Lesser General Public License for more details.
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
15 *
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1332
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
19 */
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1304
diff changeset
20
2620
792383dd085e Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 2602
diff changeset
21 #ifndef FFMPEG_AVFORMAT_H
792383dd085e Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 2602
diff changeset
22 #define FFMPEG_AVFORMAT_H
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
23
2836
e043e56e6e6c Increase minor version due to new av_close_input_stream
reimar
parents: 2835
diff changeset
24 #define LIBAVFORMAT_VERSION_INT ((52<<16)+(3<<8)+0)
e043e56e6e6c Increase minor version due to new av_close_input_stream
reimar
parents: 2835
diff changeset
25 #define LIBAVFORMAT_VERSION 52.3.0
829
e3a3fe90b62f A.B.C versions
michael
parents: 820
diff changeset
26 #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
218
7fc8e8ee081a bump version numbers to 0.4.8
al3x
parents: 211
diff changeset
27
829
e3a3fe90b62f A.B.C versions
michael
parents: 820
diff changeset
28 #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
29
230
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
30 #include <time.h>
314
8756dec3281f * *FILE needs <stdio.h>
kabi
parents: 303
diff changeset
31 #include <stdio.h> /* FILE */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
32 #include "avcodec.h"
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
33
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
34 #include "avio.h"
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
35
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
36 /* packet functions */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
37
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
38 typedef struct AVPacket {
775
c5077fdab490 AVPacket.pos
michael
parents: 743
diff changeset
39 int64_t pts; ///< presentation time stamp in time_base units
c5077fdab490 AVPacket.pos
michael
parents: 743
diff changeset
40 int64_t dts; ///< decompression time stamp in time_base units
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 64
diff changeset
41 uint8_t *data;
53
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
42 int size;
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
43 int stream_index;
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
44 int flags;
775
c5077fdab490 AVPacket.pos
michael
parents: 743
diff changeset
45 int duration; ///< presentation duration in time_base units (0 if not available)
53
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
46 void (*destruct)(struct AVPacket *);
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
47 void *priv;
775
c5077fdab490 AVPacket.pos
michael
parents: 743
diff changeset
48 int64_t pos; ///< byte position in stream, -1 if unknown
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
49 } AVPacket;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
50 #define PKT_FLAG_KEY 0x0001
53
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
51
535
8430e4610971 uninitalized variables
michael
parents: 533
diff changeset
52 void av_destruct_packet_nofree(AVPacket *pkt);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
53
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
54 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
55 * Default packet destructor.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
56 */
797
f5a231a9a2f1 support changing in bitstream global headers into extradata style and back
michael
parents: 795
diff changeset
57 void av_destruct_packet(AVPacket *pkt);
535
8430e4610971 uninitalized variables
michael
parents: 533
diff changeset
58
2140
5b2736d3ac57 Doxygenize av_init_packet
ramiro
parents: 2139
diff changeset
59 /**
5b2736d3ac57 Doxygenize av_init_packet
ramiro
parents: 2139
diff changeset
60 * Initialize optional fields of a packet to default values.
5b2736d3ac57 Doxygenize av_init_packet
ramiro
parents: 2139
diff changeset
61 *
5b2736d3ac57 Doxygenize av_init_packet
ramiro
parents: 2139
diff changeset
62 * @param pkt packet
5b2736d3ac57 Doxygenize av_init_packet
ramiro
parents: 2139
diff changeset
63 */
2139
12a46571c0c9 Export av_init_packet
ramiro
parents: 2088
diff changeset
64 void av_init_packet(AVPacket *pkt);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
65
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
66 /**
2148
5efd0362497c spelling
diego
parents: 2141
diff changeset
67 * Allocate the payload of a packet and initialize its fields to default values.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
68 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
69 * @param pkt packet
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
70 * @param size wanted payload size
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
71 * @return 0 if OK. AVERROR_xxx otherwise.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
72 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
73 int av_new_packet(AVPacket *pkt, int size);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
74
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
75 /**
2148
5efd0362497c spelling
diego
parents: 2141
diff changeset
76 * Allocate and read the payload of a packet and initialize its fields to default values.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
77 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
78 * @param pkt packet
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
79 * @param size wanted payload size
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
80 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
81 */
775
c5077fdab490 AVPacket.pos
michael
parents: 743
diff changeset
82 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
83
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
84 /**
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
85 * @warning This is a hack - the packet memory allocation stuff is broken. The
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
86 * packet is allocated if it was not really allocated
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
87 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
88 int av_dup_packet(AVPacket *pkt);
53
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
89
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
90 /**
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
91 * Free a packet
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
92 *
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
93 * @param pkt packet to free
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
94 */
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
95 static inline void av_free_packet(AVPacket *pkt)
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
96 {
163
470456bd0065 av_free_packet SEGV fix by (Arthur van Hoff (javanator))
michaelni
parents: 159
diff changeset
97 if (pkt && pkt->destruct) {
887
d70e50f1495f COSMETICS: tabs --> spaces, some prettyprinting
diego
parents: 885
diff changeset
98 pkt->destruct(pkt);
163
470456bd0065 av_free_packet SEGV fix by (Arthur van Hoff (javanator))
michaelni
parents: 159
diff changeset
99 }
53
fb671d87824e zero copy packet handling for DV1394 by Max Krasnyansky
bellard
parents: 52
diff changeset
100 }
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
101
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
102 /*************************************************/
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
103 /* fractional numbers for exact pts handling */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
104
2065
64bd1b09cef2 patch so that the deprecated items show up correctly
benoit
parents: 2061
diff changeset
105 /**
64bd1b09cef2 patch so that the deprecated items show up correctly
benoit
parents: 2061
diff changeset
106 * the exact value of the fractional number is: 'val + num / den'.
64bd1b09cef2 patch so that the deprecated items show up correctly
benoit
parents: 2061
diff changeset
107 * num is assumed to be such as 0 <= num < den
64bd1b09cef2 patch so that the deprecated items show up correctly
benoit
parents: 2061
diff changeset
108 * @deprecated Use AVRational instead
64bd1b09cef2 patch so that the deprecated items show up correctly
benoit
parents: 2061
diff changeset
109 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
110 typedef struct AVFrac {
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
111 int64_t val, num, den;
1258
558c75bd81a0 attribute_deprecated
michael
parents: 1251
diff changeset
112 } AVFrac attribute_deprecated;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
113
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
114 /*************************************************/
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
115 /* input/output formats */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
116
1677
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
117 struct AVCodecTag;
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
118
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
119 struct AVFormatContext;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
120
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
121 /** this structure contains the data a format has to probe a file */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
122 typedef struct AVProbeData {
64
b0e0eb595e29 * static,const,compiler warning cleanup
kabi
parents: 53
diff changeset
123 const char *filename;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
124 unsigned char *buf;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
125 int buf_size;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
126 } AVProbeData;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
127
1304
45a55380918e AVPROBE_SCORE_MAX doc
michael
parents: 1294
diff changeset
128 #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
2001
1a3c9056982a allocate 32 extra bytes at the end of the probe buffer and remove most probe buf_size checks
michael
parents: 1986
diff changeset
129 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
130
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
131 typedef struct AVFormatParameters {
743
af4e24d6310c switch to native time bases
michael
parents: 726
diff changeset
132 AVRational time_base;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
133 int sample_rate;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
134 int channels;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
135 int width;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
136 int height;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
137 enum PixelFormat pix_fmt;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
138 int channel; /**< used to select dv channel */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
139 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
140 int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
141 int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
293
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
142 stream packet (only meaningful if
2141
ramiro
parents: 2140
diff changeset
143 mpeg2ts_raw is TRUE) */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
144 int initial_pause:1; /**< do not begin to play the stream
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
145 immediately (RTSP only) */
1278
f40d75601106 initial support for AVOption in AVFormatContext
nicodvb
parents: 1258
diff changeset
146 int prealloced_context:1;
2833
578a0c783eae Remove *_codec_id from AVFormatParameters with the next major version bump.
michael
parents: 2832
diff changeset
147 #if LIBAVFORMAT_VERSION_INT < (53<<16)
583
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
148 enum CodecID video_codec_id;
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
149 enum CodecID audio_codec_id;
2833
578a0c783eae Remove *_codec_id from AVFormatParameters with the next major version bump.
michael
parents: 2832
diff changeset
150 #endif
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
151 } AVFormatParameters;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
152
1675
b8656dd86312 Attempt to better document AVFMT_NOFILE.
reimar
parents: 1663
diff changeset
153 //! demuxer will use url_fopen, no opened file should be provided by the caller
b8656dd86312 Attempt to better document AVFMT_NOFILE.
reimar
parents: 1663
diff changeset
154 #define AVFMT_NOFILE 0x0001
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
155 #define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
156 #define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
157 #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
158 raw picture data */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
159 #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
160 #define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
161 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
162
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
163 typedef struct AVOutputFormat {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
164 const char *name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
165 const char *long_name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
166 const char *mime_type;
1879
3afb2bec62c1 Clarify doxygen description.
takis
parents: 1878
diff changeset
167 const char *extensions; /**< comma separated filename extensions */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
168 /** size of private data so that it can be allocated in the wrapper */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
169 int priv_data_size;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
170 /* output support */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
171 enum CodecID audio_codec; /**< default audio codec */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
172 enum CodecID video_codec; /**< default video codec */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
173 int (*write_header)(struct AVFormatContext *);
468
60f897e8dd2d pass AVPacket into av_write_frame()
michael
parents: 464
diff changeset
174 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
175 int (*write_trailer)(struct AVFormatContext *);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
176 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
177 int flags;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
178 /** currently only used to set pixel format if not YUV420P */
17
e1200dd82537 added simple still image format support to simplify image and imagepipe video formats
bellard
parents: 5
diff changeset
179 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
536
76c47c58064f move packet interleaving function into AVOutputFormat, so it can be overriden easily instead of doing reordering twice if the muxer needs some other interleaving then dts based
michael
parents: 535
diff changeset
180 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
1677
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
181
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
182 /**
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
183 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
184 * the arrays are all CODEC_ID_NONE terminated
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
185 */
1679
ba58d49d4685 get rid of the [4] limitation of codec tag lists
michael
parents: 1677
diff changeset
186 const struct AVCodecTag **codec_tag;
1677
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
187
2280
69270eb6b20c add proper support for subtitles muxing/stream copying
aurel
parents: 2241
diff changeset
188 enum CodecID subtitle_codec; /**< default subtitle codec */
69270eb6b20c add proper support for subtitles muxing/stream copying
aurel
parents: 2241
diff changeset
189
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
190 /* private fields */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
191 struct AVOutputFormat *next;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
192 } AVOutputFormat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
193
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
194 typedef struct AVInputFormat {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
195 const char *name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
196 const char *long_name;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
197 /** size of private data so that it can be allocated in the wrapper */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
198 int priv_data_size;
2367
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
199 /**
2815
64cf0a2303ac cosmetics: comment typo fixes
diego
parents: 2813
diff changeset
200 * Tell if a given file has a chance of being parsed by this format.
64cf0a2303ac cosmetics: comment typo fixes
diego
parents: 2813
diff changeset
201 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
64cf0a2303ac cosmetics: comment typo fixes
diego
parents: 2813
diff changeset
202 * big so you do not have to check for that unless you need more.
2367
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
203 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
204 int (*read_probe)(AVProbeData *);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
205 /** read the format header and initialize the AVFormatContext
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
206 structure. Return 0 if OK. 'ap' if non NULL contains
1986
cf1622476eb7 typos/grammar
diego
parents: 1918
diff changeset
207 additional paramters. Only used in raw format right
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
208 now. 'av_new_stream' should be called to create new streams. */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
209 int (*read_header)(struct AVFormatContext *,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
210 AVFormatParameters *ap);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
211 /** read one packet and put it in 'pkt'. pts and flags are also
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
212 set. 'av_new_stream' can be called only if the flag
293
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
213 AVFMTCTX_NOHEADER is used. */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
214 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
215 /** close the stream. The AVFormatContext and AVStreams are not
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
216 freed by this function */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
217 int (*read_close)(struct AVFormatContext *);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
218 /**
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
219 * seek to a given timestamp relative to the frames in
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
220 * stream component stream_index
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
221 * @param stream_index must not be -1
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
222 * @param flags selects which direction should be preferred if no exact
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
223 * match is available
2203
a81bd08b5ff2 * clarifying the AVInputFormat::read_seek return value
romansh
parents: 2190
diff changeset
224 * @return >= 0 on success (but not necessarily the new offset)
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
225 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
226 int (*read_seek)(struct AVFormatContext *,
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
227 int stream_index, int64_t timestamp, int flags);
437
50bae308f71e moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents: 420
diff changeset
228 /**
2876
067baa2b8f38 Correct doxy about timestamp units of read_timestamp().
michael
parents: 2875
diff changeset
229 * gets the next timestamp in stream[stream_index].time_base units.
2875
acc9a7c3baea Document return of read_timestamp.
michael
parents: 2851
diff changeset
230 * @return the timestamp or AV_NOPTS_VALUE if an error occured
437
50bae308f71e moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents: 420
diff changeset
231 */
50bae308f71e moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents: 420
diff changeset
232 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
50bae308f71e moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents: 420
diff changeset
233 int64_t *pos, int64_t pos_limit);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
234 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
235 int flags;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
236 /** if extensions are defined, then no probe is done. You should
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
237 usually not use extension format guessing because it is not
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
238 reliable enough */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
239 const char *extensions;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
240 /** general purpose read only value that the format can use */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
241 int value;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
242
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
243 /** start/resume playing - only meaningful if using a network based format
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
244 (RTSP) */
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
245 int (*read_play)(struct AVFormatContext *);
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
246
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
247 /** pause playing - only meaningful if using a network based format
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
248 (RTSP) */
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
249 int (*read_pause)(struct AVFormatContext *);
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
250
1679
ba58d49d4685 get rid of the [4] limitation of codec tag lists
michael
parents: 1677
diff changeset
251 const struct AVCodecTag **codec_tag;
1677
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
252
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
253 /* private fields */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
254 struct AVInputFormat *next;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
255 } AVInputFormat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
256
2023
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
257 enum AVStreamParseType {
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
258 AVSTREAM_PARSE_NONE,
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
259 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
260 AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
261 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
262 };
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
263
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
264 typedef struct AVIndexEntry {
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
265 int64_t pos;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
266 int64_t timestamp;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
267 #define AVINDEX_KEYFRAME 0x0001
979
d2e5dfdf4def add size to AVIndex
michael
parents: 961
diff changeset
268 int flags:2;
2165
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
269 int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs 32 byte due to possible 8byte align).
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
270 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
271 } AVIndexEntry;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
272
2846
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
273 /**
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
274 * Stream structure.
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
275 * New fields can be added to the end with minor version bumps.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
276 * Removal, reordering and changes to existing fields require a major
2846
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
277 * version bump.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
278 * sizeof(AVStream) must not be used outside libav*.
2846
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
279 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
280 typedef struct AVStream {
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
281 int index; /**< stream index in AVFormatContext */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
282 int id; /**< format specific stream id */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
283 AVCodecContext *codec; /**< codec context */
793
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
284 /**
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
285 * Real base frame rate of the stream.
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
286 * This is the lowest frame rate with which all timestamps can be
2141
ramiro
parents: 2140
diff changeset
287 * represented accurately (it is the least common multiple of all
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
288 * frame rates in the stream), Note, this value is just a guess!
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
289 * For example if the timebase is 1/90000 and all frames have either
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
290 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
793
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
291 */
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
292 AVRational r_frame_rate;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
293 void *priv_data;
2300
9c8cfadff191 correct initial timestamps which have AV_NOPTS_VALUE
michael
parents: 2284
diff changeset
294
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
295 /* internal data used in av_find_stream_info() */
2300
9c8cfadff191 correct initial timestamps which have AV_NOPTS_VALUE
michael
parents: 2284
diff changeset
296 int64_t first_dts;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
297 /** encoding: PTS generation when outputing stream */
2241
914aeda381e6 avoid deprecation warnings for AVFrac from avformat.h
mru
parents: 2220
diff changeset
298 struct AVFrac pts;
844
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
299
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
300 /**
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
301 * This is the fundamental unit of time (in seconds) in terms
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
302 * of which frame timestamps are represented. For fixed-fps content,
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
303 * timebase should be 1/frame rate and timestamp increments should be
844
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
304 * identically 1.
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
305 */
462
b69898ffc92a move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents: 437
diff changeset
306 AVRational time_base;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
307 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
308 /* ffmpeg.c private use */
1878
02dce5a6b035 Cleanup doxygen comment.
takis
parents: 1877
diff changeset
309 int stream_copy; /**< if set, just copy stream */
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
310 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
650
c129846f7f02 support discarding of uninterresting packets
michael
parents: 639
diff changeset
311 //FIXME move stuff to a flags field?
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
312 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
313 * MN: dunno if that is the right place for it */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
314 float quality;
2386
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
315 /**
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
316 * Decoding: pts of the first frame of the stream, in stream time base.
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
317 * Only set this if you are absolutely 100% sure that the value you set
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
318 * it to really is the pts of the first frame.
2396
28f19eb568a2 mention that start_time maybe AV_NOPTS_VALUE (from patch by neilb suse de)
michael
parents: 2386
diff changeset
319 * This may be undefined (AV_NOPTS_VALUE).
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
320 * @note The ASF header does NOT contain a correct start_time the ASF
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
321 * demuxer must NOT set this.
2386
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
322 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
323 int64_t start_time;
2397
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
324 /**
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
325 * Decoding: duration of the stream, in stream time base.
2397
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
326 * If a source file does not specify a duration, but does specify
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
327 * a bitrate, this value will be estimates from bit rate and file size.
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
328 */
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
329 int64_t duration;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
330
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
331 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
784
5f3e609d7361 optional ISO 639 3 letter language field
bellard
parents: 775
diff changeset
332
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
333 /* av_read_frame() support */
2023
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
334 enum AVStreamParseType need_parsing;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
335 struct AVCodecParserContext *parser;
334
7f089db11f9a fixed incorrect PTS/DTS logic in MPEG video case (caused rare PTS glitches if start codes were between two PES packets)
bellard
parents: 315
diff changeset
336
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
337 int64_t cur_dts;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
338 int last_IP_duration;
464
09e46bfc859c cur_dts in native timebase
michael
parents: 463
diff changeset
339 int64_t last_IP_pts;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
340 /* av_seek_frame() support */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
341 AVIndexEntry *index_entries; /**< only used if the format does not
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
342 support seeking natively */
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
343 int nb_index_entries;
1332
7474cc6383d4 fix some signedness warnings
mru
parents: 1322
diff changeset
344 unsigned int index_entries_allocated_size;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
345
793
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
346 int64_t nb_frames; ///< number of frames in this stream if known or 0
1285
b5226e679a31 fix b pyramid in mp4 muxing if no dts are provided to the muxer
michael
parents: 1279
diff changeset
347
b5226e679a31 fix b pyramid in mp4 muxing if no dts are provided to the muxer
michael
parents: 1279
diff changeset
348 #define MAX_REORDER_DELAY 4
b5226e679a31 fix b pyramid in mp4 muxing if no dts are provided to the muxer
michael
parents: 1279
diff changeset
349 int64_t pts_buffer[MAX_REORDER_DELAY+1];
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
350 } AVStream;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
351
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
352 #define AV_PROGRAM_RUNNING 1
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
353
2846
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
354 /**
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
355 * New fields can be added to the end with minor version bumps.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
356 * Removal, reordering and changes to existing fields require a major
2846
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
357 * version bump.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
358 * sizeof(AVProgram) must not be used outside libav*.
2846
625c2c60f585 Document a few more structure change rules with relation to ABI/API.
michael
parents: 2844
diff changeset
359 */
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
360 typedef struct AVProgram {
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
361 int id;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
362 char *provider_name; ///< Network name for DVB streams
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
363 char *name; ///< Service name for DVB streams
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
364 int flags;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
365 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
2650
4e3d38c8896c API extension: AVProgram now has an array (stream_index) containing the indexes of the streams in AVFormatContext
nicodvb
parents: 2620
diff changeset
366 unsigned int *stream_index;
4e3d38c8896c API extension: AVProgram now has an array (stream_index) containing the indexes of the streams in AVFormatContext
nicodvb
parents: 2620
diff changeset
367 unsigned int nb_stream_indexes;
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
368 } AVProgram;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
369
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
370 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
293
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
371 (streams are added dynamically) */
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
372
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
373 #define MAX_STREAMS 20
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
374
2844
440267faee3c Document structure change rules with relation to ABI/API.
michael
parents: 2836
diff changeset
375 /**
440267faee3c Document structure change rules with relation to ABI/API.
michael
parents: 2836
diff changeset
376 * format I/O context.
440267faee3c Document structure change rules with relation to ABI/API.
michael
parents: 2836
diff changeset
377 * New fields can be added to the end with minor version bumps.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
378 * Removal, reordering and changes to existing fields require a major
2844
440267faee3c Document structure change rules with relation to ABI/API.
michael
parents: 2836
diff changeset
379 * version bump.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
380 * sizeof(AVFormatContext) must not be used outside libav*.
2844
440267faee3c Document structure change rules with relation to ABI/API.
michael
parents: 2836
diff changeset
381 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
382 typedef struct AVFormatContext {
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
383 const AVClass *av_class; /**< set by av_alloc_format_context */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
384 /* can only be iformat or oformat, not both at the same time */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
385 struct AVInputFormat *iformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
386 struct AVOutputFormat *oformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
387 void *priv_data;
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2749
diff changeset
388 ByteIOContext *pb;
1663
a7508607760c Make nb_streams unsigned to avoid an ugly cast.
diego
parents: 1602
diff changeset
389 unsigned int nb_streams;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
390 AVStream *streams[MAX_STREAMS];
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
391 char filename[1024]; /**< input or output filename */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
392 /* stream info */
420
e440fb884442 * making it possible to specify recording date and time in a stream
romansh
parents: 384
diff changeset
393 int64_t timestamp;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
394 char title[512];
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
395 char author[512];
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
396 char copyright[512];
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
397 char comment[512];
234
b99548e3ab84 ID3 parsing and generation in MP3 format
bellard
parents: 230
diff changeset
398 char album[512];
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
399 int year; /**< ID3 year, 0 if none */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
400 int track; /**< track number, 0 if none */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
401 char genre[32]; /**< ID3 genre */
234
b99548e3ab84 ID3 parsing and generation in MP3 format
bellard
parents: 230
diff changeset
402
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
403 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
404 /* private data for pts handling (do not modify directly) */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
405 /** This buffer is only needed when packets were already buffered but
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
406 not decoded, for example to get the codec parameters in mpeg
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
407 streams */
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
408 struct AVPacketList *packet_buffer;
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
409
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
410 /** decoding: position of the first frame of the component, in
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
411 AV_TIME_BASE fractional seconds. NEVER set this value directly:
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
412 it is deduced from the AVStream values. */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
413 int64_t start_time;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
414 /** decoding: duration of the stream, in AV_TIME_BASE fractional
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
415 seconds. NEVER set this value directly: it is deduced from the
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
416 AVStream values. */
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
417 int64_t duration;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
418 /** decoding: total file size. 0 if unknown */
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
419 int64_t file_size;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
420 /** decoding: total stream bitrate in bit/s, 0 if not
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
421 available. Never set it directly if the file_size and the
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
422 duration are known as ffmpeg can compute it automatically. */
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
423 int bit_rate;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
424
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
425 /* av_read_frame() support */
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
426 AVStream *cur_st;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
427 const uint8_t *cur_ptr;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
428 int cur_len;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
429 AVPacket cur_pkt;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
430
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
431 /* av_seek_frame() support */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
432 int64_t data_offset; /** offset of the first packet */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
433 int index_built;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
434
551
ef359bf133cc user selectable packet_size and mux_rate
michael
parents: 549
diff changeset
435 int mux_rate;
ef359bf133cc user selectable packet_size and mux_rate
michael
parents: 549
diff changeset
436 int packet_size;
566
c1e54abaa87e user setable preload and max_mux_delay
michael
parents: 565
diff changeset
437 int preload;
c1e54abaa87e user setable preload and max_mux_delay
michael
parents: 565
diff changeset
438 int max_delay;
790
80aec794c2ed Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents: 784
diff changeset
439
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
440 #define AVFMT_NOOUTPUTLOOP -1
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
441 #define AVFMT_INFINITEOUTPUTLOOP 0
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
442 /** number of times to loop output in formats that support it */
790
80aec794c2ed Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents: 784
diff changeset
443 int loop_output;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
444
841
ba7631ba33a7 support fixing missing pts by parsing future frames
michael
parents: 829
diff changeset
445 int flags;
ba7631ba33a7 support fixing missing pts by parsing future frames
michael
parents: 829
diff changeset
446 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
1294
12398b868e18 ignore index parameter to ignore the ODML index in avi
michael
parents: 1291
diff changeset
447 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
2220
0d93ef692caa Add support for non-blocking input formats
lucabe
parents: 2203
diff changeset
448 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
1175
8b53c0f3e7ad add loop_input to AVFormatContext, getting rid of old hack
mru
parents: 1167
diff changeset
449
8b53c0f3e7ad add loop_input to AVFormatContext, getting rid of old hack
mru
parents: 1167
diff changeset
450 int loop_input;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
451 /** decoding: size of data to probe; encoding unused */
1279
a12e0b434174 added option probesize; at the moment only used by mpegts.c
nicodvb
parents: 1278
diff changeset
452 unsigned int probesize;
1720
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
453
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
454 /**
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
455 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
456 */
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
457 int max_analyze_duration;
1778
d8c6b719a070 add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents: 1756
diff changeset
458
d8c6b719a070 add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents: 1756
diff changeset
459 const uint8_t *key;
d8c6b719a070 add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents: 1756
diff changeset
460 int keylen;
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
461
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
462 unsigned int nb_programs;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
463 AVProgram **programs;
2832
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
464
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
465 /**
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
466 * Forced video codec_id.
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
467 * demuxing: set by user
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
468 */
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
469 enum CodecID video_codec_id;
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
470 /**
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
471 * Forced audio codec_id.
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
472 * demuxing: set by user
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
473 */
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
474 enum CodecID audio_codec_id;
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
475 /**
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
476 * Forced subtitle codec_id.
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
477 * demuxing: set by user
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
478 */
8ac5fe1c5549 Allow overriding codec_ids.
michael
parents: 2815
diff changeset
479 enum CodecID subtitle_codec_id;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
480 } AVFormatContext;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
481
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
482 typedef struct AVPacketList {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
483 AVPacket pkt;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
484 struct AVPacketList *next;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
485 } AVPacketList;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
486
2812
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2788
diff changeset
487 #if LIBAVFORMAT_VERSION_INT < (53<<16)
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
488 extern AVInputFormat *first_iformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
489 extern AVOutputFormat *first_oformat;
2812
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2788
diff changeset
490 #endif
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2788
diff changeset
491
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2788
diff changeset
492 AVInputFormat *av_iformat_next(AVInputFormat *f);
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2788
diff changeset
493 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
494
583
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
495 enum CodecID av_guess_image2_codec(const char *filename);
17
e1200dd82537 added simple still image format support to simplify image and imagepipe video formats
bellard
parents: 5
diff changeset
496
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
497 /* XXX: use automatic init with either ELF sections or C file parser */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
498 /* modules */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
499
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
500 /* utils.c */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
501 void av_register_input_format(AVInputFormat *format);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
502 void av_register_output_format(AVOutputFormat *format);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
503 AVOutputFormat *guess_stream_format(const char *short_name,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
504 const char *filename, const char *mime_type);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
505 AVOutputFormat *guess_format(const char *short_name,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
506 const char *filename, const char *mime_type);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
507
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
508 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
509 * Guesses the codec id based upon muxer and filename.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
510 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
511 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
583
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
512 const char *filename, const char *mime_type, enum CodecType type);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
513
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
514 /**
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
515 * Send a nice hexadecimal dump of a buffer to the specified file stream.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
516 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
517 * @param f The file stream pointer where the dump should be sent to.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
518 * @param buf buffer
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
519 * @param size buffer size
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
520 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
521 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
522 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
523 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
524
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
525 /**
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
526 * Send a nice hexadecimal dump of a buffer to the log.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
527 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
528 * @param avcl A pointer to an arbitrary struct of which the first field is a
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
529 * pointer to an AVClass struct.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
530 * @param level The importance level of the message, lower values signifying
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
531 * higher importance.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
532 * @param buf buffer
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
533 * @param size buffer size
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
534 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
535 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
536 */
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
537 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
538
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
539 /**
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
540 * Send a nice dump of a packet to the specified file stream.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
541 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
542 * @param f The file stream pointer where the dump should be sent to.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
543 * @param pkt packet to dump
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
544 * @param dump_payload true if the payload must be displayed too
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
545 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
546 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
547
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
548 /**
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
549 * Send a nice dump of a packet to the log.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
550 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
551 * @param avcl A pointer to an arbitrary struct of which the first field is a
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
552 * pointer to an AVClass struct.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
553 * @param level The importance level of the message, lower values signifying
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
554 * higher importance.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
555 * @param pkt packet to dump
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
556 * @param dump_payload true if the payload must be displayed too
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
557 */
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
558 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
559
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
560 void av_register_all(void);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
561
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
562 /** codec tag <-> codec id */
1679
ba58d49d4685 get rid of the [4] limitation of codec tag lists
michael
parents: 1677
diff changeset
563 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
ba58d49d4685 get rid of the [4] limitation of codec tag lists
michael
parents: 1677
diff changeset
564 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
1677
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
565
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
566 /* media file input */
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
567
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
568 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
569 * finds AVInputFormat based on input format's short name.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
570 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
571 AVInputFormat *av_find_input_format(const char *short_name);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
572
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
573 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
574 * Guess file format.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
575 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
576 * @param is_opened whether the file is already opened, determines whether
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
577 * demuxers with or without AVFMT_NOFILE are probed
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
578 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
579 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
580
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
581 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
582 * Allocates all the structures needed to read an input stream.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
583 * This does not open the needed codecs for decoding the stream[s].
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
584 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
585 int av_open_input_stream(AVFormatContext **ic_ptr,
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
586 ByteIOContext *pb, const char *filename,
293
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
587 AVInputFormat *fmt, AVFormatParameters *ap);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
588
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
589 /**
2141
ramiro
parents: 2140
diff changeset
590 * Open a media file as input. The codecs are not opened. Only the file
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
591 * header (if present) is read.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
592 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
593 * @param ic_ptr the opened media file handle is put here
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
594 * @param filename filename to open.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
595 * @param fmt if non NULL, force the file format to use
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
596 * @param buf_size optional buffer size (zero if default is OK)
1986
cf1622476eb7 typos/grammar
diego
parents: 1918
diff changeset
597 * @param ap additional parameters needed when opening the file (NULL if default)
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
598 * @return 0 if OK. AVERROR_xxx otherwise.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
599 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
600 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
601 AVInputFormat *fmt,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
602 int buf_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
603 AVFormatParameters *ap);
2813
9d53cc092c55 document how to free the result of av_alloc_format_context()
michael
parents: 2812
diff changeset
604 /**
9d53cc092c55 document how to free the result of av_alloc_format_context()
michael
parents: 2812
diff changeset
605 * Allocate an AVFormatContext.
2815
64cf0a2303ac cosmetics: comment typo fixes
diego
parents: 2813
diff changeset
606 * Can be freed with av_free() but do not forget to free everything you
2813
9d53cc092c55 document how to free the result of av_alloc_format_context()
michael
parents: 2812
diff changeset
607 * explicitly allocated as well!
9d53cc092c55 document how to free the result of av_alloc_format_context()
michael
parents: 2812
diff changeset
608 */
370
845f9de2c883 av_log() patch by (Michel Bardiaux <mbardiaux at peaktime dot be>)
michael
parents: 369
diff changeset
609 AVFormatContext *av_alloc_format_context(void);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
610
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
611 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
612 * Read packets of a media file to get stream information. This
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
613 * is useful for file formats with no headers such as MPEG. This
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
614 * function also computes the real frame rate in case of mpeg2 repeat
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
615 * frame mode.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
616 * The logical file position is not changed by this function;
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
617 * examined packets may be buffered for later processing.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
618 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
619 * @param ic media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
620 * @return >=0 if OK. AVERROR_xxx if error.
2745
takis
parents: 2731
diff changeset
621 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
622 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
623 int av_find_stream_info(AVFormatContext *ic);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
624
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
625 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
626 * Read a transport packet from a media file.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
627 *
2141
ramiro
parents: 2140
diff changeset
628 * This function is obsolete and should never be used.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
629 * Use av_read_frame() instead.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
630 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
631 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
632 * @param pkt is filled
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
633 * @return 0 if OK. AVERROR_xxx if error.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
634 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
635 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
636
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
637 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
638 * Return the next frame of a stream.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
639 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
640 * The returned packet is valid
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
641 * until the next av_read_frame() or until av_close_input_file() and
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
642 * must be freed with av_free_packet. For video, the packet contains
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
643 * exactly one frame. For audio, it contains an integer number of
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
644 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
645 * data). If the audio frames have a variable size (e.g. MPEG audio),
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
646 * then it contains one frame.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
647 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
648 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1844
2c91663b3bc6 Correct wrong avformat documentation.
takis
parents: 1840
diff changeset
649 * values in AVStream.timebase units (and guessed if the format cannot
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
650 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
651 * has B frames, so it is better to rely on pkt->dts if you do not
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
652 * decompress the payload.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
653 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
654 * @return 0 if OK, < 0 if error or end of file.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
655 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
656 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
657
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
658 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
659 * Seek to the key frame at timestamp.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
660 * 'timestamp' in 'stream_index'.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
661 * @param stream_index If stream_index is (-1), a default
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
662 * stream is selected, and timestamp is automatically converted
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
663 * from AV_TIME_BASE units to the stream specific time_base.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
664 * @param timestamp timestamp in AVStream.time_base units
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
665 * or if there is no stream specified then in AV_TIME_BASE units
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
666 * @param flags flags which select direction and seeking mode
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
667 * @return >= 0 on success
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
668 */
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
669 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
670
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
671 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
672 * start playing a network based stream (e.g. RTSP stream) at the
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
673 * current position
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
674 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
675 int av_read_play(AVFormatContext *s);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
676
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
677 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
678 * Pause a network based stream (e.g. RTSP stream).
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
679 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
680 * Use av_read_play() to resume it.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
681 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
682 int av_read_pause(AVFormatContext *s);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
683
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
684 /**
2835
b158768c5352 Add a av_close_input_stream function
reimar
parents: 2834
diff changeset
685 * Free a AVFormatContext allocated by av_open_input_stream.
b158768c5352 Add a av_close_input_stream function
reimar
parents: 2834
diff changeset
686 * @param s context to free
b158768c5352 Add a av_close_input_stream function
reimar
parents: 2834
diff changeset
687 */
b158768c5352 Add a av_close_input_stream function
reimar
parents: 2834
diff changeset
688 void av_close_input_stream(AVFormatContext *s);
b158768c5352 Add a av_close_input_stream function
reimar
parents: 2834
diff changeset
689
b158768c5352 Add a av_close_input_stream function
reimar
parents: 2834
diff changeset
690 /**
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
691 * Close a media file (but not its codecs).
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
692 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
693 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
694 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
695 void av_close_input_file(AVFormatContext *s);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
696
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
697 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
698 * Add a new stream to a media file.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
699 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
700 * Can only be called in the read_header() function. If the flag
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
701 * AVFMTCTX_NOHEADER is in the format context, then new streams
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
702 * can be added in read_packet too.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
703 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
704 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
705 * @param id file format dependent stream id
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
706 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
707 AVStream *av_new_stream(AVFormatContext *s, int id);
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
708 AVProgram *av_new_program(AVFormatContext *s, int id);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
709
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
710 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
711 * Set the pts for a given stream.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
712 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
713 * @param s stream
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
714 * @param pts_wrap_bits number of bits effectively used by the pts
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
715 * (used for wrap control, 33 is the value for MPEG)
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
716 * @param pts_num numerator to convert to seconds (MPEG: 1)
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
717 * @param pts_den denominator to convert to seconds (MPEG: 90000)
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
718 */
462
b69898ffc92a move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents: 437
diff changeset
719 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
720 int pts_num, int pts_den);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
721
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
722 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
723 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
698
829c5c8e5cf2 keyframe & non keyframe index fixes
michael
parents: 650
diff changeset
724 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
725
346
e154eb1b7149 caching of timestamps for mpeg-ps so seeking is faster
michael
parents: 338
diff changeset
726 int av_find_default_stream_index(AVFormatContext *s);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
727
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
728 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
729 * Gets the index for a specific timestamp.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
730 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
731 * the timestamp which is <= the requested one, if backward is 0
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
732 * then it will be >=
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
733 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
734 * @return < 0 if no such timestamp could be found
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
735 */
597
d814669d2c13 int / int64 fix by (Wolfram Gloger <wmglo @@@ dent:med:uni-muenchen:de>)
michael
parents: 594
diff changeset
736 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
737
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
738 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
739 * Add a index entry into a sorted list updateing if it is already there.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
740 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
741 * @param timestamp timestamp in the timebase of the given stream
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
742 */
354
6770ca07abe2 store searched distance in index, so we dont waste time searching for keyframes where we already searched
michael
parents: 346
diff changeset
743 int av_add_index_entry(AVStream *st,
979
d2e5dfdf4def add size to AVIndex
michael
parents: 961
diff changeset
744 int64_t pos, int64_t timestamp, int size, int distance, int flags);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
745
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
746 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
747 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
748 * This is not supposed to be called directly by a user application, but by demuxers.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
749 * @param target_ts target timestamp in the time base of the given stream
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
750 * @param stream_index stream number
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
751 */
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
752 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
753
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
754 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
755 * Updates cur_dts of all streams based on given timestamp and AVStream.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
756 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
757 * Stream ref_st unchanged, others set cur_dts in their native timebase
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
758 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
759 * @param timestamp new dts expressed in time_base of param ref_st
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
760 * @param ref_st reference stream giving time_base of param timestamp
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
761 */
1185
13dc486b272b Try to find out correct start time to make seeking faster and add some
reimar
parents: 1175
diff changeset
762 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
763
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
764 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
765 * Does a binary search using read_timestamp().
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
766 * This is not supposed to be called directly by a user application, but by demuxers.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
767 * @param target_ts target timestamp in the time base of the given stream
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
768 * @param stream_index stream number
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
769 */
1496
7e288adde245 split av_seek_frame_binary() so the code becomes idependant of AVInputFormat and AVIndex
michael
parents: 1486
diff changeset
770 int64_t av_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
346
e154eb1b7149 caching of timestamps for mpeg-ps so seeking is faster
michael
parents: 338
diff changeset
771
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
772 /** media file output */
17
e1200dd82537 added simple still image format support to simplify image and imagepipe video formats
bellard
parents: 5
diff changeset
773 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
774
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
775 /**
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
776 * Allocate the stream private data and write the stream header to an
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
777 * output media file.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
778 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
779 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
780 * @return 0 if OK. AVERROR_xxx if error.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
781 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
782 int av_write_header(AVFormatContext *s);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
783
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
784 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
785 * Write a packet to an output media file.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
786 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
787 * The packet shall contain one audio or video frame.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
788 * The packet must be correctly interleaved according to the container specification,
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
789 * if not then av_interleaved_write_frame must be used
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
790 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
791 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
792 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
793 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
794 */
468
60f897e8dd2d pass AVPacket into av_write_frame()
michael
parents: 464
diff changeset
795 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
796
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
797 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
798 * Writes a packet to an output media file ensuring correct interleaving.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
799 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
800 * The packet must contain one audio or video frame.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
801 * If the packets are already correctly interleaved the application should
2165
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
802 * call av_write_frame() instead as it is slightly faster. It is also important
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
803 * to keep in mind that completely non-interleaved input will need huge amounts
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
804 * of memory to interleave with this, so it is preferable to interleave at the
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
805 * demuxer level.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
806 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
807 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
808 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
809 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
810 */
470
334e08488ad1 correctly interleave packets during encoding
michael
parents: 468
diff changeset
811 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
812
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
813 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
814 * Interleave a packet per DTS in an output media file.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
815 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
816 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
817 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
818 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
819 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
820 * @param out the interleaved packet will be output here
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
821 * @param in the input packet
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
822 * @param flush 1 if no further packets are available as input and all
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
823 * remaining packets should be output
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
824 * @return 1 if a packet was output, 0 if no packet could be output,
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
825 * < 0 if an error occured
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
826 */
1251
d06e5cb7fb52 export av_interleave_packet_per_dts
bcoudurier
parents: 1245
diff changeset
827 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
468
60f897e8dd2d pass AVPacket into av_write_frame()
michael
parents: 464
diff changeset
828
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
829 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
830 * @brief Write the stream trailer to an output media file and
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
831 * free the file private data.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
832 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
833 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
834 * @return 0 if OK. AVERROR_xxx if error.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
835 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
836 int av_write_trailer(AVFormatContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
837
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
838 void dump_format(AVFormatContext *ic,
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
839 int index,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
840 const char *url,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
841 int is_output);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
842
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
843 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
844 * parses width and height out of string str.
2163
6c0176688fae Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents: 2148
diff changeset
845 * @deprecated Use av_parse_video_frame_size instead.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
846 */
2163
6c0176688fae Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents: 2148
diff changeset
847 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
848
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
849 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
850 * Converts frame rate from string to a fraction.
2163
6c0176688fae Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents: 2148
diff changeset
851 * @deprecated Use av_parse_video_frame_rate instead.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
852 */
2163
6c0176688fae Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents: 2148
diff changeset
853 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
854
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
855 /**
2559
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
856 * Parses \p datestr and returns a corresponding number of microseconds.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
857 * @param datestr String representing a date or a duration.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
858 * - If a date the syntax is:
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
859 * @code
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
860 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
861 * @endcode
2559
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
862 * Time is localtime unless Z is appended, in which case it is
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
863 * interpreted as UTC.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
864 * If the year-month-day part isn't specified it takes the current
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
865 * year-month-day.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
866 * Returns the number of microseconds since 1st of January, 1970 up to
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
867 * the time of the parsed date or INT64_MIN if \p datestr cannot be
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
868 * successfully parsed.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
869 * - If a duration the syntax is:
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
870 * @code
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
871 * [-]HH[:MM[:SS[.m...]]]
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
872 * [-]S+[.m...]
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
873 * @endcode
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
874 * Returns the number of microseconds contained in a time interval
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
875 * with the specified duration or INT64_MIN if \p datestr cannot be
2788
f66d29c833a6 succes --> success typo
diego
parents: 2784
diff changeset
876 * successfully parsed.
2559
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
877 * @param duration Flag which tells how to interpret \p datestr, if
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
878 * not zero \p datestr is interpreted as a duration, otherwise as a
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
879 * date.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
880 */
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 64
diff changeset
881 int64_t parse_date(const char *datestr, int duration);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
882
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 64
diff changeset
883 int64_t av_gettime(void);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
884
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
885 /* ffm specific for ffserver */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
886 #define FFM_PACKET_SIZE 4096
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
887 offset_t ffm_read_write_index(int fd);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
888 void ffm_write_write_index(int fd, offset_t pos);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
889 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
890
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
891 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
892 * Attempts to find a specific tag in a URL.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
893 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
894 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
895 * Return 1 if found.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
896 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
897 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
898
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
899 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
900 * Returns in 'buf' the path with '%d' replaced by number.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
901
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
902 * Also handles the '%0nd' format where 'n' is the total number
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
903 * of digits and '%%'.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
904 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
905 * @param buf destination buffer
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
906 * @param buf_size destination buffer size
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
907 * @param path numbered sequence string
2749
2a6baeedf776 Fix Doxygen parameter
takis
parents: 2745
diff changeset
908 * @param number frame number
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
909 * @return 0 if OK, -1 if format error.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
910 */
1291
185190bdc185 Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents: 1289
diff changeset
911 int av_get_frame_filename(char *buf, int buf_size,
185190bdc185 Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents: 1289
diff changeset
912 const char *path, int number);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
913
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
914 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
915 * Check whether filename actually is a numbered sequence generator.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
916 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
917 * @param filename possible numbered sequence string
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
918 * @return 1 if a valid numbered sequence string, 0 otherwise.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
919 */
1291
185190bdc185 Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents: 1289
diff changeset
920 int av_filename_number_test(const char *filename);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
921
2284
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
922 /**
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
923 * Generate an SDP for an RTP session.
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
924 *
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
925 * @param ac array of AVFormatContexts describing the RTP streams. If the
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
926 * array is composed by only one context, such context can contain
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
927 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
928 * all the contexts in the array (an AVCodecContext per RTP stream)
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
929 * must contain only one AVStream
2317
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
930 * @param n_files number of AVCodecContexts contained in ac
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
931 * @param buff buffer where the SDP will be stored (must be allocated by
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
932 * the caller
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
933 * @param size the size of the buffer
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
934 * @return 0 if OK. AVERROR_xxx if error.
2284
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
935 */
2317
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
936 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
2284
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
937
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
938 #ifdef HAVE_AV_CONFIG_H
230
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
939
151
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
940 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
941
255
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
942 #ifdef __GNUC__
151
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
943 #define dynarray_add(tab, nb_ptr, elem)\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
944 do {\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
945 typeof(tab) _tab = (tab);\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
946 typeof(elem) _elem = (elem);\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
947 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
948 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
949 } while(0)
255
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
950 #else
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
951 #define dynarray_add(tab, nb_ptr, elem)\
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
952 do {\
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
953 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
954 } while(0)
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
955 #endif
151
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
956
230
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
957 time_t mktimegm(struct tm *tm);
515
ad72189eec07 * replacing calls to not-always-available gmtime_r with our own code.
romansh
parents: 511
diff changeset
958 struct tm *brktimegm(time_t secs, struct tm *tm);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
959 const char *small_strptime(const char *p, const char *fmt,
230
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
960 struct tm *dt);
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
961
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
962 struct in_addr;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
963 int resolve_host(struct in_addr *sin_addr, const char *hostname);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
964
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
965 void url_split(char *proto, int proto_size,
511
056991ab9f10 HTTP Authentication Patch by (Petr Doubek <doubek at vision dot ee dot ethz dot ch>)
michael
parents: 497
diff changeset
966 char *authorization, int authorization_size,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
967 char *hostname, int hostname_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
968 int *port_ptr,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
969 char *path, int path_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
970 const char *url);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
971
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
972 int match_ext(const char *filename, const char *extensions);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
973
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
974 #endif /* HAVE_AV_CONFIG_H */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
975
2620
792383dd085e Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 2602
diff changeset
976 #endif /* FFMPEG_AVFORMAT_H */