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