DeckLink: added more help for DeckLink IP

- example for IP-specific opts in capture - hint in display to consult capture help - help:FourCC - in help usage
CESNET · Feb 18, 2025 · 925c9e5 · 925c9e5
1 parent abc30c2
commit 925c9e5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/src/blackmagic_common.cpp b/src/blackmagic_common.cpp
@@ -971,7 +971,7 @@ bmd_opt_help()
         color_printf(TBOLD("aacl=on") " - set audio consumer levels (flag)\n");
         color_printf(TBOLD("voio=blac") " - display black when no output\n");
         color_printf(TBOLD("DHCP=yes") " - use DHCP config for DeckLink IP\n");
-        color_printf(TBOLD(
+        color_printf(TBOLD("DHCP=no:"
             "nsip=10.0.0.3:nssm=255.255.255.0:nsgw=10.0.0.1") " - use static "
                                                               "net config for "
                                                               "DeckLink IP\n");

diff --git a/src/video_capture/decklink.cpp b/src/video_capture/decklink.cpp
@@ -516,9 +516,11 @@ decklink_help(bool full, const char *query_prop_fcc = nullptr)
 {
 	col() << "\nDeckLink options:\n";
         col() << SBOLD(SRED("\t-t decklink") << ":[full]help") << " | "
-              << SBOLD(SRED("-t decklink") << ":query=<FourCC>") << "\n";
+              << SBOLD(SRED("-t decklink") << ":query=<FourCC>") << " | "
+              << SBOLD(SRED("-t decklink") << ":help=FourCC") << "\n";
         col() << SBOLD(SRED("\t-t decklink")
-                       << "{:m[ode]=<mode>|:d[evice]=<idx|ID|name>|:c[odec]=<colorspace>...<key>=<"
+                       << "{:m[ode]=<mode>|:d[evice]=<idx|ID|name>|:c[odec]=<"
+                          "colorspace>...<key>=<"
                           "val>}*")
               << "\n";
         col() << SBOLD(SRED("\t-t decklink")
@@ -692,6 +694,12 @@ decklink_help(bool full, const char *query_prop_fcc = nullptr)
                        << " -t decklink:d=\"DeckLink 8K Pro (1)\":profile=1dfd")
               << " # capture from 8K Pro and set profile to 1-subdevice "
                  "full-duplex (useful for 3D capture)\n";
+        col() << "\t"
+              << SBOLD(uv_argv[0] << " -t "
+                                     "decklink:d=670600:con=Ethernet:DHCP=no:"
+                                     "nsip=10.0.0.3:nssm=255.255.255.0")
+              << " # DeckLink IP (identified by topological ID), use \""
+              << SBOLD(":help=FourCC") << "\" for list of options\n";
 
         printf("\n");
 

diff --git a/src/video_display/decklink.cpp b/src/video_display/decklink.cpp
@@ -557,8 +557,9 @@ show_help(bool full, const char *query_prop_fcc = nullptr)
                        << "[:d[evice]=<device>][:Level{A|B}][:3D][:half-"
                           "duplex][:HDR[=<t>][:drift_fix]]\n");
         col() << SBOLD(SRED("\t-d decklink") << ":[full]help") << " | "
-              << SBOLD(SRED("-d decklink") << ":query=<FourCC>"
-                                              "\n");
+              << SBOLD(SRED("-d decklink") << ":query=<FourCC>") << " | "
+              << SBOLD(SRED("-d decklink") << ":help=FourCC")
+                                              << "\n";
         col() << "\nOptions:\n";
         if (!full) {
                 col() << SBOLD("\tfullhelp") << "\tdisplay additional options and more details\n";
@@ -671,6 +672,8 @@ show_help(bool full, const char *query_prop_fcc = nullptr)
         if (!full) {
                 col() << "(use \"" << SBOLD("fullhelp") << "\" to see device modes)\n";
         }
+        col() << "(see also \"" << SBOLD("-t decklink:help")
+              << "\" for examples and other information)\n";
 
         decklink_uninitialize(&com_initialized);