Deprecate avcodec_pix_fmt_string() in favor of
[ffmpeg.git] / doc / APIchanges
index a25279b..a3b587e 100644 (file)
@@ -2,6 +2,7 @@ Never assume the API of libav* to be stable unless at least 1 week has passed si
 the last major version increase.
 The last version increases were:
 libavcodec:  ?
+libavcore:   2010-07-21
 libavdevice: ?
 libavfilter: 2009-10-18
 libavformat: ?
@@ -11,9 +12,310 @@ libavutil:   2009-03-08
 
 
 API changes, most recent first:
+2010-12-04 - r25879 - lavu 50.34.0 - av_get_pix_fmt_string()
+  Deprecate avcodec_pix_fmt_string() in favor of
+  pixdesc.h/av_get_pix_fmt_string().
+
+2010-12-04 - r25878 - lavcore 1.15.0 - av_image_alloc()
+  Add av_image_alloc() to libavcore/imgutils.h.
+
+2010-12-02 - r25862 - lavfi 1.67.0 - avfilter_graph_create_filter()
+  Add function avfilter_graph_create_filter() in avfiltergraph.h.
+
+2010-11-25 - r25826 - lavfi 1.65.0 - avfilter_get_video_buffer_ref_from_arrays()
+  Add function avfilter_get_video_buffer_ref_from_arrays() in
+  avfilter.h.
+
+2010-11-21 - r25787 - lavcore 0.14.0 - audioconvert.h
+  Add a public audio channel API in audioconvert.h, and deprecate the
+  corresponding functions in libavcodec:
+  avcodec_get_channel_name()
+  avcodec_get_channel_layout()
+  avcodec_get_channel_layout_string()
+  avcodec_channel_layout_num_channels()
+  and the CH_* macros defined in libavcodec/avcodec.h.
+
+2010-11-21 - r25777 - lavf 52.85.0 - avformat.h
+  Add av_append_packet().
+
+2010-11-21 - r25776 - lavc 52.97.0 - avcodec.h
+  Add av_grow_packet().
+
+2010-11-17 - r25761 - lavcore 0.13.0 - parseutils.h
+  Add av_parse_color() declared in libavcore/parseutils.h.
+
+2010-11-13 - r25745 - lavc 52.95.0 - AVCodecContext
+  Add AVCodecContext.subtitle_header and AVCodecContext.subtitle_header_size
+  fields.
+
+2010-11-13 - r25740 - lavfi 1.62.0 - avfiltergraph.h
+  Make avfiltergraph.h public.
+
+2010-11-13 - r25737 - lavfi 1.61.0 - avfiltergraph.h
+  Remove declarations from avfiltergraph.h for the functions:
+  avfilter_graph_check_validity()
+  avfilter_graph_config_links()
+  avfilter_graph_config_formats()
+  which are now internal.
+  Use avfilter_graph_config() instead.
+
+2010-11-08 - r25708 - lavu 50.33.0 - eval.h
+  Deprecate functions:
+  av_parse_and_eval_expr(),
+  av_parse_expr(),
+  av_eval_expr(),
+  av_free_expr(),
+  in favor of the functions:
+  av_expr_parse_and_eval(),
+  av_expr_parse(),
+  av_expr_eval(),
+  av_expr_free().
+
+2010-11-08 - r25707 - lavfi 1.59.0 - avfilter_free()
+  Rename avfilter_destroy() to avfilter_free().
+  This change breaks libavfilter API/ABI.
+
+2010-11-07 - r25705 - lavfi 1.58.0 - avfiltergraph.h
+  Remove graphparser.h header, move AVFilterInOut and
+  avfilter_graph_parse() declarations to libavfilter/avfiltergraph.h.
+
+2010-11-07 - r25700 - lavfi 1.57.0 - AVFilterInOut
+  Rename field AVFilterInOut.filter to AVFilterInOut.filter_ctx.
+  This change breaks libavfilter API.
+
+2010-11-04 - r25674 - lavfi 1.56.0 - avfilter_graph_free()
+  Rename avfilter_graph_destroy() to avfilter_graph_free().
+  This change breaks libavfilter API/ABI.
 
-2010-06-22 - r23702 - lavf 52.69.0 - av_register_protocol2
-  Add av_register_protocol2(), deprecating av_register_protocol()
+2010-11-04 - r25673 - lavfi 1.55.0 - avfilter_graph_alloc()
+  Add avfilter_graph_alloc() to libavfilter/avfiltergraph.h.
+
+2010-11-02 - r25654 - lavcore 0.12.0 - av_get_bits_per_sample_fmt()
+  Add av_get_bits_per_sample_fmt() to libavcore/samplefmt.h and
+  deprecate av_get_bits_per_sample_format().
+
+2010-11-02 - r25653 - lavcore 0.11.0 - samplefmt.h
+  Add sample format functions in libavcore/samplefmt.h:
+  av_get_sample_fmt_name(),
+  av_get_sample_fmt(),
+  av_get_sample_fmt_string(),
+  and deprecate the corresponding libavcodec/audioconvert.h functions:
+  avcodec_get_sample_fmt_name(),
+  avcodec_get_sample_fmt(),
+  avcodec_sample_fmt_string().
+
+2010-11-02 - r25652 - lavcore 0.10.0 - samplefmt.h
+  Define enum AVSampleFormat in libavcore/samplefmt.h, deprecate enum
+  SampleFormat.
+
+2010-10-16 - r25502 - lavfi 1.52.0 - avfilter_graph_config()
+  Add the function avfilter_graph_config() in avfiltergraph.h.
+
+2010-10-15 - r25493 - lavf 52.83.0 - metadata API
+  Change demuxers to export metadata in generic format and
+  muxers to accept generic format. Deprecate the public
+  conversion API.
+
+2010-10-10 - r25441 - lavfi 1.49.0 - AVFilterLink.time_base
+  Add time_base field to AVFilterLink.
+
+2010-09-27 - r25236 - lavu 50.31.0 - av_set_options_string()
+  Move av_set_options_string() from libavfilter/parseutils.h to
+  libavutil/opt.h.
+
+2010-09-27 - r25227 - lavfi 1.47.0 - AVFilterLink
+  Make the AVFilterLink fields srcpad and dstpad store the pointers to
+  the source and destination pads, rather than their indexes.
+
+2010-09-27 - r25225 - lavu 50.30.0 - av_get_token()
+  Move av_get_token() from libavfilter/parseutils.h to
+  libavutil/avstring.h.
+
+2010-09-26 - r32368 - lsws 0.12.0 - swscale.h
+  Add the functions sws_alloc_context() and sws_init_context().
+
+2010-09-26 - r25210 - lavu 50.29.0 - opt.h
+  Move libavcodec/opt.h to libavutil/opt.h.
+
+2010-09-24 - r25174 - lavu 50.28.0 - av_log_set_flags()
+  Default of av_log() changed due to many problems to the old no repeat
+  detection. Read the docs of AV_LOG_SKIP_REPEATED in log.h before
+  enabling it for your app!.
+
+2010-09-24 - r25167 - lavc 52.90.0 - av_opt_show2()
+  Deprecate av_opt_show() in favor or av_opt_show2().
+
+2010-09-14 - r25120 - lavu 50.27.0 - av_popcount()
+  Add av_popcount() to libavutil/common.h.
+
+2010-09-08 - r25076 - lavu 50.26.0 - av_get_cpu_flags()
+  Add av_get_cpu_flags().
+
+2010-09-07 - r25067 - lavcore 0.9.0 - av_image_copy()
+  Add av_image_copy().
+
+2010-09-07 - r25064 - lavcore 0.8.0 - av_image_copy_plane()
+  Add av_image_copy_plane().
+
+2010-09-07 - r25057 - lavcore 0.7.0 - imgutils.h
+  Adopt hierarchical scheme for the imgutils.h function names,
+  deprecate the old names.
+
+2010-09-04 - r25040 - lavu 50.25.0 - AV_CPU_FLAG_*
+  Deprecate the FF_MM_* flags defined in libavcodec/avcodec.h in favor
+  of the AV_CPU_FLAG_* flags defined in libavutil/cpu.h.
+
+2010-08-26 - r24936 - lavc 52.87.0 - avcodec_get_channel_layout()
+  Add avcodec_get_channel_layout() in audioconvert.h.
+
+2010-08-20 - r24851 - lavcore 0.6.0 - av_fill_image_max_pixsteps()
+  Rename av_fill_image_max_pixstep() to av_fill_image_max_pixsteps().
+
+2010-08-18 - r24827 - lavcore 0.5.0 - av_fill_image_max_pixstep()
+  Add av_fill_image_max_pixstep() in imgutils.h.
+
+2010-08-17 - r24814 - lavu 50.24.0 - AV_NE()
+  Add the AV_NE macro.
+
+2010-08-17 - r24811 - lavfi 1.36.0 - audio framework
+  Implement AVFilterBufferRefAudioProps struct for audio properties,
+  get_audio_buffer(), filter_samples() functions and related changes.
+
+2010-08-12 - r24787 - lavcore 0.4.0 - av_get_image_linesize()
+  Add av_get_image_linesize() in imgutils.h.
+
+2010-08-11 - r24773 - lavfi 1.34.0 - AVFilterBufferRef
+  Resize data and linesize arrays in AVFilterBufferRef to 8.
+
+  This change breaks libavfilter API/ABI.
+
+2010-08-11 - r24768 - lavc 52.85.0 - av_picture_data_copy()
+  Add av_picture_data_copy in avcodec.h.
+
+2010-08-11 - r24765 - lavfi 1.33.0 - avfilter_open()
+  Change avfilter_open() signature:
+  AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name) ->
+  int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
+
+  This change breaks libavfilter API/ABI.
+
+2010-08-11 - r24763 - lavfi 1.32.0 - AVFilterBufferRef
+  Add a type field to AVFilterBufferRef, and move video specific
+  properties to AVFilterBufferRefVideoProps.
+
+  This change breaks libavfilter API/ABI.
+
+2010-08-07 - r24732 - lavfi 1.31.0 - AVFilterLink
+  Rename AVFilterLink fields:
+  AVFilterLink.srcpic    ->  AVFilterLink.src_buf
+  AVFilterLink.cur_pic   ->  AVFilterLink.cur_buf
+  AVFilterLink.outpic    ->  AVFilterLink.out_buf
+
+2010-08-07 - r24731 - lavfi 1.30.0
+  Rename functions and fields:
+  avfilter_(un)ref_pic       -> avfilter_(un)ref_buffer
+  avfilter_copy_picref_props -> avfilter_copy_buffer_ref_props
+  AVFilterBufferRef.pic      -> AVFilterBufferRef.buffer
+
+2010-08-07 - r24730 - lavfi 1.29.0 - AVFilterBufferRef
+  Rename AVFilterPicRef to AVFilterBufferRef.
+
+2010-08-07 - r24728 - lavfi 1.28.0 - AVFilterBuffer
+  Move format field from AVFilterBuffer to AVFilterPicRef.
+
+2010-08-06 - r24709 - lavcore 0.3.0 - av_check_image_size()
+  Deprecate avcodec_check_dimensions() in favor of the function
+  av_check_image_size() defined in libavcore/imgutils.h.
+
+2010-07-30 - r24592 - lavfi 1.27.0 - AVFilterBuffer
+  Increase size of the arrays AVFilterBuffer.data and
+  AVFilterBuffer.linesize from 4 to 8.
+
+  This change breaks libavfilter ABI.
+
+2010-07-29 - r24583 - lavcore 0.2.0 - imgutils.h
+  Add functions av_fill_image_linesizes() and
+  av_fill_image_pointers(), declared in libavcore/imgutils.h.
+
+2010-07-27 - r24518 - lavcore 0.1.0 - parseutils.h
+  Deprecate av_parse_video_frame_size() and av_parse_video_frame_rate()
+  defined in libavcodec in favor of the newly added functions
+  av_parse_video_size() and av_parse_video_rate() declared in
+  libavcore/parseutils.h.
+
+2010-07-23 - r24439 - lavu 50.23.0 - mathematics.h
+  Add the M_PHI constant definition.
+
+2010-07-22 - r24424 - lavfi 1.26.0 - media format generalization
+  Add a type field to AVFilterLink.
+
+  Change the field types:
+  enum PixelFormat format   -> int format   in AVFilterBuffer
+  enum PixelFormat *formats -> int *formats in AVFilterFormats
+  enum PixelFormat *format  -> int format   in AVFilterLink
+
+  Change the function signatures:
+  AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts); ->
+  AVFilterFormats *avfilter_make_format_list(const int *fmts);
+
+  int avfilter_add_colorspace(AVFilterFormats **avff, enum PixelFormat pix_fmt); ->
+  int avfilter_add_format    (AVFilterFormats **avff, int fmt);
+
+  AVFilterFormats *avfilter_all_colorspaces(void); ->
+  AVFilterFormats *avfilter_all_formats    (enum AVMediaType type);
+
+  This change breaks libavfilter API/ABI.
+
+2010-07-21 - r24393 - lavcore 0.0.0
+  Add libavcore.
+
+2010-07-17 - r24291 - lavfi 1.25.0 - AVFilterBuffer
+  Remove w and h fields from AVFilterBuffer.
+
+2010-07-17 - r24284 - lavfi 1.24.0 - AVFilterBuffer
+  Rename AVFilterPic to AVFilterBuffer.
+
+2010-07-17 - r24278 - lavf 52.74.0 - url_fskip()
+  Make url_fskip() return an int error code instead of void.
+
+2010-07-11 - r24199 - lavc 52.83.0
+  Add AVCodecContext.lpc_type and AVCodecContext.lpc_passes fields.
+  Add AVLPCType enum.
+  Deprecate AVCodecContext.use_lpc.
+
+2010-07-11 - r24185 - lavc 52.82.0 - avsubtitle_free()
+  Add a function for free the contents of a AVSubtitle generated by
+  avcodec_decode_subtitle.
+
+2010-07-11 - r24174 - lavu 50.22.0 - bswap.h and intreadwrite.h
+  Make the bswap.h and intreadwrite.h API public.
+
+2010-07-08 - r24101 - lavu 50.21.0 - pixdesc.h
+  Rename read/write_line() to av_read/write_image_line().
+
+2010-07-07 - r24091 - lavfi 1.21.0 - avfilter_copy_picref_props()
+  Add avfilter_copy_picref_props().
+
+2010-07-03 - r24021 - lavc 52.79.0
+  Add FF_COMPLIANCE_UNOFFICIAL and change all instances of
+  FF_COMPLIANCE_INOFFICIAL to use FF_COMPLIANCE_UNOFFICIAL.
+
+2010-07-02 - r23985 - lavu 50.20.0 - lfg.h
+  Export av_lfg_init(), av_lfg_get(), av_mlfg_get(), and av_bmg_get() through
+  lfg.h.
+
+2010-06-28 - r23835 - lavfi 1.20.1 - av_parse_color()
+  Extend av_parse_color() syntax, make it accept an alpha value specifier and
+  set the alpha value to 255 by default.
+
+2010-06-22 - r23706 - lavf 52.71.0 - URLProtocol.priv_data_size, priv_data_class
+  Add priv_data_size and priv_data_class to URLProtocol.
+
+2010-06-22 - r23704 - lavf 52.70.0 - url_alloc(), url_connect()
+  Add url_alloc() and url_connect().
+
+2010-06-22 - r23702 - lavf 52.69.0 - av_register_protocol2()
+  Add av_register_protocol2(), deprecating av_register_protocol().
 
 2010-06-09 - r23551 - lavu 50.19.0 - av_compare_mod()
   Add av_compare_mod() to libavutil/mathematics.h.
@@ -24,20 +326,20 @@ API changes, most recent first:
 2010-06-04 - r23461 - lavu 50.17.0 - AV_BASE64_SIZE
   Add AV_BASE64_SIZE() macro.
 
-2010-06-02 - r23421 - lavc 52.73.0 - av_get_codec_tag_string
+2010-06-02 - r23421 - lavc 52.73.0 - av_get_codec_tag_string()
   Add av_get_codec_tag_string().
 
 2010-06-01 - r31301 - lsws 0.11.0 - convertPalette API
-  Add sws_convertPalette8ToPacked32 and sws_convertPalette8ToPacked24
+  Add sws_convertPalette8ToPacked32() and sws_convertPalette8ToPacked24().
 
 2010-05-26 - r23334 - lavc 52.72.0 - CODEC_CAP_EXPERIMENTAL
   Add CODEC_CAP_EXPERIMENTAL flag.
 
-2010-05-23 - r23255 - lavu 50.16.0 - av_get_random_seed
-  Add av_get_random_seed()
+2010-05-23 - r23255 - lavu 50.16.0 - av_get_random_seed()
+  Add av_get_random_seed().
 
 2010-05-18 - r23161 - lavf 52.63.0 - AVFMT_FLAG_RTP_HINT
-  Add AVFMT_FLAG_RTP_HINT as possible value for AVFormatContext.flags
+  Add AVFMT_FLAG_RTP_HINT as possible value for AVFormatContext.flags.
 
 2010-05-09 - r23066 - lavfi 1.20.0 - AVFilterPicRef
   Add interlaced and top_field_first fields to AVFilterPicRef.
@@ -51,7 +353,7 @@ API changes, most recent first:
   existing tags.
 
 2010-04-01 - r22753 - lavc 52.66.0
-  Add avcodec_get_edge_width()
+  Add avcodec_get_edge_width().
 
 2010-03-31 - r22750 - lavc 52.65.0
   Add avcodec_copy_context().
@@ -70,7 +372,7 @@ API changes, most recent first:
   Implement av_strerror().
 
 2010-03-23 - r22649 - lavc 52.60.0 - av_dct_init()
-  Support DCT-I and DST-I
+  Support DCT-I and DST-I.
 
 2010-03-15 - r22540 - lavf 52.56.0 - AVFormatContext.start_time_realtime
   Add AVFormatContext.start_time_realtime field.
@@ -104,13 +406,13 @@ API changes, most recent first:
 2010-01-30 - r21545 - lavu 50.8.0 - av_get_pix_fmt()
   Add av_get_pix_fmt().
 
-2010-01-21 - r30381 - lsws 0.9.0 - sws_scale
+2010-01-21 - r30381 - lsws 0.9.0 - sws_scale()
   Change constness attributes of sws_scale() parameters.
 
 2010-01-10 - r21121 - lavfi 1.15.0 - avfilter_graph_config_links()
   Add a log_ctx parameter to avfilter_graph_config_links().
 
-2010-01-07 - r30236 - lsws 0.8.0 - sws_isSupported{In,Out}put
+2010-01-07 - r30236 - lsws 0.8.0 - sws_isSupported{In,Out}put()
   Add sws_isSupportedInput() and sws_isSupportedOutput() functions.
 
 2010-01-06 - r21035 - lavfi 1.14.0 - avfilter_add_colorspace()
@@ -127,7 +429,8 @@ API changes, most recent first:
   Add av_guess_format(), it should be used in place of guess_format().
 
 2009-12-13 - r20834 - lavf 52.43.0 - metadata API
-  Add av_metadata_set2(), AV_METADATA_DONT_STRDUP_KEY and AV_METADATA_DONT_STRDUP_VAL.
+  Add av_metadata_set2(), AV_METADATA_DONT_STRDUP_KEY and
+  AV_METADATA_DONT_STRDUP_VAL.
 
 2009-12-13 - r20829 - lavu 50.7.0 - avstring.h API
   Add av_d2str().
@@ -193,10 +496,10 @@ API changes, most recent first:
   When the lock manager is registered, FFmpeg is guaranteed to behave
   correctly in a multi-threaded application.
 
-2009-04-30 - r18719 - lavc 52.28.0 - av_free_packet
+2009-04-30 - r18719 - lavc 52.28.0 - av_free_packet()
   av_free_packet() is no longer an inline function. It is now exported.
 
-2009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree
+2009-04-11 - r18431 - lavc 52.25.0 - deprecate av_destruct_packet_nofree()
   Please use NULL instead. This has been supported since r16506
   (lavf > 52.23.1, lavc > 52.10.0).
 
@@ -206,7 +509,7 @@ API changes, most recent first:
   avcodec_decode_subtitle2(). These new functions take an AVPacket *pkt
   argument instead of a const uint8_t *buf / int buf_size pair.
 
-2009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space
+2009-04-03 - r18321 - lavu 50.3.0 - av_fifo_space()
   Introduce the av_fifo_space() function.
 
 2009-04-02 - r18317 - lavc 52.23.0 - AVPacket