Add an entry for the AVFilterBuffer change of r24592.
[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-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
22 2010-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
26 2010-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
32 2010-07-23 - r24439 - lavu 50.23.0 - mathematics.h
33 Add the M_PHI constant definition.
34
35 2010-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
55 2010-07-21 - r24393 - lavcore 0.0.0
56 Add libavcore.
57
58 2010-07-17 - r24291 - lavfi 1.25.0 - AVFilterBuffer
59 Remove w and h fields from AVFilterBuffer.
60
61 2010-07-17 - r24284 - lavfi 1.24.0 - AVFilterBuffer
62 Rename AVFilterPic to AVFilterBuffer.
63
64 2010-07-17 - r24278 - lavf 52.74.0 - url_fskip()
65 Make url_fskip() return an int error code instead of void.
66
67 2010-07-11 - r24199 - lavc 52.83.0
68 Add AVCodecContext.lpc_type and AVCodecContext.lpc_passes fields.
69 Add AVLPCType enum.
70 Deprecate AVCodecContext.use_lpc.
71
72 2010-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
76 2010-07-11 - r24174 - lavu 50.22.0 - bswap.h and intreadwrite.h
77 Make the bswap.h and intreadwrite.h API public.
78
79 2010-07-08 - r24101 - lavu 50.21.0 - pixdesc.h
80 Rename read/write_line() to av_read/write_image_line().
81
82 2010-07-07 - r24091 - lavfi 1.21.0 - avfilter_copy_picref_props()
83 Add avfilter_copy_picref_props().
84
85 2010-07-03 - r24021 - lavc 52.79.0
86 Add FF_COMPLIANCE_UNOFFICIAL and change all instances of
87 FF_COMPLIANCE_INOFFICIAL to use FF_COMPLIANCE_UNOFFICIAL.
88
89 2010-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
93 2010-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
97 2010-06-22 - r23706 - lavf 52.71.0 - URLProtocol.priv_data_size, priv_data_class
98 Add priv_data_size and priv_data_class to URLProtocol.
99
100 2010-06-22 - r23704 - lavf 52.70.0 - url_alloc(), url_connect()
101 Add url_alloc() and url_connect().
102
103 2010-06-22 - r23702 - lavf 52.69.0 - av_register_protocol2()
104 Add av_register_protocol2(), deprecating av_register_protocol().
105
106 2010-06-09 - r23551 - lavu 50.19.0 - av_compare_mod()
107 Add av_compare_mod() to libavutil/mathematics.h.
108
109 2010-06-05 - r23485 - lavu 50.18.0 - eval API
110 Make the eval API public.
111
112 2010-06-04 - r23461 - lavu 50.17.0 - AV_BASE64_SIZE
113 Add AV_BASE64_SIZE() macro.
114
115 2010-06-02 - r23421 - lavc 52.73.0 - av_get_codec_tag_string()
116 Add av_get_codec_tag_string().
117
118 2010-06-01 - r31301 - lsws 0.11.0 - convertPalette API
119 Add sws_convertPalette8ToPacked32() and sws_convertPalette8ToPacked24().
120
121 2010-05-26 - r23334 - lavc 52.72.0 - CODEC_CAP_EXPERIMENTAL
122 Add CODEC_CAP_EXPERIMENTAL flag.
123
124 2010-05-23 - r23255 - lavu 50.16.0 - av_get_random_seed()
125 Add av_get_random_seed().
126
127 2010-05-18 - r23161 - lavf 52.63.0 - AVFMT_FLAG_RTP_HINT
128 Add AVFMT_FLAG_RTP_HINT as possible value for AVFormatContext.flags.
129
130 2010-05-09 - r23066 - lavfi 1.20.0 - AVFilterPicRef
131 Add interlaced and top_field_first fields to AVFilterPicRef.
132
133 2010-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
137 2010-04-01 - r22806 - lavf 52.61.0 - metadata API
138 Add a flag for av_metadata_set2() to disable overwriting of
139 existing tags.
140
141 2010-04-01 - r22753 - lavc 52.66.0
142 Add avcodec_get_edge_width().
143
144 2010-03-31 - r22750 - lavc 52.65.0
145 Add avcodec_copy_context().
146
147 2010-03-31 - r22748 - lavf 52.60.0 - av_match_ext()
148 Make av_match_ext() public.
149
150 2010-03-31 - r22736 - lavu 50.14.0 - AVMediaType
151 Move AVMediaType enum from libavcodec to libavutil.
152
153 2010-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
157 2010-03-25 - r22684 - lavu 50.13.0 - av_strerror()
158 Implement av_strerror().
159
160 2010-03-23 - r22649 - lavc 52.60.0 - av_dct_init()
161 Support DCT-I and DST-I.
162
163 2010-03-15 - r22540 - lavf 52.56.0 - AVFormatContext.start_time_realtime
164 Add AVFormatContext.start_time_realtime field.
165
166 2010-03-13 - r22506 - lavfi 1.18.0 - AVFilterPicRef.pos
167 Add AVFilterPicRef.pos field.
168
169 2010-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
173 2010-03-07 - r22291 - lavc 52.56.0 - avfft.h
174 Add public FFT interface.
175
176 2010-03-06 - r22251 - lavu 50.11.0 - av_stristr()
177 Add av_stristr().
178
179 2010-03-03 - r22174 - lavu 50.10.0 - av_tree_enumerate()
180 Add av_tree_enumerate().
181
182 2010-02-07 - r21673 - lavu 50.9.0 - av_compare_ts()
183 Add av_compare_ts().
184
185 2010-02-05 - r30513 - lsws 0.10.0 - sws_getCoefficients()
186 Add sws_getCoefficients().
187
188 2010-02-01 - r21587 - lavf 52.50.0 - metadata API
189 Add a list of generic tag names, change 'author' -> 'artist',
190 'year' -> 'date'.
191
192 2010-01-30 - r21545 - lavu 50.8.0 - av_get_pix_fmt()
193 Add av_get_pix_fmt().
194
195 2010-01-21 - r30381 - lsws 0.9.0 - sws_scale()
196 Change constness attributes of sws_scale() parameters.
197
198 2010-01-10 - r21121 - lavfi 1.15.0 - avfilter_graph_config_links()
199 Add a log_ctx parameter to avfilter_graph_config_links().
200
201 2010-01-07 - r30236 - lsws 0.8.0 - sws_isSupported{In,Out}put()
202 Add sws_isSupportedInput() and sws_isSupportedOutput() functions.
203
204 2010-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
208 2010-01-03 - r21007 - lavfi 1.13.0 - avfilter_add_colorspace()
209 Add avfilter_add_colorspace().
210
211 2010-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
214 2010-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
217 2009-12-13 - r20834 - lavf 52.43.0 - metadata API
218 Add av_metadata_set2(), AV_METADATA_DONT_STRDUP_KEY and
219 AV_METADATA_DONT_STRDUP_VAL.
220
221 2009-12-13 - r20829 - lavu 50.7.0 - avstring.h API
222 Add av_d2str().
223
224 2009-12-13 - r20826 - lavc 52.42.0 - AVStream
225 Add avg_frame_rate.
226
227 2009-12-12 - r20808 - lavu 50.6.0 - av_bmg_next()
228 Introduce the av_bmg_next() function.
229
230 2009-12-05 - r20734 - lavfi 1.12.0 - avfilter_draw_slice()
231 Add a slice_dir parameter to avfilter_draw_slice().
232
233 2009-11-26 - r20611 - lavfi 1.11.0 - AVFilter
234 Remove the next field from AVFilter, this is not anymore required.
235
236 2009-11-25 - r20607 - lavfi 1.10.0 - avfilter_next()
237 Introduce the avfilter_next() function.
238
239 2009-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
243 2009-11-25 - r20603 - lavu 50.5.0 - pixdesc.h API
244 Make the pixdesc.h API public.
245
246 2009-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
250 2009-10-23 - r20356 - lavfi 1.4.1 - AVFilter.description
251 Add a description field to AVFilter.
252
253 2009-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
258 2009-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
262 2009-10-07 - r20189 - lavfi 0.5.1 - AVFilterPic
263 Add w and h fields to AVFilterPic.
264
265 2009-06-22 - r19250 - lavf 52.34.1 - AVFormatContext.packet_size
266 This is now an unsigned int instead of a signed int.
267
268 2009-06-19 - r19222 - lavc 52.32.0 - AVSubtitle.pts
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
271 not work right without this.
272
273 2009-06-03 - r19078 - lavc 52.30.2 - AV_PKT_FLAG_KEY
274 PKT_FLAG_KEY has been deprecated and will be dropped at the next
275 major version. Use AV_PKT_FLAG_KEY instead.
276
277 2009-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
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.
284
285 2009-04-30 - r18719 - lavc 52.28.0 - av_free_packet()
286 av_free_packet() is no longer an inline function. It is now exported.
287
288 2009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree()
289 Please use NULL instead. This has been supported since r16506
290 (lavf > 52.23.1, lavc > 52.10.0).
291
292 2009-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
298 2009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space()
299 Introduce the av_fifo_space() function.
300
301 2009-04-02 - r18317 - lavc 52.23.0 - AVPacket
302 Move AVPacket declaration from libavformat/avformat.h to
303 libavcodec/avcodec.h.
304
305 2009-03-22 - r18163 - lavu 50.2.0 - RGB32 pixel formats
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.
311 Re-sort the enum PixelFormat list accordingly.
312 This change breaks API/ABI backward compatibility.
313
314 2009-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
319 2009-03-21 - r18116 - lavu 50.0.0 - av_random*
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
324 2009-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
329 was changed to match av_fifo_generic_write.
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.
332
333 2009-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
336 includes the following structure fields:
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