b9de6d1789bd5012007b59d750b8a464c44d5504
[libav.git] / doc / APIchanges
1 Never assume the API of libav* to be stable unless at least 1 week has passed since
2 the last major version increase.
3 The last version increases were:
4 libavcodec: ?
5 libavcore: 2010-07-21
6 libavdevice: ?
7 libavfilter: 2009-10-18
8 libavformat: ?
9 libpostproc: ?
10 libswscale: ?
11 libavutil: 2009-03-08
12
13
14 API changes, most recent first:
15
16 2010-07-27 - r24518 - lavcore 0.1.0 - parseutils.h
17 Deprecate av_parse_video_frame_size() and av_parse_video_frame_rate()
18 defined in libavcodec in favor of the newly added functions
19 av_parse_video_size() and av_parse_video_rate() declared in
20 libavcore/parseutils.h.
21
22 2010-07-23 - r24439 - lavu 50.23.0 - mathematics.h
23 Add the M_PHI constant definition.
24
25 2010-07-22 - r24424 - lavfi 1.26.0 - media format generalization
26 Add a type field to AVFilterLink.
27
28 Change the field types:
29 enum PixelFormat format -> int format in AVFilterBuffer
30 enum PixelFormat *formats -> int *formats in AVFilterFormats
31 enum PixelFormat *format -> int format in AVFilterLink
32
33 Change the function signatures:
34 AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts); ->
35 AVFilterFormats *avfilter_make_format_list(const int *fmts);
36
37 int avfilter_add_colorspace(AVFilterFormats **avff, enum PixelFormat pix_fmt); ->
38 int avfilter_add_format (AVFilterFormats **avff, int fmt);
39
40 AVFilterFormats *avfilter_all_colorspaces(void); ->
41 AVFilterFormats *avfilter_all_formats (enum AVMediaType type);
42
43 This change breaks libavfilter API/ABI.
44
45 2010-07-21 - r24393 - lavcore 0.0.0
46 Add libavcore.
47
48 2010-07-17 - r24291 - lavfi 1.25.0 - AVFilterBuffer
49 Remove w and h fields from AVFilterBuffer.
50
51 2010-07-17 - r24284 - lavfi 1.24.0 - AVFilterBuffer
52 Rename AVFilterPic to AVFilterBuffer.
53
54 2010-07-17 - r24278 - lavf 52.74.0 - url_fskip()
55 Make url_fskip() return an int error code instead of void.
56
57 2010-07-11 - r24199 - lavc 52.83.0
58 Add AVCodecContext.lpc_type and AVCodecContext.lpc_passes fields.
59 Add AVLPCType enum.
60 Deprecate AVCodecContext.use_lpc.
61
62 2010-07-11 - r24185 - lavc 52.82.0 - avsubtitle_free()
63 Add a function for free the contents of a AVSubtitle generated by
64 avcodec_decode_subtitle.
65
66 2010-07-11 - r24174 - lavu 50.22.0 - bswap.h and intreadwrite.h
67 Make the bswap.h and intreadwrite.h API public.
68
69 2010-07-08 - r24101 - lavu 50.21.0 - pixdesc.h
70 Rename read/write_line() to av_read/write_image_line().
71
72 2010-07-07 - r24091 - lavfi 1.21.0 - avfilter_copy_picref_props()
73 Add avfilter_copy_picref_props().
74
75 2010-07-03 - r24021 - lavc 52.79.0
76 Add FF_COMPLIANCE_UNOFFICIAL and change all instances of
77 FF_COMPLIANCE_INOFFICIAL to use FF_COMPLIANCE_UNOFFICIAL.
78
79 2010-07-02 - r23985 - lavu 50.20.0 - lfg.h
80 Export av_lfg_init(), av_lfg_get(), av_mlfg_get(), and av_bmg_get() through
81 lfg.h.
82
83 2010-06-28 - r23835 - lavfi 1.20.1 - av_parse_color()
84 Extend av_parse_color() syntax, make it accept an alpha value specifier and
85 set the alpha value to 255 by default.
86
87 2010-06-22 - r23706 - lavf 52.71.0 - URLProtocol.priv_data_size, priv_data_class
88 Add priv_data_size and priv_data_class to URLProtocol.
89
90 2010-06-22 - r23704 - lavf 52.70.0 - url_alloc(), url_connect()
91 Add url_alloc() and url_connect().
92
93 2010-06-22 - r23702 - lavf 52.69.0 - av_register_protocol2()
94 Add av_register_protocol2(), deprecating av_register_protocol().
95
96 2010-06-09 - r23551 - lavu 50.19.0 - av_compare_mod()
97 Add av_compare_mod() to libavutil/mathematics.h.
98
99 2010-06-05 - r23485 - lavu 50.18.0 - eval API
100 Make the eval API public.
101
102 2010-06-04 - r23461 - lavu 50.17.0 - AV_BASE64_SIZE
103 Add AV_BASE64_SIZE() macro.
104
105 2010-06-02 - r23421 - lavc 52.73.0 - av_get_codec_tag_string()
106 Add av_get_codec_tag_string().
107
108 2010-06-01 - r31301 - lsws 0.11.0 - convertPalette API
109 Add sws_convertPalette8ToPacked32() and sws_convertPalette8ToPacked24().
110
111 2010-05-26 - r23334 - lavc 52.72.0 - CODEC_CAP_EXPERIMENTAL
112 Add CODEC_CAP_EXPERIMENTAL flag.
113
114 2010-05-23 - r23255 - lavu 50.16.0 - av_get_random_seed()
115 Add av_get_random_seed().
116
117 2010-05-18 - r23161 - lavf 52.63.0 - AVFMT_FLAG_RTP_HINT
118 Add AVFMT_FLAG_RTP_HINT as possible value for AVFormatContext.flags.
119
120 2010-05-09 - r23066 - lavfi 1.20.0 - AVFilterPicRef
121 Add interlaced and top_field_first fields to AVFilterPicRef.
122
123 2010-05-01 - r23002 - lavf 52.62.0 - probe function
124 Add av_probe_input_format2 to API, it allows ignoring probe
125 results below given score and returns the actual probe score.
126
127 2010-04-01 - r22806 - lavf 52.61.0 - metadata API
128 Add a flag for av_metadata_set2() to disable overwriting of
129 existing tags.
130
131 2010-04-01 - r22753 - lavc 52.66.0
132 Add avcodec_get_edge_width().
133
134 2010-03-31 - r22750 - lavc 52.65.0
135 Add avcodec_copy_context().
136
137 2010-03-31 - r22748 - lavf 52.60.0 - av_match_ext()
138 Make av_match_ext() public.
139
140 2010-03-31 - r22736 - lavu 50.14.0 - AVMediaType
141 Move AVMediaType enum from libavcodec to libavutil.
142
143 2010-03-31 - r22735 - lavc 52.64.0 - AVMediaType
144 Define AVMediaType enum, and use it instead of enum CodecType, which
145 is deprecated and will be dropped at the next major bump.
146
147 2010-03-25 - r22684 - lavu 50.13.0 - av_strerror()
148 Implement av_strerror().
149
150 2010-03-23 - r22649 - lavc 52.60.0 - av_dct_init()
151 Support DCT-I and DST-I.
152
153 2010-03-15 - r22540 - lavf 52.56.0 - AVFormatContext.start_time_realtime
154 Add AVFormatContext.start_time_realtime field.
155
156 2010-03-13 - r22506 - lavfi 1.18.0 - AVFilterPicRef.pos
157 Add AVFilterPicRef.pos field.
158
159 2010-03-13 - r22501 - lavu 50.12.0 - error.h
160 Move error code definitions from libavcodec/avcodec.h to
161 the new public header libavutil/error.h.
162
163 2010-03-07 - r22291 - lavc 52.56.0 - avfft.h
164 Add public FFT interface.
165
166 2010-03-06 - r22251 - lavu 50.11.0 - av_stristr()
167 Add av_stristr().
168
169 2010-03-03 - r22174 - lavu 50.10.0 - av_tree_enumerate()
170 Add av_tree_enumerate().
171
172 2010-02-07 - r21673 - lavu 50.9.0 - av_compare_ts()
173 Add av_compare_ts().
174
175 2010-02-05 - r30513 - lsws 0.10.0 - sws_getCoefficients()
176 Add sws_getCoefficients().
177
178 2010-02-01 - r21587 - lavf 52.50.0 - metadata API
179 Add a list of generic tag names, change 'author' -> 'artist',
180 'year' -> 'date'.
181
182 2010-01-30 - r21545 - lavu 50.8.0 - av_get_pix_fmt()
183 Add av_get_pix_fmt().
184
185 2010-01-21 - r30381 - lsws 0.9.0 - sws_scale()
186 Change constness attributes of sws_scale() parameters.
187
188 2010-01-10 - r21121 - lavfi 1.15.0 - avfilter_graph_config_links()
189 Add a log_ctx parameter to avfilter_graph_config_links().
190
191 2010-01-07 - r30236 - lsws 0.8.0 - sws_isSupported{In,Out}put()
192 Add sws_isSupportedInput() and sws_isSupportedOutput() functions.
193
194 2010-01-06 - r21035 - lavfi 1.14.0 - avfilter_add_colorspace()
195 Change the avfilter_add_colorspace() signature, make it accept an
196 (AVFilterFormats **) rather than an (AVFilterFormats *) as before.
197
198 2010-01-03 - r21007 - lavfi 1.13.0 - avfilter_add_colorspace()
199 Add avfilter_add_colorspace().
200
201 2010-01-02 - r20998 - lavf 52.46.0 - av_match_ext()
202 Add av_match_ext(), it should be used in place of match_ext().
203
204 2010-01-01 - r20991 - lavf 52.45.0 - av_guess_format()
205 Add av_guess_format(), it should be used in place of guess_format().
206
207 2009-12-13 - r20834 - lavf 52.43.0 - metadata API
208 Add av_metadata_set2(), AV_METADATA_DONT_STRDUP_KEY and
209 AV_METADATA_DONT_STRDUP_VAL.
210
211 2009-12-13 - r20829 - lavu 50.7.0 - avstring.h API
212 Add av_d2str().
213
214 2009-12-13 - r20826 - lavc 52.42.0 - AVStream
215 Add avg_frame_rate.
216
217 2009-12-12 - r20808 - lavu 50.6.0 - av_bmg_next()
218 Introduce the av_bmg_next() function.
219
220 2009-12-05 - r20734 - lavfi 1.12.0 - avfilter_draw_slice()
221 Add a slice_dir parameter to avfilter_draw_slice().
222
223 2009-11-26 - r20611 - lavfi 1.11.0 - AVFilter
224 Remove the next field from AVFilter, this is not anymore required.
225
226 2009-11-25 - r20607 - lavfi 1.10.0 - avfilter_next()
227 Introduce the avfilter_next() function.
228
229 2009-11-25 - r20605 - lavfi 1.9.0 - avfilter_register()
230 Change the signature of avfilter_register() to make it return an
231 int. This is required since now the registration operation may fail.
232
233 2009-11-25 - r20603 - lavu 50.5.0 - pixdesc.h API
234 Make the pixdesc.h API public.
235
236 2009-10-27 - r20385 - lavfi 1.5.0 - AVFilter.next
237 Add a next field to AVFilter, this is used for simplifying the
238 registration and management of the registered filters.
239
240 2009-10-23 - r20356 - lavfi 1.4.1 - AVFilter.description
241 Add a description field to AVFilter.
242
243 2009-10-19 - r20302 - lavfi 1.3.0 - avfilter_make_format_list()
244 Change the interface of avfilter_make_format_list() from
245 avfilter_make_format_list(int n, ...) to
246 avfilter_make_format_list(enum PixelFormat *pix_fmts).
247
248 2009-10-18 - r20272 - lavfi 1.0.0 - avfilter_get_video_buffer()
249 Make avfilter_get_video_buffer() recursive and add the w and h
250 parameters to it.
251
252 2009-10-07 - r20189 - lavfi 0.5.1 - AVFilterPic
253 Add w and h fields to AVFilterPic.
254
255 2009-06-22 - r19250 - lavf 52.34.1 - AVFormatContext.packet_size
256 This is now an unsigned int instead of a signed int.
257
258 2009-06-19 - r19222 - lavc 52.32.0 - AVSubtitle.pts
259 Add a pts field to AVSubtitle which gives the subtitle packet pts
260 in AV_TIME_BASE. Some subtitle de-/encoders (e.g. XSUB) will
261 not work right without this.
262
263 2009-06-03 - r19078 - lavc 52.30.2 - AV_PKT_FLAG_KEY
264 PKT_FLAG_KEY has been deprecated and will be dropped at the next
265 major version. Use AV_PKT_FLAG_KEY instead.
266
267 2009-06-01 - r19025 - lavc 52.30.0 - av_lockmgr_register()
268 av_lockmgr_register() can be used to register a callback function
269 that lavc (and in the future, libraries that depend on lavc) can use
270 to implement mutexes. The application should provide a callback function
271 that implements the AV_LOCK_* operations described in avcodec.h.
272 When the lock manager is registered, FFmpeg is guaranteed to behave
273 correctly in a multi-threaded application.
274
275 2009-04-30 - r18719 - lavc 52.28.0 - av_free_packet()
276 av_free_packet() is no longer an inline function. It is now exported.
277
278 2009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree()
279 Please use NULL instead. This has been supported since r16506
280 (lavf > 52.23.1, lavc > 52.10.0).
281
282 2009-04-07 - r18351 - lavc 52.23.0 - avcodec_decode_video/audio/subtitle
283 The old decoding functions are deprecated, all new code should use the
284 new functions avcodec_decode_video2(), avcodec_decode_audio3() and
285 avcodec_decode_subtitle2(). These new functions take an AVPacket *pkt
286 argument instead of a const uint8_t *buf / int buf_size pair.
287
288 2009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space()
289 Introduce the av_fifo_space() function.
290
291 2009-04-02 - r18317 - lavc 52.23.0 - AVPacket
292 Move AVPacket declaration from libavformat/avformat.h to
293 libavcodec/avcodec.h.
294
295 2009-03-22 - r18163 - lavu 50.2.0 - RGB32 pixel formats
296 Convert the pixel formats PIX_FMT_ARGB, PIX_FMT_RGBA, PIX_FMT_ABGR,
297 PIX_FMT_BGRA, which were defined as macros, into enum PixelFormat values.
298 Conversely PIX_FMT_RGB32, PIX_FMT_RGB32_1, PIX_FMT_BGR32 and
299 PIX_FMT_BGR32_1 are now macros.
300 avcodec_get_pix_fmt() now recognizes the "rgb32" and "bgr32" aliases.
301 Re-sort the enum PixelFormat list accordingly.
302 This change breaks API/ABI backward compatibility.
303
304 2009-03-22 - r18133 - lavu 50.1.0 - PIX_FMT_RGB5X5 endian variants
305 Add the enum PixelFormat values:
306 PIX_FMT_RGB565BE, PIX_FMT_RGB565LE, PIX_FMT_RGB555BE, PIX_FMT_RGB555LE,
307 PIX_FMT_BGR565BE, PIX_FMT_BGR565LE, PIX_FMT_BGR555BE, PIX_FMT_BGR555LE.
308
309 2009-03-21 - r18116 - lavu 50.0.0 - av_random*
310 The Mersenne Twister PRNG implemented through the av_random* functions
311 was removed. Use the lagged Fibonacci PRNG through the av_lfg* functions
312 instead.
313
314 2009-03-08 - r17869 - lavu 50.0.0 - AVFifoBuffer
315 av_fifo_init, av_fifo_read, av_fifo_write and av_fifo_realloc were dropped
316 and replaced by av_fifo_alloc, av_fifo_generic_read, av_fifo_generic_write
317 and av_fifo_realloc2.
318 In addition, the order of the function arguments of av_fifo_generic_read
319 was changed to match av_fifo_generic_write.
320 The AVFifoBuffer/struct AVFifoBuffer may only be used in an opaque way by
321 applications, they may not use sizeof() or directly access members.
322
323 2009-03-01 - r17682 - lavf 52.31.0 - Generic metadata API
324 Introduce a new metadata API (see av_metadata_get() and friends).
325 The old API is now deprecated and should not be used anymore. This especially
326 includes the following structure fields:
327 - AVFormatContext.title
328 - AVFormatContext.author
329 - AVFormatContext.copyright
330 - AVFormatContext.comment
331 - AVFormatContext.album
332 - AVFormatContext.year
333 - AVFormatContext.track
334 - AVFormatContext.genre
335 - AVStream.language
336 - AVStream.filename
337 - AVProgram.provider_name
338 - AVProgram.name
339 - AVChapter.title