tools/gst-launch.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *               2000 Wim Taymans <wtay@chello.be>
   4  *               2004 Thomas Vander Stichele <thomas@apestaart.org>
   5  *
   6  * gst-launch.c: tool to launch GStreamer pipelines from the command line
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 /* FIXME: hack alert */
  29 #ifdef HAVE_WIN32
  30 #define DISABLE_FAULT_HANDLER
  31 #endif
  32
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <signal.h>
  36 #ifdef HAVE_UNISTD_H
  37 #include <unistd.h>
  38 #endif
  39 #ifndef DISABLE_FAULT_HANDLER
  40 #include <sys/wait.h>
  41 #endif
  42 #include <locale.h>             /* for LC_ALL */
  43 #include "tools.h"
  44
  45 /* FIXME: This is just a temporary hack.  We should have a better
  46  * check for siginfo handling. */
  47 #ifdef SA_SIGINFO
  48 #define USE_SIGINFO
  49 #endif
  50
  51 extern volatile gboolean glib_on_error_halt;
  52
  53 #ifndef DISABLE_FAULT_HANDLER
  54 static void fault_restore (void);
  55 static void fault_spin (void);
  56 static void sigint_restore (void);
  57 static gboolean caught_intr = FALSE;
  58 #endif
  59
  60 /* event_loop return codes */
  61 typedef enum _EventLoopResult
  62 {
  63   ELR_NO_ERROR = 0,
  64   ELR_ERROR,
  65   ELR_INTERRUPT
  66 } EventLoopResult;
  67
  68 static GstElement *pipeline;
  69 static EventLoopResult caught_error = ELR_NO_ERROR;
  70 static gboolean quiet = FALSE;
  71 static gboolean tags = FALSE;
  72 static gboolean messages = FALSE;
  73 static gboolean is_live = FALSE;
  74 static gboolean waiting_eos = FALSE;
  75
  76 /* convenience macro so we don't have to litter the code with if(!quiet) */
  77 #define PRINT if(!quiet)g_print
  78
  79 #ifndef DISABLE_FAULT_HANDLER
  80 #ifndef USE_SIGINFO
  81 static void
  82 fault_handler_sighandler (int signum)
  83 {
  84   fault_restore ();
  85
  86   /* printf is used instead of g_print(), since it's less likely to
  87    * deadlock */
  88   switch (signum) {
  89     case SIGSEGV:
  90       fprintf (stderr, "Caught SIGSEGV\n");
  91       break;
  92     case SIGQUIT:
  93       if (!quiet)
  94         printf ("Caught SIGQUIT\n");
  95       break;
  96     default:
  97       fprintf (stderr, "signo:  %d\n", signum);
  98       break;
  99   }
 100
 101   fault_spin ();
 102 }
 103
 104 #else /* USE_SIGINFO */
 105
 106 static void
 107 fault_handler_sigaction (int signum, siginfo_t * si, void *misc)
 108 {
 109   fault_restore ();
 110
 111   /* printf is used instead of g_print(), since it's less likely to
 112    * deadlock */
 113   switch (si->si_signo) {
 114     case SIGSEGV:
 115       fprintf (stderr, "Caught SIGSEGV accessing address %p\n", si->si_addr);
 116       break;
 117     case SIGQUIT:
 118       if (!quiet)
 119         printf ("Caught SIGQUIT\n");
 120       break;
 121     default:
 122       fprintf (stderr, "signo:  %d\n", si->si_signo);
 123       fprintf (stderr, "errno:  %d\n", si->si_errno);
 124       fprintf (stderr, "code:   %d\n", si->si_code);
 125       break;
 126   }
 127
 128   fault_spin ();
 129 }
 130 #endif /* USE_SIGINFO */
 131
 132 static void
 133 fault_spin (void)
 134 {
 135   int spinning = TRUE;
 136
 137   glib_on_error_halt = FALSE;
 138   g_on_error_stack_trace ("gst-launch");
 139
 140   wait (NULL);
 141
 142   /* FIXME how do we know if we were run by libtool? */
 143   fprintf (stderr,
 144       "Spinning.  Please run 'gdb gst-launch %d' to continue debugging, "
 145       "Ctrl-C to quit, or Ctrl-\\ to dump core.\n", (gint) getpid ());
 146   while (spinning)
 147     g_usleep (1000000);
 148 }
 149
 150 static void
 151 fault_restore (void)
 152 {
 153   struct sigaction action;
 154
 155   memset (&action, 0, sizeof (action));
 156   action.sa_handler = SIG_DFL;
 157
 158   sigaction (SIGSEGV, &action, NULL);
 159   sigaction (SIGQUIT, &action, NULL);
 160 }
 161
 162 static void
 163 fault_setup (void)
 164 {
 165   struct sigaction action;
 166
 167   memset (&action, 0, sizeof (action));
 168 #ifdef USE_SIGINFO
 169   action.sa_sigaction = fault_handler_sigaction;
 170   action.sa_flags = SA_SIGINFO;
 171 #else
 172   action.sa_handler = fault_handler_sighandler;
 173 #endif
 174
 175   sigaction (SIGSEGV, &action, NULL);
 176   sigaction (SIGQUIT, &action, NULL);
 177 }
 178 #endif /* DISABLE_FAULT_HANDLER */
 179
 180 typedef struct _GstIndexStats
 181 {
 182   gint id;
 183   gchar *desc;
 184
 185   guint num_frames;
 186   guint num_keyframes;
 187   guint num_dltframes;
 188   GstClockTime last_keyframe;
 189   GstClockTime last_dltframe;
 190   GstClockTime min_keyframe_gap;
 191   GstClockTime max_keyframe_gap;
 192   GstClockTime avg_keyframe_gap;
 193 } GstIndexStats;
 194
 195 static void
 196 entry_added (GstIndex * index, GstIndexEntry * entry, gpointer user_data)
 197 {
 198   GPtrArray *index_stats = (GPtrArray *) user_data;
 199   GstIndexStats *s;
 200
 201   switch (entry->type) {
 202     case GST_INDEX_ENTRY_ID:
 203       /* we have a new writer */
 204       GST_DEBUG_OBJECT (index, "id %d: describes writer %s", entry->id,
 205           GST_INDEX_ID_DESCRIPTION (entry));
 206       if (entry->id >= index_stats->len) {
 207         g_ptr_array_set_size (index_stats, entry->id + 1);
 208       }
 209       s = g_new (GstIndexStats, 1);
 210       s->id = entry->id;
 211       s->desc = g_strdup (GST_INDEX_ID_DESCRIPTION (entry));
 212       s->num_frames = s->num_keyframes = s->num_dltframes = 0;
 213       s->last_keyframe = s->last_dltframe = GST_CLOCK_TIME_NONE;
 214       s->min_keyframe_gap = s->max_keyframe_gap = s->avg_keyframe_gap =
 215           GST_CLOCK_TIME_NONE;
 216       g_ptr_array_index (index_stats, entry->id) = s;
 217       break;
 218     case GST_INDEX_ENTRY_FORMAT:
 219       /* have not found any code calling this */
 220       GST_DEBUG_OBJECT (index, "id %d: registered format %d for %s\n",
 221           entry->id, GST_INDEX_FORMAT_FORMAT (entry),
 222           GST_INDEX_FORMAT_KEY (entry));
 223       break;
 224     case GST_INDEX_ENTRY_ASSOCIATION:
 225     {
 226       gint64 ts;
 227       GstAssocFlags flags = GST_INDEX_ASSOC_FLAGS (entry);
 228
 229       s = g_ptr_array_index (index_stats, entry->id);
 230       gst_index_entry_assoc_map (entry, GST_FORMAT_TIME, &ts);
 231
 232       if (flags & GST_ASSOCIATION_FLAG_KEY_UNIT) {
 233         s->num_keyframes++;
 234
 235         if (GST_CLOCK_TIME_IS_VALID (ts)) {
 236           if (GST_CLOCK_TIME_IS_VALID (s->last_keyframe)) {
 237             GstClockTimeDiff d = GST_CLOCK_DIFF (s->last_keyframe, ts);
 238
 239             if (G_UNLIKELY (d < 0)) {
 240               GST_WARNING ("received out-of-order keyframe at %"
 241                   GST_TIME_FORMAT, GST_TIME_ARGS (ts));
 242               /* FIXME: does it still make sense to use that for the statistics */
 243               d = GST_CLOCK_DIFF (ts, s->last_keyframe);
 244             }
 245
 246             if (GST_CLOCK_TIME_IS_VALID (s->min_keyframe_gap)) {
 247               if (d < s->min_keyframe_gap)
 248                 s->min_keyframe_gap = d;
 249             } else {
 250               s->min_keyframe_gap = d;
 251             }
 252             if (GST_CLOCK_TIME_IS_VALID (s->max_keyframe_gap)) {
 253               if (d > s->max_keyframe_gap)
 254                 s->max_keyframe_gap = d;
 255             } else {
 256               s->max_keyframe_gap = d;
 257             }
 258             if (GST_CLOCK_TIME_IS_VALID (s->avg_keyframe_gap)) {
 259               s->avg_keyframe_gap = (d + s->num_frames * s->avg_keyframe_gap) /
 260                   (s->num_frames + 1);
 261             } else {
 262               s->avg_keyframe_gap = d;
 263             }
 264           }
 265           s->last_keyframe = ts;
 266         }
 267       }
 268       if (flags & GST_ASSOCIATION_FLAG_DELTA_UNIT) {
 269         s->num_dltframes++;
 270         if (GST_CLOCK_TIME_IS_VALID (ts)) {
 271           s->last_dltframe = ts;
 272         }
 273       }
 274       s->num_frames++;
 275
 276       break;
 277     }
 278     default:
 279       break;
 280   }
 281 }
 282
 283 /* print statistics from the entry_added callback, free the entries */
 284 static void
 285 print_index_stats (GPtrArray * index_stats)
 286 {
 287   gint i;
 288
 289   if (index_stats->len) {
 290     g_print ("%s:\n", _("Index statistics"));
 291   }
 292
 293   for (i = 0; i < index_stats->len; i++) {
 294     GstIndexStats *s = g_ptr_array_index (index_stats, i);
 295     if (s) {
 296       g_print ("id %d, %s\n", s->id, s->desc);
 297       if (s->num_frames) {
 298         GstClockTime last_frame = s->last_keyframe;
 299
 300         if (GST_CLOCK_TIME_IS_VALID (s->last_dltframe)) {
 301           if (!GST_CLOCK_TIME_IS_VALID (last_frame) ||
 302               (s->last_dltframe > last_frame))
 303             last_frame = s->last_dltframe;
 304         }
 305
 306         if (GST_CLOCK_TIME_IS_VALID (last_frame)) {
 307           g_print ("  total time               = %" GST_TIME_FORMAT "\n",
 308               GST_TIME_ARGS (last_frame));
 309         }
 310         g_print ("  frame/keyframe rate      = %u / %u = ", s->num_frames,
 311             s->num_keyframes);
 312         if (s->num_keyframes)
 313           g_print ("%lf\n", s->num_frames / (gdouble) s->num_keyframes);
 314         else
 315           g_print ("-\n");
 316         if (s->num_keyframes) {
 317           g_print ("  min/avg/max keyframe gap = %" GST_TIME_FORMAT ", %"
 318               GST_TIME_FORMAT ", %" GST_TIME_FORMAT "\n",
 319               GST_TIME_ARGS (s->min_keyframe_gap),
 320               GST_TIME_ARGS (s->avg_keyframe_gap),
 321               GST_TIME_ARGS (s->max_keyframe_gap));
 322         }
 323       } else {
 324         g_print ("  no stats\n");
 325       }
 326
 327       g_free (s->desc);
 328       g_free (s);
 329     }
 330   }
 331 }
 332
 333 /* Kids, use the functions from libgstpbutils in gst-plugins-base in your
 334  * own code (we can't do that here because it would introduce a circular
 335  * dependency) */
 336 static gboolean
 337 gst_is_missing_plugin_message (GstMessage * msg)
 338 {
 339   if (GST_MESSAGE_TYPE (msg) != GST_MESSAGE_ELEMENT
 340       || gst_message_get_structure (msg) == NULL)
 341     return FALSE;
 342
 343   return gst_structure_has_name (gst_message_get_structure (msg),
 344       "missing-plugin");
 345 }
 346
 347 static const gchar *
 348 gst_missing_plugin_message_get_description (GstMessage * msg)
 349 {
 350   return gst_structure_get_string (gst_message_get_structure (msg), "name");
 351 }
 352
 353 static void
 354 print_error_message (GstMessage * msg)
 355 {
 356   GError *err = NULL;
 357   gchar *name, *debug = NULL;
 358
 359   name = gst_object_get_path_string (msg->src);
 360   gst_message_parse_error (msg, &err, &debug);
 361
 362   g_printerr (_("ERROR: from element %s: %s\n"), name, err->message);
 363   if (debug != NULL)
 364     g_printerr (_("Additional debug info:\n%s\n"), debug);
 365
 366   g_error_free (err);
 367   g_free (debug);
 368   g_free (name);
 369 }
 370
 371 static void
 372 print_tag (const GstTagList * list, const gchar * tag, gpointer unused)
 373 {
 374   gint i, count;
 375
 376   count = gst_tag_list_get_tag_size (list, tag);
 377
 378   for (i = 0; i < count; i++) {
 379     gchar *str;
 380
 381     if (gst_tag_get_type (tag) == G_TYPE_STRING) {
 382       if (!gst_tag_list_get_string_index (list, tag, i, &str))
 383         g_assert_not_reached ();
 384     } else if (gst_tag_get_type (tag) == GST_TYPE_BUFFER) {
 385       GstBuffer *img;
 386
 387       img = gst_value_get_buffer (gst_tag_list_get_value_index (list, tag, i));
 388       if (img) {
 389         gchar *caps_str;
 390
 391         caps_str = g_strdup ("unknown");
 392         str = g_strdup_printf ("buffer of %" G_GSIZE_FORMAT " bytes, type: %s",
 393             gst_buffer_get_size (img), caps_str);
 394         g_free (caps_str);
 395       } else {
 396         str = g_strdup ("NULL buffer");
 397       }
 398     } else if (gst_tag_get_type (tag) == GST_TYPE_DATE_TIME) {
 399       GstDateTime *dt = NULL;
 400
 401       gst_tag_list_get_date_time_index (list, tag, i, &dt);
 402       if (gst_date_time_get_hour (dt) < 0) {
 403         str = g_strdup_printf ("%02u-%02u-%04u", gst_date_time_get_day (dt),
 404             gst_date_time_get_month (dt), gst_date_time_get_year (dt));
 405       } else {
 406         gdouble tz_offset = gst_date_time_get_time_zone_offset (dt);
 407         gchar tz_str[32];
 408
 409         if (tz_offset != 0.0) {
 410           g_snprintf (tz_str, sizeof (tz_str), "(UTC %s%gh)",
 411               (tz_offset > 0.0) ? "+" : "", tz_offset);
 412         } else {
 413           g_snprintf (tz_str, sizeof (tz_str), "(UTC)");
 414         }
 415
 416         str = g_strdup_printf ("%04u-%02u-%02u %02u:%02u:%02u %s",
 417             gst_date_time_get_year (dt), gst_date_time_get_month (dt),
 418             gst_date_time_get_day (dt), gst_date_time_get_hour (dt),
 419             gst_date_time_get_minute (dt), gst_date_time_get_second (dt),
 420             tz_str);
 421       }
 422       gst_date_time_unref (dt);
 423     } else {
 424       str =
 425           g_strdup_value_contents (gst_tag_list_get_value_index (list, tag, i));
 426     }
 427
 428     if (i == 0) {
 429       PRINT ("%16s: %s\n", gst_tag_get_nick (tag), str);
 430     } else {
 431       PRINT ("%16s: %s\n", "", str);
 432     }
 433
 434     g_free (str);
 435   }
 436 }
 437
 438 #ifndef DISABLE_FAULT_HANDLER
 439 /* we only use sighandler here because the registers are not important */
 440 static void
 441 sigint_handler_sighandler (int signum)
 442 {
 443   PRINT ("Caught interrupt -- ");
 444
 445   /* If we were waiting for an EOS, we still want to catch
 446    * the next signal to shutdown properly (and the following one
 447    * will quit the program). */
 448   if (waiting_eos) {
 449     waiting_eos = FALSE;
 450   } else {
 451     sigint_restore ();
 452   }
 453   /* we set a flag that is checked by the mainloop, we cannot do much in the
 454    * interrupt handler (no mutex or other blocking stuff) */
 455   caught_intr = TRUE;
 456 }
 457
 458 /* is called every 250 milliseconds (4 times a second), the interrupt handler
 459  * will set a flag for us. We react to this by posting a message. */
 460 static gboolean
 461 check_intr (GstElement * pipeline)
 462 {
 463   if (!caught_intr) {
 464     return TRUE;
 465   } else {
 466     caught_intr = FALSE;
 467     PRINT ("handling interrupt.\n");
 468
 469     /* post an application specific message */
 470     gst_element_post_message (GST_ELEMENT (pipeline),
 471         gst_message_new_application (GST_OBJECT (pipeline),
 472             gst_structure_new ("GstLaunchInterrupt",
 473                 "message", G_TYPE_STRING, "Pipeline interrupted", NULL)));
 474
 475     /* remove timeout handler */
 476     return FALSE;
 477   }
 478 }
 479
 480 static void
 481 sigint_setup (void)
 482 {
 483   struct sigaction action;
 484
 485   memset (&action, 0, sizeof (action));
 486   action.sa_handler = sigint_handler_sighandler;
 487
 488   sigaction (SIGINT, &action, NULL);
 489 }
 490
 491 static void
 492 sigint_restore (void)
 493 {
 494   struct sigaction action;
 495
 496   memset (&action, 0, sizeof (action));
 497   action.sa_handler = SIG_DFL;
 498
 499   sigaction (SIGINT, &action, NULL);
 500 }
 501 #endif /* DISABLE_FAULT_HANDLER */
 502
 503 /* returns ELR_ERROR if there was an error
 504  * or ELR_INTERRUPT if we caught a keyboard interrupt
 505  * or ELR_NO_ERROR otherwise. */
 506 static EventLoopResult
 507 event_loop (GstElement * pipeline, gboolean blocking, GstState target_state)
 508 {
 509 #ifndef DISABLE_FAULT_HANDLER
 510   gulong timeout_id;
 511 #endif
 512   GstBus *bus;
 513   GstMessage *message = NULL;
 514   EventLoopResult res = ELR_NO_ERROR;
 515   gboolean buffering = FALSE;
 516
 517   bus = gst_element_get_bus (GST_ELEMENT (pipeline));
 518
 519 #ifndef DISABLE_FAULT_HANDLER
 520   timeout_id = g_timeout_add (250, (GSourceFunc) check_intr, pipeline);
 521 #endif
 522
 523   while (TRUE) {
 524     message = gst_bus_poll (bus, GST_MESSAGE_ANY, blocking ? -1 : 0);
 525
 526     /* if the poll timed out, only when !blocking */
 527     if (message == NULL)
 528       goto exit;
 529
 530     /* check if we need to dump messages to the console */
 531     if (messages) {
 532       GstObject *src_obj;
 533       const GstStructure *s;
 534       guint32 seqnum;
 535
 536       seqnum = gst_message_get_seqnum (message);
 537
 538       s = gst_message_get_structure (message);
 539
 540       src_obj = GST_MESSAGE_SRC (message);
 541
 542       if (GST_IS_ELEMENT (src_obj)) {
 543         PRINT (_("Got message #%u from element \"%s\" (%s): "),
 544             (guint) seqnum, GST_ELEMENT_NAME (src_obj),
 545             GST_MESSAGE_TYPE_NAME (message));
 546       } else if (GST_IS_PAD (src_obj)) {
 547         PRINT (_("Got message #%u from pad \"%s:%s\" (%s): "),
 548             (guint) seqnum, GST_DEBUG_PAD_NAME (src_obj),
 549             GST_MESSAGE_TYPE_NAME (message));
 550       } else if (GST_IS_OBJECT (src_obj)) {
 551         PRINT (_("Got message #%u from object \"%s\" (%s): "),
 552             (guint) seqnum, GST_OBJECT_NAME (src_obj),
 553             GST_MESSAGE_TYPE_NAME (message));
 554       } else {
 555         PRINT (_("Got message #%u (%s): "), (guint) seqnum,
 556             GST_MESSAGE_TYPE_NAME (message));
 557       }
 558
 559       if (s) {
 560         gchar *sstr;
 561
 562         sstr = gst_structure_to_string (s);
 563         PRINT ("%s\n", sstr);
 564         g_free (sstr);
 565       } else {
 566         PRINT ("no message details\n");
 567       }
 568     }
 569
 570     switch (GST_MESSAGE_TYPE (message)) {
 571       case GST_MESSAGE_NEW_CLOCK:
 572       {
 573         GstClock *clock;
 574
 575         gst_message_parse_new_clock (message, &clock);
 576
 577         PRINT ("New clock: %s\n", (clock ? GST_OBJECT_NAME (clock) : "NULL"));
 578         break;
 579       }
 580       case GST_MESSAGE_CLOCK_LOST:
 581         PRINT ("Clock lost, selecting a new one\n");
 582         gst_element_set_state (pipeline, GST_STATE_PAUSED);
 583         gst_element_set_state (pipeline, GST_STATE_PLAYING);
 584         break;
 585       case GST_MESSAGE_EOS:{
 586         waiting_eos = FALSE;
 587         PRINT (_("Got EOS from element \"%s\".\n"),
 588             GST_MESSAGE_SRC_NAME (message));
 589         goto exit;
 590       }
 591       case GST_MESSAGE_TAG:
 592         if (tags) {
 593           GstTagList *tags;
 594
 595           if (GST_IS_ELEMENT (GST_MESSAGE_SRC (message))) {
 596             PRINT (_("FOUND TAG      : found by element \"%s\".\n"),
 597                 GST_MESSAGE_SRC_NAME (message));
 598           } else if (GST_IS_PAD (GST_MESSAGE_SRC (message))) {
 599             PRINT (_("FOUND TAG      : found by pad \"%s:%s\".\n"),
 600                 GST_DEBUG_PAD_NAME (GST_MESSAGE_SRC (message)));
 601           } else if (GST_IS_OBJECT (GST_MESSAGE_SRC (message))) {
 602             PRINT (_("FOUND TAG      : found by object \"%s\".\n"),
 603                 GST_MESSAGE_SRC_NAME (message));
 604           } else {
 605             PRINT (_("FOUND TAG\n"));
 606           }
 607
 608           gst_message_parse_tag (message, &tags);
 609           gst_tag_list_foreach (tags, print_tag, NULL);
 610           gst_tag_list_free (tags);
 611         }
 612         break;
 613       case GST_MESSAGE_INFO:{
 614         GError *gerror;
 615         gchar *debug;
 616         gchar *name = gst_object_get_path_string (GST_MESSAGE_SRC (message));
 617
 618         gst_message_parse_info (message, &gerror, &debug);
 619         if (debug) {
 620           PRINT (_("INFO:\n%s\n"), debug);
 621         }
 622         g_error_free (gerror);
 623         g_free (debug);
 624         g_free (name);
 625         break;
 626       }
 627       case GST_MESSAGE_WARNING:{
 628         GError *gerror;
 629         gchar *debug;
 630         gchar *name = gst_object_get_path_string (GST_MESSAGE_SRC (message));
 631
 632         /* dump graph on warning */
 633         GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (pipeline),
 634             GST_DEBUG_GRAPH_SHOW_ALL, "gst-launch.warning");
 635
 636         gst_message_parse_warning (message, &gerror, &debug);
 637         PRINT (_("WARNING: from element %s: %s\n"), name, gerror->message);
 638         if (debug) {
 639           PRINT (_("Additional debug info:\n%s\n"), debug);
 640         }
 641         g_error_free (gerror);
 642         g_free (debug);
 643         g_free (name);
 644         break;
 645       }
 646       case GST_MESSAGE_ERROR:{
 647         /* dump graph on error */
 648         GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (pipeline),
 649             GST_DEBUG_GRAPH_SHOW_ALL, "gst-launch.error");
 650
 651         print_error_message (message);
 652
 653         /* we have an error */
 654         res = ELR_ERROR;
 655         goto exit;
 656       }
 657       case GST_MESSAGE_STATE_CHANGED:{
 658         GstState old, new, pending;
 659
 660         /* we only care about pipeline state change messages */
 661         if (GST_MESSAGE_SRC (message) != GST_OBJECT_CAST (pipeline))
 662           break;
 663
 664         /* ignore when we are buffering since then we mess with the states
 665          * ourselves. */
 666         if (buffering) {
 667           PRINT (_("Prerolled, waiting for buffering to finish...\n"));
 668           break;
 669         }
 670
 671         gst_message_parse_state_changed (message, &old, &new, &pending);
 672
 673         /* if we reached the final target state, exit */
 674         if (target_state == GST_STATE_PAUSED && new == target_state)
 675           goto exit;
 676
 677         /* else not an interesting message */
 678         break;
 679       }
 680       case GST_MESSAGE_BUFFERING:{
 681         gint percent;
 682
 683         gst_message_parse_buffering (message, &percent);
 684         PRINT ("%s %d%%  \r", _("buffering..."), percent);
 685
 686         /* no state management needed for live pipelines */
 687         if (is_live)
 688           break;
 689
 690         if (percent == 100) {
 691           /* a 100% message means buffering is done */
 692           buffering = FALSE;
 693           /* if the desired state is playing, go back */
 694           if (target_state == GST_STATE_PLAYING) {
 695             PRINT (_("Done buffering, setting pipeline to PLAYING ...\n"));
 696             gst_element_set_state (pipeline, GST_STATE_PLAYING);
 697           } else
 698             goto exit;
 699         } else {
 700           /* buffering busy */
 701           if (buffering == FALSE && target_state == GST_STATE_PLAYING) {
 702             /* we were not buffering but PLAYING, PAUSE  the pipeline. */
 703             PRINT (_("Buffering, setting pipeline to PAUSED ...\n"));
 704             gst_element_set_state (pipeline, GST_STATE_PAUSED);
 705           }
 706           buffering = TRUE;
 707         }
 708         break;
 709       }
 710       case GST_MESSAGE_LATENCY:
 711       {
 712         PRINT (_("Redistribute latency...\n"));
 713         gst_bin_recalculate_latency (GST_BIN (pipeline));
 714         break;
 715       }
 716       case GST_MESSAGE_REQUEST_STATE:
 717       {
 718         GstState state;
 719         gchar *name = gst_object_get_path_string (GST_MESSAGE_SRC (message));
 720
 721         gst_message_parse_request_state (message, &state);
 722
 723         PRINT (_("Setting state to %s as requested by %s...\n"),
 724             gst_element_state_get_name (state), name);
 725
 726         gst_element_set_state (pipeline, state);
 727
 728         g_free (name);
 729         break;
 730       }
 731       case GST_MESSAGE_APPLICATION:{
 732         const GstStructure *s;
 733
 734         s = gst_message_get_structure (message);
 735
 736         if (gst_structure_has_name (s, "GstLaunchInterrupt")) {
 737           /* this application message is posted when we caught an interrupt and
 738            * we need to stop the pipeline. */
 739           PRINT (_("Interrupt: Stopping pipeline ...\n"));
 740           res = ELR_INTERRUPT;
 741           goto exit;
 742         }
 743         break;
 744       }
 745       case GST_MESSAGE_ELEMENT:{
 746         if (gst_is_missing_plugin_message (message)) {
 747           const gchar *desc;
 748
 749           desc = gst_missing_plugin_message_get_description (message);
 750           PRINT (_("Missing element: %s\n"), desc ? desc : "(no description)");
 751         }
 752         break;
 753       }
 754       default:
 755         /* just be quiet by default */
 756         break;
 757     }
 758     if (message)
 759       gst_message_unref (message);
 760   }
 761   g_assert_not_reached ();
 762
 763 exit:
 764   {
 765     if (message)
 766       gst_message_unref (message);
 767     gst_object_unref (bus);
 768 #ifndef DISABLE_FAULT_HANDLER
 769     g_source_remove (timeout_id);
 770 #endif
 771     return res;
 772   }
 773 }
 774
 775 static GstBusSyncReply
 776 bus_sync_handler (GstBus * bus, GstMessage * message, gpointer data)
 777 {
 778   GstElement *pipeline = (GstElement *) data;
 779
 780   switch (GST_MESSAGE_TYPE (message)) {
 781     case GST_MESSAGE_STATE_CHANGED:
 782       /* we only care about pipeline state change messages */
 783       if (GST_MESSAGE_SRC (message) == GST_OBJECT_CAST (pipeline)) {
 784         GstState old, new, pending;
 785         gchar *state_transition_name;
 786
 787         gst_message_parse_state_changed (message, &old, &new, &pending);
 788
 789         state_transition_name = g_strdup_printf ("%s_%s",
 790             gst_element_state_get_name (old), gst_element_state_get_name (new));
 791
 792         /* dump graph for (some) pipeline state changes */
 793         {
 794           gchar *dump_name = g_strconcat ("gst-launch.", state_transition_name,
 795               NULL);
 796           GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (pipeline),
 797               GST_DEBUG_GRAPH_SHOW_ALL, dump_name);
 798           g_free (dump_name);
 799         }
 800
 801         /* place a marker into e.g. strace logs */
 802         {
 803           gchar *access_name = g_strconcat (g_get_tmp_dir (), G_DIR_SEPARATOR_S,
 804               "gst-launch", G_DIR_SEPARATOR_S, state_transition_name, NULL);
 805           g_file_test (access_name, G_FILE_TEST_EXISTS);
 806           g_free (access_name);
 807         }
 808
 809         g_free (state_transition_name);
 810       }
 811     default:
 812       break;
 813   }
 814   return GST_BUS_PASS;
 815 }
 816
 817 int
 818 main (int argc, char *argv[])
 819 {
 820   /* options */
 821   gboolean verbose = FALSE;
 822   gboolean no_fault = FALSE;
 823   gboolean trace = FALSE;
 824   gboolean eos_on_shutdown = FALSE;
 825   gboolean check_index = FALSE;
 826   gchar *savefile = NULL;
 827   gchar *exclude_args = NULL;
 828 #ifndef GST_DISABLE_OPTION_PARSING
 829   GOptionEntry options[] = {
 830     {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
 831         N_("Output tags (also known as metadata)"), NULL},
 832     {"verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose,
 833         N_("Output status information and property notifications"), NULL},
 834     {"quiet", 'q', 0, G_OPTION_ARG_NONE, &quiet,
 835         N_("Do not print any progress information"), NULL},
 836     {"messages", 'm', 0, G_OPTION_ARG_NONE, &messages,
 837         N_("Output messages"), NULL},
 838     {"exclude", 'X', 0, G_OPTION_ARG_NONE, &exclude_args,
 839         N_("Do not output status information of TYPE"), N_("TYPE1,TYPE2,...")},
 840     {"no-fault", 'f', 0, G_OPTION_ARG_NONE, &no_fault,
 841         N_("Do not install a fault handler"), NULL},
 842     {"trace", 'T', 0, G_OPTION_ARG_NONE, &trace,
 843         N_("Print alloc trace (if enabled at compile time)"), NULL},
 844     {"eos-on-shutdown", 'e', 0, G_OPTION_ARG_NONE, &eos_on_shutdown,
 845         N_("Force EOS on sources before shutting the pipeline down"), NULL},
 846     {"index", 'i', 0, G_OPTION_ARG_NONE, &check_index,
 847         N_("Gather and print index statistics"), NULL},
 848     GST_TOOLS_GOPTION_VERSION,
 849     {NULL}
 850   };
 851   GOptionContext *ctx;
 852   GError *err = NULL;
 853 #endif
 854   GstIndex *index;
 855   GPtrArray *index_stats = NULL;
 856   gchar **argvn;
 857   GError *error = NULL;
 858   gint res = 0;
 859
 860   free (malloc (8));            /* -lefence */
 861
 862 #ifdef ENABLE_NLS
 863   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
 864   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
 865   textdomain (GETTEXT_PACKAGE);
 866 #endif
 867
 868 #if !GLIB_CHECK_VERSION (2, 31, 0)
 869   g_thread_init (NULL);
 870 #endif
 871
 872   gst_tools_set_prgname ("gst-launch");
 873
 874 #ifndef GST_DISABLE_OPTION_PARSING
 875   ctx = g_option_context_new ("PIPELINE-DESCRIPTION");
 876   g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
 877   g_option_context_add_group (ctx, gst_init_get_option_group ());
 878   if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
 879     if (err)
 880       g_printerr ("Error initializing: %s\n", GST_STR_NULL (err->message));
 881     else
 882       g_printerr ("Error initializing: Unknown error!\n");
 883     exit (1);
 884   }
 885   g_option_context_free (ctx);
 886 #else
 887   gst_init (&argc, &argv);
 888 #endif
 889
 890   gst_tools_print_version ("gst-launch");
 891
 892 #ifndef DISABLE_FAULT_HANDLER
 893   if (!no_fault)
 894     fault_setup ();
 895
 896   sigint_setup ();
 897 #endif
 898
 899   if (trace) {
 900     if (!gst_alloc_trace_available ()) {
 901       g_warning ("Trace not available (recompile with trace enabled).");
 902     }
 903     gst_alloc_trace_set_flags_all (GST_ALLOC_TRACE_LIVE |
 904         GST_ALLOC_TRACE_MEM_LIVE);
 905     gst_alloc_trace_print_live ();
 906   }
 907
 908   /* make a null-terminated version of argv */
 909   argvn = g_new0 (char *, argc);
 910   memcpy (argvn, argv + 1, sizeof (char *) * (argc - 1));
 911   {
 912     pipeline =
 913         (GstElement *) gst_parse_launchv ((const gchar **) argvn, &error);
 914   }
 915   g_free (argvn);
 916
 917   if (!pipeline) {
 918     if (error) {
 919       g_printerr (_("ERROR: pipeline could not be constructed: %s.\n"),
 920           GST_STR_NULL (error->message));
 921       g_error_free (error);
 922     } else {
 923       g_printerr (_("ERROR: pipeline could not be constructed.\n"));
 924     }
 925     return 1;
 926   } else if (error) {
 927     g_printerr (_("WARNING: erroneous pipeline: %s\n"),
 928         GST_STR_NULL (error->message));
 929     g_error_free (error);
 930     return 1;
 931   }
 932
 933   if (verbose) {
 934     gchar **exclude_list =
 935         exclude_args ? g_strsplit (exclude_args, ",", 0) : NULL;
 936     g_signal_connect (pipeline, "deep-notify",
 937         G_CALLBACK (gst_object_default_deep_notify), exclude_list);
 938   }
 939
 940   if (!savefile) {
 941     GstState state, pending;
 942     GstStateChangeReturn ret;
 943     GstBus *bus;
 944
 945     /* If the top-level object is not a pipeline, place it in a pipeline. */
 946     if (!GST_IS_PIPELINE (pipeline)) {
 947       GstElement *real_pipeline = gst_element_factory_make ("pipeline", NULL);
 948
 949       if (real_pipeline == NULL) {
 950         g_printerr (_("ERROR: the 'pipeline' element wasn't found.\n"));
 951         return 1;
 952       }
 953       gst_bin_add (GST_BIN (real_pipeline), pipeline);
 954       pipeline = real_pipeline;
 955     }
 956
 957     if (check_index) {
 958       /* gst_index_new() creates a null-index, it does not store anything, but
 959        * the entry-added signal works and this is what we use to build the
 960        * statistics */
 961       index = gst_index_new ();
 962       if (index) {
 963         index_stats = g_ptr_array_new ();
 964         g_signal_connect (G_OBJECT (index), "entry-added",
 965             G_CALLBACK (entry_added), index_stats);
 966         g_object_set (G_OBJECT (index), "resolver", GST_INDEX_RESOLVER_GTYPE,
 967             NULL);
 968         gst_element_set_index (pipeline, index);
 969       }
 970     }
 971
 972     bus = gst_element_get_bus (pipeline);
 973     gst_bus_set_sync_handler (bus, bus_sync_handler, (gpointer) pipeline);
 974     gst_object_unref (bus);
 975
 976     PRINT (_("Setting pipeline to PAUSED ...\n"));
 977     ret = gst_element_set_state (pipeline, GST_STATE_PAUSED);
 978
 979     switch (ret) {
 980       case GST_STATE_CHANGE_FAILURE:
 981         g_printerr (_("ERROR: Pipeline doesn't want to pause.\n"));
 982         res = -1;
 983         event_loop (pipeline, FALSE, GST_STATE_VOID_PENDING);
 984         goto end;
 985       case GST_STATE_CHANGE_NO_PREROLL:
 986         PRINT (_("Pipeline is live and does not need PREROLL ...\n"));
 987         is_live = TRUE;
 988         break;
 989       case GST_STATE_CHANGE_ASYNC:
 990         PRINT (_("Pipeline is PREROLLING ...\n"));
 991         caught_error = event_loop (pipeline, TRUE, GST_STATE_PAUSED);
 992         if (caught_error) {
 993           g_printerr (_("ERROR: pipeline doesn't want to preroll.\n"));
 994           goto end;
 995         }
 996         state = GST_STATE_PAUSED;
 997         /* fallthrough */
 998       case GST_STATE_CHANGE_SUCCESS:
 999         PRINT (_("Pipeline is PREROLLED ...\n"));
1000         break;
1001     }
1002
1003     caught_error = event_loop (pipeline, FALSE, GST_STATE_PLAYING);
1004
1005     if (caught_error) {
1006       g_printerr (_("ERROR: pipeline doesn't want to preroll.\n"));
1007     } else {
1008       GstClockTime tfthen, tfnow;
1009       GstClockTimeDiff diff;
1010
1011       PRINT (_("Setting pipeline to PLAYING ...\n"));
1012
1013       if (gst_element_set_state (pipeline,
1014               GST_STATE_PLAYING) == GST_STATE_CHANGE_FAILURE) {
1015         GstMessage *err_msg;
1016         GstBus *bus;
1017
1018         g_printerr (_("ERROR: pipeline doesn't want to play.\n"));
1019         bus = gst_element_get_bus (pipeline);
1020         if ((err_msg = gst_bus_poll (bus, GST_MESSAGE_ERROR, 0))) {
1021           print_error_message (err_msg);
1022           gst_message_unref (err_msg);
1023         }
1024         gst_object_unref (bus);
1025         res = -1;
1026         goto end;
1027       }
1028
1029       tfthen = gst_util_get_timestamp ();
1030       caught_error = event_loop (pipeline, TRUE, GST_STATE_PLAYING);
1031       if (eos_on_shutdown && caught_error == ELR_INTERRUPT) {
1032         PRINT (_("EOS on shutdown enabled -- Forcing EOS on the pipeline\n"));
1033         waiting_eos = TRUE;
1034         gst_element_send_event (pipeline, gst_event_new_eos ());
1035         PRINT (_("Waiting for EOS...\n"));
1036         caught_error = event_loop (pipeline, TRUE, GST_STATE_PLAYING);
1037
1038         if (caught_error == ELR_NO_ERROR) {
1039           /* we got EOS */
1040           PRINT (_("EOS received - stopping pipeline...\n"));
1041         } else if (caught_error == ELR_ERROR) {
1042           PRINT (_("An error happened while waiting for EOS\n"));
1043         }
1044       }
1045       tfnow = gst_util_get_timestamp ();
1046
1047       diff = GST_CLOCK_DIFF (tfthen, tfnow);
1048
1049       PRINT (_("Execution ended after %" G_GUINT64_FORMAT " ns.\n"), diff);
1050     }
1051
1052     PRINT (_("Setting pipeline to PAUSED ...\n"));
1053     gst_element_set_state (pipeline, GST_STATE_PAUSED);
1054     if (caught_error == ELR_NO_ERROR)
1055       gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
1056
1057     /* iterate mainloop to process pending stuff */
1058     while (g_main_context_iteration (NULL, FALSE));
1059
1060     PRINT (_("Setting pipeline to READY ...\n"));
1061     gst_element_set_state (pipeline, GST_STATE_READY);
1062     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
1063
1064     if (check_index) {
1065       print_index_stats (index_stats);
1066       g_ptr_array_free (index_stats, TRUE);
1067     }
1068
1069   end:
1070     PRINT (_("Setting pipeline to NULL ...\n"));
1071     gst_element_set_state (pipeline, GST_STATE_NULL);
1072     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
1073   }
1074
1075   PRINT (_("Freeing pipeline ...\n"));
1076   gst_object_unref (pipeline);
1077
1078   gst_deinit ();
1079   if (trace)
1080     gst_alloc_trace_print_live ();
1081
1082   return res;
1083 }