print_options.c 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. /*
  2. * Copyright (c) 2012 Anton Khirnov
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. /*
  21. * generate texinfo manpages for avoptions
  22. */
  23. #include <stddef.h>
  24. #include <string.h>
  25. #include <float.h>
  26. #include "libavformat/avformat.h"
  27. #include "libavformat/options_table.h"
  28. #include "libavcodec/avcodec.h"
  29. #include "libavcodec/options_table.h"
  30. #include "libavutil/opt.h"
  31. static void print_usage(void)
  32. {
  33. fprintf(stderr, "Usage: enum_options type\n"
  34. "type: format codec\n");
  35. exit(1);
  36. }
  37. static void print_option(const AVOption *opts, const AVOption *o, int per_stream)
  38. {
  39. if (!(o->flags & (AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_ENCODING_PARAM)))
  40. return;
  41. printf("@item -%s%s @var{", o->name, per_stream ? "[:stream_specifier]" : "");
  42. switch (o->type) {
  43. case AV_OPT_TYPE_BINARY: printf("hexadecimal string"); break;
  44. case AV_OPT_TYPE_STRING: printf("string"); break;
  45. case AV_OPT_TYPE_INT:
  46. case AV_OPT_TYPE_INT64: printf("integer"); break;
  47. case AV_OPT_TYPE_FLOAT:
  48. case AV_OPT_TYPE_DOUBLE: printf("float"); break;
  49. case AV_OPT_TYPE_RATIONAL: printf("rational number"); break;
  50. case AV_OPT_TYPE_FLAGS: printf("flags"); break;
  51. default: printf("value"); break;
  52. }
  53. printf("} (@emph{");
  54. if (o->flags & AV_OPT_FLAG_DECODING_PARAM) {
  55. printf("input");
  56. if (o->flags & AV_OPT_FLAG_ENCODING_PARAM)
  57. printf("/");
  58. }
  59. if (o->flags & AV_OPT_FLAG_ENCODING_PARAM) printf("output");
  60. if (o->flags & AV_OPT_FLAG_AUDIO_PARAM) printf(",audio");
  61. if (o->flags & AV_OPT_FLAG_VIDEO_PARAM) printf(",video");
  62. if (o->flags & AV_OPT_FLAG_SUBTITLE_PARAM) printf(",subtitles");
  63. printf("})\n");
  64. if (o->help)
  65. printf("%s\n", o->help);
  66. if (o->unit) {
  67. const AVOption *u;
  68. printf("\nPossible values:\n@table @samp\n");
  69. for (u = opts; u->name; u++) {
  70. if (u->type == AV_OPT_TYPE_CONST && u->unit && !strcmp(u->unit, o->unit))
  71. printf("@item %s\n%s\n", u->name, u->help ? u->help : "");
  72. }
  73. printf("@end table\n");
  74. }
  75. }
  76. static void show_opts(const AVOption *opts, int per_stream)
  77. {
  78. const AVOption *o;
  79. printf("@table @option\n");
  80. for (o = opts; o->name; o++) {
  81. if (o->type != AV_OPT_TYPE_CONST)
  82. print_option(opts, o, per_stream);
  83. }
  84. printf("@end table\n");
  85. }
  86. static void show_format_opts(void)
  87. {
  88. printf("@section Format AVOptions\n");
  89. show_opts(avformat_options, 0);
  90. }
  91. static void show_codec_opts(void)
  92. {
  93. printf("@section Codec AVOptions\n");
  94. show_opts(avcodec_options, 1);
  95. }
  96. int main(int argc, char **argv)
  97. {
  98. if (argc < 2)
  99. print_usage();
  100. printf("@c DO NOT EDIT THIS FILE!\n"
  101. "@c It was generated by print_options.\n\n");
  102. if (!strcmp(argv[1], "format"))
  103. show_format_opts();
  104. else if (!strcmp(argv[1], "codec"))
  105. show_codec_opts();
  106. else
  107. print_usage();
  108. return 0;
  109. }