Add an entry for the AVFilterBuffer change of r24592.
[libav.git] / doc / APIchanges
CommitLineData
06d19718
RD
1Never assume the API of libav* to be stable unless at least 1 week has passed since
2the last major version increase.
3The last version increases were:
4libavcodec: ?
a33e0365 5libavcore: 2010-07-21
06d19718 6libavdevice: ?
c3b27a3d 7libavfilter: 2009-10-18
06d19718
RD
8libavformat: ?
9libpostproc: ?
10libswscale: ?
11libavutil: 2009-03-08
12
13
14API changes, most recent first:
15
92dd4959
SS
162010-07-30 - r24592 - lavfi 1.27.0 - AVFilterBuffer
17 Increase size of the arrays AVFilterBuffer.data and
18 AVFilterBuffer.linesize from 4 to 8.
19
20 This change breaks libavfilter ABI.
21
3dec10cd
SS
222010-07-29 - r24583 - lavcore 0.2.0 - imgutils.h
23 Add functions av_fill_image_linesizes() and
24 av_fill_image_pointers(), declared in libavcore/imgutils.h.
25
fa8ead00
SS
262010-07-27 - r24518 - lavcore 0.1.0 - parseutils.h
27 Deprecate av_parse_video_frame_size() and av_parse_video_frame_rate()
28 defined in libavcodec in favor of the newly added functions
29 av_parse_video_size() and av_parse_video_rate() declared in
30 libavcore/parseutils.h.
31
c257c752
SS
322010-07-23 - r24439 - lavu 50.23.0 - mathematics.h
33 Add the M_PHI constant definition.
34
73642926
SS
352010-07-22 - r24424 - lavfi 1.26.0 - media format generalization
36 Add a type field to AVFilterLink.
37
38 Change the field types:
39 enum PixelFormat format -> int format in AVFilterBuffer
40 enum PixelFormat *formats -> int *formats in AVFilterFormats
41 enum PixelFormat *format -> int format in AVFilterLink
42
43 Change the function signatures:
44 AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts); ->
45 AVFilterFormats *avfilter_make_format_list(const int *fmts);
46
47 int avfilter_add_colorspace(AVFilterFormats **avff, enum PixelFormat pix_fmt); ->
48 int avfilter_add_format (AVFilterFormats **avff, int fmt);
49
50 AVFilterFormats *avfilter_all_colorspaces(void); ->
51 AVFilterFormats *avfilter_all_formats (enum AVMediaType type);
52
53 This change breaks libavfilter API/ABI.
54
a33e0365
SS
552010-07-21 - r24393 - lavcore 0.0.0
56 Add libavcore.
57
8e9d9308
SS
582010-07-17 - r24291 - lavfi 1.25.0 - AVFilterBuffer
59 Remove w and h fields from AVFilterBuffer.
60
9840147d
SS
612010-07-17 - r24284 - lavfi 1.24.0 - AVFilterBuffer
62 Rename AVFilterPic to AVFilterBuffer.
63
57fe80fe
MS
642010-07-17 - r24278 - lavf 52.74.0 - url_fskip()
65 Make url_fskip() return an int error code instead of void.
66
37497979 672010-07-11 - r24199 - lavc 52.83.0
6f5ac9c1 68 Add AVCodecContext.lpc_type and AVCodecContext.lpc_passes fields.
23940f14
JR
69 Add AVLPCType enum.
70 Deprecate AVCodecContext.use_lpc.
71
e1d7c883
RD
722010-07-11 - r24185 - lavc 52.82.0 - avsubtitle_free()
73 Add a function for free the contents of a AVSubtitle generated by
74 avcodec_decode_subtitle.
75
617d56ca
SS
762010-07-11 - r24174 - lavu 50.22.0 - bswap.h and intreadwrite.h
77 Make the bswap.h and intreadwrite.h API public.
78
52706b95
SS
792010-07-08 - r24101 - lavu 50.21.0 - pixdesc.h
80 Rename read/write_line() to av_read/write_image_line().
81
822010-07-07 - r24091 - lavfi 1.21.0 - avfilter_copy_picref_props()
16400da6 83 Add avfilter_copy_picref_props().
52706b95 84
34171e87 852010-07-03 - r24021 - lavc 52.79.0
16400da6
SS
86 Add FF_COMPLIANCE_UNOFFICIAL and change all instances of
87 FF_COMPLIANCE_INOFFICIAL to use FF_COMPLIANCE_UNOFFICIAL.
34171e87 88
13088d27
RP
892010-07-02 - r23985 - lavu 50.20.0 - lfg.h
90 Export av_lfg_init(), av_lfg_get(), av_mlfg_get(), and av_bmg_get() through
91 lfg.h.
92
6951515c
SS
932010-06-28 - r23835 - lavfi 1.20.1 - av_parse_color()
94 Extend av_parse_color() syntax, make it accept an alpha value specifier and
95 set the alpha value to 255 by default.
96
58cc11c7 972010-06-22 - r23706 - lavf 52.71.0 - URLProtocol.priv_data_size, priv_data_class
16400da6 98 Add priv_data_size and priv_data_class to URLProtocol.
58cc11c7 99
4636f115 1002010-06-22 - r23704 - lavf 52.70.0 - url_alloc(), url_connect()
16400da6 101 Add url_alloc() and url_connect().
4636f115 102
16400da6
SS
1032010-06-22 - r23702 - lavf 52.69.0 - av_register_protocol2()
104 Add av_register_protocol2(), deprecating av_register_protocol().
6c4cbc8d 105
276b45af
SS
1062010-06-09 - r23551 - lavu 50.19.0 - av_compare_mod()
107 Add av_compare_mod() to libavutil/mathematics.h.
108
4cd5100c
SS
1092010-06-05 - r23485 - lavu 50.18.0 - eval API
110 Make the eval API public.
111
6532c6f9
SS
1122010-06-04 - r23461 - lavu 50.17.0 - AV_BASE64_SIZE
113 Add AV_BASE64_SIZE() macro.
114
16400da6 1152010-06-02 - r23421 - lavc 52.73.0 - av_get_codec_tag_string()
2a00992f
SS
116 Add av_get_codec_tag_string().
117
7f464a0a 1182010-06-01 - r31301 - lsws 0.11.0 - convertPalette API
16400da6 119 Add sws_convertPalette8ToPacked32() and sws_convertPalette8ToPacked24().
7f464a0a 120
fe9c2007
SS
1212010-05-26 - r23334 - lavc 52.72.0 - CODEC_CAP_EXPERIMENTAL
122 Add CODEC_CAP_EXPERIMENTAL flag.
123
16400da6
SS
1242010-05-23 - r23255 - lavu 50.16.0 - av_get_random_seed()
125 Add av_get_random_seed().
cca68a54 126
b724102a 1272010-05-18 - r23161 - lavf 52.63.0 - AVFMT_FLAG_RTP_HINT
16400da6 128 Add AVFMT_FLAG_RTP_HINT as possible value for AVFormatContext.flags.
b724102a 129
fc25c049
SS
1302010-05-09 - r23066 - lavfi 1.20.0 - AVFilterPicRef
131 Add interlaced and top_field_first fields to AVFilterPicRef.
132
d0eb2b78
RD
1332010-05-01 - r23002 - lavf 52.62.0 - probe function
134 Add av_probe_input_format2 to API, it allows ignoring probe
135 results below given score and returns the actual probe score.
136
2100348c 1372010-04-01 - r22806 - lavf 52.61.0 - metadata API
3dd6180f
AK
138 Add a flag for av_metadata_set2() to disable overwriting of
139 existing tags.
140
0fb49b59 1412010-04-01 - r22753 - lavc 52.66.0
16400da6 142 Add avcodec_get_edge_width().
0fb49b59 143
c846a984
RB
1442010-03-31 - r22750 - lavc 52.65.0
145 Add avcodec_copy_context().
146
e33f1fa0
SS
1472010-03-31 - r22748 - lavf 52.60.0 - av_match_ext()
148 Make av_match_ext() public.
149
fc8b1075
SS
1502010-03-31 - r22736 - lavu 50.14.0 - AVMediaType
151 Move AVMediaType enum from libavcodec to libavutil.
152
1532010-03-31 - r22735 - lavc 52.64.0 - AVMediaType
154 Define AVMediaType enum, and use it instead of enum CodecType, which
155 is deprecated and will be dropped at the next major bump.
156
82ba847e
SS
1572010-03-25 - r22684 - lavu 50.13.0 - av_strerror()
158 Implement av_strerror().
159
69087742 1602010-03-23 - r22649 - lavc 52.60.0 - av_dct_init()
16400da6 161 Support DCT-I and DST-I.
e1484ebe 162
a5b3d34b
MS
1632010-03-15 - r22540 - lavf 52.56.0 - AVFormatContext.start_time_realtime
164 Add AVFormatContext.start_time_realtime field.
165
8955a324
SS
1662010-03-13 - r22506 - lavfi 1.18.0 - AVFilterPicRef.pos
167 Add AVFilterPicRef.pos field.
168
99de2b59
SS
1692010-03-13 - r22501 - lavu 50.12.0 - error.h
170 Move error code definitions from libavcodec/avcodec.h to
171 the new public header libavutil/error.h.
172
c7094831
MR
1732010-03-07 - r22291 - lavc 52.56.0 - avfft.h
174 Add public FFT interface.
175
c18fb631
SS
1762010-03-06 - r22251 - lavu 50.11.0 - av_stristr()
177 Add av_stristr().
178
4b83fc0f
VS
1792010-03-03 - r22174 - lavu 50.10.0 - av_tree_enumerate()
180 Add av_tree_enumerate().
181
fbef7a76
SS
1822010-02-07 - r21673 - lavu 50.9.0 - av_compare_ts()
183 Add av_compare_ts().
184
e49407ee
SS
1852010-02-05 - r30513 - lsws 0.10.0 - sws_getCoefficients()
186 Add sws_getCoefficients().
187
ca76a119
AK
1882010-02-01 - r21587 - lavf 52.50.0 - metadata API
189 Add a list of generic tag names, change 'author' -> 'artist',
190 'year' -> 'date'.
191
14ace37e
SS
1922010-01-30 - r21545 - lavu 50.8.0 - av_get_pix_fmt()
193 Add av_get_pix_fmt().
194
16400da6 1952010-01-21 - r30381 - lsws 0.9.0 - sws_scale()
e49407ee
SS
196 Change constness attributes of sws_scale() parameters.
197
2d187e23
SS
1982010-01-10 - r21121 - lavfi 1.15.0 - avfilter_graph_config_links()
199 Add a log_ctx parameter to avfilter_graph_config_links().
200
16400da6 2012010-01-07 - r30236 - lsws 0.8.0 - sws_isSupported{In,Out}put()
1c790092 202 Add sws_isSupportedInput() and sws_isSupportedOutput() functions.
715cff9a 203
1e289b09
SS
2042010-01-06 - r21035 - lavfi 1.14.0 - avfilter_add_colorspace()
205 Change the avfilter_add_colorspace() signature, make it accept an
206 (AVFilterFormats **) rather than an (AVFilterFormats *) as before.
207
a2b16627
SS
2082010-01-03 - r21007 - lavfi 1.13.0 - avfilter_add_colorspace()
209 Add avfilter_add_colorspace().
210
79c2f2d3
SS
2112010-01-02 - r20998 - lavf 52.46.0 - av_match_ext()
212 Add av_match_ext(), it should be used in place of match_ext().
213
bb1a8793
SS
2142010-01-01 - r20991 - lavf 52.45.0 - av_guess_format()
215 Add av_guess_format(), it should be used in place of guess_format().
216
b8f11ec8 2172009-12-13 - r20834 - lavf 52.43.0 - metadata API
16400da6
SS
218 Add av_metadata_set2(), AV_METADATA_DONT_STRDUP_KEY and
219 AV_METADATA_DONT_STRDUP_VAL.
b8f11ec8 220
60a92a77 2212009-12-13 - r20829 - lavu 50.7.0 - avstring.h API
f69d394f 222 Add av_d2str().
60a92a77 223
c3d15329 2242009-12-13 - r20826 - lavc 52.42.0 - AVStream
f69d394f 225 Add avg_frame_rate.
c3d15329 226
54c24216
SS
2272009-12-12 - r20808 - lavu 50.6.0 - av_bmg_next()
228 Introduce the av_bmg_next() function.
229
11f6d098
SS
2302009-12-05 - r20734 - lavfi 1.12.0 - avfilter_draw_slice()
231 Add a slice_dir parameter to avfilter_draw_slice().
232
7cab9a66
SS
2332009-11-26 - r20611 - lavfi 1.11.0 - AVFilter
234 Remove the next field from AVFilter, this is not anymore required.
235
b5a683eb
SS
2362009-11-25 - r20607 - lavfi 1.10.0 - avfilter_next()
237 Introduce the avfilter_next() function.
238
73e2247d
SS
2392009-11-25 - r20605 - lavfi 1.9.0 - avfilter_register()
240 Change the signature of avfilter_register() to make it return an
241 int. This is required since now the registration operation may fail.
242
d0df2fcc
SS
2432009-11-25 - r20603 - lavu 50.5.0 - pixdesc.h API
244 Make the pixdesc.h API public.
245
290d4a44
SS
2462009-10-27 - r20385 - lavfi 1.5.0 - AVFilter.next
247 Add a next field to AVFilter, this is used for simplifying the
248 registration and management of the registered filters.
249
54116673
SS
2502009-10-23 - r20356 - lavfi 1.4.1 - AVFilter.description
251 Add a description field to AVFilter.
01537e9f 252
027e85d8
SS
2532009-10-19 - r20302 - lavfi 1.3.0 - avfilter_make_format_list()
254 Change the interface of avfilter_make_format_list() from
255 avfilter_make_format_list(int n, ...) to
256 avfilter_make_format_list(enum PixelFormat *pix_fmts).
257
c3b27a3d
SS
2582009-10-18 - r20272 - lavfi 1.0.0 - avfilter_get_video_buffer()
259 Make avfilter_get_video_buffer() recursive and add the w and h
260 parameters to it.
261
04670366 2622009-10-07 - r20189 - lavfi 0.5.1 - AVFilterPic
227d1b98 263 Add w and h fields to AVFilterPic.
04670366 264
b394438e
RB
2652009-06-22 - r19250 - lavf 52.34.1 - AVFormatContext.packet_size
266 This is now an unsigned int instead of a signed int.
267
4bbe788a 2682009-06-19 - r19222 - lavc 52.32.0 - AVSubtitle.pts
227d1b98
DB
269 Add a pts field to AVSubtitle which gives the subtitle packet pts
270 in AV_TIME_BASE. Some subtitle de-/encoders (e.g. XSUB) will
4bbe788a
RD
271 not work right without this.
272
8f3f2e06 2732009-06-03 - r19078 - lavc 52.30.2 - AV_PKT_FLAG_KEY
227d1b98 274 PKT_FLAG_KEY has been deprecated and will be dropped at the next
8f3f2e06
RD
275 major version. Use AV_PKT_FLAG_KEY instead.
276
f988ce6c
2772009-06-01 - r19025 - lavc 52.30.0 - av_lockmgr_register()
278 av_lockmgr_register() can be used to register a callback function
279 that lavc (and in the future, libraries that depend on lavc) can use
280 to implement mutexes. The application should provide a callback function
227d1b98
DB
281 that implements the AV_LOCK_* operations described in avcodec.h.
282 When the lock manager is registered, FFmpeg is guaranteed to behave
283 correctly in a multi-threaded application.
f988ce6c 284
16400da6 2852009-04-30 - r18719 - lavc 52.28.0 - av_free_packet()
52bcc8e1
RP
286 av_free_packet() is no longer an inline function. It is now exported.
287
16400da6 2882009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree()
0c13bbf5
RD
289 Please use NULL instead. This has been supported since r16506
290 (lavf > 52.23.1, lavc > 52.10.0).
291
2851d225
RB
2922009-04-07 - r18351 - lavc 52.23.0 - avcodec_decode_video/audio/subtitle
293 The old decoding functions are deprecated, all new code should use the
294 new functions avcodec_decode_video2(), avcodec_decode_audio3() and
295 avcodec_decode_subtitle2(). These new functions take an AVPacket *pkt
296 argument instead of a const uint8_t *buf / int buf_size pair.
297
16400da6 2982009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space()
b1516707
SS
299 Introduce the av_fifo_space() function.
300
dd3bbb49
SS
3012009-04-02 - r18317 - lavc 52.23.0 - AVPacket
302 Move AVPacket declaration from libavformat/avformat.h to
303 libavcodec/avcodec.h.
304
5a43bbc3 3052009-03-22 - r18163 - lavu 50.2.0 - RGB32 pixel formats
227d1b98
DB
306 Convert the pixel formats PIX_FMT_ARGB, PIX_FMT_RGBA, PIX_FMT_ABGR,
307 PIX_FMT_BGRA, which were defined as macros, into enum PixelFormat values.
308 Conversely PIX_FMT_RGB32, PIX_FMT_RGB32_1, PIX_FMT_BGR32 and
309 PIX_FMT_BGR32_1 are now macros.
310 avcodec_get_pix_fmt() now recognizes the "rgb32" and "bgr32" aliases.
f3370e14 311 Re-sort the enum PixelFormat list accordingly.
5a43bbc3
SS
312 This change breaks API/ABI backward compatibility.
313
dd3bbb49
SS
3142009-03-22 - r18133 - lavu 50.1.0 - PIX_FMT_RGB5X5 endian variants
315 Add the enum PixelFormat values:
316 PIX_FMT_RGB565BE, PIX_FMT_RGB565LE, PIX_FMT_RGB555BE, PIX_FMT_RGB555LE,
317 PIX_FMT_BGR565BE, PIX_FMT_BGR565LE, PIX_FMT_BGR555BE, PIX_FMT_BGR555LE.
318
b4656e6b 3192009-03-21 - r18116 - lavu 50.0.0 - av_random*
c8f742ca
DB
320 The Mersenne Twister PRNG implemented through the av_random* functions
321 was removed. Use the lagged Fibonacci PRNG through the av_lfg* functions
322 instead.
323
889cdae8
DB
3242009-03-08 - r17869 - lavu 50.0.0 - AVFifoBuffer
325 av_fifo_init, av_fifo_read, av_fifo_write and av_fifo_realloc were dropped
326 and replaced by av_fifo_alloc, av_fifo_generic_read, av_fifo_generic_write
327 and av_fifo_realloc2.
328 In addition, the order of the function arguments of av_fifo_generic_read
227d1b98 329 was changed to match av_fifo_generic_write.
889cdae8
DB
330 The AVFifoBuffer/struct AVFifoBuffer may only be used in an opaque way by
331 applications, they may not use sizeof() or directly access members.
22d4f236 332
889cdae8
DB
3332009-03-01 - r17682 - lavf 52.31.0 - Generic metadata API
334 Introduce a new metadata API (see av_metadata_get() and friends).
335 The old API is now deprecated and should not be used anymore. This especially
429d6b21 336 includes the following structure fields:
38ce707e
AJ
337 - AVFormatContext.title
338 - AVFormatContext.author
339 - AVFormatContext.copyright
340 - AVFormatContext.comment
341 - AVFormatContext.album
342 - AVFormatContext.year
343 - AVFormatContext.track
344 - AVFormatContext.genre
345 - AVStream.language
346 - AVStream.filename
347 - AVProgram.provider_name
348 - AVProgram.name
349 - AVChapter.title