moap ignore
[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 WIN32
30 #define DISABLE_FAULT_HANDLER
31 #endif
32
33 #include <string.h>
34 #include <signal.h>
35 #ifdef HAVE_UNISTD_H
36 #include <unistd.h>
37 #endif
38 #ifndef DISABLE_FAULT_HANDLER
39 #include <sys/wait.h>
40 #endif
41 #include <locale.h>             /* for LC_ALL */
42 #include "tools.h"
43
44 /* FIXME: This is just a temporary hack.  We should have a better
45  * check for siginfo handling. */
46 #ifdef SA_SIGINFO
47 #define USE_SIGINFO
48 #endif
49
50 extern volatile gboolean glib_on_error_halt;
51
52 #ifndef DISABLE_FAULT_HANDLER
53 static void fault_restore (void);
54 static void fault_spin (void);
55 static void sigint_restore (void);
56 static gboolean caught_intr = FALSE;
57 #endif
58
59 static GstElement *pipeline;
60 static gboolean caught_error = FALSE;
61 static gboolean tags = FALSE;
62 static gboolean messages = FALSE;
63
64
65 #ifndef GST_DISABLE_LOADSAVE
66 static GstElement *
67 xmllaunch_parse_cmdline (const gchar ** argv)
68 {
69   GstElement *pipeline = NULL, *e;
70   GstXML *xml;
71   gboolean err;
72   const gchar *arg;
73   gchar *element, *property, *value;
74   GList *l;
75   gint i = 0;
76
77   if (!(arg = argv[0])) {
78     g_print (_
79         ("Usage: gst-xmllaunch <file.xml> [ element.property=value ... ]\n"));
80     exit (1);
81   }
82
83   xml = gst_xml_new ();
84   /* FIXME guchar from gstxml.c */
85   err = gst_xml_parse_file (xml, (guchar *) arg, NULL);
86
87   if (err != TRUE) {
88     fprintf (stderr, _("ERROR: parse of xml file '%s' failed.\n"), arg);
89     exit (1);
90   }
91
92   l = gst_xml_get_topelements (xml);
93   if (!l) {
94     fprintf (stderr, _("ERROR: no toplevel pipeline element in file '%s'.\n"),
95         arg);
96     exit (1);
97   }
98
99   if (l->next)
100     fprintf (stderr,
101         _("WARNING: only one toplevel element is supported at this time."));
102
103   pipeline = GST_ELEMENT (l->data);
104
105   while ((arg = argv[++i])) {
106     element = g_strdup (arg);
107     property = strchr (element, '.');
108     value = strchr (element, '=');
109
110     if (!(element < property && property < value)) {
111       fprintf (stderr,
112           _("ERROR: could not parse command line argument %d: %s.\n"), i,
113           element);
114       g_free (element);
115       exit (1);
116     }
117
118     *property++ = '\0';
119     *value++ = '\0';
120
121     e = gst_bin_get_by_name (GST_BIN (pipeline), element);
122     if (!e) {
123       fprintf (stderr, _("WARNING: element named '%s' not found.\n"), element);
124     } else {
125       gst_util_set_object_arg (G_OBJECT (e), property, value);
126     }
127     g_free (element);
128   }
129
130   if (!l)
131     return NULL;
132   else
133     return l->data;
134 }
135 #endif
136
137 #ifndef DISABLE_FAULT_HANDLER
138 #ifndef USE_SIGINFO
139 static void
140 fault_handler_sighandler (int signum)
141 {
142   fault_restore ();
143
144   /* printf is used instead of g_print(), since it's less likely to
145    * deadlock */
146   switch (signum) {
147     case SIGSEGV:
148       printf ("Caught SIGSEGV\n");
149       break;
150     case SIGQUIT:
151       printf ("Caught SIGQUIT\n");
152       break;
153     default:
154       printf ("signo:  %d\n", signum);
155       break;
156   }
157
158   fault_spin ();
159 }
160
161 #else /* USE_SIGINFO */
162
163 static void
164 fault_handler_sigaction (int signum, siginfo_t * si, void *misc)
165 {
166   fault_restore ();
167
168   /* printf is used instead of g_print(), since it's less likely to
169    * deadlock */
170   switch (si->si_signo) {
171     case SIGSEGV:
172       printf ("Caught SIGSEGV accessing address %p\n", si->si_addr);
173       break;
174     case SIGQUIT:
175       printf ("Caught SIGQUIT\n");
176       break;
177     default:
178       printf ("signo:  %d\n", si->si_signo);
179       printf ("errno:  %d\n", si->si_errno);
180       printf ("code:   %d\n", si->si_code);
181       break;
182   }
183
184   fault_spin ();
185 }
186 #endif /* USE_SIGINFO */
187
188 static void
189 fault_spin (void)
190 {
191   int spinning = TRUE;
192
193   glib_on_error_halt = FALSE;
194   g_on_error_stack_trace ("gst-launch");
195
196   wait (NULL);
197
198   /* FIXME how do we know if we were run by libtool? */
199   printf ("Spinning.  Please run 'gdb gst-launch %d' to continue debugging, "
200       "Ctrl-C to quit, or Ctrl-\\ to dump core.\n", (gint) getpid ());
201   while (spinning)
202     g_usleep (1000000);
203 }
204
205 static void
206 fault_restore (void)
207 {
208   struct sigaction action;
209
210   memset (&action, 0, sizeof (action));
211   action.sa_handler = SIG_DFL;
212
213   sigaction (SIGSEGV, &action, NULL);
214   sigaction (SIGQUIT, &action, NULL);
215 }
216
217 static void
218 fault_setup (void)
219 {
220   struct sigaction action;
221
222   memset (&action, 0, sizeof (action));
223 #ifdef USE_SIGINFO
224   action.sa_sigaction = fault_handler_sigaction;
225   action.sa_flags = SA_SIGINFO;
226 #else
227   action.sa_handler = fault_handler_sighandler;
228 #endif
229
230   sigaction (SIGSEGV, &action, NULL);
231   sigaction (SIGQUIT, &action, NULL);
232 }
233 #endif /* DISABLE_FAULT_HANDLER */
234
235 static void
236 print_tag (const GstTagList * list, const gchar * tag, gpointer unused)
237 {
238   gint i, count;
239
240   count = gst_tag_list_get_tag_size (list, tag);
241
242   for (i = 0; i < count; i++) {
243     gchar *str;
244
245     if (gst_tag_get_type (tag) == G_TYPE_STRING) {
246       if (!gst_tag_list_get_string_index (list, tag, i, &str))
247         g_assert_not_reached ();
248     } else if (gst_tag_get_type (tag) == GST_TYPE_BUFFER) {
249       GstBuffer *img;
250
251       img = gst_value_get_buffer (gst_tag_list_get_value_index (list, tag, i));
252       if (img) {
253         gchar *caps_str;
254
255         caps_str = GST_BUFFER_CAPS (img) ?
256             gst_caps_to_string (GST_BUFFER_CAPS (img)) : g_strdup ("unknown");
257         str = g_strdup_printf ("buffer of %u bytes, type: %s",
258             GST_BUFFER_SIZE (img), caps_str);
259         g_free (caps_str);
260       } else {
261         str = g_strdup ("NULL buffer");
262       }
263     } else {
264       str =
265           g_strdup_value_contents (gst_tag_list_get_value_index (list, tag, i));
266     }
267
268     if (i == 0) {
269       g_print ("%15s: %s\n", gst_tag_get_nick (tag), str);
270     } else {
271       g_print ("               : %s\n", str);
272     }
273
274     g_free (str);
275   }
276 }
277
278 #ifndef DISABLE_FAULT_HANDLER
279 /* we only use sighandler here because the registers are not important */
280 static void
281 sigint_handler_sighandler (int signum)
282 {
283   g_print ("Caught interrupt -- ");
284
285   sigint_restore ();
286
287   caught_intr = TRUE;
288 }
289
290 static gboolean
291 check_intr (GstElement * pipeline)
292 {
293   if (!caught_intr) {
294     return TRUE;
295   } else {
296     GstBus *bus;
297     GstMessage *message;
298
299     caught_intr = FALSE;
300     g_print ("Pausing pipeline.\n");
301
302     bus = gst_element_get_bus (GST_ELEMENT (pipeline));
303     message = gst_message_new_warning (GST_OBJECT (pipeline),
304         NULL, "pipeline interrupted");
305     gst_bus_post (bus, message);
306
307     /* pipeline will wait for element to go to PAUSED */
308     gst_element_set_state (pipeline, GST_STATE_PAUSED);
309     g_print ("Pipeline paused.\n");
310
311     gst_object_unref (bus);
312
313     return FALSE;
314   }
315 }
316
317 static void
318 sigint_setup (void)
319 {
320   struct sigaction action;
321
322   memset (&action, 0, sizeof (action));
323   action.sa_handler = sigint_handler_sighandler;
324
325   sigaction (SIGINT, &action, NULL);
326 }
327
328 static void
329 sigint_restore (void)
330 {
331   struct sigaction action;
332
333   memset (&action, 0, sizeof (action));
334   action.sa_handler = SIG_DFL;
335
336   sigaction (SIGINT, &action, NULL);
337 }
338
339 static void
340 play_handler (int signum)
341 {
342   switch (signum) {
343     case SIGUSR1:
344       g_print ("Caught SIGUSR1 - Play request.\n");
345       gst_element_set_state (pipeline, GST_STATE_PLAYING);
346       break;
347     case SIGUSR2:
348       g_print ("Caught SIGUSR2 - Stop request.\n");
349       gst_element_set_state (pipeline, GST_STATE_NULL);
350       break;
351   }
352 }
353
354 static void
355 play_signal_setup (void)
356 {
357   struct sigaction action;
358
359   memset (&action, 0, sizeof (action));
360   action.sa_handler = play_handler;
361   sigaction (SIGUSR1, &action, NULL);
362   sigaction (SIGUSR2, &action, NULL);
363 }
364 #endif /* DISABLE_FAULT_HANDLER */
365
366 static gboolean
367 event_loop (GstElement * pipeline, gboolean blocking, GstState target_state)
368 {
369   GstBus *bus;
370   GstMessage *message = NULL;
371
372   bus = gst_element_get_bus (GST_ELEMENT (pipeline));
373
374 #ifndef DISABLE_FAULT_HANDLER
375   g_timeout_add (50, (GSourceFunc) check_intr, pipeline);
376 #endif
377
378   while (TRUE) {
379     message = gst_bus_poll (bus, GST_MESSAGE_ANY, blocking ? -1 : 0);
380
381     /* if the poll timed out, only when !blocking */
382     if (message == NULL) {
383       gst_object_unref (bus);
384       return FALSE;
385     }
386
387     if (messages) {
388       const GstStructure *s;
389
390       s = gst_message_get_structure (message);
391
392       g_print (_("Got Message from element \"%s\" (%s): "),
393           GST_STR_NULL (GST_ELEMENT_NAME (GST_MESSAGE_SRC (message))),
394           gst_message_type_get_name (GST_MESSAGE_TYPE (message)));
395       if (s) {
396         gchar *sstr;
397
398         sstr = gst_structure_to_string (s);
399         g_print ("%s\n", sstr);
400         g_free (sstr);
401       } else {
402         g_print ("no message details\n");
403       }
404     }
405
406     switch (GST_MESSAGE_TYPE (message)) {
407       case GST_MESSAGE_NEW_CLOCK:
408       {
409         GstClock *clock;
410
411         gst_message_parse_new_clock (message, &clock);
412
413         g_print ("New clock: %s\n", GST_OBJECT_NAME (clock));
414         gst_message_unref (message);
415         break;
416       }
417       case GST_MESSAGE_EOS:
418         g_print (_
419             ("Got EOS from element \"%s\".\n"),
420             GST_STR_NULL (GST_ELEMENT_NAME (GST_MESSAGE_SRC (message))));
421         gst_message_unref (message);
422         gst_object_unref (bus);
423         return FALSE;
424       case GST_MESSAGE_TAG:
425         if (tags) {
426           GstTagList *tags;
427
428           gst_message_parse_tag (message, &tags);
429           g_print (_("FOUND TAG      : found by element \"%s\".\n"),
430               GST_STR_NULL (GST_ELEMENT_NAME (GST_MESSAGE_SRC (message))));
431           gst_tag_list_foreach (tags, print_tag, NULL);
432           gst_tag_list_free (tags);
433         }
434         gst_message_unref (message);
435         break;
436       case GST_MESSAGE_WARNING:{
437         GError *gerror;
438         gchar *debug;
439
440         gst_message_parse_warning (message, &gerror, &debug);
441         if (debug) {
442           g_print ("WARNING: Element \"%s\" warns: %s\n",
443               GST_STR_NULL (GST_ELEMENT_NAME (GST_MESSAGE_SRC (message))),
444               debug);
445         }
446         gst_message_unref (message);
447         if (gerror)
448           g_error_free (gerror);
449         g_free (debug);
450         break;
451       }
452       case GST_MESSAGE_ERROR:{
453         GError *gerror;
454         gchar *debug;
455
456         gst_message_parse_error (message, &gerror, &debug);
457         gst_object_default_error (GST_MESSAGE_SRC (message), gerror, debug);
458         gst_message_unref (message);
459         if (gerror)
460           g_error_free (gerror);
461         g_free (debug);
462         gst_object_unref (bus);
463         return TRUE;
464       }
465       case GST_MESSAGE_STATE_CHANGED:{
466         GstState old, new, pending;
467
468         gst_message_parse_state_changed (message, &old, &new, &pending);
469         if (GST_MESSAGE_SRC (message) == GST_OBJECT (pipeline) &&
470             target_state != GST_STATE_VOID_PENDING && new == target_state) {
471           gst_message_unref (message);
472           gst_object_unref (bus);
473           return FALSE;
474         }
475         if (!(old == GST_STATE_PLAYING && new == GST_STATE_PAUSED &&
476                 GST_MESSAGE_SRC (message) == GST_OBJECT (pipeline))) {
477           gst_message_unref (message);
478           break;
479         }
480         g_print (_
481             ("Element \"%s\" has gone from PLAYING to PAUSED, quitting.\n"),
482             GST_STR_NULL (GST_ELEMENT_NAME (GST_MESSAGE_SRC (message))));
483         /* cut out of the event loop if check_intr set us to PAUSED */
484         gst_message_unref (message);
485         gst_object_unref (bus);
486         return FALSE;
487       }
488       default:
489         /* just be quiet by default */
490         gst_message_unref (message);
491         break;
492     }
493   }
494
495   g_assert_not_reached ();
496   return TRUE;
497 }
498
499 int
500 main (int argc, char *argv[])
501 {
502   gint i, j;
503
504   /* options */
505   gboolean verbose = FALSE;
506   gboolean no_fault = FALSE;
507   gboolean trace = FALSE;
508   gchar *savefile = NULL;
509   gchar *exclude_args = NULL;
510   GOptionEntry options[] = {
511     {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
512         N_("Output tags (also known as metadata)"), NULL},
513     {"verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose,
514         N_("Output status information and property notifications"), NULL},
515     {"messages", 'm', 0, G_OPTION_ARG_NONE, &messages,
516         N_("Output messages"), NULL},
517     {"exclude", 'X', 0, G_OPTION_ARG_NONE, &exclude_args,
518         N_("Do not output status information of TYPE"), N_("TYPE1,TYPE2,...")},
519 #ifndef GST_DISABLE_LOADSAVE
520     {"output", 'o', 0, G_OPTION_ARG_STRING, &savefile,
521         N_("Save xml representation of pipeline to FILE and exit"), N_("FILE")},
522 #endif
523     {"no-fault", 'f', 0, G_OPTION_ARG_NONE, &no_fault,
524         N_("Do not install a fault handler"), NULL},
525     {"trace", 'T', 0, G_OPTION_ARG_NONE, &trace,
526         N_("Print alloc trace (if enabled at compile time)"), NULL},
527     GST_TOOLS_GOPTION_VERSION,
528     {NULL}
529   };
530   GOptionContext *ctx;
531   GError *err = NULL;
532   gchar **argvn;
533   GError *error = NULL;
534   gint res = 0;
535
536   free (malloc (8));            /* -lefence */
537
538 #ifdef ENABLE_NLS
539   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
540   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
541   textdomain (GETTEXT_PACKAGE);
542 #endif
543
544   gst_alloc_trace_set_flags_all (GST_ALLOC_TRACE_LIVE);
545
546   ctx = g_option_context_new ("PIPELINE-DESCRIPTION");
547   g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
548   g_option_context_add_group (ctx, gst_init_get_option_group ());
549   if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
550     g_print ("Error initializing: %s\n", GST_STR_NULL (err->message));
551     exit (1);
552   }
553   g_option_context_free (ctx);
554
555   gst_tools_print_version ("gst-launch");
556
557   /* FIXpopt: strip short args, too. We do it ourselves for now */
558   j = 1;
559   for (i = 1; i < argc; i++) {
560     if (*(argv[i]) == '-') {
561       if (strlen (argv[i]) == 2) {
562         gchar *c = argv[i];
563
564         c++;
565         if (*c == 'X' || *c == 'o') {
566           i++;
567         }
568       }
569     } else {
570       argv[j] = argv[i];
571       j++;
572     }
573   }
574   argc = j;
575
576 #ifndef DISABLE_FAULT_HANDLER
577   if (!no_fault)
578     fault_setup ();
579
580   sigint_setup ();
581   play_signal_setup ();
582 #endif
583
584   if (trace) {
585     if (!gst_alloc_trace_available ()) {
586       g_warning ("Trace not available (recompile with trace enabled).");
587     }
588     gst_alloc_trace_print_live ();
589   }
590
591   /* make a null-terminated version of argv */
592   argvn = g_new0 (char *, argc);
593   memcpy (argvn, argv + 1, sizeof (char *) * (argc - 1));
594 #ifndef GST_DISABLE_LOADSAVE
595   if (strstr (argv[0], "gst-xmllaunch")) {
596     pipeline = xmllaunch_parse_cmdline ((const gchar **) argvn);
597   } else
598 #endif
599   {
600     pipeline =
601         (GstElement *) gst_parse_launchv ((const gchar **) argvn, &error);
602   }
603   g_free (argvn);
604
605   if (!pipeline) {
606     if (error) {
607       fprintf (stderr, _("ERROR: pipeline could not be constructed: %s.\n"),
608           GST_STR_NULL (error->message));
609       g_error_free (error);
610     } else {
611       fprintf (stderr, _("ERROR: pipeline could not be constructed.\n"));
612     }
613     return 1;
614   } else if (error) {
615     fprintf (stderr, _("WARNING: erroneous pipeline: %s\n"),
616         GST_STR_NULL (error->message));
617     g_error_free (error);
618     return 1;
619   }
620
621   if (verbose) {
622     gchar **exclude_list =
623         exclude_args ? g_strsplit (exclude_args, ",", 0) : NULL;
624     g_signal_connect (pipeline, "deep_notify",
625         G_CALLBACK (gst_object_default_deep_notify), exclude_list);
626   }
627 #ifndef GST_DISABLE_LOADSAVE
628   if (savefile) {
629     gst_xml_write_file (GST_ELEMENT (pipeline), fopen (savefile, "w"));
630   }
631 #endif
632
633   if (!savefile) {
634     GstState state, pending;
635     GstStateChangeReturn ret;
636
637     if (!GST_IS_BIN (pipeline)) {
638       GstElement *real_pipeline = gst_element_factory_make ("pipeline", NULL);
639
640       if (real_pipeline == NULL) {
641         fprintf (stderr, _("ERROR: the 'pipeline' element wasn't found.\n"));
642         return 1;
643       }
644       gst_bin_add (GST_BIN (real_pipeline), pipeline);
645       pipeline = real_pipeline;
646     }
647     fprintf (stderr, _("Setting pipeline to PAUSED ...\n"));
648     ret = gst_element_set_state (pipeline, GST_STATE_PAUSED);
649
650     switch (ret) {
651       case GST_STATE_CHANGE_FAILURE:
652         fprintf (stderr, _("ERROR: Pipeline doesn't want to pause.\n"));
653         res = -1;
654         event_loop (pipeline, FALSE, GST_STATE_VOID_PENDING);
655         goto end;
656       case GST_STATE_CHANGE_NO_PREROLL:
657         fprintf (stderr, _("Pipeline is live and does not need PREROLL ...\n"));
658         break;
659       case GST_STATE_CHANGE_ASYNC:
660         fprintf (stderr, _("Pipeline is PREROLLING ...\n"));
661         caught_error = event_loop (pipeline, TRUE, GST_STATE_PAUSED);
662         if (caught_error) {
663           fprintf (stderr, _("ERROR: pipeline doesn't want to preroll.\n"));
664           goto end;
665         }
666         state = GST_STATE_PAUSED;
667         /* fallthrough */
668       case GST_STATE_CHANGE_SUCCESS:
669         fprintf (stderr, _("Pipeline is PREROLLED ...\n"));
670         break;
671     }
672
673     caught_error = event_loop (pipeline, FALSE, GST_STATE_VOID_PENDING);
674
675     if (caught_error) {
676       fprintf (stderr, _("ERROR: pipeline doesn't want to preroll.\n"));
677     } else {
678       GTimeVal tfthen, tfnow;
679       GstClockTimeDiff diff;
680
681       fprintf (stderr, _("Setting pipeline to PLAYING ...\n"));
682       if (gst_element_set_state (pipeline,
683               GST_STATE_PLAYING) == GST_STATE_CHANGE_FAILURE) {
684         fprintf (stderr, _("ERROR: pipeline doesn't want to play.\n"));
685         res = -1;
686         goto end;
687       }
688
689       g_get_current_time (&tfthen);
690       caught_error = event_loop (pipeline, TRUE, GST_STATE_VOID_PENDING);
691       g_get_current_time (&tfnow);
692
693       diff = GST_TIMEVAL_TO_TIME (tfnow) - GST_TIMEVAL_TO_TIME (tfthen);
694
695       g_print (_("Execution ended after %" G_GUINT64_FORMAT " ns.\n"), diff);
696     }
697     while (g_main_context_iteration (NULL, FALSE));
698
699     fprintf (stderr, _("Setting pipeline to PAUSED ...\n"));
700     gst_element_set_state (pipeline, GST_STATE_PAUSED);
701     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
702     fprintf (stderr, _("Setting pipeline to READY ...\n"));
703     gst_element_set_state (pipeline, GST_STATE_READY);
704     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
705
706   end:
707     fprintf (stderr, _("Setting pipeline to NULL ...\n"));
708     gst_element_set_state (pipeline, GST_STATE_NULL);
709     gst_element_get_state (pipeline, &state, &pending, GST_CLOCK_TIME_NONE);
710   }
711
712   fprintf (stderr, _("FREEING pipeline ...\n"));
713   gst_object_unref (pipeline);
714
715   gst_deinit ();
716   if (trace)
717     gst_alloc_trace_print_live ();
718
719   return res;
720 }