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