gesdemux.c 18.3 KB
Newer Older
1 2
/* GStreamer GES plugin
 *
Thibault Saunier's avatar
Thibault Saunier committed
3 4
 * Copyright (C) 2019 Igalia S.L
 *     Author: 2019 Thibault Saunier <tsaunier@igalia.com>
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * gesdemux.c
 *
 * 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., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
Thibault Saunier's avatar
Thibault Saunier committed
22
 */
23

Thibault Saunier's avatar
Thibault Saunier committed
24
 /**
25 26 27 28 29 30 31 32 33 34 35 36 37 38
 * SECTION:gstdemux
 * @short_description: A GstBin subclasses use to use GESTimeline
 * as demux inside any GstPipeline.
 * @see_also: #GESTimeline
 *
 * The gstdemux is a bin that will simply expose the track source pads
 * and implements the GstUriHandler interface using a custom ges://0Xpointer
 * uri scheme.
 **/

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

39 40
#include "gesbasebin.h"

41 42 43
#include <gst/gst.h>
#include <glib/gstdio.h>
#include <gst/pbutils/pbutils.h>
44 45
#include <gst/base/gstadapter.h>
#include <ges/ges.h>
46 47 48 49

GST_DEBUG_CATEGORY_STATIC (gesdemux);
#define GST_CAT_DEFAULT gesdemux

50
G_DECLARE_FINAL_TYPE (GESDemux, ges_demux, GES, DEMUX, GESBaseBin);
51 52 53

struct _GESDemux
{
54
  GESBaseBin parent;
55 56 57 58 59

  GESTimeline *timeline;
  GstPad *sinkpad;

  GstAdapter *input_adapter;
60 61 62

  gchar *upstream_uri;
  GStatBuf stats;
63 64
};

65
G_DEFINE_TYPE (GESDemux, ges_demux, ges_base_bin_get_type ());
66
#define GES_DEMUX(obj) ((GESDemux*)obj)
67 68 69 70 71 72 73 74 75 76

enum
{
  PROP_0,
  PROP_TIMELINE,
  PROP_LAST
};

static GParamSpec *properties[PROP_LAST];

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 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 160 161 162
static GstCaps *
ges_demux_get_sinkpad_caps ()
{
  GList *tmp, *formatters;
  GstCaps *sinkpad_caps = gst_caps_new_empty ();

  formatters = ges_list_assets (GES_TYPE_FORMATTER);
  for (tmp = formatters; tmp; tmp = tmp->next) {
    GstCaps *caps;
    const gchar *mimetype =
        ges_meta_container_get_string (GES_META_CONTAINER (tmp->data),
        GES_META_FORMATTER_MIMETYPE);
    if (!mimetype)
      continue;

    caps = gst_caps_from_string (mimetype);

    if (!caps) {
      GST_INFO_OBJECT (tmp->data,
          "%s - could not create caps from mimetype: %s",
          ges_meta_container_get_string (GES_META_CONTAINER (tmp->data),
              GES_META_FORMATTER_NAME), mimetype);

      continue;
    }

    gst_caps_append (sinkpad_caps, caps);
  }
  g_list_free (formatters);

  return sinkpad_caps;
}

static gchar *
ges_demux_get_extension (GstStructure * _struct)
{
  GList *tmp, *formatters;
  gchar *ext = NULL;

  formatters = ges_list_assets (GES_TYPE_FORMATTER);
  for (tmp = formatters; tmp; tmp = tmp->next) {
    gchar **extensions_a;
    gint i, n_exts;
    GstCaps *caps;
    const gchar *mimetype =
        ges_meta_container_get_string (GES_META_CONTAINER (tmp->data),
        GES_META_FORMATTER_MIMETYPE);
    const gchar *extensions =
        ges_meta_container_get_string (GES_META_CONTAINER (tmp->data),
        GES_META_FORMATTER_EXTENSION);
    if (!mimetype)
      continue;

    if (!extensions)
      continue;

    caps = gst_caps_from_string (mimetype);
    if (!caps) {
      GST_INFO_OBJECT (tmp->data,
          "%s - could not create caps from mimetype: %s",
          ges_meta_container_get_string (GES_META_CONTAINER (tmp->data),
              GES_META_FORMATTER_NAME), mimetype);

      continue;
    }

    extensions_a = g_strsplit (extensions, ",", -1);
    n_exts = g_strv_length (extensions_a);
    for (i = 0; i < gst_caps_get_size (caps) && i < n_exts; i++) {
      GstStructure *structure = gst_caps_get_structure (caps, i);

      if (gst_structure_has_name (_struct, gst_structure_get_name (structure))) {
        ext = g_strdup (extensions_a[i]);
        g_strfreev (extensions_a);
        gst_caps_unref (caps);
        goto done;
      }
    }
    g_strfreev (extensions_a);
  }
done:
  g_list_free (formatters);

  return ext;
}

163 164 165 166 167 168 169 170
static void
ges_demux_get_property (GObject * object, guint property_id,
    GValue * value, GParamSpec * pspec)
{
  GESDemux *self = GES_DEMUX (object);

  switch (property_id) {
    case PROP_TIMELINE:
171 172
      g_value_set_object (value,
          ges_base_bin_get_timeline (GES_BASE_BIN (self)));
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  }
}

static void
ges_demux_set_property (GObject * object, guint property_id,
    const GValue * value, GParamSpec * pspec)
{
  switch (property_id) {
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  }
}

static void
ges_demux_class_init (GESDemuxClass * self_class)
{
  GObjectClass *gclass = G_OBJECT_CLASS (self_class);
  GstElementClass *gstelement_klass = GST_ELEMENT_CLASS (self_class);
194
  GstCaps *sinkpad_caps = ges_demux_get_sinkpad_caps ();
195 196 197

  GST_DEBUG_CATEGORY_INIT (gesdemux, "gesdemux", 0, "ges demux element");

198 199
  gst_tag_register ("is-ges-timeline", GST_TAG_FLAG_META, G_TYPE_BOOLEAN,
      "is-ges-timeline", "The stream is a ges timeline.", NULL);
200 201 202 203 204 205 206 207 208 209 210
  gclass->get_property = ges_demux_get_property;
  gclass->set_property = ges_demux_set_property;

  /**
   * GESDemux:timeline:
   *
   * Timeline to use in this source.
   */
  properties[PROP_TIMELINE] = g_param_spec_object ("timeline", "Timeline",
      "Timeline to use in this source.",
      GES_TYPE_TIMELINE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
211
  g_object_class_override_property (gclass, PROP_TIMELINE, "timeline");
212 213 214 215 216 217

  gst_element_class_set_static_metadata (gstelement_klass,
      "GStreamer Editing Services based 'demuxer'",
      "Codec/Demux/Editing",
      "Demuxer for complex timeline file formats using GES.",
      "Thibault Saunier <tsaunier@igalia.com");
218 219 220 221 222

  gst_element_class_add_pad_template (gstelement_klass,
      gst_pad_template_new ("sink", GST_PAD_SINK, GST_PAD_ALWAYS,
          sinkpad_caps));
  gst_caps_unref (sinkpad_caps);
223 224 225 226 227 228 229 230 231
}

typedef struct
{
  GESTimeline *timeline;
  GMainLoop *ml;
  GError *error;
  gulong loaded_sigid;
  gulong error_sigid;
232
  gulong error_asset_sigid;
233 234 235 236 237 238 239 240 241 242 243 244 245 246
} TimelineConstructionData;

static void
project_loaded_cb (GESProject * project, GESTimeline * timeline,
    TimelineConstructionData * data)
{
  data->timeline = timeline;
  g_signal_handler_disconnect (project, data->loaded_sigid);
  data->loaded_sigid = 0;

  g_main_loop_quit (data->ml);
}

static void
247 248
error_loading_cb (GESProject * project, GESTimeline * timeline,
    GError * error, TimelineConstructionData * data)
249 250 251 252 253 254 255 256
{
  data->error = g_error_copy (error);
  g_signal_handler_disconnect (project, data->error_sigid);
  data->error_sigid = 0;

  g_main_loop_quit (data->ml);
}

257 258 259 260 261 262 263 264 265 266 267
static void
error_loading_asset_cb (GESProject * project, GError * error, gchar * id,
    GType extractable_type, TimelineConstructionData * data)
{
  data->error = g_error_copy (error);
  g_signal_handler_disconnect (project, data->error_asset_sigid);
  data->error_asset_sigid = 0;

  g_main_loop_quit (data->ml);
}

268 269 270
static gboolean
ges_demux_src_probe (GstPad * pad, GstPadProbeInfo * info, GstElement * parent)
{
271 272 273
  GESDemux *self = GES_DEMUX (parent);
  GstEvent *event;

274
  if (info->type & (GST_PAD_PROBE_TYPE_QUERY_UPSTREAM)) {
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
    GstQuery *query = info->data;

    if (GST_QUERY_TYPE (query) == GST_QUERY_CUSTOM) {
      GstStructure *structure =
          (GstStructure *) gst_query_get_structure (query);

      if (gst_structure_has_name (structure,
              "NleCompositionQueryNeedsTearDown")) {
        GstQuery *uri_query = gst_query_new_uri ();

        if (gst_pad_peer_query (self->sinkpad, uri_query)) {
          gchar *upstream_uri = NULL;
          GStatBuf stats;
          gst_query_parse_uri (uri_query, &upstream_uri);

          if (gst_uri_has_protocol (upstream_uri, "file")) {
            gchar *location = gst_uri_get_location (upstream_uri);

            g_stat (location, &stats);
            g_free (location);
            GST_OBJECT_LOCK (self);
            if (g_strcmp0 (upstream_uri, self->upstream_uri)
                || stats.st_mtime != self->stats.st_mtime
                || stats.st_size != self->stats.st_size) {
              GST_INFO_OBJECT (self,
                  "Underlying file changed, asking for an update");
              gst_structure_set (structure, "result", G_TYPE_BOOLEAN, TRUE,
                  NULL);
              g_free (self->upstream_uri);
              self->upstream_uri = upstream_uri;
              self->stats = stats;
            } else {
              g_free (upstream_uri);
            }
            GST_OBJECT_UNLOCK (self);
          }
        }
        gst_query_unref (uri_query);
      }
    }
315

316 317 318
    return GST_PAD_PROBE_OK;
  }
  event = info->data;
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
  switch (GST_EVENT_TYPE (event)) {
    case GST_EVENT_STREAM_START:
    {
      const gchar *stream_id;
      gchar *new_stream_id;
      guint stream_group;

      gst_event_parse_stream_start (event, &stream_id);
      gst_event_parse_group_id (event, &stream_group);
      new_stream_id =
          gst_pad_create_stream_id (pad, GST_ELEMENT (parent), stream_id);
      gst_event_unref (event);

      event = gst_event_new_stream_start (new_stream_id);
      gst_event_set_group_id (event, stream_group);
      g_free (new_stream_id);
      break;
    }
    default:
      break;
  }
  info->data = event;

  return GST_PAD_PROBE_OK;
}

static gboolean
ges_demux_set_srcpad_probe (GstElement * element, GstPad * pad,
    gpointer user_data)
{
349 350
  GstTagList *tlist = gst_tag_list_new ("is-ges-timeline", TRUE, NULL);

351 352
  gst_pad_add_probe (pad,
      GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | GST_PAD_PROBE_TYPE_QUERY_UPSTREAM,
353
      (GstPadProbeCallback) ges_demux_src_probe, element, NULL);
354 355 356

  gst_tag_list_set_scope (tlist, GST_TAG_SCOPE_GLOBAL);
  gst_pad_push_event (pad, gst_event_new_tag (tlist));
357 358 359
  return TRUE;
}

360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
static void
ges_demux_adapt_timeline_duration (GESDemux * self, GESTimeline * timeline)
{
  GType nleobject_type = g_type_from_name ("NleObject");
  GstObject *parent, *tmpparent;

  parent = gst_object_get_parent (GST_OBJECT (self));
  while (parent) {
    if (g_type_is_a (G_OBJECT_TYPE (parent), nleobject_type)) {
      GstClockTime duration, inpoint, timeline_duration;

      g_object_get (parent, "duration", &duration, "inpoint", &inpoint, NULL);
      g_object_get (timeline, "duration", &timeline_duration, NULL);

      if (inpoint + duration > timeline_duration) {
        GESLayer *layer = ges_timeline_get_layer (timeline, 0);

        if (layer) {
          GESClip *clip = GES_CLIP (ges_test_clip_new ());
          GList *tmp, *tracks = ges_timeline_get_tracks (timeline);

          g_object_set (clip, "start", timeline_duration, "duration",
              inpoint + duration, "vpattern", GES_VIDEO_TEST_PATTERN_SMPTE75,
              NULL);
          ges_layer_add_clip (layer, clip);
          for (tmp = tracks; tmp; tmp = tmp->next) {
            if (GES_IS_VIDEO_TRACK (tmp->data)) {
              GESEffect *text;
              GstCaps *caps;
              gchar *effect_str_full = NULL;
              const gchar *effect_str =
                  "textoverlay text=\"Nested timeline too short, please FIX!\" halignment=center valignment=center";

              g_object_get (tmp->data, "restriction-caps", &caps, NULL);
              if (caps) {
                gchar *caps_str = gst_caps_to_string (caps);
                effect_str = effect_str_full =
                    g_strdup_printf ("capsfilter caps=\"%s\" ! %s", caps_str,
                    effect_str);
                g_free (caps_str);
                gst_caps_unref (caps);
              }
              text = ges_effect_new (effect_str);
              g_free (effect_str_full);

              ges_container_add (GES_CONTAINER (clip),
                  GES_TIMELINE_ELEMENT (text));
            }

          }
          g_list_free_full (tracks, gst_object_unref);
          GST_INFO_OBJECT (timeline,
              "Added test clip with duration: %" GST_TIME_FORMAT " - %"
              GST_TIME_FORMAT " to match parent nleobject duration",
              GST_TIME_ARGS (timeline_duration),
              GST_TIME_ARGS (inpoint + duration - timeline_duration));
        }
      }
      gst_object_unref (parent);

      return;
    }

    tmpparent = parent;
    parent = gst_object_get_parent (GST_OBJECT (parent));
    gst_object_unref (tmpparent);
  }
}

429
static gboolean
430
ges_demux_create_timeline (GESDemux * self, gchar * uri, GError ** error)
431
{
432
  GESProject *project = ges_project_new (uri);
433
  G_GNUC_UNUSED void *unused;
434 435
  TimelineConstructionData data = { 0, };
  GMainContext *ctx = g_main_context_new ();
436
  GstQuery *query;
437

438 439
  g_main_context_push_thread_default (ctx);
  data.ml = g_main_loop_new (ctx, TRUE);
440

441
  data.loaded_sigid =
442
      g_signal_connect (project, "loaded", G_CALLBACK (project_loaded_cb),
443
      &data);
444
  data.error_asset_sigid =
445 446
      g_signal_connect_after (project, "error-loading-asset",
      G_CALLBACK (error_loading_asset_cb), &data);
447 448 449
  data.error_sigid =
      g_signal_connect_after (project, "error-loading",
      G_CALLBACK (error_loading_cb), &data);
450

451 452 453
  unused = GES_TIMELINE (ges_asset_extract (GES_ASSET (project), &data.error));
  if (data.error) {
    *error = data.error;
454 455 456 457

    goto done;
  }

458 459
  g_main_loop_run (data.ml);
  g_main_loop_unref (data.ml);
460 461 462
  if (data.error)
    goto done;

463
  ges_demux_adapt_timeline_duration (self, data.timeline);
464

465 466 467
  query = gst_query_new_uri ();
  if (gst_pad_peer_query (self->sinkpad, query)) {
    GList *assets, *tmp;
468 469 470 471 472 473 474 475 476 477

    GST_OBJECT_LOCK (self);
    g_free (self->upstream_uri);
    gst_query_parse_uri (query, &self->upstream_uri);
    if (gst_uri_has_protocol (self->upstream_uri, "file")) {
      gchar *location = gst_uri_get_location (self->upstream_uri);

      g_stat (location, &self->stats);
      g_free (location);
    }
478 479 480 481 482

    assets = ges_project_list_assets (project, GES_TYPE_URI_CLIP);
    for (tmp = assets; tmp; tmp = tmp->next) {
      const gchar *id = ges_asset_get_id (tmp->data);

483
      if (!g_strcmp0 (id, self->upstream_uri)) {
484
        g_set_error (error, GST_STREAM_ERROR, GST_STREAM_ERROR_DEMUX,
485
            "Recursively loading uri: %s", self->upstream_uri);
486 487 488
        break;
      }
    }
489
    GST_OBJECT_UNLOCK (self);
490 491 492
    g_list_free_full (assets, g_object_unref);
  }

493
done:
494 495
  if (data.loaded_sigid)
    g_signal_handler_disconnect (project, data.loaded_sigid);
496

497 498
  if (data.error_sigid)
    g_signal_handler_disconnect (project, data.error_sigid);
499

500 501 502
  if (data.error_asset_sigid)
    g_signal_handler_disconnect (project, data.error_asset_sigid);

503
  g_clear_object (&project);
504

505 506
  GST_INFO_OBJECT (self, "Timeline properly loaded: %" GST_PTR_FORMAT,
      data.timeline);
507 508 509 510 511 512 513 514

  if (!data.error) {
    ges_base_bin_set_timeline (GES_BASE_BIN (self), data.timeline);
    gst_element_foreach_src_pad (GST_ELEMENT (self), ges_demux_set_srcpad_probe,
        NULL);
  } else {
    *error = data.error;
  }
515

516
  g_main_context_pop_thread_default (ctx);
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542

  return G_SOURCE_REMOVE;
}

static gboolean
ges_demux_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
{
  GESDemux *self = GES_DEMUX (parent);

  switch (event->type) {
    case GST_EVENT_EOS:{
      GstMapInfo map;
      GstBuffer *xges_buffer;
      gboolean ret = TRUE;
      gsize available;

      available = gst_adapter_available (self->input_adapter);
      if (available == 0) {
        GST_WARNING_OBJECT (self,
            "Received EOS without any serialized timeline.");

        return gst_pad_event_default (pad, parent, event);
      }

      xges_buffer = gst_adapter_take_buffer (self->input_adapter, available);
      if (gst_buffer_map (xges_buffer, &map, GST_MAP_READ)) {
543
        gint f;
544
        GError *err = NULL;
545
        gchar *template = NULL;
546
        gchar *filename = NULL, *uri = NULL;
547 548 549 550 551 552 553 554 555 556 557 558
        GstCaps *caps = gst_pad_get_current_caps (pad);
        GstStructure *structure = gst_caps_get_structure (caps, 0);
        gchar *ext = ges_demux_get_extension (structure);

        gst_caps_unref (caps);
        if (ext) {
          template = g_strdup_printf ("XXXXXX.%s", ext);
          g_free (ext);
        }

        f = g_file_open_tmp (template, &filename, &err);
        g_free (template);
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576

        if (err) {
          GST_ELEMENT_ERROR (self, RESOURCE, OPEN_WRITE,
              ("Could not open temporary file to write timeline description"),
              ("%s", err->message));

          goto error;
        }

        g_file_set_contents (filename, (gchar *) map.data, map.size, &err);
        if (err) {
          GST_ELEMENT_ERROR (self, RESOURCE, WRITE,
              ("Could not write temporary timeline description file"),
              ("%s", err->message));

          goto error;
        }

577
        uri = gst_filename_to_uri (filename, NULL);
578
        GST_INFO_OBJECT (self, "Pre loading the timeline.");
579

580 581
        ges_demux_create_timeline (self, uri, &err);
        if (err)
582 583 584 585 586 587 588
          goto error;

      done:
        g_free (filename);
        g_free (uri);
        g_close (f, NULL);
        return ret;
589

590 591
      error:
        ret = FALSE;
592
        gst_element_post_message (GST_ELEMENT (self),
593
            gst_message_new_error (parent, err,
594
                "Could not create timeline from description"));
595
        g_clear_error (&err);
596

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
        goto done;
      } else {
        GST_ELEMENT_ERROR (self, RESOURCE, READ,
            ("Could not map buffer containing timeline description"),
            ("Not info"));
      }
    }
    default:
      break;
  }

  return gst_pad_event_default (pad, parent, event);
}

static GstFlowReturn
ges_demux_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
{
  GESDemux *self = GES_DEMUX (parent);

  gst_adapter_push (self->input_adapter, buffer);

  GST_INFO_OBJECT (self, "Received buffer, total size is %i bytes",
      (gint) gst_adapter_available (self->input_adapter));

  return GST_FLOW_OK;
}

static void
ges_demux_init (GESDemux * self)
{
  ges_init ();
628

629 630 631
  SUPRESS_UNUSED_WARNING (GES_DEMUX);
  SUPRESS_UNUSED_WARNING (GES_IS_DEMUX);

632 633 634
  self->sinkpad =
      gst_pad_new_from_template (gst_element_get_pad_template (GST_ELEMENT
          (self), "sink"), "sink");
635 636 637 638 639 640 641 642 643 644
  gst_element_add_pad (GST_ELEMENT (self), self->sinkpad);

  self->input_adapter = gst_adapter_new ();

  gst_pad_set_chain_function (self->sinkpad,
      GST_DEBUG_FUNCPTR (ges_demux_sink_chain));

  gst_pad_set_event_function (self->sinkpad,
      GST_DEBUG_FUNCPTR (ges_demux_sink_event));
}