annotate opt.h @ 12522:776789af0304 libavcodec

Move AVOptions from libavcodec to libavutil
author michael
date Sun, 26 Sep 2010 14:25:22 +0000
parents 7220936dc29c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3699
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
1 /*
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
2 * AVOptions
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
3 * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
4 *
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3702
diff changeset
5 * This file is part of FFmpeg.
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3702
diff changeset
6 *
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3702
diff changeset
7 * FFmpeg is free software; you can redistribute it and/or
3699
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
8 * modify it under the terms of the GNU Lesser General Public
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
9 * License as published by the Free Software Foundation; either
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3702
diff changeset
10 * version 2.1 of the License, or (at your option) any later version.
3699
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
11 *
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3702
diff changeset
12 * FFmpeg is distributed in the hope that it will be useful,
3699
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
15 * Lesser General Public License for more details.
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
16 *
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3702
diff changeset
18 * License along with FFmpeg; if not, write to the Free Software
3699
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
20 */
c537a97eec66 Add official LGPL license headers to the files that were missing them.
diego
parents: 2967
diff changeset
21
7760
c4a4495715dd Globally rename the header inclusion guard names.
stefano
parents: 7427
diff changeset
22 #ifndef AVCODEC_OPT_H
c4a4495715dd Globally rename the header inclusion guard names.
stefano
parents: 7427
diff changeset
23 #define AVCODEC_OPT_H
2874
b6def74f5811 flags and named constants with type checking of course for AVOption
michael
parents:
diff changeset
24
b6def74f5811 flags and named constants with type checking of course for AVOption
michael
parents:
diff changeset
25 /**
11644
7dd2a45249a9 Remove explicit filename from Doxygen @file commands.
diego
parents: 10410
diff changeset
26 * @file
2874
b6def74f5811 flags and named constants with type checking of course for AVOption
michael
parents:
diff changeset
27 * AVOptions
b6def74f5811 flags and named constants with type checking of course for AVOption
michael
parents:
diff changeset
28 */
b6def74f5811 flags and named constants with type checking of course for AVOption
michael
parents:
diff changeset
29
6395
9259af8a686b Install headers in $prefix/include/$libname
mru
parents: 6034
diff changeset
30 #include "libavutil/rational.h"
8579
dc7bfff68156 add the necessary include for LIBAV*_VERSION_*
aurel
parents: 8407
diff changeset
31 #include "avcodec.h"
12522
776789af0304 Move AVOptions from libavcodec to libavutil
michael
parents: 12509
diff changeset
32 #include "libavutil/opt.h"
7224
d5a52b28c9de Fix the av_set_string() free / alloc issue.
michael
parents: 7205
diff changeset
33
8407
8903ad65c412 Put under #if LIBAVCODEC_VERSION_MAJOR < 53 the deprecated functions
stefano
parents: 8356
diff changeset
34 #if LIBAVCODEC_VERSION_MAJOR < 53
7427
a725aab8fe81 Complete documentation for av_set_string().
stefano
parents: 7224
diff changeset
35 /**
a725aab8fe81 Complete documentation for av_set_string().
stefano
parents: 7224
diff changeset
36 * @see av_set_string2()
a725aab8fe81 Complete documentation for av_set_string().
stefano
parents: 7224
diff changeset
37 */
7224
d5a52b28c9de Fix the av_set_string() free / alloc issue.
michael
parents: 7205
diff changeset
38 attribute_deprecated const AVOption *av_set_string(void *obj, const char *name, const char *val);
d5a52b28c9de Fix the av_set_string() free / alloc issue.
michael
parents: 7205
diff changeset
39
d5a52b28c9de Fix the av_set_string() free / alloc issue.
michael
parents: 7205
diff changeset
40 /**
8356
0030146fc2ba Implement av_set_string3().
stefano
parents: 8309
diff changeset
41 * @return a pointer to the AVOption corresponding to the field set or
9822
2887f410011f Remove '\p', '\c' and '\e' doxygen markup from doxy, as it should
stefano
parents: 9642
diff changeset
42 * NULL if no matching AVOption exists, or if the value val is not
8356
0030146fc2ba Implement av_set_string3().
stefano
parents: 8309
diff changeset
43 * valid
0030146fc2ba Implement av_set_string3().
stefano
parents: 8309
diff changeset
44 * @see av_set_string3()
0030146fc2ba Implement av_set_string3().
stefano
parents: 8309
diff changeset
45 */
0030146fc2ba Implement av_set_string3().
stefano
parents: 8309
diff changeset
46 attribute_deprecated const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc);
8407
8903ad65c412 Put under #if LIBAVCODEC_VERSION_MAJOR < 53 the deprecated functions
stefano
parents: 8356
diff changeset
47 #endif
12509
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
48 #if FF_API_OPT_SHOW
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
49 /**
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
50 * @deprecated Use av_opt_show2() instead.
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
51 */
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
52 attribute_deprecated int av_opt_show(void *obj, void *av_log_obj);
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
53 #endif
7220936dc29c Deprecate av_opt_show() in favor of a new function av_opt_show2(),
stefano
parents: 12024
diff changeset
54
7760
c4a4495715dd Globally rename the header inclusion guard names.
stefano
parents: 7427
diff changeset
55 #endif /* AVCODEC_OPT_H */