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