annotate avformat.h @ 2788:f66d29c833a6 libavformat

succes --> success typo
author diego
date Sat, 01 Dec 2007 12:05:59 +0000
parents 7046ab98056e
children 173b5cb7efde
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
2784
7046ab98056e Bump lavf minor due to addition of
andoma
parents: 2773
diff changeset
24 #define LIBAVFORMAT_VERSION_INT ((52<<16)+(1<<8)+0)
7046ab98056e Bump lavf minor due to addition of
andoma
parents: 2773
diff changeset
25 #define LIBAVFORMAT_VERSION 52.1.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 */
1795
62792a60f740 implement new grabbing interface, as described here:
gpoirier
parents: 1787
diff changeset
139 #if LIBAVFORMAT_VERSION_INT < (52<<16)
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
140 const char *device; /**< video, audio or DV device */
1795
62792a60f740 implement new grabbing interface, as described here:
gpoirier
parents: 1787
diff changeset
141 #endif
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
142 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
143 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
144 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
145 stream packet (only meaningful if
2141
ramiro
parents: 2140
diff changeset
146 mpeg2ts_raw is TRUE) */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
147 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
148 immediately (RTSP only) */
1278
f40d75601106 initial support for AVOption in AVFormatContext
nicodvb
parents: 1258
diff changeset
149 int prealloced_context:1;
583
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
150 enum CodecID video_codec_id;
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
151 enum CodecID audio_codec_id;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
152 } AVFormatParameters;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
153
1675
b8656dd86312 Attempt to better document AVFMT_NOFILE.
reimar
parents: 1663
diff changeset
154 //! 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
155 #define AVFMT_NOFILE 0x0001
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
156 #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
157 #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
158 #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
159 raw picture data */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
160 #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
161 #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
162 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
163
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
164 typedef struct AVOutputFormat {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
165 const char *name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
166 const char *long_name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
167 const char *mime_type;
1879
3afb2bec62c1 Clarify doxygen description.
takis
parents: 1878
diff changeset
168 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
169 /** size of private data so that it can be allocated in the wrapper */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
170 int priv_data_size;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
171 /* output support */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
172 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
173 enum CodecID video_codec; /**< default video codec */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
174 int (*write_header)(struct AVFormatContext *);
468
60f897e8dd2d pass AVPacket into av_write_frame()
michael
parents: 464
diff changeset
175 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
176 int (*write_trailer)(struct AVFormatContext *);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
177 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
178 int flags;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
179 /** 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
180 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
181 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
182
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
183 /**
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
184 * 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
185 * the arrays are all CODEC_ID_NONE terminated
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
186 */
1679
ba58d49d4685 get rid of the [4] limitation of codec tag lists
michael
parents: 1677
diff changeset
187 const struct AVCodecTag **codec_tag;
1677
2a85c82b8538 add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents: 1675
diff changeset
188
2280
69270eb6b20c add proper support for subtitles muxing/stream copying
aurel
parents: 2241
diff changeset
189 enum CodecID subtitle_codec; /**< default subtitle codec */
69270eb6b20c add proper support for subtitles muxing/stream copying
aurel
parents: 2241
diff changeset
190
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
191 /* private fields */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
192 struct AVOutputFormat *next;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
193 } AVOutputFormat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
194
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
195 typedef struct AVInputFormat {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
196 const char *name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
197 const char *long_name;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
198 /** size of private data so that it can be allocated in the wrapper */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
199 int priv_data_size;
2367
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
200 /**
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
201 * tell if a given file has a chance of being parsed by this format.
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
202 * The buffer provided is guranteed to be AVPROBE_PADDING_SIZE bytes big
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
203 * so you dont have to check for that unless you need more.
43a4290a6d77 mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents: 2317
diff changeset
204 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
205 int (*read_probe)(AVProbeData *);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
206 /** read the format header and initialize the AVFormatContext
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
207 structure. Return 0 if OK. 'ap' if non NULL contains
1986
cf1622476eb7 typos/grammar
diego
parents: 1918
diff changeset
208 additional paramters. Only used in raw format right
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
209 now. 'av_new_stream' should be called to create new streams. */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
210 int (*read_header)(struct AVFormatContext *,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
211 AVFormatParameters *ap);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
212 /** read one packet and put it in 'pkt'. pts and flags are also
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
213 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
214 AVFMTCTX_NOHEADER is used. */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
215 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
216 /** close the stream. The AVFormatContext and AVStreams are not
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
217 freed by this function */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
218 int (*read_close)(struct AVFormatContext *);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
219 /**
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
220 * seek to a given timestamp relative to the frames in
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
221 * stream component stream_index
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
222 * @param stream_index must not be -1
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
223 * @param flags selects which direction should be preferred if no exact
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
224 * match is available
2203
a81bd08b5ff2 * clarifying the AVInputFormat::read_seek return value
romansh
parents: 2190
diff changeset
225 * @return >= 0 on success (but not necessarily the new offset)
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
226 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
227 int (*read_seek)(struct AVFormatContext *,
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
228 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
229 /**
50bae308f71e moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents: 420
diff changeset
230 * gets the next timestamp in AV_TIME_BASE units.
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
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
273 typedef struct AVStream {
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
274 int index; /**< stream index in AVFormatContext */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
275 int id; /**< format specific stream id */
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
276 AVCodecContext *codec; /**< codec context */
793
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
277 /**
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
278 * real base frame rate of the stream.
1486
fa7d68133f17 more verbose r_frame_rate definition
michael
parents: 1444
diff changeset
279 * this is the lowest framerate with which all timestamps can be
2141
ramiro
parents: 2140
diff changeset
280 * represented accurately (it is the least common multiple of all
1486
fa7d68133f17 more verbose r_frame_rate definition
michael
parents: 1444
diff changeset
281 * framerates in the stream), Note, this value is just a guess!
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
282 * for example if the timebase is 1/90000 and all frames have either
793
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
283 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
284 */
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
285 AVRational r_frame_rate;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
286 void *priv_data;
2300
9c8cfadff191 correct initial timestamps which have AV_NOPTS_VALUE
michael
parents: 2284
diff changeset
287
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
288 /* internal data used in av_find_stream_info() */
2300
9c8cfadff191 correct initial timestamps which have AV_NOPTS_VALUE
michael
parents: 2284
diff changeset
289 int64_t first_dts;
9c8cfadff191 correct initial timestamps which have AV_NOPTS_VALUE
michael
parents: 2284
diff changeset
290 #if LIBAVFORMAT_VERSION_INT < (52<<16)
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
291 int codec_info_nb_frames;
1906
330115d147d6 remove codec_info_duration/nb_frames from AVStream
bcoudurier
parents: 1879
diff changeset
292 #endif
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
293 /** encoding: PTS generation when outputing stream */
2241
914aeda381e6 avoid deprecation warnings for AVFrac from avformat.h
mru
parents: 2220
diff changeset
294 struct AVFrac pts;
844
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
295
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
296 /**
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
297 * this is the fundamental unit of time (in seconds) in terms
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
298 * of which frame timestamps are represented. for fixed-fps content,
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
299 * timebase should be 1/framerate and timestamp increments should be
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
300 * identically 1.
35e372e6a6c3 time_base description by Rich Felker | dalias, aerifal cx
michael
parents: 842
diff changeset
301 */
462
b69898ffc92a move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents: 437
diff changeset
302 AVRational time_base;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
303 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
304 /* ffmpeg.c private use */
1878
02dce5a6b035 Cleanup doxygen comment.
takis
parents: 1877
diff changeset
305 int stream_copy; /**< if set, just copy stream */
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
306 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
307 //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
308 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
309 * MN: dunno if that is the right place for it */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
310 float quality;
2386
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
311 /**
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
312 * decoding: pts of the first frame of the stream, in stream time base.
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
313 * only set this if you are absolutely 100% sure that the value you set
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
314 * 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
315 * This may be undefined (AV_NOPTS_VALUE).
2386
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
316 * @note the ASF header does NOT contain a correct start_time the ASF
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
317 * demuxer must NOT set this
2beaa59babad elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents: 2374
diff changeset
318 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
319 int64_t start_time;
2397
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
320 /**
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
321 * decoding: duration of the stream, in stream time base.
e5086ec7a4d4 more verbose doxy for duration (from patch by neilb suse de)
michael
parents: 2396
diff changeset
322 * 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
323 * 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
324 */
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
325 int64_t duration;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
326
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
327 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
328
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
329 /* av_read_frame() support */
2023
a3e79d6e4e3c add an enum for need_parsing
aurel
parents: 2020
diff changeset
330 enum AVStreamParseType need_parsing;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
331 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
332
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
333 int64_t cur_dts;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
334 int last_IP_duration;
464
09e46bfc859c cur_dts in native timebase
michael
parents: 463
diff changeset
335 int64_t last_IP_pts;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
336 /* av_seek_frame() support */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
337 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
338 support seeking natively */
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
339 int nb_index_entries;
1332
7474cc6383d4 fix some signedness warnings
mru
parents: 1322
diff changeset
340 unsigned int index_entries_allocated_size;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
341
793
977417187c64 AVStream.nb_frames and docs for r_frame_rate
michael
parents: 790
diff changeset
342 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
343
b5226e679a31 fix b pyramid in mp4 muxing if no dts are provided to the muxer
michael
parents: 1279
diff changeset
344 #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
345 int64_t pts_buffer[MAX_REORDER_DELAY+1];
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
346 } AVStream;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
347
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
348 #define AV_PROGRAM_RUNNING 1
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
349
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
350 typedef struct AVProgram {
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
351 int id;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
352 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
353 char *name; ///< Service name for DVB streams
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
354 int flags;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
355 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
356 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
357 unsigned int nb_stream_indexes;
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
358 } AVProgram;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
359
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
360 #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
361 (streams are added dynamically) */
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
362
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
363 #define MAX_STREAMS 20
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
364
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
365 /* format I/O context */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
366 typedef struct AVFormatContext {
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
367 const AVClass *av_class; /**< set by av_alloc_format_context */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
368 /* can only be iformat or oformat, not both at the same time */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
369 struct AVInputFormat *iformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
370 struct AVOutputFormat *oformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
371 void *priv_data;
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2749
diff changeset
372 ByteIOContext *pb;
1663
a7508607760c Make nb_streams unsigned to avoid an ugly cast.
diego
parents: 1602
diff changeset
373 unsigned int nb_streams;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
374 AVStream *streams[MAX_STREAMS];
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
375 char filename[1024]; /**< input or output filename */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
376 /* stream info */
420
e440fb884442 * making it possible to specify recording date and time in a stream
romansh
parents: 384
diff changeset
377 int64_t timestamp;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
378 char title[512];
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
379 char author[512];
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
380 char copyright[512];
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
381 char comment[512];
234
b99548e3ab84 ID3 parsing and generation in MP3 format
bellard
parents: 230
diff changeset
382 char album[512];
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
383 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
384 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
385 char genre[32]; /**< ID3 genre */
234
b99548e3ab84 ID3 parsing and generation in MP3 format
bellard
parents: 230
diff changeset
386
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
387 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
388 /* 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
389 /** This buffer is only needed when packets were already buffered but
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
390 not decoded, for example to get the codec parameters in mpeg
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
391 streams */
186
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
392 struct AVPacketList *packet_buffer;
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
393
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
394 /** 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
395 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
396 it is deduced from the AVStream values. */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
397 int64_t start_time;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
398 /** 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
399 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
400 AVStream values. */
2265d21a04c8 added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents: 184
diff changeset
401 int64_t duration;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
402 /** 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
403 int64_t file_size;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
404 /** 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
405 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
406 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
407 int bit_rate;
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
408
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
409 /* av_read_frame() support */
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
410 AVStream *cur_st;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
411 const uint8_t *cur_ptr;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
412 int cur_len;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
413 AVPacket cur_pkt;
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
414
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
415 /* av_seek_frame() support */
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
416 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
417 int index_built;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
418
551
ef359bf133cc user selectable packet_size and mux_rate
michael
parents: 549
diff changeset
419 int mux_rate;
ef359bf133cc user selectable packet_size and mux_rate
michael
parents: 549
diff changeset
420 int packet_size;
566
c1e54abaa87e user setable preload and max_mux_delay
michael
parents: 565
diff changeset
421 int preload;
c1e54abaa87e user setable preload and max_mux_delay
michael
parents: 565
diff changeset
422 int max_delay;
790
80aec794c2ed Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents: 784
diff changeset
423
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
424 #define AVFMT_NOOUTPUTLOOP -1
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
425 #define AVFMT_INFINITEOUTPUTLOOP 0
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
426 /** 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
427 int loop_output;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
428
841
ba7631ba33a7 support fixing missing pts by parsing future frames
michael
parents: 829
diff changeset
429 int flags;
ba7631ba33a7 support fixing missing pts by parsing future frames
michael
parents: 829
diff changeset
430 #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
431 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
2220
0d93ef692caa Add support for non-blocking input formats
lucabe
parents: 2203
diff changeset
432 #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
433
8b53c0f3e7ad add loop_input to AVFormatContext, getting rid of old hack
mru
parents: 1167
diff changeset
434 int loop_input;
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
435 /** 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
436 unsigned int probesize;
1720
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
437
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
438 /**
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
439 * 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
440 */
1a8d1f66c867 make av_find_stream_info() duration user selectable
michael
parents: 1679
diff changeset
441 int max_analyze_duration;
1778
d8c6b719a070 add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents: 1756
diff changeset
442
d8c6b719a070 add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents: 1756
diff changeset
443 const uint8_t *key;
d8c6b719a070 add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents: 1756
diff changeset
444 int keylen;
2573
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
445
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
446 unsigned int nb_programs;
2842354cb9a4 Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents: 2559
diff changeset
447 AVProgram **programs;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
448 } AVFormatContext;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
449
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
450 typedef struct AVPacketList {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
451 AVPacket pkt;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
452 struct AVPacketList *next;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
453 } AVPacketList;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
454
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
455 extern AVInputFormat *first_iformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
456 extern AVOutputFormat *first_oformat;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
457
583
7793767ffe35 move p*m from image/lavf -> image2/lavc
michael
parents: 571
diff changeset
458 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
459
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
460 /* XXX: use automatic init with either ELF sections or C file parser */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
461 /* modules */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
462
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
463 /* utils.c */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
464 void av_register_input_format(AVInputFormat *format);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
465 void av_register_output_format(AVOutputFormat *format);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
466 AVOutputFormat *guess_stream_format(const char *short_name,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
467 const char *filename, const char *mime_type);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
468 AVOutputFormat *guess_format(const char *short_name,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
469 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
470
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
471 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
472 * 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
473 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
474 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
475 const char *filename, const char *mime_type, enum CodecType type);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
476
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
477 /**
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
478 * 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
479 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
480 * @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
481 * @param buf buffer
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
482 * @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
483 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
484 * @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
485 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
486 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
487
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
488 /**
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
489 * 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
490 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
491 * @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
492 * 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
493 * @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
494 * higher importance.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
495 * @param buf buffer
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
496 * @param size buffer size
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
497 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
498 * @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
499 */
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
500 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
501
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
502 /**
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
503 * 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
504 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
505 * @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
506 * @param pkt packet to dump
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
507 * @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
508 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
509 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
510
1908
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
511 /**
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
512 * 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
513 *
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
514 * @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
515 * 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
516 * @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
517 * higher importance.
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
518 * @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
519 * @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
520 */
174083eafc6c Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents: 1906
diff changeset
521 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
522
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
523 void av_register_all(void);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
524
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
525 /** codec tag <-> codec id */
1679
ba58d49d4685 get rid of the [4] limitation of codec tag lists
michael
parents: 1677
diff changeset
526 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
527 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
528
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
529 /* media file input */
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
530
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
531 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
532 * 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
533 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
534 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
535
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
536 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
537 * Guess file format.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
538 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
539 * @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
540 * 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
541 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
542 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
543
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
544 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
545 * 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
546 * 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
547 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
548 int av_open_input_stream(AVFormatContext **ic_ptr,
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
549 ByteIOContext *pb, const char *filename,
293
62cec412a186 make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents: 274
diff changeset
550 AVInputFormat *fmt, AVFormatParameters *ap);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
551
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
552 /**
2141
ramiro
parents: 2140
diff changeset
553 * 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
554 * header (if present) is read.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
555 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
556 * @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
557 * @param filename filename to open.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
558 * @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
559 * @param buf_size optional buffer size (zero if default is OK)
1986
cf1622476eb7 typos/grammar
diego
parents: 1918
diff changeset
560 * @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
561 * @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
562 */
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
563 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
564 AVInputFormat *fmt,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
565 int buf_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
566 AVFormatParameters *ap);
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
567 /** no av_open for output, so applications will need this: */
370
845f9de2c883 av_log() patch by (Michel Bardiaux <mbardiaux at peaktime dot be>)
michael
parents: 369
diff changeset
568 AVFormatContext *av_alloc_format_context(void);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
569
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
570 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
571 * 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
572 * 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
573 * 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
574 * frame mode.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
575 * 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
576 * 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
577 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
578 * @param ic media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
579 * @return >=0 if OK. AVERROR_xxx if error.
2745
takis
parents: 2731
diff changeset
580 * @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
581 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
582 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
583
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
584 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
585 * 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
586 *
2141
ramiro
parents: 2140
diff changeset
587 * 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
588 * Use av_read_frame() instead.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
589 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
590 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
591 * @param pkt is filled
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
592 * @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
593 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
594 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
595
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
596 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
597 * 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
598 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
599 * The returned packet is valid
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
600 * 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
601 * 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
602 * 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
603 * 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
604 * 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
605 * then it contains one frame.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
606 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
607 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1844
2c91663b3bc6 Correct wrong avformat documentation.
takis
parents: 1840
diff changeset
608 * 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
609 * 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
610 * 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
611 * decompress the payload.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
612 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
613 * @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
614 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
615 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
616
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
617 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
618 * 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
619 * 'timestamp' in 'stream_index'.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
620 * @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
621 * 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
622 * 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
623 * @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
624 * 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
625 * @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
626 * @return >= 0 on success
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
627 */
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
628 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
629
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 * 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
632 * current position
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
633 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
634 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
635
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 * 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
638 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
639 * 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
640 */
303
2833c2311b66 initial av_read_frame() and av_seek_frame() support
bellard
parents: 293
diff changeset
641 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
642
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
643 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
644 * 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
645 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
646 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
647 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
648 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
649
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
650 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
651 * 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
652 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
653 * 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
654 * 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
655 * 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
656 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
657 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
658 * @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
659 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
660 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
661 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
662
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
663 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
664 * 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
665 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
666 * @param s stream
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
667 * @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
668 * (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
669 * @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
670 * @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
671 */
462
b69898ffc92a move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents: 437
diff changeset
672 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
673 int pts_num, int pts_den);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
674
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
675 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
676 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
698
829c5c8e5cf2 keyframe & non keyframe index fixes
michael
parents: 650
diff changeset
677 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
678
346
e154eb1b7149 caching of timestamps for mpeg-ps so seeking is faster
michael
parents: 338
diff changeset
679 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
680
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
681 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
682 * 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
683 * @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
684 * 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
685 * then it will be >=
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
686 * 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
687 * @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
688 */
597
d814669d2c13 int / int64 fix by (Wolfram Gloger <wmglo @@@ dent:med:uni-muenchen:de>)
michael
parents: 594
diff changeset
689 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
690
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
691 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
692 * 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
693 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
694 * @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
695 */
354
6770ca07abe2 store searched distance in index, so we dont waste time searching for keyframes where we already searched
michael
parents: 346
diff changeset
696 int av_add_index_entry(AVStream *st,
979
d2e5dfdf4def add size to AVIndex
michael
parents: 961
diff changeset
697 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
698
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 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
701 * 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
702 * @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
703 * @param stream_index stream number
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
704 */
555
0a997108f384 use native timebase for seeking
michael
parents: 554
diff changeset
705 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
706
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
707 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
708 * 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
709 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
710 * Stream ref_st unchanged, others set cur_dts in their native timebase
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
711 * 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
712 * @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
713 * @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
714 */
1185
13dc486b272b Try to find out correct start time to make seeking faster and add some
reimar
parents: 1175
diff changeset
715 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
716
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
717 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
718 * Does a binary search using read_timestamp().
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
719 * 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
720 * @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
721 * @param stream_index stream number
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
722 */
1496
7e288adde245 split av_seek_frame_binary() so the code becomes idependant of AVInputFormat and AVIndex
michael
parents: 1486
diff changeset
723 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
724
1858
7ce72baa2ce5 Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents: 1844
diff changeset
725 /** media file output */
17
e1200dd82537 added simple still image format support to simplify image and imagepipe video formats
bellard
parents: 5
diff changeset
726 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
727
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
728 /**
2164
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
729 * Allocate the stream private data and write the stream header to an
3804e39efbfd misc spelling fixes
diego
parents: 2163
diff changeset
730 * output media file.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
731 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
732 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
733 * @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
734 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
735 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
736
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 * 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
739 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
740 * 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
741 * 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
742 * 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
743 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
744 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
745 * @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
746 * @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
747 */
468
60f897e8dd2d pass AVPacket into av_write_frame()
michael
parents: 464
diff changeset
748 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
749
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
750 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
751 * 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
752 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
753 * 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
754 * If the packets are already correctly interleaved the application should
2165
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
755 * call av_write_frame() instead as it is slightly faster. It is also important
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
756 * to keep in mind that completely non-interleaved input will need huge amounts
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
757 * of memory to interleave with this, so it is preferable to interleave at the
eac986610f47 misc typo fixes
diego
parents: 2164
diff changeset
758 * demuxer level.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
759 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
760 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
761 * @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
762 * @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
763 */
470
334e08488ad1 correctly interleave packets during encoding
michael
parents: 468
diff changeset
764 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
765
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
766 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
767 * 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
768 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
769 * 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
770 * 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
771 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
772 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
773 * @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
774 * @param in the input packet
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
775 * @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
776 * remaining packets should be output
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
777 * @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
778 * < 0 if an error occured
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
779 */
1251
d06e5cb7fb52 export av_interleave_packet_per_dts
bcoudurier
parents: 1245
diff changeset
780 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
781
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
782 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
783 * @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
784 * free the file private data.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
785 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
786 * @param s media file handle
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
787 * @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
788 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
789 int av_write_trailer(AVFormatContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
790
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
791 void dump_format(AVFormatContext *ic,
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
792 int index,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
793 const char *url,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
794 int is_output);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
795
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 * 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
798 * @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
799 */
2163
6c0176688fae Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents: 2148
diff changeset
800 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
801
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
802 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
803 * 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
804 * @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
805 */
2163
6c0176688fae Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents: 2148
diff changeset
806 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
807
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
808 /**
2559
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
809 * 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
810 * @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
811 * - 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
812 * @code
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
813 * [{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
814 * @endcode
2559
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
815 * 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
816 * interpreted as UTC.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
817 * 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
818 * year-month-day.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
819 * 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
820 * 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
821 * successfully parsed.
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
822 * - If a duration the syntax is:
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
823 * @code
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
824 * [-]HH[:MM[:SS[.m...]]]
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
825 * [-]S+[.m...]
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
826 * @endcode
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
827 * 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
828 * with the specified duration or INT64_MIN if \p datestr cannot be
2788
f66d29c833a6 succes --> success typo
diego
parents: 2784
diff changeset
829 * successfully parsed.
2559
c57d3d6c8f44 Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents: 2548
diff changeset
830 * @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
831 * 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
832 * date.
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
833 */
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 64
diff changeset
834 int64_t parse_date(const char *datestr, int duration);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
835
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 64
diff changeset
836 int64_t av_gettime(void);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
837
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
838 /* ffm specific for ffserver */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
839 #define FFM_PACKET_SIZE 4096
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
840 offset_t ffm_read_write_index(int fd);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
841 void ffm_write_write_index(int fd, offset_t pos);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
842 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
843
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
844 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
845 * 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
846 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
847 * 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
848 * Return 1 if found.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
849 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
850 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
851
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
852 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
853 * 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
854
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
855 * 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
856 * of digits and '%%'.
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
857 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
858 * @param buf destination buffer
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
859 * @param buf_size destination buffer size
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
860 * @param path numbered sequence string
2749
2a6baeedf776 Fix Doxygen parameter
takis
parents: 2745
diff changeset
861 * @param number frame number
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
862 * @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
863 */
1291
185190bdc185 Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents: 1289
diff changeset
864 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
865 const char *path, int number);
1840
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
866
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
867 /**
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
868 * 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
869 *
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
870 * @param filename possible numbered sequence string
daaa79ca14f0 Move the libavformat public API comments to avformat.h. The comments are
takis
parents: 1795
diff changeset
871 * @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
872 */
1291
185190bdc185 Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents: 1289
diff changeset
873 int av_filename_number_test(const char *filename);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
874
2284
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
875 /**
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
876 * Generate an SDP for an RTP session.
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
877 *
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
878 * @param ac array of AVFormatContexts describing the RTP streams. If the
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
879 * array is composed by only one context, such context can contain
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
880 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
881 * all the contexts in the array (an AVCodecContext per RTP stream)
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
882 * 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
883 * @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
884 * @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
885 * the caller
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
886 * @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
887 * @return 0 if OK. AVERROR_xxx if error.
2284
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
888 */
2317
2adc9f64ecfb Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents: 2300
diff changeset
889 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
2284
59d84b0f7d30 Introduce an SDP generator
lucabe
parents: 2280
diff changeset
890
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
891 #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
892
151
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
893 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
894
255
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
895 #ifdef __GNUC__
151
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
896 #define dynarray_add(tab, nb_ptr, elem)\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
897 do {\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
898 typeof(tab) _tab = (tab);\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
899 typeof(elem) _elem = (elem);\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
900 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
901 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
902 } while(0)
255
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
903 #else
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
904 #define dynarray_add(tab, nb_ptr, elem)\
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
905 do {\
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
906 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
907 } while(0)
302d133294d3 Fix compilation with ccc
mellum
parents: 244
diff changeset
908 #endif
151
ec4d9190d3b1 dynamic array functions
bellard
parents: 146
diff changeset
909
230
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
910 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
911 struct tm *brktimegm(time_t secs, struct tm *tm);
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 879
diff changeset
912 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
913 struct tm *dt);
9f4f4ca9f7b5 simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents: 225
diff changeset
914
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
915 struct in_addr;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
916 int resolve_host(struct in_addr *sin_addr, const char *hostname);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
917
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
918 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
919 char *authorization, int authorization_size,
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
920 char *hostname, int hostname_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
921 int *port_ptr,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
922 char *path, int path_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
923 const char *url);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
924
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
925 int match_ext(const char *filename, const char *extensions);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
926
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
927 #endif /* HAVE_AV_CONFIG_H */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
928
2620
792383dd085e Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 2602
diff changeset
929 #endif /* FFMPEG_AVFORMAT_H */