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