Add support for encoding XSUB subtitles. Muxing support is still missing.
[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: ?
7 libavformat: ?
8 libpostproc: ?
9 libswscale:  ?
10 libavutil:   2009-03-08
11
12
13 API changes, most recent first:
14
15 2009-06-19 - r19222 - lavc 52.32.0 - AVSubtitle.pts
16   Added a pts field to AVSubtitle which gives the subtitle's packet
17   PTS in AV_TIME_BASE. Some subtitle de-/encoders (e.g. XSUB) will
18   not work right without this.
19
20 2009-06-03 - r19078 - lavc 52.30.2 - AV_PKT_FLAG_KEY
21   PKT_FLAG_KEY has been deprecated and will be dropped for the next
22   major version. Use AV_PKT_FLAG_KEY instead.
23
24 2009-06-01 - r19025 - lavc 52.30.0 - av_lockmgr_register()
25   av_lockmgr_register() can be used to register a callback function
26   that lavc (and in the future, libraries that depend on lavc) can use
27   to implement mutexes. The application should provide a callback function
28   the implements the AV_LOCK_* operations described in avcodec.h.
29   When the lock manager is registered FFmpeg is guaranteed to behave
30   correct also in a multi-threaded application.
31
32 2009-04-30 - r18719 - lavc 52.28.0 - av_free_packet
33   av_free_packet() is no longer an inline function. It is now exported.
34
35 2009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree
36   Please use NULL instead. This has been supported since r16506
37   (lavf > 52.23.1, lavc > 52.10.0).
38
39 2009-04-07 - r18351 - lavc 52.23.0 - avcodec_decode_video/audio/subtitle
40   The old decoding functions are deprecated, all new code should use the
41   new functions avcodec_decode_video2(), avcodec_decode_audio3() and
42   avcodec_decode_subtitle2(). These new functions take an AVPacket *pkt
43   argument instead of a const uint8_t *buf / int buf_size pair.
44
45 2009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space
46   Introduce the av_fifo_space() function.
47
48 2009-04-02 - r18317 - lavc 52.23.0 - AVPacket
49   Move AVPacket declaration from libavformat/avformat.h to
50   libavcodec/avcodec.h.
51
52 2009-03-22 - r18163 - lavu 50.2.0 - RGB32 pixel formats
53   Make the pixel formats: PIX_FMT_ARGB, PIX_FMT_RGBA, PIX_FMT_ABGR,
54   PIX_FMT_BGRA, which were defined as macros, defined as enum
55   PixelFormat values, and viceversa make PIX_FMT_RGB32,
56   PIX_FMT_RGB32_1, PIX_FMT_BGR32, PIX_FMT_BGR32_1 defined as macros.
57   Also make avcodec_get_pix_fmt() recognize the "rgb32" and "bgr32"
58   aliases.
59   Re-sort the enum PixelFormat list accordingly.
60   This change breaks API/ABI backward compatibility.
61
62 2009-03-22 - r18133 - lavu 50.1.0 - PIX_FMT_RGB5X5 endian variants
63   Add the enum PixelFormat values:
64   PIX_FMT_RGB565BE, PIX_FMT_RGB565LE, PIX_FMT_RGB555BE, PIX_FMT_RGB555LE,
65   PIX_FMT_BGR565BE, PIX_FMT_BGR565LE, PIX_FMT_BGR555BE, PIX_FMT_BGR555LE.
66
67 2009-03-21 - r18116 - lavu 50.0.0  - av_random*
68   The Mersenne Twister PRNG implemented through the av_random* functions
69   was removed. Use the lagged Fibonacci PRNG through the av_lfg* functions
70   instead.
71
72 2009-03-08 - r17869 - lavu 50.0.0  - AVFifoBuffer
73   av_fifo_init, av_fifo_read, av_fifo_write and av_fifo_realloc were dropped
74   and replaced by av_fifo_alloc, av_fifo_generic_read, av_fifo_generic_write
75   and av_fifo_realloc2.
76   In addition, the order of the function arguments of av_fifo_generic_read
77   were changed to match av_fifo_generic_write.
78   The AVFifoBuffer/struct AVFifoBuffer may only be used in an opaque way by
79   applications, they may not use sizeof() or directly access members.
80
81 2009-03-01 - r17682 - lavf 52.31.0 - Generic metadata API
82   Introduce a new metadata API (see av_metadata_get() and friends).
83   The old API is now deprecated and should not be used anymore. This especially
84   includes the following structure fields:
85     - AVFormatContext.title
86     - AVFormatContext.author
87     - AVFormatContext.copyright
88     - AVFormatContext.comment
89     - AVFormatContext.album
90     - AVFormatContext.year
91     - AVFormatContext.track
92     - AVFormatContext.genre
93     - AVStream.language
94     - AVStream.filename
95     - AVProgram.provider_name
96     - AVProgram.name
97     - AVChapter.title