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