Mark URL as such with texinfo markup.
[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 libavdevice: ?
6 libavfilter: 2009-10-18
7 libavformat: ?
8 libpostproc: ?
9 libswscale:  ?
10 libavutil:   2009-03-08
11
12
13 API changes, most recent first:
14
15 2010-07-17 - r24291 - lavfi 1.25.0 - AVFilterBuffer
16   Remove w and h fields from AVFilterBuffer.
17
18 2010-07-17 - r24284 - lavfi 1.24.0 - AVFilterBuffer
19   Rename AVFilterPic to AVFilterBuffer.
20
21 2010-07-17 - r24278 - lavf 52.74.0 - url_fskip()
22   Make url_fskip() return an int error code instead of void.
23
24 2010-07-11 - r24199 - lavc 52.83.0
25   Add AVCodecContext.lpc_type and AVCodecContext.lpc_passes fields.
26   Add AVLPCType enum.
27   Deprecate AVCodecContext.use_lpc.
28
29 2010-07-11 - r24185 - lavc 52.82.0 - avsubtitle_free()
30   Add a function for free the contents of a AVSubtitle generated by
31   avcodec_decode_subtitle.
32
33 2010-07-11 - r24174 - lavu 50.22.0 - bswap.h and intreadwrite.h
34   Make the bswap.h and intreadwrite.h API public.
35
36 2010-07-08 - r24101 - lavu 50.21.0 - pixdesc.h
37   Rename read/write_line() to av_read/write_image_line().
38
39 2010-07-07 - r24091 - lavfi 1.21.0 - avfilter_copy_picref_props()
40   Add avfilter_copy_picref_props().
41
42 2010-07-03 - r24021 - lavc 52.79.0
43   Add FF_COMPLIANCE_UNOFFICIAL and change all instances of
44   FF_COMPLIANCE_INOFFICIAL to use FF_COMPLIANCE_UNOFFICIAL.
45
46 2010-07-02 - r23985 - lavu 50.20.0 - lfg.h
47   Export av_lfg_init(), av_lfg_get(), av_mlfg_get(), and av_bmg_get() through
48   lfg.h.
49
50 2010-06-28 - r23835 - lavfi 1.20.1 - av_parse_color()
51   Extend av_parse_color() syntax, make it accept an alpha value specifier and
52   set the alpha value to 255 by default.
53
54 2010-06-22 - r23706 - lavf 52.71.0 - URLProtocol.priv_data_size, priv_data_class
55   Add priv_data_size and priv_data_class to URLProtocol.
56
57 2010-06-22 - r23704 - lavf 52.70.0 - url_alloc(), url_connect()
58   Add url_alloc() and url_connect().
59
60 2010-06-22 - r23702 - lavf 52.69.0 - av_register_protocol2()
61   Add av_register_protocol2(), deprecating av_register_protocol().
62
63 2010-06-09 - r23551 - lavu 50.19.0 - av_compare_mod()
64   Add av_compare_mod() to libavutil/mathematics.h.
65
66 2010-06-05 - r23485 - lavu 50.18.0 - eval API
67   Make the eval API public.
68
69 2010-06-04 - r23461 - lavu 50.17.0 - AV_BASE64_SIZE
70   Add AV_BASE64_SIZE() macro.
71
72 2010-06-02 - r23421 - lavc 52.73.0 - av_get_codec_tag_string()
73   Add av_get_codec_tag_string().
74
75 2010-06-01 - r31301 - lsws 0.11.0 - convertPalette API
76   Add sws_convertPalette8ToPacked32() and sws_convertPalette8ToPacked24().
77
78 2010-05-26 - r23334 - lavc 52.72.0 - CODEC_CAP_EXPERIMENTAL
79   Add CODEC_CAP_EXPERIMENTAL flag.
80
81 2010-05-23 - r23255 - lavu 50.16.0 - av_get_random_seed()
82   Add av_get_random_seed().
83
84 2010-05-18 - r23161 - lavf 52.63.0 - AVFMT_FLAG_RTP_HINT
85   Add AVFMT_FLAG_RTP_HINT as possible value for AVFormatContext.flags.
86
87 2010-05-09 - r23066 - lavfi 1.20.0 - AVFilterPicRef
88   Add interlaced and top_field_first fields to AVFilterPicRef.
89
90 2010-05-01 - r23002 - lavf 52.62.0 - probe function
91   Add av_probe_input_format2 to API, it allows ignoring probe
92   results below given score and returns the actual probe score.
93
94 2010-04-01 - r22806 - lavf 52.61.0 - metadata API
95   Add a flag for av_metadata_set2() to disable overwriting of
96   existing tags.
97
98 2010-04-01 - r22753 - lavc 52.66.0
99   Add avcodec_get_edge_width().
100
101 2010-03-31 - r22750 - lavc 52.65.0
102   Add avcodec_copy_context().
103
104 2010-03-31 - r22748 - lavf 52.60.0 - av_match_ext()
105   Make av_match_ext() public.
106
107 2010-03-31 - r22736 - lavu 50.14.0 - AVMediaType
108   Move AVMediaType enum from libavcodec to libavutil.
109
110 2010-03-31 - r22735 - lavc 52.64.0 - AVMediaType
111   Define AVMediaType enum, and use it instead of enum CodecType, which
112   is deprecated and will be dropped at the next major bump.
113
114 2010-03-25 - r22684 - lavu 50.13.0 - av_strerror()
115   Implement av_strerror().
116
117 2010-03-23 - r22649 - lavc 52.60.0 - av_dct_init()
118   Support DCT-I and DST-I.
119
120 2010-03-15 - r22540 - lavf 52.56.0 - AVFormatContext.start_time_realtime
121   Add AVFormatContext.start_time_realtime field.
122
123 2010-03-13 - r22506 - lavfi 1.18.0 - AVFilterPicRef.pos
124   Add AVFilterPicRef.pos field.
125
126 2010-03-13 - r22501 - lavu 50.12.0 - error.h
127   Move error code definitions from libavcodec/avcodec.h to
128   the new public header libavutil/error.h.
129
130 2010-03-07 - r22291 - lavc 52.56.0 - avfft.h
131   Add public FFT interface.
132
133 2010-03-06 - r22251 - lavu 50.11.0 - av_stristr()
134   Add av_stristr().
135
136 2010-03-03 - r22174 - lavu 50.10.0 - av_tree_enumerate()
137   Add av_tree_enumerate().
138
139 2010-02-07 - r21673 - lavu 50.9.0 - av_compare_ts()
140   Add av_compare_ts().
141
142 2010-02-05 - r30513 - lsws 0.10.0 - sws_getCoefficients()
143   Add sws_getCoefficients().
144
145 2010-02-01 - r21587 - lavf 52.50.0 - metadata API
146   Add a list of generic tag names, change 'author' -> 'artist',
147   'year' -> 'date'.
148
149 2010-01-30 - r21545 - lavu 50.8.0 - av_get_pix_fmt()
150   Add av_get_pix_fmt().
151
152 2010-01-21 - r30381 - lsws 0.9.0 - sws_scale()
153   Change constness attributes of sws_scale() parameters.
154
155 2010-01-10 - r21121 - lavfi 1.15.0 - avfilter_graph_config_links()
156   Add a log_ctx parameter to avfilter_graph_config_links().
157
158 2010-01-07 - r30236 - lsws 0.8.0 - sws_isSupported{In,Out}put()
159   Add sws_isSupportedInput() and sws_isSupportedOutput() functions.
160
161 2010-01-06 - r21035 - lavfi 1.14.0 - avfilter_add_colorspace()
162   Change the avfilter_add_colorspace() signature, make it accept an
163   (AVFilterFormats **) rather than an (AVFilterFormats *) as before.
164
165 2010-01-03 - r21007 - lavfi 1.13.0 - avfilter_add_colorspace()
166   Add avfilter_add_colorspace().
167
168 2010-01-02 - r20998 - lavf 52.46.0 - av_match_ext()
169   Add av_match_ext(), it should be used in place of match_ext().
170
171 2010-01-01 - r20991 - lavf 52.45.0 - av_guess_format()
172   Add av_guess_format(), it should be used in place of guess_format().
173
174 2009-12-13 - r20834 - lavf 52.43.0 - metadata API
175   Add av_metadata_set2(), AV_METADATA_DONT_STRDUP_KEY and
176   AV_METADATA_DONT_STRDUP_VAL.
177
178 2009-12-13 - r20829 - lavu 50.7.0 - avstring.h API
179   Add av_d2str().
180
181 2009-12-13 - r20826 - lavc 52.42.0 - AVStream
182   Add avg_frame_rate.
183
184 2009-12-12 - r20808 - lavu 50.6.0 - av_bmg_next()
185   Introduce the av_bmg_next() function.
186
187 2009-12-05 - r20734 - lavfi 1.12.0 - avfilter_draw_slice()
188   Add a slice_dir parameter to avfilter_draw_slice().
189
190 2009-11-26 - r20611 - lavfi 1.11.0 - AVFilter
191   Remove the next field from AVFilter, this is not anymore required.
192
193 2009-11-25 - r20607 - lavfi 1.10.0 - avfilter_next()
194   Introduce the avfilter_next() function.
195
196 2009-11-25 - r20605 - lavfi 1.9.0 - avfilter_register()
197   Change the signature of avfilter_register() to make it return an
198   int. This is required since now the registration operation may fail.
199
200 2009-11-25 - r20603 - lavu 50.5.0 - pixdesc.h API
201   Make the pixdesc.h API public.
202
203 2009-10-27 - r20385 - lavfi 1.5.0 - AVFilter.next
204   Add a next field to AVFilter, this is used for simplifying the
205   registration and management of the registered filters.
206
207 2009-10-23 - r20356 - lavfi 1.4.1 - AVFilter.description
208   Add a description field to AVFilter.
209
210 2009-10-19 - r20302 - lavfi 1.3.0 - avfilter_make_format_list()
211   Change the interface of avfilter_make_format_list() from
212   avfilter_make_format_list(int n, ...) to
213   avfilter_make_format_list(enum PixelFormat *pix_fmts).
214
215 2009-10-18 - r20272 - lavfi 1.0.0 - avfilter_get_video_buffer()
216   Make avfilter_get_video_buffer() recursive and add the w and h
217   parameters to it.
218
219 2009-10-07 - r20189 - lavfi 0.5.1 - AVFilterPic
220   Add w and h fields to AVFilterPic.
221
222 2009-06-22 - r19250 - lavf 52.34.1 - AVFormatContext.packet_size
223   This is now an unsigned int instead of a signed int.
224
225 2009-06-19 - r19222 - lavc 52.32.0 - AVSubtitle.pts
226   Add a pts field to AVSubtitle which gives the subtitle packet pts
227   in AV_TIME_BASE. Some subtitle de-/encoders (e.g. XSUB) will
228   not work right without this.
229
230 2009-06-03 - r19078 - lavc 52.30.2 - AV_PKT_FLAG_KEY
231   PKT_FLAG_KEY has been deprecated and will be dropped at the next
232   major version. Use AV_PKT_FLAG_KEY instead.
233
234 2009-06-01 - r19025 - lavc 52.30.0 - av_lockmgr_register()
235   av_lockmgr_register() can be used to register a callback function
236   that lavc (and in the future, libraries that depend on lavc) can use
237   to implement mutexes. The application should provide a callback function
238   that implements the AV_LOCK_* operations described in avcodec.h.
239   When the lock manager is registered, FFmpeg is guaranteed to behave
240   correctly in a multi-threaded application.
241
242 2009-04-30 - r18719 - lavc 52.28.0 - av_free_packet()
243   av_free_packet() is no longer an inline function. It is now exported.
244
245 2009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree()
246   Please use NULL instead. This has been supported since r16506
247   (lavf > 52.23.1, lavc > 52.10.0).
248
249 2009-04-07 - r18351 - lavc 52.23.0 - avcodec_decode_video/audio/subtitle
250   The old decoding functions are deprecated, all new code should use the
251   new functions avcodec_decode_video2(), avcodec_decode_audio3() and
252   avcodec_decode_subtitle2(). These new functions take an AVPacket *pkt
253   argument instead of a const uint8_t *buf / int buf_size pair.
254
255 2009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space()
256   Introduce the av_fifo_space() function.
257
258 2009-04-02 - r18317 - lavc 52.23.0 - AVPacket
259   Move AVPacket declaration from libavformat/avformat.h to
260   libavcodec/avcodec.h.
261
262 2009-03-22 - r18163 - lavu 50.2.0 - RGB32 pixel formats
263   Convert the pixel formats PIX_FMT_ARGB, PIX_FMT_RGBA, PIX_FMT_ABGR,
264   PIX_FMT_BGRA, which were defined as macros, into enum PixelFormat values.
265   Conversely PIX_FMT_RGB32, PIX_FMT_RGB32_1, PIX_FMT_BGR32 and
266   PIX_FMT_BGR32_1 are now macros.
267   avcodec_get_pix_fmt() now recognizes the "rgb32" and "bgr32" aliases.
268   Re-sort the enum PixelFormat list accordingly.
269   This change breaks API/ABI backward compatibility.
270
271 2009-03-22 - r18133 - lavu 50.1.0 - PIX_FMT_RGB5X5 endian variants
272   Add the enum PixelFormat values:
273   PIX_FMT_RGB565BE, PIX_FMT_RGB565LE, PIX_FMT_RGB555BE, PIX_FMT_RGB555LE,
274   PIX_FMT_BGR565BE, PIX_FMT_BGR565LE, PIX_FMT_BGR555BE, PIX_FMT_BGR555LE.
275
276 2009-03-21 - r18116 - lavu 50.0.0  - av_random*
277   The Mersenne Twister PRNG implemented through the av_random* functions
278   was removed. Use the lagged Fibonacci PRNG through the av_lfg* functions
279   instead.
280
281 2009-03-08 - r17869 - lavu 50.0.0  - AVFifoBuffer
282   av_fifo_init, av_fifo_read, av_fifo_write and av_fifo_realloc were dropped
283   and replaced by av_fifo_alloc, av_fifo_generic_read, av_fifo_generic_write
284   and av_fifo_realloc2.
285   In addition, the order of the function arguments of av_fifo_generic_read
286   was changed to match av_fifo_generic_write.
287   The AVFifoBuffer/struct AVFifoBuffer may only be used in an opaque way by
288   applications, they may not use sizeof() or directly access members.
289
290 2009-03-01 - r17682 - lavf 52.31.0 - Generic metadata API
291   Introduce a new metadata API (see av_metadata_get() and friends).
292   The old API is now deprecated and should not be used anymore. This especially
293   includes the following structure fields:
294     - AVFormatContext.title
295     - AVFormatContext.author
296     - AVFormatContext.copyright
297     - AVFormatContext.comment
298     - AVFormatContext.album
299     - AVFormatContext.year
300     - AVFormatContext.track
301     - AVFormatContext.genre
302     - AVStream.language
303     - AVStream.filename
304     - AVProgram.provider_name
305     - AVProgram.name
306     - AVChapter.title