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