testcard: improved help

- describe 'fps' option - although the semantics is obvious, it was not
  mentioned that it accepts 'i' (interlaced) suffix
- change FPS in examples to '59.94i' to illustrate the syntax

refer to GH-317
This commit is contained in:
Martin Pulec
2023-05-26 16:53:54 +02:00
parent 066d1f4fd9
commit fbb6b77b4c

View File

@@ -395,20 +395,21 @@ static int vidcap_testcard_init(struct vidcap_params *params, void **state)
color_printf("or\n");
color_printf(TBOLD(TRED("\t-t testcard") ":<width>:<height>:<fps>:<codec>") "[:other_opts]\n");
color_printf("where\n");
color_printf(TBOLD("\tfile") " - use file for input data instead of predefined pattern\n");
color_printf(TBOLD("\ti|sf") " - send as interlaced or segmented frame, may be used also as a suffix to 'fps' option\n");
color_printf(TBOLD("\tmode") " - use specified mode (use 'mode=help' for list)\n");
color_printf(TBOLD("\tp") " - pan with frame\n");
color_printf(TBOLD("\tpattern") " - pattern to use, use \"" TBOLD("pattern=help") "\" for options\n");
color_printf(TBOLD("\ts") " - split the frames into XxY separate tiles (currently defunct)\n");
color_printf(TBOLD("\tstill") " - send still image\n");
color_printf(TBOLD("\t file ") " - use file for input data instead of predefined pattern\n");
color_printf(TBOLD("\t fps ") " - frames per second (with optional 'i' suffix for interlaced)\n");
color_printf(TBOLD("\t i|sf ") " - send as interlaced or segmented frame\n");
color_printf(TBOLD("\t mode ") " - use specified mode (use 'mode=help' for list)\n");
color_printf(TBOLD("\t p ") " - pan with frame\n");
color_printf(TBOLD("\tpattern") " - pattern to use, use \"" TBOLD("pattern=help") "\" for options\n");
color_printf(TBOLD("\t s ") " - split the frames into XxY separate tiles (currently defunct)\n");
color_printf(TBOLD("\t still ") " - send still image\n");
color_printf("\n");
testcard_show_codec_help("testcard", false);
color_printf("\n");
color_printf("Examples:\n");
color_printf(TBOLD("\t%s -t testcard:file=picture.pam\n"), uv_argv[0]);
color_printf(TBOLD("\t%s -t testcard:mode=VGA\n"), uv_argv[0]);
color_printf(TBOLD("\t%s -t testcard:size=1920x1080:fps=23.98\n"), uv_argv[0]);
color_printf(TBOLD("\t%s -t testcard:size=1920x1080:fps=59.94i\n"), uv_argv[0]);
color_printf("\n");
color_printf("Default mode: %s\n", video_desc_to_string(DEFAULT_FORMAT));
color_printf(TBOLD("Note:") " only certain codec and generator combinations produce full-depth samples (not up-sampled 8-bit), use " TBOLD("pattern=help") " for details.\n");