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