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