video_rxtx: fn renames

more descriptive fn names

+ document vrxtx_get_compression

Author: MartinPulec

src/main.cpp

@@ -669,7 +669,7 @@ static bool parse_protocol(int ch, char *optarg, struct ug_options *opt) {
                 col() << SBOLD("\t-x A:proto") " - use specified audio protocol\n";
                 col() << SBOLD("\t-x V:proto") " - use specified audio protocol\n";
                 col() << "\nAudio protocol can be one of: " << TBOLD(AUDIO_PROTOCOLS) " (not all must be available)\n";
-                vrxtx_list(strcmp(optarg, "fullhelp") == 0);
+                vrxtx_list_protocols(strcmp(optarg, "fullhelp") == 0);
                 return false;
         }
         if (set_audio) {
@@ -1390,7 +1390,8 @@ int main(int argc, char *argv[])
                       << "\n";
                 col() << TBOLD("Audio codec      : ")
                       << get_name_to_audio_codec(ac_params.codec) << "\n";
-                col() << TBOLD("Network protocol : ") << vrxtx_get_long_name(opt.video_protocol) << "\n";
+                col() << TBOLD("Network protocol : ")
+                      << vrxtx_get_proto_long_name(opt.video_protocol) << "\n";
                 col() << TBOLD("Audio FEC        : ") << opt.audio.fec_cfg << "\n";
                 col() << TBOLD("Video FEC        : ") << opt.video.fec << "\n";
                 col() << "\n";

src/video_rxtx.cpp

@@ -119,6 +119,10 @@ struct video_rxtx {
         std::atomic<codec_t> m_input_codec{};
 };
 
+/**
+ * @returns req_compression if specified (!= 0); protocol default compression
+ * otherwise
+ */
 const char *
 vrxtx_get_compression(const char *video_protocol, const char *req_compression)
 {
@@ -387,13 +391,14 @@ int vrxtx_init(const char *proto_name, const struct vrxtx_params *params,
 }
 
 void
-vrxtx_list(bool full)
+vrxtx_list_protocols(bool full)
 {
         video_rxtx::list(full);
 }
 
 const char *
-vrxtx_get_long_name(const char *short_name)
+vrxtx_get_proto_long_name(const char *short_name)
+
 {
         return video_rxtx::get_long_name(short_name);
 }

src/video_rxtx.h

@@ -114,8 +114,8 @@ struct video_rxtx;
 int  vrxtx_init(const char *proto_name, const struct vrxtx_params *params,
                 const struct common_opts *opts, struct video_rxtx **state);
 void vrxtx_destroy(struct video_rxtx *state);
-void vrxtx_list(bool full);
-const char *vrxtx_get_long_name(const char *short_name);
+void        vrxtx_list_protocols(bool full);
+const char *vrxtx_get_proto_long_name(const char *short_name);
 const char *vrxtx_get_compression(const char *video_protocol,
                                   const char *req_compression);
 void        vrxtx_join(struct video_rxtx *state);