Merge branch 'master' into 0.11
[platform/upstream/gstreamer.git] / 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 static void
334 print_error_message (GstMessage * msg)
335 {
336   GError *err = NULL;
337   gchar *name, *debug = NULL;
338
339   name = gst_object_get_path_string (msg->src);
340   gst_message_parse_error (msg, &err, &debug);
341
342   g_printerr (_("ERROR: from element %s: %s\n"), name, err->message);
343   if (debug != NULL)
344     g_printerr (_("Additional debug info:\n%s\n"), debug);
345
346   g_error_free (err);
347   g_free (debug);
348   g_free (name);
349 }
350
351 static void
352 print_tag (const GstTagList * list, const gchar * tag, gpointer unused)
353 {
354   gint i, count;
355
356   count = gst_tag_list_get_tag_size (list, tag);
357
358   for (i = 0; i < count; i++) {
359     gchar *str;
360
361     if (gst_tag_get_type (tag) == G_TYPE_STRING) {
362       if (!gst_tag_list_get_string_index (list, tag, i, &str))
363         g_assert_not_reached ();
364     } else if (gst_tag_get_type (tag) == GST_TYPE_BUFFER) {
365       GstBuffer *img;
366
367       img = gst_value_get_buffer (gst_tag_list_get_value_index (list, tag, i));
368       if (img) {
369         gchar *caps_str;
370
371         caps_str = GST_BUFFER_CAPS (img) ?
372             gst_caps_to_string (GST_BUFFER_CAPS (img)) : g_strdup ("unknown");
373         str = g_strdup_printf ("buffer of %" G_GSIZE_FORMAT " bytes, type: %s",
374             gst_buffer_get_size (img), caps_str);
375         g_free (caps_str);
376       } else {
377         str = g_strdup ("NULL buffer");
378       }
379     } else if (gst_tag_get_type (tag) == GST_TYPE_DATE_TIME) {
380       GstDateTime *dt = NULL;
381
382       gst_tag_list_get_date_time_index (list, tag, i, &dt);
383       if (gst_date_time_get_hour (dt) < 0) {
384         str = g_strdup_printf ("%02u-%02u-%04u", gst_date_time_get_day (dt),
385             gst_date_time_get_month (dt), gst_date_time_get_year (dt));
386       } else {
387         gdouble tz_offset = gst_date_time_get_time_zone_offset (dt);
388         gchar tz_str[32];
389
390         if (tz_offset != 0.0) {
391           g_snprintf (tz_str, sizeof (tz_str), "(UTC %s%gh)",
392               (tz_offset > 0.0) ? "+" : "", tz_offset);
393         } else {
394           g_snprintf (tz_str, sizeof (tz_str), "(UTC)");
395         }
396
397         str = g_strdup_printf ("%04u-%02u-%02u %02u:%02u:%02u %s",
398             gst_date_time_get_year (dt), gst_date_time_get_month (dt),
399             gst_date_time_get_day (dt), gst_date_time_get_hour (dt),
400             gst_date_time_get_minute (dt), gst_date_time_get_second (dt),
401             tz_str);
402       }
403       gst_date_time_unref (dt);
404     } else {
405       str =
406           g_strdup_value_contents (gst_tag_list_get_value_index (list, tag, i));
407     }
408
409     if (i == 0) {
410       PRINT ("%16s: %s\n", gst_tag_get_nick (tag), str);
411     } else {
412       PRINT ("%16s: %s\n", "", str);
413     }
414
415     g_free (str);
416   }
417 }
418
419 #ifndef DISABLE_FAULT_HANDLER
420 /* we only use sighandler here because the registers are not important */
421 static void
422 sigint_handler_sighandler (int signum)
423 {
424   PRINT ("Caught interrupt -- ");
425
426   /* If we were waiting for an EOS, we still want to catch
427    * the next signal to shutdown properly (and the following one
428    * will quit the program). */
429   if (waiting_eos) {
430     waiting_eos = FALSE;
431   } else {
432     sigint_restore ();
433   }
434   /* we set a flag that is checked by the mainloop, we cannot do much in the
435    * interrupt handler (no mutex or other blocking stuff) */
436   caught_intr = TRUE;
437 }
438
439 /* is called every 250 milliseconds (4 times a second), the interrupt handler
440  * will set a flag for us. We react to this by posting a message. */
441 static gboolean
442 check_intr (GstElement * pipeline)
443 {
444   if (!caught_intr) {
445     return TRUE;
446   } else {
447     caught_intr = FALSE;
448     PRINT ("handling interrupt.\n");
449
450     /* post an application specific message */
451     gst_element_post_message (GST_ELEMENT (pipeline),
452         gst_message_new_application (GST_OBJECT (pipeline),
453             gst_structure_new ("GstLaunchInterrupt",
454                 "message", G_TYPE_STRING, "Pipeline interrupted", NULL)));
455
456     /* remove timeout handler */
457     return FALSE;
458   }
459 }
460
461 static void
462 sigint_setup (void)
463 {
464   struct sigaction action;
465
466   memset (&action, 0, sizeof (action));
467   action.sa_handler = sigint_handler_sighandler;
468
469   sigaction (SIGINT, &action, NULL);
470 }
471
472 static void
473 sigint_restore (void)
474 {
475   struct sigaction action;
476
477   memset (&action, 0, sizeof (action));
478   action.sa_handler = SIG_DFL;
479
480   sigaction (SIGINT, &action, NULL);
481 }
482
483 /* FIXME 0.11: remove SIGUSR handling (also from man page) */
484 static void
485 play_handler (int signum)
486 {
487   switch (signum) {
488     case SIGUSR1:
489       PRINT ("Caught SIGUSR1 - Play request.\n");
490       gst_element_set_state (pipeline, GST_STATE_PLAYING);
491       break;
492     case SIGUSR2:
493       PRINT ("Caught SIGUSR2 - Stop request.\n");
494       gst_element_set_state (pipeline, GST_STATE_NULL);
495       break;
496   }
497 }
498
499 static void
500 play_signal_setup (void)
501 {
502   struct sigaction action;
503
504   memset (&action, 0, sizeof (action));
505   action.sa_handler = play_handler;
506   sigaction (SIGUSR1, &action, NULL);
507   sigaction (SIGUSR2, &action, NULL);
508 }
509 #endif /* DISABLE_FAULT_HANDLER */
510
511 /* returns ELR_ERROR if there was an error
512  * or ELR_INTERRUPT if we caught a keyboard interrupt
513  * or ELR_NO_ERROR otherwise. */
514 static EventLoopResult
515 event_loop (GstElement * pipeline, gboolean blocking, GstState target_state)
516 {
517 #ifndef DISABLE_FAULT_HANDLER
518   gulong timeout_id;
519 #endif
520   GstBus *bus;
521   GstMessage *message = NULL;
522   EventLoopResult res = ELR_NO_ERROR;
523   gboolean buffering = FALSE;
524
525   bus = gst_element_get_bus (GST_ELEMENT (pipeline));
526
527 #ifndef DISABLE_FAULT_HANDLER
528   timeout_id = g_timeout_add (250, (GSourceFunc) check_intr, pipeline);
529 #endif
530
531   while (TRUE) {
532     message = gst_bus_poll (bus, GST_MESSAGE_ANY, blocking ? -1 : 0);
533
534     /* if the poll timed out, only when !blocking */
535     if (message == NULL)
536       goto exit;
537
538     /* check if we need to dump messages to the console */
539     if (messages) {
540       GstObject *src_obj;
541       const GstStructure *s;
542       guint32 seqnum;
543
544       seqnum = gst_message_get_seqnum (message);
545
546       s = gst_message_get_structure (message);
547
548       src_obj = GST_MESSAGE_SRC (message);
549
550       if (GST_IS_ELEMENT (src_obj)) {
551         PRINT (_("Got message #%u from element \"%s\" (%s): "),
552             (guint) seqnum, GST_ELEMENT_NAME (src_obj),
553             GST_MESSAGE_TYPE_NAME (message));
554       } else if (GST_IS_PAD (src_obj)) {
555         PRINT (_("Got message #%u from pad \"%s:%s\" (%s): "),
556             (guint) seqnum, GST_DEBUG_PAD_NAME (src_obj),
557             GST_MESSAGE_TYPE_NAME (message));
558       } else if (GST_IS_OBJECT (src_obj)) {
559         PRINT (_("Got message #%u from object \"%s\" (%s): "),
560             (guint) seqnum, GST_OBJECT_NAME (src_obj),
561             GST_MESSAGE_TYPE_NAME (message));
562       } else {
563         PRINT (_("Got message #%u (%s): "), (guint) seqnum,
564             GST_MESSAGE_TYPE_NAME (message));
565       }
566
567       if (s) {
568         gchar *sstr;
569
570         sstr = gst_structure_to_string (s);
571         PRINT ("%s\n", sstr);
572         g_free (sstr);
573       } else {
574         PRINT ("no message details\n");
575       }
576     }
577
578     switch (GST_MESSAGE_TYPE (message)) {
579       case GST_MESSAGE_NEW_CLOCK:
580       {
581         GstClock *clock;
582
583         gst_message_parse_new_clock (message, &clock);
584
585         PRINT ("New clock: %s\n", (clock ? GST_OBJECT_NAME (clock) : "NULL"));
586         break;
587       }
588       case GST_MESSAGE_CLOCK_LOST:
589         PRINT ("Clock lost, selecting a new one\n");
590         gst_element_set_state (pipeline, GST_STATE_PAUSED);
591         gst_element_set_state (pipeline, GST_STATE_PLAYING);
592         break;
593       case GST_MESSAGE_EOS:{
594         waiting_eos = FALSE;
595         PRINT (_("Got EOS from element \"%s\".\n"),
596             GST_MESSAGE_SRC_NAME (message));
597         goto exit;
598       }
599       case GST_MESSAGE_TAG:
600         if (tags) {
601           GstTagList *tags;
602
603           if (GST_IS_ELEMENT (GST_MESSAGE_SRC (message))) {
604             PRINT (_("FOUND TAG      : found by element \"%s\".\n"),
605                 GST_MESSAGE_SRC_NAME (message));
606           } else if (GST_IS_PAD (GST_MESSAGE_SRC (message))) {
607             PRINT (_("FOUND TAG      : found by pad \"%s:%s\".\n"),
608                 GST_DEBUG_PAD_NAME (GST_MESSAGE_SRC (message)));
609           } else if (GST_IS_OBJECT (GST_MESSAGE_SRC (message))) {
610             PRINT (_("FOUND TAG      : found by object \"%s\".\n"),
611                 GST_MESSAGE_SRC_NAME (message));
612           } else {
613             PRINT (_("FOUND TAG\n"));
614           }
615
616           gst_message_parse_tag (message, &tags);
617           gst_tag_list_foreach (tags, print_tag, NULL);
618           gst_tag_list_free (tags);
619         }
620         break;
621       case GST_MESSAGE_INFO:{
622         GError *gerror;
623         gchar *debug;
624         gchar *name = gst_object_get_path_string (GST_MESSAGE_SRC (message));
625
626         gst_message_parse_info (message, &gerror, &debug);
627         if (debug) {
628           PRINT (_("INFO:\n%s\n"), debug);
629         }
630         g_error_free (gerror);
631         g_free (debug);
632         g_free (name);
633         break;
634       }
635       case GST_MESSAGE_WARNING:{
636         GError *gerror;
637         gchar *debug;
638         gchar *name = gst_object_get_path_string (GST_MESSAGE_SRC (message));
639
640         /* dump graph on warning */
641         GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (pipeline),
642             GST_DEBUG_GRAPH_SHOW_ALL, "gst-launch.warning");
643
644         gst_message_parse_warning (message, &gerror, &debug);
645         PRINT (_("WARNING: from element %s: %s\n"), name, gerror->message);
646         if (debug) {
647           PRINT (_("Additional debug info:\n%s\n"), debug);
648         }
649         g_error_free (gerror);
650         g_free (debug);
651         g_free (name);
652         break;
653       }
654       case GST_MESSAGE_ERROR:{
655         /* dump graph on error */
656         GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (pipeline),
657             GST_DEBUG_GRAPH_SHOW_ALL, "gst-launch.error");
658
659         print_error_message (message);
660
661         /* we have an error */
662         res = ELR_ERROR;
663         goto exit;
664       }
665       case GST_MESSAGE_STATE_CHANGED:{
666         GstState old, new, pending;
667
668         /* we only care about pipeline state change messages */
669         if (GST_MESSAGE_SRC (message) != GST_OBJECT_CAST (pipeline))
670           break;
671
672         /* ignore when we are buffering since then we mess with the states
673          * ourselves. */
674         if (buffering) {
675           PRINT (_("Prerolled, waiting for buffering to finish...\n"));
676           break;
677         }
678
679         gst_message_parse_state_changed (message, &old, &new, &pending);
680
681         /* if we reached the final target state, exit */
682         if (target_state == GST_STATE_PAUSED && new == target_state)
683           goto exit;
684
685         /* else not an interesting message */
686         break;
687       }
688       case GST_MESSAGE_BUFFERING:{
689         gint percent;
690
691         gst_message_parse_buffering (message, &percent);
692         PRINT ("%s %d%%  \r", _("buffering..."), percent);
693
694         /* no state management needed for live pipelines */
695         if (is_live)
696           break;
697
698         if (percent == 100) {
699           /* a 100% message means buffering is done */
700           buffering = FALSE;
701           /* if the desired state is playing, go back */
702           if (target_state == GST_STATE_PLAYING) {
703             PRINT (_("Done buffering, setting pipeline to PLAYING ...\n"));
704             gst_element_set_state (pipeline, GST_STATE_PLAYING);
705           } else
706             goto exit;
707         } else {
708           /* buffering busy */
709           if (buffering == FALSE && target_state == GST_STATE_PLAYING) {
710             /* we were not buffering but PLAYING, PAUSE  the pipeline. */
711             PRINT (_("Buffering, setting pipeline to PAUSED ...\n"));
712             gst_element_set_state (pipeline, GST_STATE_PAUSED);
713           }
714           buffering = TRUE;
715         }
716         break;
717       }
718       case GST_MESSAGE_LATENCY:
719       {
720         PRINT (_("Redistribute latency...\n"));
721         gst_bin_recalculate_latency (GST_BIN (pipeline));
722         break;
723       }
724       case GST_MESSAGE_REQUEST_STATE:
725       {
726         GstState state;
727         gchar *name = gst_object_get_path_string (GST_MESSAGE_SRC (message));
728
729         gst_message_parse_request_state (message, &state);
730
731         PRINT (_("Setting state to %s as requested by %s...\n"),
732             gst_element_state_get_name (state), name);
733
734         gst_element_set_state (pipeline, state);
735
736         g_free (name);
737         break;
738       }
739       case GST_MESSAGE_APPLICATION:{
740         const GstStructure *s;
741
742         s = gst_message_get_structure (message);
743
744         if (gst_structure_has_name (s, "GstLaunchInterrupt")) {
745           /* this application message is posted when we caught an interrupt and
746            * we need to stop the pipeline. */
747           PRINT (_("Interrupt: Stopping pipeline ...\n"));
748           res = ELR_INTERRUPT;
749           goto exit;
750         }
751       }
752       default:
753         /* just be quiet by default */
754         break;
755     }
756     if (message)
757       gst_message_unref (message);
758   }
759   g_assert_not_reached ();
760
761 exit:
762   {
763     if (message)
764       gst_message_unref (message);
765     gst_object_unref (bus);
766 #ifndef DISABLE_FAULT_HANDLER
767     g_source_remove (timeout_id);
768 #endif
769     return res;
770   }
771 }
772
773 static GstBusSyncReply
774 bus_sync_handler (GstBus * bus, GstMessage * message, gpointer data)
775 {
776   GstElement *pipeline = (GstElement *) data;
777
778   switch (GST_MESSAGE_TYPE (message)) {
779     case GST_MESSAGE_STATE_CHANGED:
780       /* we only care about pipeline state change messages */
781       if (GST_MESSAGE_SRC (message) == GST_OBJECT_CAST (pipeline)) {
782         GstState old, new, pending;
783         gchar *state_transition_name;
784
785         gst_message_parse_state_changed (message, &old, &new, &pending);
786
787         state_transition_name = g_strdup_printf ("%s_%s",
788             gst_element_state_get_name (old), gst_element_state_get_name (new));
789
790         /* dump graph for (some) pipeline state changes */
791         {
792           gchar *dump_name = g_strconcat ("gst-launch.", state_transition_name,
793               NULL);
794           GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS (GST_BIN (pipeline),
795               GST_DEBUG_GRAPH_SHOW_ALL, dump_name);
796           g_free (dump_name);
797         }
798
799         /* place a marker into e.g. strace logs */
800         {
801           gchar *access_name = g_strconcat (g_get_tmp_dir (), G_DIR_SEPARATOR_S,
802               "gst-launch", G_DIR_SEPARATOR_S, state_transition_name, NULL);
803           g_file_test (access_name, G_FILE_TEST_EXISTS);
804           g_free (access_name);
805         }
806
807         g_free (state_transition_name);
808       }
809     default:
810       break;
811   }
812   return GST_BUS_PASS;
813 }
814
815 int
816 main (int argc, char *argv[])
817 {
818   /* options */
819   gboolean verbose = FALSE;
820   gboolean no_fault = FALSE;
821   gboolean no_sigusr_handler = FALSE;
822   gboolean trace = FALSE;
823   gboolean eos_on_shutdown = FALSE;
824   gboolean check_index = FALSE;
825   gchar *savefile = NULL;
826   gchar *exclude_args = NULL;
827 #ifndef GST_DISABLE_OPTION_PARSING
828   GOptionEntry options[] = {
829     {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
830         N_("Output tags (also known as metadata)"), NULL},
831     {"verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose,
832         N_("Output status information and property notifications"), NULL},
833     {"quiet", 'q', 0, G_OPTION_ARG_NONE, &quiet,
834         N_("Do not print any progress information"), NULL},
835     {"messages", 'm', 0, G_OPTION_ARG_NONE, &messages,
836         N_("Output messages"), NULL},
837     {"exclude", 'X', 0, G_OPTION_ARG_NONE, &exclude_args,
838         N_("Do not output status information of TYPE"), N_("TYPE1,TYPE2,...")},
839     {"no-fault", 'f', 0, G_OPTION_ARG_NONE, &no_fault,
840         N_("Do not install a fault handler"), NULL},
841     {"no-sigusr-handler", '\0', 0, G_OPTION_ARG_NONE, &no_sigusr_handler,
842         N_("Do not install signal handlers for SIGUSR1 and SIGUSR2"), NULL},
843     {"trace", 'T', 0, G_OPTION_ARG_NONE, &trace,
844         N_("Print alloc trace (if enabled at compile time)"), NULL},
845     {"eos-on-shutdown", 'e', 0, G_OPTION_ARG_NONE, &eos_on_shutdown,
846         N_("Force EOS on sources before shutting the pipeline down"), NULL},
847     {"index", 'i', 0, G_OPTION_ARG_NONE, &check_index,
848         N_("Gather and print index statistics"), NULL},
849     GST_TOOLS_GOPTION_VERSION,
850     {NULL}
851   };
852   GOptionContext *ctx;
853   GError *err = NULL;
854 #endif
855   GstIndex *index;
856   GPtrArray *index_stats = NULL;
857   gchar **argvn;
858   GError *error = NULL;
859   gint res = 0;
860
861   free (malloc (8));            /* -lefence */
862
863 #ifdef ENABLE_NLS
864   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
865   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
866   textdomain (GETTEXT_PACKAGE);
867 #endif
868
869   g_thread_init (NULL);
870
871   gst_tools_set_prgname ("gst-launch");
872
873 #ifndef GST_DISABLE_OPTION_PARSING
874   ctx = g_option_context_new ("PIPELINE-DESCRIPTION");
875   g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
876   g_option_context_add_group (ctx, gst_init_get_option_group ());
877   if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
878     if (err)
879       g_printerr ("Error initializing: %s\n", GST_STR_NULL (err->message));
880     else
881       g_printerr ("Error initializing: Unknown error!\n");
882     exit (1);
883   }
884   g_option_context_free (ctx);
885 #else
886   gst_init (&argc, &argv);
887 #endif
888
889   gst_tools_print_version ("gst-launch");
890
891 #ifndef DISABLE_FAULT_HANDLER
892   if (!no_fault)
893     fault_setup ();
894
895   sigint_setup ();
896
897   if (!no_sigusr_handler)
898     play_signal_setup ();
899 #endif
900
901   if (trace) {
902     if (!gst_alloc_trace_available ()) {
903       g_warning ("Trace not available (recompile with trace enabled).");
904     }
905     gst_alloc_trace_set_flags_all (GST_ALLOC_TRACE_LIVE |
906         GST_ALLOC_TRACE_MEM_LIVE);
907     gst_alloc_trace_print_live ();
908   }
909
910   /* make a null-terminated version of argv */
911   argvn = g_new0 (char *, argc);
912   memcpy (argvn, argv + 1, sizeof (char *) * (argc - 1));
913   {
914     pipeline =
915         (GstElement *) gst_parse_launchv ((const gchar **) argvn, &error);
916   }
917   g_free (argvn);
918
919   if (!pipeline) {
920     if (error) {
921       g_printerr (_("ERROR: pipeline could not be constructed: %s.\n"),
922           GST_STR_NULL (error->message));
923       g_error_free (error);
924     } else {
925       g_printerr (_("ERROR: pipeline could not be constructed.\n"));
926     }
927     return 1;
928   } else if (error) {
929     g_printerr (_("WARNING: erroneous pipeline: %s\n"),
930         GST_STR_NULL (error->message));
931     g_error_free (error);
932     return 1;
933   }
934
935   if (verbose) {
936     gchar **exclude_list =
937         exclude_args ? g_strsplit (exclude_args, ",", 0) : NULL;
938     g_signal_connect (pipeline, "deep-notify",
939         G_CALLBACK (gst_object_default_deep_notify), exclude_list);
940   }
941
942   if (!savefile) {
943     GstState state, pending;
944     GstStateChangeReturn ret;
945     GstBus *bus;
946
947     /* If the top-level object is not a pipeline, place it in a pipeline. */
948     if (!GST_IS_PIPELINE (pipeline)) {
949       GstElement *real_pipeline = gst_element_factory_make ("pipeline", NULL);
950
951       if (real_pipeline == NULL) {
952         g_printerr (_("ERROR: the 'pipeline' element wasn't found.\n"));
953         return 1;
954       }
955       gst_bin_add (GST_BIN (real_pipeline), pipeline);
956       pipeline = real_pipeline;
957     }
958
959     if (check_index) {
960       /* gst_index_new() creates a null-index, it does not store anything, but
961        * the entry-added signal works and this is what we use to build the
962        * statistics */
963       index = gst_index_new ();
964       if (index) {
965         index_stats = g_ptr_array_new ();
966         g_signal_connect (G_OBJECT (index), "entry-added",
967             G_CALLBACK (entry_added), index_stats);
968         g_object_set (G_OBJECT (index), "resolver", GST_INDEX_RESOLVER_GTYPE,
969             NULL);
970         gst_element_set_index (pipeline, index);
971       }
972     }
973
974     bus = gst_element_get_bus (pipeline);
975     gst_bus_set_sync_handler (bus, bus_sync_handler, (gpointer) pipeline);
976     gst_object_unref (bus);
977
978     PRINT (_("Setting pipeline to PAUSED ...\n"));
979     ret = gst_element_set_state (pipeline, GST_STATE_PAUSED);
980
981     switch (ret) {
982       case GST_STATE_CHANGE_FAILURE:
983         g_printerr (_("ERROR: Pipeline doesn't want to pause.\n"));
984         res = -1;
985         event_loop (pipeline, FALSE, GST_STATE_VOID_PENDING);
986         goto end;
987       case GST_STATE_CHANGE_NO_PREROLL:
988         PRINT (_("Pipeline is live and does not need PREROLL ...\n"));
989         is_live = TRUE;
990         break;
991       case GST_STATE_CHANGE_ASYNC:
992         PRINT (_("Pipeline is PREROLLING ...\n"));
993         caught_error = event_loop (pipeline, TRUE, GST_STATE_PAUSED);
994         if (caught_error) {
995           g_printerr (_("ERROR: pipeline doesn't want to preroll.\n"));
996           goto end;
997         }
998         state = GST_STATE_PAUSED;
999         /* fallthrough */
1000       case GST_STATE_CHANGE_SUCCESS:
1001         PRINT (_("Pipeline is PREROLLED ...\n"));
1002         break;
1003     }
1004
1005     caught_error = event_loop (pipeline, FALSE, GST_STATE_PLAYING);
1006
1007     if (caught_error) {
1008       g_printerr (_("ERROR: pipeline doesn't want to preroll.\n"));
1009     } else {
1010       GstClockTime tfthen, tfnow;
1011       GstClockTimeDiff diff;
1012
1013       PRINT (_("Setting pipeline to PLAYING ...\n"));
1014
1015       if (gst_element_set_state (pipeline,
1016               GST_STATE_PLAYING) == GST_STATE_CHANGE_FAILURE) {
1017         GstMessage *err_msg;
1018         GstBus *bus;
1019
1020         g_printerr (_("ERROR: pipeline doesn't want to play.\n"));
1021         bus = gst_element_get_bus (pipeline);
1022         if ((err_msg = gst_bus_poll (bus, GST_MESSAGE_ERROR, 0))) {
1023           print_error_message (err_msg);
1024           gst_message_unref (err_msg);
1025         }
1026         gst_object_unref (bus);
1027         res = -1;
1028         goto end;
1029       }
1030
1031       tfthen = gst_util_get_timestamp ();
1032       caught_error = event_loop (pipeline, TRUE, GST_STATE_PLAYING);
1033       if (eos_on_shutdown && caught_error == ELR_INTERRUPT) {
1034         PRINT (_("EOS on shutdown enabled -- Forcing EOS on the pipeline\n"));
1035         waiting_eos = TRUE;
1036         gst_element_send_event (pipeline, gst_event_new_eos ());
1037         PRINT (_("Waiting for EOS...\n"));
1038         caught_error = event_loop (pipeline, TRUE, GST_STATE_PLAYING);
1039
1040         if (caught_error == ELR_NO_ERROR) {
1041           /* we got EOS */
1042           PRINT (_("EOS received - stopping pipeline...\n"));
1043         } else if (caught_error == ELR_ERROR) {
1044           PRINT (_("An error happened while waiting for EOS\n"));
1045         }
1046       }
1047       tfnow = gst_util_get_timestamp ();
1048
1049       diff = GST_CLOCK_DIFF (tfthen, tfnow);
1050
1051       PRINT (_("Execution ended after %" G_GUINT64_FORMAT " ns.\n"), diff);
1052     }
1053
1054     PRINT (_("Setting pipeline to PAUSED ...\n"));
1055     gst_element_set_state (pipeline, GST_STATE_PAUSED);
1056     if (caught_error == ELR_NO_ERROR)
1057       gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
1058
1059     /* iterate mainloop to process pending stuff */
1060     while (g_main_context_iteration (NULL, FALSE));
1061
1062     PRINT (_("Setting pipeline to READY ...\n"));
1063     gst_element_set_state (pipeline, GST_STATE_READY);
1064     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
1065
1066     if (check_index) {
1067       print_index_stats (index_stats);
1068       g_ptr_array_free (index_stats, TRUE);
1069     }
1070
1071   end:
1072     PRINT (_("Setting pipeline to NULL ...\n"));
1073     gst_element_set_state (pipeline, GST_STATE_NULL);
1074     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
1075   }
1076
1077   PRINT (_("Freeing pipeline ...\n"));
1078   gst_object_unref (pipeline);
1079
1080   gst_deinit ();
1081   if (trace)
1082     gst_alloc_trace_print_live ();
1083
1084   return res;
1085 }