You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

444 lines
15KB

  1. /*
  2. * AVOptions
  3. * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
  4. *
  5. * This file is part of FFmpeg.
  6. *
  7. * FFmpeg is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * FFmpeg is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with FFmpeg; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. */
  21. /**
  22. * @file opt.c
  23. * AVOptions
  24. * @author Michael Niedermayer <michaelni@gmx.at>
  25. */
  26. #include "avcodec.h"
  27. #include "opt.h"
  28. #include "eval.h"
  29. //FIXME order them and do a bin search
  30. const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags){
  31. AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
  32. const AVOption *o= c->option;
  33. for(;o && o->name; o++){
  34. if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
  35. return o;
  36. }
  37. return NULL;
  38. }
  39. const AVOption *av_next_option(void *obj, const AVOption *last){
  40. if(last && last[1].name) return ++last;
  41. else if(last) return NULL;
  42. else return (*(AVClass**)obj)->option;
  43. }
  44. static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
  45. const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
  46. void *dst;
  47. if(!o || o->offset<=0)
  48. return NULL;
  49. if(o->max*den < num*intnum || o->min*den > num*intnum) {
  50. av_log(NULL, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range.\n", num, name);
  51. return NULL;
  52. }
  53. dst= ((uint8_t*)obj) + o->offset;
  54. switch(o->type){
  55. case FF_OPT_TYPE_FLAGS:
  56. case FF_OPT_TYPE_INT: *(int *)dst= llrint(num/den)*intnum; break;
  57. case FF_OPT_TYPE_INT64: *(int64_t *)dst= llrint(num/den)*intnum; break;
  58. case FF_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
  59. case FF_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
  60. case FF_OPT_TYPE_RATIONAL:
  61. if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
  62. else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
  63. break;
  64. default:
  65. return NULL;
  66. }
  67. return o;
  68. }
  69. static const AVOption *set_all_opt(void *v, const char *unit, double d){
  70. AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
  71. const AVOption *o= c->option;
  72. const AVOption *ret=NULL;
  73. for(;o && o->name; o++){
  74. if(o->type != FF_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)){
  75. double tmp= d;
  76. if(o->type == FF_OPT_TYPE_FLAGS)
  77. tmp= av_get_int(v, o->name, NULL) | (int64_t)d;
  78. av_set_number(v, o->name, tmp, 1, 1);
  79. ret= o;
  80. }
  81. }
  82. return ret;
  83. }
  84. static const double const_values[]={
  85. M_PI,
  86. M_E,
  87. FF_QP2LAMBDA,
  88. 0
  89. };
  90. static const char * const const_names[]={
  91. "PI",
  92. "E",
  93. "QP2LAMBDA",
  94. 0
  95. };
  96. static int hexchar2int(char c) {
  97. if (c >= '0' && c <= '9') return c - '0';
  98. if (c >= 'a' && c <= 'f') return c - 'a' + 10;
  99. if (c >= 'A' && c <= 'F') return c - 'A' + 10;
  100. return -1;
  101. }
  102. const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc){
  103. const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
  104. if(o && o->offset==0 && o->type == FF_OPT_TYPE_CONST && o->unit){
  105. return set_all_opt(obj, o->unit, o->default_val);
  106. }
  107. if(!o || !val || o->offset<=0)
  108. return NULL;
  109. if(o->type == FF_OPT_TYPE_BINARY){
  110. uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
  111. int *lendst = (int *)(dst + 1);
  112. uint8_t *bin, *ptr;
  113. int len = strlen(val);
  114. av_freep(dst);
  115. *lendst = 0;
  116. if (len & 1) return NULL;
  117. len /= 2;
  118. ptr = bin = av_malloc(len);
  119. while (*val) {
  120. int a = hexchar2int(*val++);
  121. int b = hexchar2int(*val++);
  122. if (a < 0 || b < 0) {
  123. av_free(bin);
  124. return NULL;
  125. }
  126. *ptr++ = (a << 4) | b;
  127. }
  128. *dst = bin;
  129. *lendst = len;
  130. return o;
  131. }
  132. if(o->type != FF_OPT_TYPE_STRING){
  133. int notfirst=0;
  134. for(;;){
  135. int i;
  136. char buf[256];
  137. int cmd=0;
  138. double d;
  139. const char *error = NULL;
  140. if(*val == '+' || *val == '-')
  141. cmd= *(val++);
  142. for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
  143. buf[i]= val[i];
  144. buf[i]=0;
  145. d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
  146. if(isnan(d)) {
  147. const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
  148. if(o_named && o_named->type == FF_OPT_TYPE_CONST)
  149. d= o_named->default_val;
  150. else if(!strcmp(buf, "default")) d= o->default_val;
  151. else if(!strcmp(buf, "max" )) d= o->max;
  152. else if(!strcmp(buf, "min" )) d= o->min;
  153. else if(!strcmp(buf, "none" )) d= 0;
  154. else if(!strcmp(buf, "all" )) d= ~0;
  155. else {
  156. if (error)
  157. av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
  158. return NULL;
  159. }
  160. }
  161. if(o->type == FF_OPT_TYPE_FLAGS){
  162. if (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
  163. else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
  164. }else{
  165. if (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
  166. else if(cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
  167. }
  168. if (!av_set_number(obj, name, d, 1, 1))
  169. return NULL;
  170. val+= i;
  171. if(!*val)
  172. return o;
  173. notfirst=1;
  174. }
  175. return NULL;
  176. }
  177. if(alloc){
  178. av_free(*(void**)(((uint8_t*)obj) + o->offset));
  179. val= av_strdup(val);
  180. }
  181. memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
  182. return o;
  183. }
  184. const AVOption *av_set_string(void *obj, const char *name, const char *val){
  185. return av_set_string2(obj, name, val, 0);
  186. }
  187. const AVOption *av_set_double(void *obj, const char *name, double n){
  188. return av_set_number(obj, name, n, 1, 1);
  189. }
  190. const AVOption *av_set_q(void *obj, const char *name, AVRational n){
  191. return av_set_number(obj, name, n.num, n.den, 1);
  192. }
  193. const AVOption *av_set_int(void *obj, const char *name, int64_t n){
  194. return av_set_number(obj, name, 1, 1, n);
  195. }
  196. /**
  197. *
  198. * @param buf a buffer which is used for returning non string values as strings, can be NULL
  199. * @param buf_len allocated length in bytes of buf
  200. */
  201. const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
  202. const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
  203. void *dst;
  204. uint8_t *bin;
  205. int len, i;
  206. if(!o || o->offset<=0)
  207. return NULL;
  208. if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
  209. return NULL;
  210. dst= ((uint8_t*)obj) + o->offset;
  211. if(o_out) *o_out= o;
  212. switch(o->type){
  213. case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
  214. case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
  215. case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
  216. case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
  217. case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
  218. case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
  219. case FF_OPT_TYPE_STRING: return *(void**)dst;
  220. case FF_OPT_TYPE_BINARY:
  221. len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
  222. if(len >= (buf_len + 1)/2) return NULL;
  223. bin = *(uint8_t**)dst;
  224. for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
  225. break;
  226. default: return NULL;
  227. }
  228. return buf;
  229. }
  230. static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
  231. const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
  232. void *dst;
  233. if(!o || o->offset<=0)
  234. goto error;
  235. dst= ((uint8_t*)obj) + o->offset;
  236. if(o_out) *o_out= o;
  237. switch(o->type){
  238. case FF_OPT_TYPE_FLAGS: *intnum= *(unsigned int*)dst;return 0;
  239. case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
  240. case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
  241. case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
  242. case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
  243. case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
  244. *den = ((AVRational*)dst)->den;
  245. return 0;
  246. }
  247. error:
  248. *den=*intnum=0;
  249. return -1;
  250. }
  251. double av_get_double(void *obj, const char *name, const AVOption **o_out){
  252. int64_t intnum=1;
  253. double num=1;
  254. int den=1;
  255. av_get_number(obj, name, o_out, &num, &den, &intnum);
  256. return num*intnum/den;
  257. }
  258. AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
  259. int64_t intnum=1;
  260. double num=1;
  261. int den=1;
  262. av_get_number(obj, name, o_out, &num, &den, &intnum);
  263. if(num == 1.0 && (int)intnum == intnum)
  264. return (AVRational){intnum, den};
  265. else
  266. return av_d2q(num*intnum/den, 1<<24);
  267. }
  268. int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
  269. int64_t intnum=1;
  270. double num=1;
  271. int den=1;
  272. av_get_number(obj, name, o_out, &num, &den, &intnum);
  273. return num*intnum/den;
  274. }
  275. static void opt_list(void *obj, void *av_log_obj, const char *unit)
  276. {
  277. const AVOption *opt=NULL;
  278. while((opt= av_next_option(obj, opt))){
  279. if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
  280. continue;
  281. /* Don't print CONST's on level one.
  282. * Don't print anything but CONST's on level two.
  283. * Only print items from the requested unit.
  284. */
  285. if (!unit && opt->type==FF_OPT_TYPE_CONST)
  286. continue;
  287. else if (unit && opt->type!=FF_OPT_TYPE_CONST)
  288. continue;
  289. else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
  290. continue;
  291. else if (unit && opt->type == FF_OPT_TYPE_CONST)
  292. av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
  293. else
  294. av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
  295. switch( opt->type )
  296. {
  297. case FF_OPT_TYPE_FLAGS:
  298. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
  299. break;
  300. case FF_OPT_TYPE_INT:
  301. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
  302. break;
  303. case FF_OPT_TYPE_INT64:
  304. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
  305. break;
  306. case FF_OPT_TYPE_DOUBLE:
  307. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
  308. break;
  309. case FF_OPT_TYPE_FLOAT:
  310. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
  311. break;
  312. case FF_OPT_TYPE_STRING:
  313. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
  314. break;
  315. case FF_OPT_TYPE_RATIONAL:
  316. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
  317. break;
  318. case FF_OPT_TYPE_BINARY:
  319. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
  320. break;
  321. case FF_OPT_TYPE_CONST:
  322. default:
  323. av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
  324. break;
  325. }
  326. av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
  327. av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
  328. av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
  329. av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
  330. av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
  331. if(opt->help)
  332. av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
  333. av_log(av_log_obj, AV_LOG_INFO, "\n");
  334. if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
  335. opt_list(obj, av_log_obj, opt->unit);
  336. }
  337. }
  338. }
  339. int av_opt_show(void *obj, void *av_log_obj){
  340. if(!obj)
  341. return -1;
  342. av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
  343. opt_list(obj, av_log_obj, NULL);
  344. return 0;
  345. }
  346. /** Set the values of the AVCodecContext or AVFormatContext structure.
  347. * They are set to the defaults specified in the according AVOption options
  348. * array default_val field.
  349. *
  350. * @param s AVCodecContext or AVFormatContext for which the defaults will be set
  351. */
  352. void av_opt_set_defaults2(void *s, int mask, int flags)
  353. {
  354. const AVOption *opt = NULL;
  355. while ((opt = av_next_option(s, opt)) != NULL) {
  356. if((opt->flags & mask) != flags)
  357. continue;
  358. switch(opt->type) {
  359. case FF_OPT_TYPE_CONST:
  360. /* Nothing to be done here */
  361. break;
  362. case FF_OPT_TYPE_FLAGS:
  363. case FF_OPT_TYPE_INT: {
  364. int val;
  365. val = opt->default_val;
  366. av_set_int(s, opt->name, val);
  367. }
  368. break;
  369. case FF_OPT_TYPE_FLOAT: {
  370. double val;
  371. val = opt->default_val;
  372. av_set_double(s, opt->name, val);
  373. }
  374. break;
  375. case FF_OPT_TYPE_RATIONAL: {
  376. AVRational val;
  377. val = av_d2q(opt->default_val, INT_MAX);
  378. av_set_q(s, opt->name, val);
  379. }
  380. break;
  381. case FF_OPT_TYPE_STRING:
  382. case FF_OPT_TYPE_BINARY:
  383. /* Cannot set default for string as default_val is of type * double */
  384. break;
  385. default:
  386. av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
  387. }
  388. }
  389. }
  390. void av_opt_set_defaults(void *s){
  391. av_opt_set_defaults2(s, 0, 0);
  392. }