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