summaryrefslogtreecommitdiff
path: root/libavutil/opt.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2011-09-04 04:11:53 +0200
committerMichael Niedermayer <michaelni@gmx.at>2011-09-04 04:11:53 +0200
commit1889c6724a449b2e4826612d3b72efc76dbfb713 (patch)
tree05abce06cd1151955b1f1280721044584012ee51 /libavutil/opt.h
parentca4d71b149ebe32aeaf617ffccf362624b9aafb1 (diff)
parente955a682e125d44143415ff2b96a99a4dac78da2 (diff)
Merge remote-tracking branch 'qatar/master'
* qatar/master: AVOptions: fix av_set_string3() doxy to match reality. cmdutils: get rid of dummy contexts for examining AVOptions. lavf,lavc,sws: add {avcodec,avformat,sws}_get_class() functions. AVOptions: add AV_OPT_SEARCH_FAKE_OBJ flag for av_opt_find(). cpu detection: avoid a signed overflow Conflicts: avconv.c cmdutils.c doc/APIchanges ffmpeg.c libavcodec/options.c libavcodec/version.h libavformat/version.h libavutil/avutil.h Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libavutil/opt.h')
-rw-r--r--libavutil/opt.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/libavutil/opt.h b/libavutil/opt.h
index 68873de563..efb4408f0d 100644
--- a/libavutil/opt.h
+++ b/libavutil/opt.h
@@ -134,7 +134,7 @@ const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int m
* when 0 then no av_free() nor av_strdup() will be used
* @return 0 if the value has been set, or an AVERROR code in case of
* error:
- * AVERROR(ENOENT) if no matching option exists
+ * AVERROR_OPTION_NOT_FOUND if no matching option exists
* AVERROR(ERANGE) if the value is out of range
* AVERROR(EINVAL) if the value is not valid
*/
@@ -216,6 +216,13 @@ int av_opt_set_dict(void *obj, struct AVDictionary **options);
#define AV_OPT_SEARCH_CHILDREN 0x0001 /**< Search in possible children of the
given object first. */
+/**
+ * The obj passed to av_opt_find() is fake -- only a double pointer to AVClass
+ * instead of a required pointer to a struct containing AVClass. This is
+ * useful for searching for options without needing to allocate the corresponding
+ * object.
+ */
+#define AV_OPT_SEARCH_FAKE_OBJ 0x0002
/**
* Look for an option in an object. Consider only options which
@@ -223,6 +230,8 @@ int av_opt_set_dict(void *obj, struct AVDictionary **options);
*
* @param[in] obj A pointer to a struct whose first element is a
* pointer to an AVClass.
+ * Alternatively a double pointer to an AVClass, if
+ * AV_OPT_SEARCH_FAKE_OBJ search flag is set.
* @param[in] name The name of the option to look for.
* @param[in] unit When searching for named constants, name of the unit
* it belongs to.