[FFmpeg-cvslog] lavc: extend doxy for avcodec_alloc_context3().

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Sat Jan 28 09:08:42 2012 +0100| [9bfe218299a1a206356c702c8651e5c6bdb0c009] | committer: Anton Khirnov

lavc: extend doxy for avcodec_alloc_context3().

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=9bfe218299a1a206356c702c8651e5c6bdb0c009
---

 libavcodec/avcodec.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 18db7c5..d8e56ca 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -3415,6 +3415,9 @@ int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
  * @param codec if non-NULL, allocate private data and initialize defaults
  *              for the given codec. It is illegal to then call avcodec_open2()
  *              with a different codec.
+ *              If NULL, then the codec-specific defaults won't be initialized,
+ *              which may result in suboptimal default settings (this is
+ *              important mainly for encoders, e.g. libx264).
  *
  * @return An AVCodecContext filled with default values or NULL on failure.
  * @see avcodec_get_context_defaults