tools: Standalone tool for discovering media file properties

Fixes #625944

tools/.gitignore

@@ -2,3 +2,4 @@ gst-launch-ext-?.*
 gst-visualise-?.*
 gst-launch-ext-?.*.1
 gst-visualise-?.*.1
+gst-discoverer

tools/Makefile.am

@@ -4,10 +4,20 @@ bin_SCRIPTS = \
 man_MANS = \
         gst-visualise-@GST_MAJORMINOR@.1
 
-CLEANFILES = $(man_MANS) $(bin_SCRIPTS)
+bin_PROGRAMS = \
+	gst-discoverer
+
+CLEANFILES = $(man_MANS) $(bin_SCRIPTS) $(bin_PROGRAMS)
 
 EXTRA_DIST = \
-	gst-visualise-m.m gst-visualise.1.in
+	gst-visualise-m.m gst-visualise.1.in \
+	gst-discoverer.c
+
+LDADD = $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_MAJORMINOR@.la\
+	-lgstpbutils-@GST_MAJORMINOR@ \
+	$(GST_LIBS)
+
+AM_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS) $(GST_CFLAGS)
 
 # generate versioned scripts from templates
 %-@GST_MAJORMINOR@: %-m.m

tools/gst-discoverer.c

@@ -0,0 +1,441 @@
+/* GStreamer
+ * Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <stdlib.h>
+#include <glib.h>
+#include <gst/gst.h>
+#include <gst/pbutils/pbutils.h>
+
+static gboolean async = FALSE;
+static gboolean silent = FALSE;
+static gboolean verbose = FALSE;
+
+typedef struct
+{
+  GstDiscoverer *dc;
+  int argc;
+  char **argv;
+} PrivStruct;
+
+#define my_g_string_append_printf(str, format, ...) \
+  g_string_append_printf (str, "%*s" format, 2*depth, " ", ##__VA_ARGS__)
+
+static gchar *
+gst_stream_audio_information_to_string (GstDiscovererStreamInfo * info,
+    gint depth)
+{
+  GString *s;
+  gchar *tmp;
+  int len = 400;
+  const GstTagList *tags;
+  GstCaps *caps;
+
+  g_return_val_if_fail (info != NULL, NULL);
+
+  s = g_string_sized_new (len);
+
+  my_g_string_append_printf (s, "Codec:\n");
+  caps = gst_discoverer_stream_info_get_caps (info);
+  tmp = gst_caps_to_string (caps);
+  gst_caps_unref (caps);
+  my_g_string_append_printf (s, "  %s\n", tmp);
+  g_free (tmp);
+
+  my_g_string_append_printf (s, "Additional info:\n");
+  if (gst_discoverer_stream_info_get_misc (info)) {
+    tmp = gst_structure_to_string (gst_discoverer_stream_info_get_misc (info));
+    my_g_string_append_printf (s, "  %s\n", tmp);
+    g_free (tmp);
+  } else {
+    my_g_string_append_printf (s, "  None\n");
+  }
+
+  my_g_string_append_printf (s, "Channels: %u\n",
+      gst_discoverer_audio_info_get_channels (info));
+  my_g_string_append_printf (s, "Sample rate: %u\n",
+      gst_discoverer_audio_info_get_sample_rate (info));
+  my_g_string_append_printf (s, "Depth: %u\n",
+      gst_discoverer_audio_info_get_depth (info));
+
+  my_g_string_append_printf (s, "Bitrate: %u\n",
+      gst_discoverer_audio_info_get_bitrate (info));
+  my_g_string_append_printf (s, "Max bitrate: %u\n",
+      gst_discoverer_audio_info_get_max_bitrate (info));
+
+  my_g_string_append_printf (s, "Tags:\n");
+  tags = gst_discoverer_stream_info_get_tags (info);
+  if (tags) {
+    tmp = gst_structure_to_string ((GstStructure *) tags);
+    my_g_string_append_printf (s, "  %s\n", tmp);
+    g_free (tmp);
+  } else {
+    my_g_string_append_printf (s, "  None\n");
+  }
+  if (verbose)
+    my_g_string_append_printf (s, "\n");
+
+  return g_string_free (s, FALSE);
+}
+
+static gchar *
+gst_stream_video_information_to_string (GstDiscovererStreamInfo * info,
+    gint depth)
+{
+  GString *s;
+  gchar *tmp;
+  int len = 500;
+  const GstStructure *misc;
+  const GstTagList *tags;
+  GstCaps *caps;
+
+  g_return_val_if_fail (info != NULL, NULL);
+
+  s = g_string_sized_new (len);
+
+  my_g_string_append_printf (s, "Codec:\n");
+  caps = gst_discoverer_stream_info_get_caps (info);
+  tmp = gst_caps_to_string (caps);
+  gst_caps_unref (caps);
+  my_g_string_append_printf (s, "  %s\n", tmp);
+  g_free (tmp);
+
+  my_g_string_append_printf (s, "Additional info:\n");
+  misc = gst_discoverer_stream_info_get_misc (info);
+  if (misc) {
+    tmp = gst_structure_to_string (misc);
+    my_g_string_append_printf (s, "  %s\n", tmp);
+    g_free (tmp);
+  } else {
+    my_g_string_append_printf (s, "  None\n");
+  }
+
+  my_g_string_append_printf (s, "Width: %u\n",
+      gst_discoverer_video_info_get_width (info));
+  my_g_string_append_printf (s, "Height: %u\n",
+      gst_discoverer_video_info_get_height (info));
+  my_g_string_append_printf (s, "Depth: %u\n",
+      gst_discoverer_video_info_get_depth (info));
+
+  my_g_string_append_printf (s, "Frame rate: %u/%u\n",
+      gst_discoverer_video_info_get_framerate_num (info),
+      gst_discoverer_video_info_get_framerate_denom (info));
+
+  my_g_string_append_printf (s, "Pixel aspect ratio: %u/%u\n",
+      gst_discoverer_video_info_get_par_num (info),
+      gst_discoverer_video_info_get_par_denom (info));
+
+  my_g_string_append_printf (s, "Interlaced: %s\n",
+      gst_discoverer_video_info_get_interlaced (info) ? "true" : "false");
+
+  my_g_string_append_printf (s, "Bitrate: %u\n",
+      gst_discoverer_video_info_get_bitrate (info));
+  my_g_string_append_printf (s, "Max bitrate: %u\n",
+      gst_discoverer_video_info_get_max_bitrate (info));
+
+  my_g_string_append_printf (s, "Tags:\n");
+  tags = gst_discoverer_stream_info_get_tags (info);
+  if (tags) {
+    tmp = gst_structure_to_string ((GstStructure *) tags);
+    my_g_string_append_printf (s, "  %s\n", tmp);
+    g_free (tmp);
+  } else {
+    my_g_string_append_printf (s, "  None\n");
+  }
+  if (verbose)
+    my_g_string_append_printf (s, "\n");
+
+  return g_string_free (s, FALSE);
+}
+
+static void
+print_stream_info (GstDiscovererStreamInfo * info, void *depth)
+{
+  gchar *desc = NULL;
+  GstCaps *caps;
+
+  caps = gst_discoverer_stream_info_get_caps (info);
+
+  if (caps) {
+    if (gst_caps_is_fixed (caps) && !verbose)
+      desc = gst_pb_utils_get_codec_description (caps);
+    else
+      desc = gst_caps_to_string (caps);
+    gst_caps_unref (caps);
+  }
+
+  g_print ("%*s%s: %s\n", 2 * GPOINTER_TO_INT (depth), " ",
+      gst_discoverer_stream_info_get_stream_type_nick (info), desc);
+
+  if (desc) {
+    g_free (desc);
+    desc = NULL;
+  }
+
+  if (verbose) {
+    if (GST_IS_DISCOVERER_AUDIO_INFO (info))
+      desc =
+          gst_stream_audio_information_to_string (info,
+          GPOINTER_TO_INT (depth) + 1);
+    else if (GST_IS_DISCOVERER_VIDEO_INFO (info))
+      desc =
+          gst_stream_video_information_to_string (info,
+          GPOINTER_TO_INT (depth) + 1);
+  }
+
+  if (desc) {
+    g_print ("%s", desc);
+    g_free (desc);
+  }
+}
+
+static void
+print_topology (GstDiscovererStreamInfo * info, gint depth)
+{
+  GstDiscovererStreamInfo *next;
+
+  if (!info)
+    return;
+
+  print_stream_info (info, GINT_TO_POINTER (depth));
+
+  next = gst_discoverer_stream_info_get_next (info);
+  if (next) {
+    print_topology (next, depth + 1);
+    gst_discoverer_stream_info_unref (next);
+  } else if (GST_IS_DISCOVERER_CONTAINER_INFO (info)) {
+    GList *tmp, *streams;
+
+    streams = gst_discoverer_container_info_get_streams (info);
+    for (tmp = streams; tmp; tmp = tmp->next) {
+      GstDiscovererStreamInfo *tmpinf = (GstDiscovererStreamInfo *) tmp->data;
+      print_topology (tmpinf, depth + 1);
+    }
+    gst_discoverer_stream_info_list_free (streams);
+  }
+}
+
+static void
+print_duration (GstDiscovererInfo * info, gint tab)
+{
+  g_print ("%*s%" GST_TIME_FORMAT "\n", tab + 1, " ",
+      GST_TIME_ARGS (gst_discoverer_info_get_duration (info)));
+}
+
+static void
+print_info (GstDiscovererInfo * info, GError * err)
+{
+  GstDiscovererResult result = gst_discoverer_info_get_result (info);
+
+  g_print ("Done discovering %s\n", gst_discoverer_info_get_uri (info));
+  if (result & GST_DISCOVERER_URI_INVALID)
+    g_print ("URI is not valid\n");
+  else if (result & GST_DISCOVERER_TIMEOUT)
+    g_print ("Timeout !\n");
+  if (result & GST_DISCOVERER_ERROR) {
+    g_print ("An error was encountered while discovering the file\n");
+    g_print (" %s\n", err->message);
+    if (verbose && (result & GST_DISCOVERER_MISSING_PLUGINS)) {
+      gchar *tmp =
+          gst_structure_to_string (gst_discoverer_info_get_misc (info));
+      g_print (" (%s)\n", tmp);
+      g_free (tmp);
+    }
+
+    return;
+  }
+
+  if (!(result & (GST_DISCOVERER_ERROR | GST_DISCOVERER_TIMEOUT))) {
+    GstDiscovererStreamInfo *sinfo = gst_discoverer_info_get_stream_info (info);
+    g_print ("\nTopology:\n");
+    print_topology (sinfo, 1);
+    g_print ("\nDuration:\n");
+    print_duration (info, 1);
+    gst_discoverer_stream_info_unref (sinfo);
+  }
+  g_print ("\n");
+
+}
+
+static void
+process_file (GstDiscoverer * dc, const gchar * filename)
+{
+  GError *err = NULL;
+  GDir *dir;
+  gchar *uri, *path;
+  GstDiscovererInfo *info;
+  GstStructure *st = NULL;
+
+  if (!gst_uri_is_valid (filename)) {
+    /* Recurse into directories */
+    if ((dir = g_dir_open (filename, 0, NULL))) {
+      const gchar *entry;
+
+      while ((entry = g_dir_read_name (dir))) {
+        gchar *path;
+        path = g_strconcat (filename, G_DIR_SEPARATOR_S, entry, NULL);
+        process_file (dc, path);
+        g_free (path);
+      }
+
+      g_dir_close (dir);
+      return;
+    }
+
+    if (!g_path_is_absolute (filename)) {
+      gchar *cur_dir;
+
+      cur_dir = g_get_current_dir ();
+      path = g_build_filename (cur_dir, filename, NULL);
+      g_free (cur_dir);
+    } else {
+      path = g_strdup (filename);
+    }
+
+    uri = g_filename_to_uri (path, NULL, &err);
+    g_free (path);
+    path = NULL;
+
+    if (err) {
+      g_warning ("Couldn't convert filename to URI: %s\n", err->message);
+      g_error_free (err);
+      return;
+    }
+  } else {
+    uri = g_strdup (filename);
+  }
+
+  if (async == FALSE) {
+    g_print ("Analyzing %s\n", uri);
+    info = gst_discoverer_discover_uri (dc, uri, &err);
+    print_info (info, err);
+    gst_discoverer_info_unref (info);
+    if (st)
+      gst_structure_free (st);
+  } else {
+    gst_discoverer_discover_uri_async (dc, uri);
+  }
+
+  g_free (uri);
+}
+
+static void
+_new_discovered_uri (GstDiscoverer * dc, GstDiscovererInfo * info, GError * err)
+{
+  print_info (info, err);
+}
+
+static gboolean
+_run_async (PrivStruct * ps)
+{
+  gint i;
+
+  for (i = 1; i < ps->argc; i++)
+    process_file (ps->dc, ps->argv[i]);
+
+  return FALSE;
+}
+
+static void
+_discoverer_ready (GstDiscoverer * dc, GMainLoop * ml)
+{
+  g_main_loop_quit (ml);
+}
+
+int
+main (int argc, char **argv)
+{
+  GError *err = NULL;
+  GstDiscoverer *dc;
+  gint timeout = 10;
+  GOptionEntry options[] = {
+    {"async", 'a', 0, G_OPTION_ARG_NONE, &async,
+        "Run asynchronously", NULL},
+    {"silent", 's', 0, G_OPTION_ARG_NONE, &silent,
+        "Don't output the information structure", NULL},
+    {"timeout", 't', 0, G_OPTION_ARG_INT, &timeout,
+        "Specify timeout (in seconds, default 10)", "T"},
+    /* {"elem", 'e', 0, G_OPTION_ARG_NONE, &elem_seek, */
+    /*     "Seek on elements instead of pads", NULL}, */
+    {"verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose,
+        "Verbose properties", NULL},
+    {NULL}
+  };
+  GOptionContext *ctx;
+
+  if (!g_thread_supported ())
+    g_thread_init (NULL);
+
+  ctx =
+      g_option_context_new
+      ("- discover files synchronously with GstDiscoverer");
+  g_option_context_add_main_entries (ctx, options, NULL);
+  g_option_context_add_group (ctx, gst_init_get_option_group ());
+
+  if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
+    g_print ("Error initializing: %s\n", err->message);
+    exit (1);
+  }
+
+  g_option_context_free (ctx);
+
+  if (argc < 2) {
+    g_print ("usage: %s <uris>\n", argv[0]);
+    exit (-1);
+  }
+
+  dc = gst_discoverer_new (timeout * GST_SECOND, &err);
+  if (G_UNLIKELY (dc == NULL)) {
+    g_print ("Error initializing: %s\n", err->message);
+    exit (1);
+  }
+
+  if (async == FALSE) {
+    gint i;
+    for (i = 1; i < argc; i++)
+      process_file (dc, argv[i]);
+  } else {
+    PrivStruct *ps = g_new0 (PrivStruct, 1);
+    GMainLoop *ml = g_main_loop_new (NULL, FALSE);
+
+    ps->dc = dc;
+    ps->argc = argc;
+    ps->argv = argv;
+
+    /* adding uris will be started when the mainloop runs */
+    g_idle_add ((GSourceFunc) _run_async, ps);
+
+    /* connect signals */
+    g_signal_connect (dc, "discovered", G_CALLBACK (_new_discovered_uri), NULL);
+    g_signal_connect (dc, "ready", G_CALLBACK (_discoverer_ready), ml);
+
+    gst_discoverer_start (dc);
+    /* run mainloop */
+    g_main_loop_run (ml);
+
+    gst_discoverer_stop (dc);
+    g_free (ps);
+  }
+  g_object_unref (dc);
+
+  return 0;
+}