gst/gstparse.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2002 Andy Wingo <wingo@pobox.com>
   5  *
   6  * gstparse.c: get a pipeline from a text pipeline description
   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 #include <string.h>
  25
  26 #include "gstparse.h"
  27 #include "gstinfo.h"
  28 #include "gstlog.h"
  29 #include "parse/types.h"
  30
  31 typedef struct _gst_parse_delayed_pad gst_parse_delayed_pad;
  32 struct _gst_parse_delayed_pad
  33 {
  34   gchar *name;
  35   GstPad *peer;
  36 };
  37
  38 typedef struct
  39 {
  40   gchar *srcpadname;
  41   GstPad *target_pad;
  42   GstElement *target_element;
  43   GstElement *pipeline;
  44 }
  45 dynamic_connection_t;
  46
  47
  48 GQuark
  49 gst_parse_error_quark (void)
  50 {
  51   static GQuark quark = 0;
  52   if (!quark)
  53     quark = g_quark_from_static_string ("gst_parse_error");
  54   return quark;
  55 }
  56
  57 G_GNUC_UNUSED static void
  58 dynamic_connect (GstElement * element, GstPad * newpad, gpointer data)
  59 {
  60   dynamic_connection_t *dc = (dynamic_connection_t *) data;
  61   gboolean warn = TRUE;
  62
  63   /* do we know the exact srcpadname? */
  64   if (dc->srcpadname) {
  65     GstPadTemplate *templ = gst_pad_get_pad_template (newpad);
  66
  67     /* see if this is the one */
  68     if (strcmp (gst_pad_get_name (newpad), dc->srcpadname) &&
  69         strcmp (gst_object_get_name (GST_OBJECT (templ)), dc->srcpadname)) {
  70       return;
  71     }
  72   }
  73
  74   /* try to find a target pad if we don't know it yet */
  75   if (!dc->target_pad) {
  76     if (!GST_PAD_IS_CONNECTED (newpad)) {
  77       dc->target_pad = gst_element_get_compatible_pad (dc->target_element, newpad);
  78       warn = FALSE;
  79     }
  80     else {
  81       return;
  82     }
  83   }
  84   if (!GST_PAD_IS_CONNECTED (dc->target_pad) && !GST_PAD_IS_CONNECTED (newpad)) {
  85     gst_element_set_state (dc->pipeline, GST_STATE_PAUSED);
  86     if (!gst_pad_connect (newpad, dc->target_pad) && warn) {
  87       g_warning ("could not connect %s:%s to %s:%s", GST_DEBUG_PAD_NAME (newpad),
  88                  GST_DEBUG_PAD_NAME (dc->target_pad));
  89     }
  90     gst_element_set_state (dc->pipeline, GST_STATE_PLAYING);
  91   }
  92 }
  93
  94 static gboolean
  95 make_elements (graph_t *g, GError **error)
  96 {
  97   GList *l = NULL;
  98   gchar *bin_type;
  99   element_t *e;
 100
 101   if (!(g->bins || g->elements)) {
 102     g_set_error (error,
 103                  GST_PARSE_ERROR,
 104                  GST_PARSE_ERROR_SYNTAX,
 105                  "Empty bin");
 106     return FALSE;
 107   }
 108
 109   if (g->current_bin_type)
 110     bin_type = g->current_bin_type;
 111   else
 112     bin_type = "pipeline";
 113
 114   if (!(g->bin = gst_element_factory_make (bin_type, NULL))) {
 115     g_set_error (error,
 116                  GST_PARSE_ERROR,
 117                  GST_PARSE_ERROR_NO_SUCH_ELEMENT,
 118                  "No such bin type %s", bin_type);
 119     return FALSE;
 120   }
 121
 122   l = g->elements;
 123   while (l) {
 124     e = (element_t*)l->data;
 125     if (!(e->element = gst_element_factory_make (e->type, NULL))) {
 126       g_set_error (error,
 127                    GST_PARSE_ERROR,
 128                    GST_PARSE_ERROR_NO_SUCH_ELEMENT,
 129                    "No such element %s", e->type);
 130       return FALSE;
 131     }
 132     gst_bin_add (GST_BIN (g->bin), e->element);
 133     l = g_list_next (l);
 134   }
 135
 136   l = g->bins;
 137   while (l) {
 138     if (!make_elements ((graph_t*)l->data, error))
 139       return FALSE;
 140     gst_bin_add (GST_BIN (g->bin), ((graph_t*)l->data)->bin);
 141     l = g_list_next (l);
 142   }
 143
 144   return TRUE;
 145 }
 146
 147 static gboolean
 148 set_properties (graph_t *g, GError **error)
 149 {
 150   GList *l, *l2;
 151   element_t *e;
 152   property_t *p;
 153   GParamSpec *pspec;
 154
 155   l = g->elements;
 156   while (l) {
 157     e = (element_t*)l->data;
 158     l2 = e->property_values;
 159     while (l2) {
 160       p = (property_t*)l2->data;
 161       if ((pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (e->element), p->name))) {
 162         g_object_set_property (G_OBJECT (e->element), p->name, p->value);
 163       } else {
 164         g_set_error (error,
 165                      GST_PARSE_ERROR,
 166                      GST_PARSE_ERROR_NO_SUCH_PROPERTY,
 167                      "No such property '%s' in element '%s'",
 168                      p->name, GST_OBJECT_NAME (GST_OBJECT (e->element)));
 169         return FALSE;
 170       }
 171       l2 = g_list_next (l2);
 172     }
 173     l = g_list_next (l);
 174   }
 175
 176   l = g->bins;
 177   while (l) {
 178     if (!set_properties ((graph_t*)l->data, error))
 179       return FALSE;
 180     l = g_list_next (l);
 181   }
 182
 183   return TRUE;
 184 }
 185
 186 static GstElement*
 187 find_element_by_index_recurse (graph_t *g, gint i)
 188 {
 189   GList *l;
 190   element_t *e;
 191   GstElement *element;
 192
 193   l = g->elements;
 194   while (l) {
 195     e = (element_t*)l->data;
 196     if (e->index == i) {
 197       return e->element;
 198     }
 199     l = g_list_next (l);
 200   }
 201
 202   l = g->bins;
 203   while (l) {
 204     if ((element = find_element_by_index_recurse ((graph_t*)l->data, i)))
 205       return element;
 206     l = g_list_next (l);
 207   }
 208
 209   return NULL;
 210 }
 211
 212 static GstElement*
 213 find_element_by_index (graph_t *g, gint i)
 214 {
 215   while (g->parent)
 216     g = g->parent;
 217
 218   return find_element_by_index_recurse (g, i);
 219 }
 220
 221 static gboolean
 222 make_connections (graph_t *g, GError **error)
 223 {
 224   GList *l, *a, *b;
 225   connection_t *c;
 226   dynamic_connection_t *dc;
 227   GstElement *src, *sink;
 228   GstPad *p1, *p2;
 229   GstPadTemplate *pt1, *pt2;
 230
 231   l = g->connections;
 232   while (l) {
 233     c = (connection_t*)l->data;
 234     if (c->src_name) {
 235       if (!(src = gst_bin_get_by_name (GST_BIN (g->bin), c->src_name))) {
 236         g_set_error (error,
 237                      GST_PARSE_ERROR,
 238                      GST_PARSE_ERROR_NO_SUCH_ELEMENT,
 239                      "No such element '%s'",
 240                      c->src_name);
 241         return FALSE;
 242       }
 243     } else {
 244       src = find_element_by_index (g, c->src_index);
 245       g_assert (src);
 246     }
 247     if (c->sink_name) {
 248       if (!(sink = gst_bin_get_by_name (GST_BIN (g->bin), c->sink_name))) {
 249         g_set_error (error,
 250                      GST_PARSE_ERROR,
 251                      GST_PARSE_ERROR_NO_SUCH_ELEMENT,
 252                      "No such element '%s'",
 253                      c->sink_name);
 254         return FALSE;
 255       }
 256     } else {
 257       sink = find_element_by_index (g, c->sink_index);
 258       g_assert (sink);
 259     }
 260
 261     a = c->src_pads;
 262     b = c->sink_pads;
 263     /* g_print ("a: %p, b: %p\n", a, b); */
 264     if (a && b) {
 265       /* balanced multipad connection */
 266       while (a && b) {
 267         p1 = gst_element_get_pad (src, (gchar*)a->data);
 268         p2 = gst_element_get_pad (sink, (gchar*)b->data);
 269
 270         if (!p2)
 271           goto could_not_get_pad_b;
 272
 273         if (!p1 && p2 && (pt1 = gst_element_get_pad_template (src, (gchar*)a->data)) &&
 274             pt1->presence == GST_PAD_SOMETIMES) {
 275           dc = g_new0 (dynamic_connection_t, 1);
 276           dc->srcpadname = (gchar*)a->data;
 277           dc->target_pad = p2;
 278           dc->target_element = sink;
 279           dc->pipeline = g->bin;
 280
 281           GST_DEBUG (GST_CAT_PIPELINE, "setting up dynamic connection %s:%s and %s:%s",
 282                      GST_OBJECT_NAME (GST_OBJECT (src)),
 283                      (gchar*)a->data, GST_DEBUG_PAD_NAME (p2));
 284
 285           g_signal_connect (G_OBJECT (src), "new_pad", G_CALLBACK (dynamic_connect), dc);
 286         } else if (!p1) {
 287           goto could_not_get_pad_a;
 288         } else if (!gst_pad_connect (p1, p2)) {
 289           goto could_not_connect_pads;
 290         }
 291         a = g_list_next (a);
 292         b = g_list_next (b);
 293       }
 294     } else if (a) {
 295       if ((pt1 = gst_element_get_pad_template (src, (gchar*)a->data))) {
 296         if ((p1 = gst_element_get_pad (src, (gchar*)a->data)) || pt1->presence == GST_PAD_SOMETIMES) {
 297           if (!p1) {
 298             /* sigh, a hack until i fix the gstelement api... */
 299             if ((pt2 = gst_element_get_compatible_pad_template (sink, pt1))) {
 300               if ((p2 = gst_element_get_pad (sink, pt2->name_template))) {
 301                 dc = g_new0 (dynamic_connection_t, 1);
 302                 dc->srcpadname = (gchar*)a->data;
 303                 dc->target_pad = p2;
 304                 dc->target_element = NULL;
 305                 dc->pipeline = g->bin;
 306
 307                 GST_DEBUG (GST_CAT_PIPELINE, "setting up dynamic connection %s:%s and %s:%s",
 308                            GST_OBJECT_NAME (GST_OBJECT (src)),
 309                            (gchar*)a->data, GST_DEBUG_PAD_NAME (p2));
 310
 311                 g_signal_connect (G_OBJECT (src), "new_pad", G_CALLBACK (dynamic_connect), dc);
 312                 goto next;
 313               } else {
 314                 /* both pt1 and pt2 are sometimes templates. sheesh. */
 315                 goto both_templates_have_sometimes_presence;
 316               }
 317             } else {
 318               /* if the target pad has no padtemplate we will figure out a target
 319                * pad later on */
 320               dc = g_new0 (dynamic_connection_t, 1);
 321               dc->srcpadname = (gchar*)a->data;
 322               dc->target_pad = NULL;
 323               dc->target_element = sink;
 324               dc->pipeline = g->bin;
 325
 326               GST_DEBUG (GST_CAT_PIPELINE, "setting up dynamic connection %s:%s, and some pad in %s",
 327                            GST_OBJECT_NAME (GST_OBJECT (src)),
 328                            (gchar*)a->data, GST_OBJECT_NAME (sink));
 329
 330               g_signal_connect (G_OBJECT (src), "new_pad", G_CALLBACK (dynamic_connect), dc);
 331               goto next;
 332             }
 333           } else {
 334             goto could_not_get_compatible_to_a;
 335           }
 336         } else {
 337           goto could_not_get_pad_a;
 338         }
 339       } else {
 340         goto could_not_get_pad_a;
 341       }
 342
 343       if (!gst_pad_connect (p1, p2)) {
 344         goto could_not_connect_pads;
 345       }
 346     } else if (b) {
 347       /* we don't support dynamic connections on this side yet, if ever */
 348       if (!(p2 = gst_element_get_pad (sink, (gchar*)b->data))) {
 349         goto could_not_get_pad_b;
 350       }
 351       if (!(p1 = gst_element_get_compatible_pad (src, p2))) {
 352         goto could_not_get_compatible_to_b;
 353       }
 354       if (!gst_pad_connect (p1, p2)) {
 355         goto could_not_connect_pads;
 356       }
 357     } else {
 358       if (!gst_element_connect (src, sink)) {
 359         goto could_not_connect_elements;
 360       }
 361     }
 362 next:
 363     l = g_list_next (l);
 364   }
 365
 366   l = g->bins;
 367   while (l) {
 368     if (!make_connections ((graph_t*)l->data, error))
 369       return FALSE;
 370     l = g_list_next (l);
 371   }
 372
 373   return TRUE;
 374
 375 could_not_get_pad_a:
 376   g_set_error (error,
 377                GST_PARSE_ERROR,
 378                GST_PARSE_ERROR_CONNECT,
 379                "Could not get a pad %s from element %s",
 380                (gchar*)a->data, GST_OBJECT_NAME (src));
 381   return FALSE;
 382 could_not_get_pad_b:
 383   g_set_error (error,
 384                GST_PARSE_ERROR,
 385                GST_PARSE_ERROR_CONNECT,
 386                "Could not get a pad %s from element %s",
 387                (gchar*)b->data, GST_OBJECT_NAME (sink));
 388   return FALSE;
 389 could_not_get_compatible_to_a:
 390   g_set_error (error,
 391                GST_PARSE_ERROR,
 392                GST_PARSE_ERROR_CONNECT,
 393                "Could not find a compatible pad in element %s to for %s:%s",
 394                GST_OBJECT_NAME (sink), GST_OBJECT_NAME (src), (gchar*)a->data);
 395   return FALSE;
 396 could_not_get_compatible_to_b:
 397   g_set_error (error,
 398                GST_PARSE_ERROR,
 399                GST_PARSE_ERROR_CONNECT,
 400                "Could not find a compatible pad in element %s to for %s:%s",
 401                GST_OBJECT_NAME (src), GST_OBJECT_NAME (sink), (gchar*)b->data);
 402   return FALSE;
 403 both_templates_have_sometimes_presence:
 404   g_set_error (error,
 405                GST_PARSE_ERROR,
 406                GST_PARSE_ERROR_CONNECT,
 407                "Both %s:%s and %s:%s have GST_PAD_SOMETIMES presence, operation not supported",
 408                GST_OBJECT_NAME (src), pt1->name_template, GST_OBJECT_NAME (sink), pt2->name_template);
 409   return FALSE;
 410 could_not_connect_pads:
 411   g_set_error (error,
 412                GST_PARSE_ERROR,
 413                GST_PARSE_ERROR_CONNECT,
 414                "Could not connect %s:%s to %s:%s",
 415                GST_DEBUG_PAD_NAME (p1),
 416                GST_DEBUG_PAD_NAME (p2));
 417   return FALSE;
 418 could_not_connect_elements:
 419   g_set_error (error,
 420                GST_PARSE_ERROR,
 421                GST_PARSE_ERROR_CONNECT,
 422                "Could not connect element %s to %s",
 423                GST_OBJECT_NAME (src),
 424                GST_OBJECT_NAME (sink));
 425   return FALSE;
 426 }
 427
 428 static GstBin*
 429 pipeline_from_graph (graph_t *g, GError **error)
 430 {
 431   if (!make_elements (g, error))
 432     return NULL;
 433
 434   if (!set_properties (g, error))
 435     return NULL;
 436
 437   if (!make_connections (g, error))
 438     return NULL;
 439
 440   return (GstBin*)g->bin;
 441 }
 442
 443 /**
 444  * gst_parse_launchv:
 445  * @argv: null-terminated array of arguments
 446  * @error: pointer to GError
 447  *
 448  * Create a new pipeline based on command line syntax.
 449  *
 450  * Returns: a new pipeline on success, NULL on failure and error
 451  * will contain the error message.
 452  */
 453 GstBin *
 454 gst_parse_launchv (const gchar **argv, GError **error)
 455 {
 456   GstBin *pipeline;
 457   GString *str;
 458   const gchar **argvp, *arg;
 459   gchar *tmp;
 460
 461   g_return_val_if_fail (argv != NULL, NULL);
 462
 463   /* let's give it a nice size. */
 464   str = g_string_sized_new (1024);
 465
 466   argvp = argv;
 467   while (*argvp) {
 468     arg = *argvp;
 469     tmp = _gst_parse_escape (arg);
 470     g_string_append (str, tmp);
 471     g_free (tmp);
 472     g_string_append (str, " ");
 473     argvp++;
 474   }
 475
 476   pipeline = gst_parse_launch (str->str, error);
 477
 478   g_string_free (str, TRUE);
 479
 480   return pipeline;
 481 }
 482
 483 gchar *_gst_parse_escape (const gchar *str)
 484 {
 485   GString *gstr = NULL;
 486
 487   g_return_val_if_fail (str != NULL, NULL);
 488
 489   gstr = g_string_sized_new (strlen (str));
 490
 491   while (*str) {
 492     if (*str == ' ')
 493       g_string_append_c (gstr, '\\');
 494     g_string_append_c (gstr, *str);
 495     str++;
 496   }
 497
 498   return gstr->str;
 499 }
 500
 501 void _gst_parse_unescape (gchar *str)
 502 {
 503   gchar *walk;
 504
 505   g_return_if_fail (str != NULL);
 506
 507   walk = str;
 508
 509   while (*walk) {
 510     if (*walk == '\\')
 511       walk++;
 512     *str = *walk;
 513     str++;
 514     walk++;
 515   }
 516   *str = '\0';
 517 }
 518
 519 /**
 520  * gst_parse_launch:
 521  * @pipeline_description: the command line describing the pipeline
 522  * @error: the error message in case of a failure
 523  *
 524  * Create a new pipeline based on command line syntax.
 525  *
 526  * Returns: a new bin on success, NULL on failure. By default the bin is
 527  * a GstPipeline, but it depends on the pipeline_description.
 528  */
 529 GstBin *
 530 gst_parse_launch (const gchar * pipeline_description, GError **error)
 531 {
 532   graph_t *graph;
 533   static GStaticMutex flex_lock = G_STATIC_MUTEX_INIT;
 534
 535   g_return_val_if_fail (pipeline_description != NULL, NULL);
 536
 537   GST_INFO (GST_CAT_PIPELINE, "parsing pipeline description %s",
 538             pipeline_description);
 539
 540   /* the need for the mutex will go away with flex 2.5.6 */
 541   g_static_mutex_lock (&flex_lock);
 542   graph = _gst_parse_launch (pipeline_description, error);
 543   g_static_mutex_unlock (&flex_lock);
 544
 545   if (!graph)
 546     return NULL;
 547
 548   return pipeline_from_graph (graph, error);
 549 }