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