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