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