comparison avcodec.h @ 9893:1d10ec092b64 libavcodec

Add doxy to av_log_missing_feature() etc. stating that the function is primarily intended for internal use in lavc/lavf, not for use in apps.
author rbultje
date Mon, 29 Jun 2009 19:17:03 +0000
parents b5ca6219e173
children 9bdf9fe9018c
comparison
equal deleted inserted replaced
9892:b5ca6219e173 9893:1d10ec092b64
3715 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */ 3715 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3716 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */ 3716 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3717 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */ 3717 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3718 3718
3719 /** 3719 /**
3720 * Logs a generic warning message about a missing feature. 3720 * Logs a generic warning message about a missing feature. This function is
3721 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3722 * only, and would normally not be used by applications.
3721 * @param[in] avc a pointer to an arbitrary struct of which the first field is 3723 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3722 * a pointer to an AVClass struct 3724 * a pointer to an AVClass struct
3723 * @param[in] feature string containing the name of the missing feature 3725 * @param[in] feature string containing the name of the missing feature
3724 * @param[in] want_sample indicates if samples are wanted which exhibit this feature. 3726 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3725 * If want_sample is non-zero, additional verbage will be added to the log 3727 * If want_sample is non-zero, additional verbage will be added to the log
3727 * mailing list. 3729 * mailing list.
3728 */ 3730 */
3729 void av_log_missing_feature(void *avc, const char *feature, int want_sample); 3731 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3730 3732
3731 /** 3733 /**
3732 * Logs a generic warning message asking for a sample. 3734 * Logs a generic warning message asking for a sample. This function is
3735 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3736 * only, and would normally not be used by applications.
3733 * @param[in] avc a pointer to an arbitrary struct of which the first field is 3737 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3734 * a pointer to an AVClass struct 3738 * a pointer to an AVClass struct
3735 * @param[in] msg string containing an optional message, or NULL if no message 3739 * @param[in] msg string containing an optional message, or NULL if no message
3736 */ 3740 */
3737 void av_log_ask_for_sample(void *avc, const char *msg); 3741 void av_log_ask_for_sample(void *avc, const char *msg);