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