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