[FFmpeg-devel] [PATCH v3 3/4] fftools: Provide a log formatting callback for context prefixes

[softworkz]

From: softworkz <softworkz at hotmail.com>

This allows to print logical ids instead of memory addresses.
The benefits are:

- Smaller log file sizes
- The disambiguation is much easier to recognize and to follow
- It eventually allows comparing and viewing log file diffs
  without almost every line being different due to those addresses
---
 fftools/cmdutils.c | 69 ++++++++++++++++++++++++++++++++++++++++++++++
 fftools/cmdutils.h |  5 ++++
 fftools/ffmpeg.c   |  1 +
 fftools/ffplay.c   |  1 +
 fftools/ffprobe.c  |  1 +
 5 files changed, 77 insertions(+)

diff --git a/fftools/cmdutils.c b/fftools/cmdutils.c
index 8ac20bf049..9f93eb6523 100644
--- a/fftools/cmdutils.c
+++ b/fftools/cmdutils.c
@@ -59,6 +59,56 @@ AVDictionary *format_opts, *codec_opts;
 
 int hide_banner = 0;
 
+static int nb_class_ids;
+
+#define NB_CLASS_IDS 1000
+static struct class_ids {
+    void *avcl;
+    uint64_t class_hash;
+    unsigned id;
+} class_ids[NB_CLASS_IDS];
+
+static uint64_t fnv_hash(const char *str)
+{
+    // FNV-1a 64-bit hash algorithm
+    uint64_t hash = 0xcbf29ce484222325ULL;
+    while (*str) {
+        hash ^= (unsigned char)*str++;
+        hash *= 0x100000001b3ULL;
+    }
+    return hash;
+}
+
+static unsigned get_class_id(void* avcl)
+{
+    AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
+    const char* class_name = avc->item_name(avcl);
+    unsigned i, nb_ids = 0;
+    uint64_t class_hash;
+
+    for (i = 0; i < NB_CLASS_IDS && class_ids[i].avcl; i++) {
+        if (class_ids[i].avcl == avcl)
+            return class_ids[i].id;
+    }
+
+    class_hash = fnv_hash(avc->class_name);
+
+    for (i = 0; i < NB_CLASS_IDS; i++) {
+        if (class_ids[i].class_hash == class_hash)
+            nb_ids++;
+
+        if (!class_ids[i].avcl) {
+            class_ids[i].avcl = avcl;
+            class_ids[i].class_hash = class_hash;
+            class_ids[i].id = nb_ids;
+            return class_ids[i].id;
+        }
+    }
+
+    // exceeded NB_CLASS_IDS entries in class_ids[]
+    return 0;
+}
+
 void uninit_opts(void)
 {
     av_dict_free(&swr_opts);
@@ -550,6 +600,25 @@ static void check_options(const OptionDef *po)
     }
 }
 
+static const char *item_name(void *obj, const AVClass *cls)
+{
+    return (cls->item_name ? cls->item_name : av_default_item_name)(obj);
+}
+
+static void log_formatprefix_callback(AVBPrint* buffer, AVClass** avcl, int log_flags)
+{
+    const int print_mem = log_flags & AV_LOG_PRINT_MEMADDRESSES;
+    if (print_mem)
+        av_bprintf(buffer+0, "[%s @ %p] ", item_name(avcl, *avcl), avcl);
+    else
+        av_bprintf(buffer+0, "[%s #%u] ", item_name(avcl, *avcl), get_class_id(avcl));
+}
+
+void init_logformatting(void)
+{
+    av_log_set_formatprefix_callback(&log_formatprefix_callback);
+}
+
 void parse_loglevel(int argc, char **argv, const OptionDef *options)
 {
     int idx;
diff --git a/fftools/cmdutils.h b/fftools/cmdutils.h
index 316b6a8c64..182d894ff9 100644
--- a/fftools/cmdutils.h
+++ b/fftools/cmdutils.h
@@ -401,6 +401,11 @@ int split_commandline(OptionParseContext *octx, int argc, char *argv[],
  */
 void uninit_parse_context(OptionParseContext *octx);
 
+/**
+ * Sets up formatting callbacks for logging
+ */
+void init_logformatting(void);
+
 /**
  * Find the '-loglevel' option in the command line args and apply it.
  */
diff --git a/fftools/ffmpeg.c b/fftools/ffmpeg.c
index dc321fb4a2..f84a7024be 100644
--- a/fftools/ffmpeg.c
+++ b/fftools/ffmpeg.c
@@ -955,6 +955,7 @@ int main(int argc, char **argv)
     setvbuf(stderr,NULL,_IONBF,0); /* win32 runtime needs this */
 
     av_log_set_flags(AV_LOG_SKIP_REPEATED);
+    init_logformatting();
     parse_loglevel(argc, argv, options);
 
 #if CONFIG_AVDEVICE
diff --git a/fftools/ffplay.c b/fftools/ffplay.c
index 2a572fc3aa..2e093c0069 100644
--- a/fftools/ffplay.c
+++ b/fftools/ffplay.c
@@ -3762,6 +3762,7 @@ int main(int argc, char **argv)
     init_dynload();
 
     av_log_set_flags(AV_LOG_SKIP_REPEATED);
+    init_logformatting();
     parse_loglevel(argc, argv, options);
 
     /* register all codecs, demux and protocols */
diff --git a/fftools/ffprobe.c b/fftools/ffprobe.c
index 7341731d2f..3a9f2128fd 100644
--- a/fftools/ffprobe.c
+++ b/fftools/ffprobe.c
@@ -4652,6 +4652,7 @@ int main(int argc, char **argv)
     init_dynload();
 
     av_log_set_flags(AV_LOG_SKIP_REPEATED);
+    init_logformatting();
 
     options = real_options;
     parse_loglevel(argc, argv, options);
-- 
ffmpeg-codebot