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