Import GstTranscoder

4 files changed, 635 insertions, 0 deletions

diff --git a/tools/gst-transcoder.c b/tools/gst-transcoder.c
new file mode 100644
index 000000000..553aea210
--- /dev/null
+++ b/tools/gst-transcoder.c
@@ -0,0 +1,401 @@
+/* GStreamer
+ *
+ * Copyright (C) 2015 Thibault Saunier <tsaunier@gnome.org>
+ *
+ * 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., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <string.h>
+
+#include "utils.h"
+#include <gst/transcoder/gsttranscoder.h>
+
+static const gchar *HELP_SUMMARY =
+    "gst-transcoder-1.0 transcodes a stream defined by its first <input-uri>\n"
+    "argument to the place defined by its second <output-uri> argument\n"
+    "into the format described in its third <encoding-format> argument,\n"
+    "or using the given <output-uri> file extension.\n"
+    "\n"
+    "The <encoding-format> argument:\n"
+    "===============================\n"
+    "\n"
+    "If the encoding format is not defined, it will be guessed with\n"
+    "the given <output-uri> file extension."
+    "\n"
+    "<encoding-format> describe the media format into which the\n"
+    "input stream is going to be transcoded. We have two different\n"
+    "ways of describing the format:\n"
+    "\n"
+    "GstEncodingProfile serialization format\n"
+    "---------------------------------------\n"
+    "\n"
+    "GStreamer encoding profiles can be descibed with a quite extensive\n"
+    "syntax which is descibed in the GstEncodingProfile documentation.\n"
+    "\n"
+    "The simple case looks like:\n"
+    "\n"
+    "    muxer_source_caps:videoencoder_source_caps:audioencoder_source_caps\n"
+    "\n"
+    "Name and category of serialized GstEncodingTarget\n"
+    "-------------------------------------------------\n"
+    "\n"
+    "Encoding targets describe well known formats which\n"
+    "those are provided in '.gep' files. You can list\n"
+    "available ones using the `--list-targets` argument.\n";
+
+typedef struct
+{
+  gint cpu_usage, rate;
+  gboolean list;
+  GstEncodingProfile *profile;
+  gchar *src_uri, *dest_uri, *encoding_format, *size;
+  gchar *framerate;
+} Settings;
+
+static void
+position_updated_cb (GstTranscoder * transcoder, GstClockTime pos)
+{
+  GstClockTime dur = -1;
+  gchar status[64] = { 0, };
+
+  g_object_get (transcoder, "duration", &dur, NULL);
+
+  memset (status, ' ', sizeof (status) - 1);
+
+  if (pos != -1 && dur > 0 && dur != -1) {
+    gchar dstr[32], pstr[32];
+
+    /* FIXME: pretty print in nicer format */
+    g_snprintf (pstr, 32, "%" GST_TIME_FORMAT, GST_TIME_ARGS (pos));
+    pstr[9] = '\0';
+    g_snprintf (dstr, 32, "%" GST_TIME_FORMAT, GST_TIME_ARGS (dur));
+    dstr[9] = '\0';
+    g_print ("%s / %s %s\r", pstr, dstr, status);
+  }
+}
+
+static GList *
+get_profiles_of_type (GstEncodingProfile * profile, GType profile_type)
+{
+  GList *tmp, *profiles = NULL;
+
+  if (GST_IS_ENCODING_CONTAINER_PROFILE (profile)) {
+    for (tmp = (GList *)
+        gst_encoding_container_profile_get_profiles
+        (GST_ENCODING_CONTAINER_PROFILE (profile)); tmp; tmp = tmp->next) {
+      if (G_OBJECT_TYPE (tmp->data) == profile_type)
+        profiles = g_list_prepend (profiles, tmp->data);
+    }
+  } else if (GST_IS_ENCODING_VIDEO_PROFILE (profile)) {
+    profiles = g_list_prepend (profiles, profile);
+  }
+
+  return profiles;
+}
+
+static gboolean
+set_video_settings (Settings * settings)
+{
+  GList *video_profiles, *tmp;
+  gchar *p, *tmpstr, **vsize;
+  gint width = 0, height = 0;
+  GValue framerate = G_VALUE_INIT;
+
+  if (!settings->size && !settings->framerate)
+    return TRUE;
+
+  if (settings->size) {
+    p = tmpstr = g_strdup (settings->size);
+
+    for (; *p; ++p)
+      *p = g_ascii_tolower (*p);
+
+    vsize = g_strsplit (tmpstr, "x", -1);
+    g_free (tmpstr);
+
+    if (!vsize[1] || vsize[2]) {
+      g_strfreev (vsize);
+      error ("Video size should be in the form: WxH, got %s", settings->size);
+
+      return FALSE;
+    }
+
+    width = g_ascii_strtoull (vsize[0], NULL, 0);
+    height = g_ascii_strtoull (vsize[1], NULL, 10);
+    g_strfreev (vsize);
+  }
+
+  if (settings->framerate) {
+    g_value_init (&framerate, GST_TYPE_FRACTION);
+    if (!gst_value_deserialize (&framerate, settings->framerate)) {
+      error ("Video framerate should be either a fraction or an integer"
+          " not: %s", settings->framerate);
+      return FALSE;
+    }
+  }
+
+  video_profiles = get_profiles_of_type (settings->profile,
+      GST_TYPE_ENCODING_VIDEO_PROFILE);
+  for (tmp = video_profiles; tmp; tmp = tmp->next) {
+    GstCaps *rest = gst_encoding_profile_get_restriction (tmp->data);
+
+    if (!rest)
+      rest = gst_caps_new_empty_simple ("video/x-raw");
+    else
+      rest = gst_caps_copy (rest);
+
+    if (settings->size) {
+      gst_caps_set_simple (rest, "width", G_TYPE_INT, width,
+          "height", G_TYPE_INT, height, NULL);
+    }
+    if (settings->framerate)
+      gst_caps_set_value (rest, "framerate", &framerate);
+
+    gst_encoding_profile_set_restriction (tmp->data, rest);
+  }
+
+  return TRUE;
+}
+
+static gboolean
+set_audio_settings (Settings * settings)
+{
+  GList *audio_profiles, *tmp;
+
+  if (settings->rate < 0)
+    return TRUE;
+
+  audio_profiles =
+      get_profiles_of_type (settings->profile, GST_TYPE_ENCODING_AUDIO_PROFILE);
+  for (tmp = audio_profiles; tmp; tmp = tmp->next) {
+    GstCaps *rest = gst_encoding_profile_get_restriction (tmp->data);
+
+    if (!rest)
+      rest = gst_caps_new_empty_simple ("audio/x-raw");
+    else
+      rest = gst_caps_copy (rest);
+
+    gst_caps_set_simple (rest, "rate", G_TYPE_INT, settings->rate, NULL);
+    gst_encoding_profile_set_restriction (tmp->data, rest);
+  }
+
+  return TRUE;
+}
+
+static void
+list_encoding_targets (void)
+{
+  GList *tmp, *targets = gst_encoding_list_all_targets (NULL);
+
+  for (tmp = targets; tmp; tmp = tmp->next) {
+    GstEncodingTarget *target = tmp->data;
+    GList *usable_profiles = get_usable_profiles (target);
+
+    if (usable_profiles) {
+      GList *tmpprof;
+
+      g_print ("\n%s (%s): %s\n * Profiles:\n",
+          gst_encoding_target_get_name (target),
+          gst_encoding_target_get_category (target),
+          gst_encoding_target_get_description (target));
+
+      for (tmpprof = usable_profiles; tmpprof; tmpprof = tmpprof->next)
+        g_print ("     - %s: %s",
+            gst_encoding_profile_get_name (tmpprof->data),
+            gst_encoding_profile_get_description (tmpprof->data));
+
+      g_print ("\n");
+      g_list_free (usable_profiles);
+    }
+  }
+
+  g_list_free_full (targets, (GDestroyNotify) g_object_unref);
+}
+
+static void
+_error_cb (GstTranscoder * transcoder, GError * err, GstStructure * details)
+{
+  if (g_error_matches (err, GST_CORE_ERROR, GST_CORE_ERROR_PAD)) {
+    GstPadLinkReturn lret;
+    GType type;
+
+    if (details && gst_structure_get (details, "linking-error",
+            GST_TYPE_PAD_LINK_RETURN, &lret,
+            "msg-source-type", G_TYPE_GTYPE, &type, NULL) &&
+        type == g_type_from_name ("GstTranscodeBin")) {
+      error ("\nCould not setup transcoding pipeline,"
+          " make sure that you transcoding format parametters"
+          " are compatible with the input stream.");
+
+      return;
+    }
+  }
+
+  error ("\nFAILURE: %s", err->message);
+}
+
+static void
+_warning_cb (GstTranscoder * transcoder, GError * error, GstStructure * details)
+{
+  gboolean cant_encode;
+  GstCaps *caps = NULL;
+  gchar *stream_id = NULL;
+
+  if (details && gst_structure_get (details, "can-t-encode-stream",
+          G_TYPE_BOOLEAN, &cant_encode, "stream-caps", GST_TYPE_CAPS,
+          &caps, "stream-id", G_TYPE_STRING, &stream_id, NULL)) {
+    gchar *source_uri = gst_transcoder_get_source_uri (transcoder);
+
+    warn ("WARNING: Input stream %s: WON'T BE ENCODED.\n"
+        "Make sure the encoding settings are valid and that"
+        " any preset you set actually exists.\n"
+        "For more information about that stream, you can inspect"
+        " the source stream with:\n\n"
+        "    gst-discoverer-1.0 -v %s\n", stream_id, source_uri);
+    gst_caps_unref (caps);
+    g_free (stream_id);;
+    g_free (source_uri);;
+
+    return;
+  }
+  warn ("Got warning: %s", error->message);
+}
+
+int
+main (int argc, char *argv[])
+{
+  gint res = 0;
+  GError *err = NULL;
+  GstTranscoder *transcoder;
+  GOptionContext *ctx;
+  Settings settings = {
+    .cpu_usage = 100,
+    .rate = -1,
+    .encoding_format = NULL,
+    .size = NULL,
+    .framerate = NULL,
+  };
+  GOptionEntry options[] = {
+    {"cpu-usage", 'c', 0, G_OPTION_ARG_INT, &settings.cpu_usage,
+        "The CPU usage to target in the transcoding process", NULL},
+    {"list-targets", 'l', G_OPTION_ARG_NONE, 0, &settings.list,
+        "List all encoding targets", NULL},
+    {"size", 's', 0, G_OPTION_ARG_STRING, &settings.size,
+        "set frame size (WxH or abbreviation)", NULL},
+    {"audio-rate", 'r', 0, G_OPTION_ARG_INT, &settings.rate,
+        "set audio sampling rate (in Hz)", NULL},
+    {"framerate", 'f', 0, G_OPTION_ARG_STRING, &settings.framerate,
+        "set video framerate as a fraction (24/1 for 24fps)"
+          " or a single number (24 for 24fps))", NULL},
+    {"video-encoder", 'v', 0, G_OPTION_ARG_STRING, &settings.size,
+        "The video encoder to use.", NULL},
+    {NULL}
+  };
+
+  g_set_prgname ("gst-transcoder");
+
+  ctx = g_option_context_new ("<source uri> <destination uri> "
+      "[<encoding format>[/<encoding profile name>]]");
+  g_option_context_set_summary (ctx, HELP_SUMMARY);
+
+  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", GST_STR_NULL (err->message));
+    g_clear_error (&err);
+    g_option_context_free (ctx);
+    return 1;
+  }
+  gst_pb_utils_init ();
+
+  if (settings.list) {
+    list_encoding_targets ();
+    return 0;
+  }
+
+  if (argc < 3 || argc > 4) {
+    g_print ("%s", g_option_context_get_help (ctx, TRUE, NULL));
+    g_option_context_free (ctx);
+
+    return -1;
+  }
+  g_option_context_free (ctx);
+
+  settings.src_uri = ensure_uri (argv[1]);
+  settings.dest_uri = ensure_uri (argv[2]);
+
+  if (argc == 3) {
+    settings.encoding_format = get_file_extension (settings.dest_uri);
+
+    if (!settings.encoding_format)
+      goto no_extension;
+  } else {
+    settings.encoding_format = argv[3];
+  }
+
+  settings.profile = create_encoding_profile (settings.encoding_format);
+
+  if (!settings.profile) {
+    error ("Could not find any encoding format for %s\n",
+        settings.encoding_format);
+    warn ("You can list available targets using %s --list-targets", argv[0]);
+    res = 1;
+    goto done;
+  }
+
+  g_print ("Encoding to:\n\n");
+  describe_encoding_profile (settings.profile);
+  if (!set_video_settings (&settings)) {
+    res = -1;
+    goto done;
+  }
+
+  if (!set_audio_settings (&settings)) {
+    res = -1;
+    goto done;
+  }
+
+  transcoder = gst_transcoder_new_full (settings.src_uri, settings.dest_uri,
+      settings.profile, NULL);
+  gst_transcoder_set_avoid_reencoding (transcoder, TRUE);
+
+  gst_transcoder_set_cpu_usage (transcoder, settings.cpu_usage);
+  g_signal_connect (transcoder, "position-updated",
+      G_CALLBACK (position_updated_cb), NULL);
+  g_signal_connect (transcoder, "warning", G_CALLBACK (_warning_cb), NULL);
+  g_signal_connect (transcoder, "error", G_CALLBACK (_error_cb), NULL);
+
+  g_assert (transcoder);
+
+  ok ("Starting transcoding...");
+  gst_transcoder_run (transcoder, &err);
+  if (!err)
+    ok ("\nDONE.");
+
+done:
+  g_free (settings.dest_uri);
+  g_free (settings.src_uri);
+
+  return res;
+
+no_extension:
+  error ("No <encoding-format> specified and no extension"
+      " available in the output target: %s", settings.dest_uri);
+  res = 1;
+
+  goto done;
+}
diff --git a/tools/meson.build b/tools/meson.build
new file mode 100644
index 000000000..3fda1f637
--- /dev/null
+++ b/tools/meson.build
@@ -0,0 +1,5 @@
+executable('gst-transcoder-' + api_version,
+  'gst-transcoder.c', 'utils.c',
+  install : true,
+  dependencies : [gst_dep, gstpbutils_dep, gst_transcoder_dep],
+)
diff --git a/tools/utils.c b/tools/utils.c
new file mode 100644
index 000000000..4f855c565
--- /dev/null
+++ b/tools/utils.c
@@ -0,0 +1,208 @@
+#include <string.h>
+
+#include "utils.h"
+#include <gst/pbutils/descriptions.h>
+
+void
+print (GstDebugColorFlags c, gboolean err, gboolean nline, const gchar * format,
+    va_list var_args)
+{
+  GString *str = g_string_new (NULL);
+  GstDebugColorMode color_mode;
+  gchar *color = NULL;
+  const gchar *clear = NULL;
+
+  color_mode = gst_debug_get_color_mode ();
+#ifdef G_OS_WIN32
+  if (color_mode == GST_DEBUG_COLOR_MODE_UNIX) {
+#else
+  if (color_mode != GST_DEBUG_COLOR_MODE_OFF) {
+#endif
+    clear = "\033[00m";
+    color = gst_debug_construct_term_color (c);
+  }
+
+  if (color) {
+    g_string_append (str, color);
+    g_free (color);
+  }
+
+  g_string_append_vprintf (str, format, var_args);
+
+  if (nline)
+    g_string_append_c (str, '\n');
+
+  if (clear)
+    g_string_append (str, clear);
+
+  if (err)
+    g_printerr ("%s", str->str);
+  else
+    g_print ("%s", str->str);
+
+  g_string_free (str, TRUE);
+}
+
+void
+ok (const gchar * format, ...)
+{
+  va_list var_args;
+
+  va_start (var_args, format);
+  print (GST_DEBUG_FG_GREEN, FALSE, TRUE, format, var_args);
+  va_end (var_args);
+}
+
+void
+warn (const gchar * format, ...)
+{
+  va_list var_args;
+
+  va_start (var_args, format);
+  print (GST_DEBUG_FG_YELLOW, TRUE, TRUE, format, var_args);
+  va_end (var_args);
+}
+
+void
+error (const gchar * format, ...)
+{
+  va_list var_args;
+
+  va_start (var_args, format);
+  print (GST_DEBUG_FG_RED, TRUE, TRUE, format, var_args);
+  va_end (var_args);
+}
+
+gchar *
+ensure_uri (const gchar * location)
+{
+  if (gst_uri_is_valid (location))
+    return g_strdup (location);
+  else
+    return gst_filename_to_uri (location, NULL);
+}
+
+gchar *
+get_file_extension (gchar * uri)
+{
+  size_t len;
+  gint find;
+
+  len = strlen (uri);
+  find = len - 1;
+
+  while (find >= 0) {
+    if (uri[find] == '.')
+      break;
+    find--;
+  }
+
+  if (find < 0)
+    return NULL;
+
+  return &uri[find + 1];
+}
+
+GList *
+get_usable_profiles (GstEncodingTarget * target)
+{
+  GList *tmpprof, *usable_profiles = NULL;
+
+  for (tmpprof = (GList *) gst_encoding_target_get_profiles (target);
+      tmpprof; tmpprof = tmpprof->next) {
+    GstEncodingProfile *profile = tmpprof->data;
+    GstElement *tmpencodebin = gst_element_factory_make ("encodebin", NULL);
+
+    gst_encoding_profile_set_presence (profile, 1);
+    if (GST_IS_ENCODING_CONTAINER_PROFILE (profile)) {
+      GList *tmpsubprof;
+      for (tmpsubprof = (GList *)
+          gst_encoding_container_profile_get_profiles
+          (GST_ENCODING_CONTAINER_PROFILE (profile)); tmpsubprof;
+          tmpsubprof = tmpsubprof->next)
+        gst_encoding_profile_set_presence (tmpsubprof->data, 1);
+    }
+
+    g_object_set (tmpencodebin, "profile", gst_object_ref (profile), NULL);
+    GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (tmpencodebin),
+        GST_DEBUG_GRAPH_SHOW_ALL, gst_encoding_profile_get_name (profile));
+
+    /* The profile could be expended */
+    if (GST_BIN (tmpencodebin)->children)
+      usable_profiles = g_list_prepend (usable_profiles, profile);
+
+    gst_object_unref (tmpencodebin);
+  }
+
+  return usable_profiles;
+}
+
+GstEncodingProfile *
+create_encoding_profile (const gchar * pname)
+{
+  GstEncodingProfile *profile;
+  GValue value = G_VALUE_INIT;
+
+  g_value_init (&value, GST_TYPE_ENCODING_PROFILE);
+
+  if (!gst_value_deserialize (&value, pname)) {
+    g_value_reset (&value);
+
+    return NULL;
+  }
+
+  profile = g_value_dup_object (&value);
+  g_value_reset (&value);
+
+  return profile;
+}
+
+static const gchar *
+get_profile_type (GstEncodingProfile * profile)
+{
+  if (GST_IS_ENCODING_CONTAINER_PROFILE (profile))
+    return "Container";
+  else if (GST_IS_ENCODING_AUDIO_PROFILE (profile))
+    return "Audio";
+  else if (GST_IS_ENCODING_VIDEO_PROFILE (profile))
+    return "Video";
+  else
+    return "Unkonwn";
+}
+
+static void
+print_profile (GstEncodingProfile * profile, const gchar * prefix)
+{
+  const gchar *name = gst_encoding_profile_get_name (profile);
+  const gchar *desc = gst_encoding_profile_get_description (profile);
+  GstCaps *format = gst_encoding_profile_get_format (profile);
+  gchar *capsdesc;
+
+  if (gst_caps_is_fixed (format))
+    capsdesc = gst_pb_utils_get_codec_description (format);
+  else
+    capsdesc = gst_caps_to_string (format);
+
+  g_print ("%s%s: %s%s%s%s%s%s\n", prefix, get_profile_type (profile),
+      name ? name : capsdesc, desc ? ": " : "", desc ? desc : "",
+      name ? " (" : "", name ? capsdesc : "", name ? ")" : "");
+
+  g_free (capsdesc);
+}
+
+void
+describe_encoding_profile (GstEncodingProfile * profile)
+{
+  g_return_if_fail (GST_IS_ENCODING_PROFILE (profile));
+
+  print_profile (profile, "  ");
+  if (GST_IS_ENCODING_CONTAINER_PROFILE (profile)) {
+    const GList *tmp;
+
+    for (tmp =
+        gst_encoding_container_profile_get_profiles
+        (GST_ENCODING_CONTAINER_PROFILE (profile)); tmp; tmp = tmp->next)
+      print_profile (tmp->data, "    - ");
+  }
+
+}
diff --git a/tools/utils.h b/tools/utils.h
new file mode 100644
index 000000000..106ec45ec
--- /dev/null
+++ b/tools/utils.h
@@ -0,0 +1,21 @@
+#ifndef __GST_TRANSCODER_UTILS_H
+#define __GST_TRANSCODER_UTILS_H
+
+#include "utils.h"
+#include <gst/gst.h>
+#include <gst/pbutils/pbutils.h>
+#include <gst/pbutils/encoding-profile.h>
+
+void print (GstDebugColorFlags c, gboolean err, gboolean nline, const gchar * format, va_list var_args);
+void ok (const gchar * format, ...);
+void warn (const gchar * format, ...);
+void error (const gchar * format, ...);
+
+gchar * ensure_uri (const gchar * location);
+gchar * get_file_extension (gchar * uri);
+
+GList * get_usable_profiles (GstEncodingTarget * target);
+GstEncodingProfile * create_encoding_profile (const gchar * pname);
+void describe_encoding_profile (GstEncodingProfile *profile);
+
+#endif /*__GST_TRANSCODER_UTILS_H*/