ges-structured-interface.c 16.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* GStreamer Editing Services
 *
 * Copyright (C) <2015> Thibault Saunier <tsaunier@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
#include "ges-structured-interface.h"

22 23
#include <string.h>

24

25 26 27
#define LAST_CONTAINER_QDATA g_quark_from_string("ges-structured-last-container")
#define LAST_CHILD_QDATA g_quark_from_string("ges-structured-last-child")

28 29 30 31 32 33 34 35 36 37 38 39
static gboolean
_get_clocktime (GstStructure * structure, const gchar * name, gpointer var)
{
  gboolean found = FALSE;
  GstClockTime *val = (GstClockTime *) var;

  const GValue *gvalue = gst_structure_get_value (structure, name);

  if (gvalue) {
    if (G_VALUE_TYPE (gvalue) == GST_TYPE_CLOCK_TIME) {
      *val = (GstClockTime) g_value_get_uint64 (gvalue);
      found = TRUE;
40 41 42 43 44 45 46 47 48 49 50 51
    } else if (G_VALUE_TYPE (gvalue) == G_TYPE_UINT64) {
      *val = (GstClockTime) g_value_get_uint64 (gvalue);
      found = TRUE;
    } else if (G_VALUE_TYPE (gvalue) == G_TYPE_UINT) {
      *val = (GstClockTime) g_value_get_uint (gvalue);
      found = TRUE;
    } else if (G_VALUE_TYPE (gvalue) == G_TYPE_INT) {
      *val = (GstClockTime) g_value_get_int (gvalue);
      found = TRUE;
    } else if (G_VALUE_TYPE (gvalue) == G_TYPE_INT64) {
      *val = (GstClockTime) g_value_get_int64 (gvalue);
      found = TRUE;
52
    } else if (G_VALUE_TYPE (gvalue) == G_TYPE_DOUBLE) {
53 54
      gdouble d = g_value_get_double (gvalue);

55
      found = TRUE;
56 57 58 59 60 61
      if (d == -1.0)
        *val = GST_CLOCK_TIME_NONE;
      else {
        *val = d * GST_SECOND;
        *val = GST_ROUND_UP_4 (*val);
      }
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    }
  }

  return found;
}

#define GET_AND_CHECK(name,type,var,label) G_STMT_START {\
  gboolean found = FALSE; \
\
  if (type == GST_TYPE_CLOCK_TIME) {\
    found = _get_clocktime(structure,name,var);\
  }\
  else { \
    found = gst_structure_get (structure, name, type, var, NULL); \
  }\
  if (!found) {\
    gchar *struct_str = gst_structure_to_string (structure); \
    *error = g_error_new (GES_ERROR, 0, \
        "Could not get the mandatory field '%s'" \
        " fields in %s", name, struct_str); \
    g_free (struct_str); \
    goto label;\
  } \
} G_STMT_END

87 88 89 90 91 92
#define TRY_GET_STRING(name,var,def) G_STMT_START {\
  *var = gst_structure_get_string (structure, name); \
  if (*var == NULL) \
    *var = def; \
} G_STMT_END

93
#define TRY_GET(name,type,var,def) G_STMT_START {\
94 95 96 97
  if (type == GST_TYPE_CLOCK_TIME) {\
    if (!_get_clocktime(structure,name,var))\
      *var = def; \
  } else if  (!gst_structure_get (structure, name, type, var, NULL)) {\
98 99 100 101
    *var = def; \
  } \
} G_STMT_END

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
typedef struct
{
  const gchar **fields;
  GList *invalid_fields;
} FieldsError;

static gboolean
_check_field (GQuark field_id, const GValue * value, FieldsError * fields_error)
{
  guint i;
  const gchar *field = g_quark_to_string (field_id);

  for (i = 0; fields_error->fields[i]; i++) {
    if (g_strcmp0 (fields_error->fields[i], field) == 0) {

      return TRUE;
    }
  }

  fields_error->invalid_fields =
      g_list_append (fields_error->invalid_fields, (gpointer) field);

  return TRUE;
}

static gboolean
_check_fields (GstStructure * structure, FieldsError fields_error,
    GError ** error)
{
  gst_structure_foreach (structure,
      (GstStructureForeachFunc) _check_field, &fields_error);

  if (fields_error.invalid_fields) {
    GList *tmp;
    const gchar *struct_name = gst_structure_get_name (structure);
    GString *msg = g_string_new (NULL);

    g_string_append_printf (msg, "Unknown propert%s in %s%s:",
        g_list_length (fields_error.invalid_fields) > 1 ? "ies" : "y",
        strlen (struct_name) > 1 ? "--" : "-",
        gst_structure_get_name (structure));

    for (tmp = fields_error.invalid_fields; tmp; tmp = tmp->next)
      g_string_append_printf (msg, " %s", (gchar *) tmp->data);

    if (error)
      *error = g_error_new_literal (GES_ERROR, 0, msg->str);
    GST_ERROR ("%s", msg->str);

    g_string_free (msg, TRUE);

    return FALSE;
  }

  return TRUE;
}


160 161 162 163 164 165 166 167 168 169 170 171 172 173
gboolean
_ges_add_remove_keyframe_from_struct (GESTimeline * timeline,
    GstStructure * structure, GError ** error)
{
  GESTrackElement *element;

  gdouble value;
  GstClockTime timestamp;
  GstControlBinding *binding = NULL;
  GstTimedValueControlSource *source = NULL;
  gchar *element_name = NULL, *property_name = NULL;

  gboolean ret = FALSE;

174 175 176 177 178 179 180 181 182
  const gchar *valid_fields[] =
      { "element-name", "property-name", "value", "timestamp",
    NULL
  };

  FieldsError fields_error = { valid_fields, NULL };

  if (!_check_fields (structure, fields_error, error))
    return FALSE;
183

184 185 186 187
  GET_AND_CHECK ("element-name", G_TYPE_STRING, &element_name, done);
  GET_AND_CHECK ("property-name", G_TYPE_STRING, &property_name, done);
  GET_AND_CHECK ("value", G_TYPE_DOUBLE, &value, done);
  GET_AND_CHECK ("timestamp", GST_TYPE_CLOCK_TIME, &timestamp, done);
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

  element =
      GES_TRACK_ELEMENT (ges_timeline_get_element (timeline, element_name));

  if (!GES_IS_TRACK_ELEMENT (element)) {
    *error =
        g_error_new (GES_ERROR, 0, "Could not find TrackElement %s",
        element_name);

    goto done;
  }

  binding = ges_track_element_get_control_binding (element, property_name);
  if (binding == NULL) {
    *error = g_error_new (GES_ERROR, 0, "No control binding found for %s:%s"
        " you should first set-control-binding on it",
        element_name, property_name);

    goto done;
  }

  g_object_get (binding, "control-source", &source, NULL);

  if (source == NULL) {
    *error = g_error_new (GES_ERROR, 0, "No control source found for %s:%s"
        " you should first set-control-binding on it",
        element_name, property_name);

    goto done;
  }

  if (!GST_IS_TIMED_VALUE_CONTROL_SOURCE (source)) {
    *error = g_error_new (GES_ERROR, 0, "You can use add-keyframe"
        " only on GstTimedValueControlSource not %s",
        G_OBJECT_TYPE_NAME (source));

    goto done;
  }

  if (!g_strcmp0 (gst_structure_get_name (structure), "add-keyframe"))
    ret = gst_timed_value_control_source_set (source, timestamp, value);
  else {
    ret = gst_timed_value_control_source_unset (source, timestamp);

    if (!ret) {
      *error =
          g_error_new (GES_ERROR, 0,
          "Could not unset value for timestamp: %" GST_TIME_FORMAT,
          GST_TIME_ARGS (timestamp));
    }
  }

done:
  if (source)
    gst_object_unref (source);
  g_free (element_name);
  g_free (property_name);

  return ret;

}

GESAsset *
_ges_get_asset_from_timeline (GESTimeline * timeline, GType type,
252
    const gchar * id, GError ** error)
253 254 255
{
  GESAsset *asset;
  GESProject *project = ges_timeline_get_project (timeline);
256
  GError *err = NULL;
257

258 259 260 261
  asset = ges_project_create_asset_sync (project, id, type, &err);

  if (err)
    g_propagate_error (error, err);
262
  if (!asset || (error && *error)) {
263 264 265 266

    if (error && !*error) {
      *error = g_error_new (GES_ERROR, 0,
          "There was an error requesting the asset with id %s and type %s (%s)",
Luis de Bethencourt's avatar
Luis de Bethencourt committed
267
          id, g_type_name (type), "unknown");
268 269
    }

270 271
    GST_ERROR
        ("There was an error requesting the asset with id %s and type %s (%s)",
272
        id, g_type_name (type), error ? (*error)->message : "unknown");
273 274 275 276 277 278 279 280 281 282 283

    return NULL;
  }

  return asset;
}

/* Unref after usage */
GESLayer *
_ges_get_layer_by_priority (GESTimeline * timeline, gint priority)
{
284
  GList *layers;
285
  gint nlayers;
286 287
  GESLayer *layer = NULL;

288
  priority = MAX (priority, 0);
289
  layers = ges_timeline_get_layers (timeline);
290 291 292 293 294 295 296 297 298 299 300
  nlayers = (gint) g_list_length (layers);
  if (priority >= nlayers) {
    gint i = nlayers;

    while (i <= priority) {
      layer = ges_timeline_append_layer (timeline);

      i++;
    }

    layer = gst_object_ref (layer);
301 302 303 304

    goto done;
  }

305
  layer = ges_timeline_get_layer (timeline, priority);
306 307 308 309 310 311 312

done:
  g_list_free_full (layers, gst_object_unref);

  return layer;
}

313 314 315 316 317 318 319 320
static gchar *
ensure_uri (gchar * location)
{
  if (gst_uri_is_valid (location))
    return g_strdup (location);
  else
    return gst_filename_to_uri (location, NULL);
}
321

322 323 324 325 326 327 328 329 330
gboolean
_ges_add_clip_from_struct (GESTimeline * timeline, GstStructure * structure,
    GError ** error)
{
  GESAsset *asset;
  GESLayer *layer;
  GESClip *clip;
  gint layer_priority;
  const gchar *name;
331
  const gchar *pattern;
332
  gchar *asset_id = NULL;
333
  gchar *check_asset_id = NULL;
334 335 336
  const gchar *type_string;
  GType type;
  gboolean res = FALSE;
337

338 339 340
  GstClockTime duration = 1 * GST_SECOND, inpoint = 0, start =
      GST_CLOCK_TIME_NONE;

341
  const gchar *valid_fields[] =
342
      { "asset-id", "pattern", "name", "layer-priority", "layer", "type",
343 344 345 346 347 348 349 350
    "start", "inpoint", "duration", NULL
  };

  FieldsError fields_error = { valid_fields, NULL };

  if (!_check_fields (structure, fields_error, error))
    return FALSE;

351
  GET_AND_CHECK ("asset-id", G_TYPE_STRING, &check_asset_id, beach);
352

353 354
  TRY_GET_STRING ("pattern", &pattern, NULL);
  TRY_GET_STRING ("name", &name, NULL);
355
  TRY_GET ("layer-priority", G_TYPE_INT, &layer_priority, -1);
356 357
  if (layer_priority == -1)
    TRY_GET ("layer", G_TYPE_INT, &layer_priority, -1);
358
  TRY_GET_STRING ("type", &type_string, "GESUriClip");
359
  TRY_GET ("start", GST_TYPE_CLOCK_TIME, &start, GST_CLOCK_TIME_NONE);
360 361 362 363 364 365 366 367 368 369
  TRY_GET ("inpoint", GST_TYPE_CLOCK_TIME, &inpoint, 0);
  TRY_GET ("duration", GST_TYPE_CLOCK_TIME, &duration, GST_CLOCK_TIME_NONE);

  if (!(type = g_type_from_name (type_string))) {
    *error = g_error_new (GES_ERROR, 0, "This type doesn't exist : %s",
        type_string);

    goto beach;
  }

370
  if (type == GES_TYPE_URI_CLIP) {
371
    asset_id = ensure_uri (check_asset_id);
372
  } else {
373
    asset_id = g_strdup (check_asset_id);
374 375
  }

376
  asset = _ges_get_asset_from_timeline (timeline, type, asset_id, error);
377 378 379 380 381 382
  if (!asset) {
    res = FALSE;

    goto beach;
  }

383 384 385 386 387 388 389 390
  if (layer_priority == -1) {
    GESContainer *container;

    container = g_object_get_qdata (G_OBJECT (timeline), LAST_CONTAINER_QDATA);
    if (!container || !GES_IS_CLIP (container))
      layer = _ges_get_layer_by_priority (timeline, 0);
    else
      layer = ges_clip_get_layer (GES_CLIP (container));
391 392 393

    if (!layer)
      layer = _ges_get_layer_by_priority (timeline, 0);
394 395 396
  } else {
    layer = _ges_get_layer_by_priority (timeline, layer_priority);
  }
397 398

  if (!layer) {
399 400
    *error =
        g_error_new (GES_ERROR, 0, "No layer with priority %d", layer_priority);
401 402 403 404 405 406 407 408
    goto beach;
  }

  clip = ges_layer_add_asset (layer, asset, start, inpoint, duration,
      GES_TRACK_TYPE_UNKNOWN);

  if (clip) {
    res = TRUE;
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

    if (GES_IS_TEST_CLIP (clip)) {
      if (pattern) {
        GEnumClass *enum_class =
            G_ENUM_CLASS (g_type_class_ref (GES_VIDEO_TEST_PATTERN_TYPE));
        GEnumValue *value = g_enum_get_value_by_nick (enum_class, pattern);

        if (!value) {
          res = FALSE;
          goto beach;
        }

        ges_test_clip_set_vpattern (GES_TEST_CLIP (clip), value->value);
        g_type_class_unref (enum_class);
      }
    }

426 427 428
    if (name
        && !ges_timeline_element_set_name (GES_TIMELINE_ELEMENT (clip), name)) {
      res = FALSE;
429 430
      *error =
          g_error_new (GES_ERROR, 0, "couldn't set name %s on clip with id %s",
431 432 433
          name, asset_id);
    }
  } else {
434
    *error = g_error_new (GES_ERROR, 0,
435 436 437 438
        "Couldn't add clip with id %s to layer with priority %d", asset_id,
        layer_priority);
  }

439 440 441 442 443
  if (res) {
    g_object_set_qdata (G_OBJECT (timeline), LAST_CONTAINER_QDATA, clip);
    g_object_set_qdata (G_OBJECT (timeline), LAST_CHILD_QDATA, NULL);
  }

444 445 446
  gst_object_unref (layer);

beach:
447
  g_free (asset_id);
448
  g_free (check_asset_id);
449 450 451 452 453 454 455 456 457 458 459 460 461
  return res;
}

gboolean
_ges_container_add_child_from_struct (GESTimeline * timeline,
    GstStructure * structure, GError ** error)
{
  GESAsset *asset;
  GESContainer *container;
  GESTimelineElement *child = NULL;
  const gchar *container_name, *child_name, *child_type, *id;

  gboolean res = TRUE;
462 463 464 465 466 467 468 469
  const gchar *valid_fields[] = { "container-name", "asset-id",
    "child-type", "child-name", NULL
  };

  FieldsError fields_error = { valid_fields, NULL };

  if (!_check_fields (structure, fields_error, error))
    return FALSE;
470 471

  container_name = gst_structure_get_string (structure, "container-name");
472 473 474 475 476 477 478 479

  if (container_name == NULL) {
    container = g_object_get_qdata (G_OBJECT (timeline), LAST_CONTAINER_QDATA);
  } else {
    container =
        GES_CONTAINER (ges_timeline_get_element (timeline, container_name));
  }

480 481 482 483 484 485 486 487
  g_return_val_if_fail (GES_IS_CONTAINER (container), FALSE);

  id = gst_structure_get_string (structure, "asset-id");
  child_type = gst_structure_get_string (structure, "child-type");

  if (id && child_type) {
    asset =
        _ges_get_asset_from_timeline (timeline, g_type_from_name (child_type),
488
        id, error);
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526

    if (asset == NULL) {
      res = FALSE;
      goto beach;
    }

    child = GES_TIMELINE_ELEMENT (ges_asset_extract (asset, NULL));
    if (!GES_IS_TIMELINE_ELEMENT (child)) {
      g_error_new (GES_ERROR, 0, "Could not extract child element");

      goto beach;
    }
  }

  child_name = gst_structure_get_string (structure, "child-name");
  if (!child && child_name) {
    child = ges_timeline_get_element (timeline, child_name);
    if (!GES_IS_TIMELINE_ELEMENT (child)) {
      g_error_new (GES_ERROR, 0, "Could not find child element");

      goto beach;
    }
  }

  if (!child) {
    g_error_new (GES_ERROR, 0, "Wong parametters, could not get a child");

    return FALSE;
  }

  if (child_name)
    ges_timeline_element_set_name (child, child_name);
  else
    child_name = GES_TIMELINE_ELEMENT_NAME (child);

  res = ges_container_add (container, child);
  if (res == FALSE) {
    g_error_new (GES_ERROR, 0, "Could not add child to container");
527 528
  } else {
    g_object_set_qdata (G_OBJECT (timeline), LAST_CHILD_QDATA, child);
529 530 531 532 533 534 535 536 537 538 539 540 541 542
  }

beach:
  return res;
}

gboolean
_ges_set_child_property_from_struct (GESTimeline * timeline,
    GstStructure * structure, GError ** error)
{
  const GValue *value;
  GESTimelineElement *element;
  const gchar *property_name, *element_name;

543 544 545 546 547 548 549
  const gchar *valid_fields[] = { "element-name", "property", "value", NULL };

  FieldsError fields_error = { valid_fields, NULL };

  if (!_check_fields (structure, fields_error, error))
    return FALSE;

550
  element_name = gst_structure_get_string (structure, "element-name");
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
  if (element_name == NULL)
    element = g_object_get_qdata (G_OBJECT (timeline), LAST_CHILD_QDATA);
  else
    element = ges_timeline_get_element (timeline, element_name);

  property_name = gst_structure_get_string (structure, "property");
  if (property_name == NULL) {
    const gchar *name = gst_structure_get_name (structure);

    if (g_str_has_prefix (name, "set-"))
      property_name = &name[4];
    else {
      gchar *struct_str = gst_structure_to_string (structure);

      *error =
          g_error_new (GES_ERROR, 0, "Could not find any property name in %s",
          struct_str);
      g_free (struct_str);

      return FALSE;
    }
  }

  if (element) {
    if (!ges_track_element_lookup_child (GES_TRACK_ELEMENT (element),
            property_name, NULL, NULL))
      element = NULL;
  }

  if (!element) {
    element = g_object_get_qdata (G_OBJECT (timeline), LAST_CONTAINER_QDATA);

    if (element == NULL) {
      *error =
          g_error_new (GES_ERROR, 0,
          "Could not find anywhere to set property: %s", property_name);

      return FALSE;
    }
  }

  if (!GES_IS_TIMELINE_ELEMENT (element)) {
593
    *error =
594
        g_error_new (GES_ERROR, 0, "Could not find child %s", element_name);
595 596 597 598 599 600 601 602 603

    return FALSE;
  }

  value = gst_structure_get_value (structure, "value");

  GST_DEBUG ("%s Setting %s property to %p",
      element->name, property_name, value);

604 605
  ges_timeline_element_set_child_property (element, property_name,
      (GValue *) value);
606 607 608

  return TRUE;
}
609 610 611

#undef GET_AND_CHECK
#undef TRY_GET