gesdemux.c 15.6 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 50 51 52 53 54

GST_DEBUG_CATEGORY_STATIC (gesdemux);
#define GST_CAT_DEFAULT gesdemux

static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
    GST_PAD_SINK,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("application/xges"));

55
G_DECLARE_FINAL_TYPE (GESDemux, ges_demux, GES, Demux, GESBaseBin);
56 57 58

struct _GESDemux
{
59
  GESBaseBin parent;
60 61 62 63 64

  GESTimeline *timeline;
  GstPad *sinkpad;

  GstAdapter *input_adapter;
65 66 67

  gchar *upstream_uri;
  GStatBuf stats;
68 69
};

70
G_DEFINE_TYPE (GESDemux, ges_demux, ges_base_bin_get_type ());
71
#define GES_DEMUX(obj) ((GESDemux*)obj)
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

enum
{
  PROP_0,
  PROP_TIMELINE,
  PROP_LAST
};

static GParamSpec *properties[PROP_LAST];

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:
90 91
      g_value_set_object (value,
          ges_base_bin_get_timeline (GES_BASE_BIN (self)));
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
      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);

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

116 117
  gst_tag_register ("is-ges-timeline", GST_TAG_FLAG_META, G_TYPE_BOOLEAN,
      "is-ges-timeline", "The stream is a ges timeline.", NULL);
118 119 120 121 122 123 124 125 126 127 128
  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);
129
  g_object_class_override_property (gclass, PROP_TIMELINE, "timeline");
130

131 132
  gst_element_class_add_pad_template (gstelement_klass,
      gst_static_pad_template_get (&sink_template));
133 134 135 136 137 138 139 140 141 142 143 144 145 146
  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");
}

typedef struct
{
  GESTimeline *timeline;
  GMainLoop *ml;
  GError *error;
  gulong loaded_sigid;
  gulong error_sigid;
147
  gulong error_asset_sigid;
148 149 150 151 152 153 154 155 156 157 158 159 160 161
} 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
162 163
error_loading_cb (GESProject * project, GESTimeline * timeline,
    GError * error, TimelineConstructionData * data)
164 165 166 167 168 169 170 171
{
  data->error = g_error_copy (error);
  g_signal_handler_disconnect (project, data->error_sigid);
  data->error_sigid = 0;

  g_main_loop_quit (data->ml);
}

172 173 174 175 176 177 178 179 180 181 182
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);
}

183 184 185
static gboolean
ges_demux_src_probe (GstPad * pad, GstPadProbeInfo * info, GstElement * parent)
{
186 187 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
  GESDemux *self = GES_DEMUX (parent);
  GstEvent *event;

  if (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM)) {
    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);
      }
    }
230

231 232 233
    return GST_PAD_PROBE_OK;
  }
  event = info->data;
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
  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)
{
264 265
  GstTagList *tlist = gst_tag_list_new ("is-ges-timeline", TRUE, NULL);

266 267
  gst_pad_add_probe (pad,
      GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | GST_PAD_PROBE_TYPE_QUERY_UPSTREAM,
268
      (GstPadProbeCallback) ges_demux_src_probe, element, NULL);
269 270 271

  gst_tag_list_set_scope (tlist, GST_TAG_SCOPE_GLOBAL);
  gst_pad_push_event (pad, gst_event_new_tag (tlist));
272 273 274
  return TRUE;
}

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 315 316 317 318 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
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);
  }
}

344
static gboolean
345
ges_demux_create_timeline (GESDemux * self, gchar * uri, GError ** error)
346
{
347
  GESProject *project = ges_project_new (uri);
348
  G_GNUC_UNUSED void *unused;
349 350
  TimelineConstructionData data = { 0, };
  GMainContext *ctx = g_main_context_new ();
351
  GstQuery *query;
352

353 354
  g_main_context_push_thread_default (ctx);
  data.ml = g_main_loop_new (ctx, TRUE);
355

356
  data.loaded_sigid =
357
      g_signal_connect (project, "loaded", G_CALLBACK (project_loaded_cb),
358
      &data);
359
  data.error_asset_sigid =
360 361
      g_signal_connect_after (project, "error-loading-asset",
      G_CALLBACK (error_loading_asset_cb), &data);
362 363 364
  data.error_sigid =
      g_signal_connect_after (project, "error-loading",
      G_CALLBACK (error_loading_cb), &data);
365

366 367 368
  unused = GES_TIMELINE (ges_asset_extract (GES_ASSET (project), &data.error));
  if (data.error) {
    *error = data.error;
369 370 371 372

    goto done;
  }

373 374
  g_main_loop_run (data.ml);
  g_main_loop_unref (data.ml);
375 376 377
  if (data.error)
    goto done;

378
  ges_demux_adapt_timeline_duration (self, data.timeline);
379

380 381 382
  query = gst_query_new_uri ();
  if (gst_pad_peer_query (self->sinkpad, query)) {
    GList *assets, *tmp;
383 384 385 386 387 388 389 390 391 392

    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);
    }
393 394 395 396 397

    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);

398
      if (!g_strcmp0 (id, self->upstream_uri)) {
399
        g_set_error (error, GST_STREAM_ERROR, GST_STREAM_ERROR_DEMUX,
400
            "Recursively loading uri: %s", self->upstream_uri);
401 402 403
        break;
      }
    }
404
    GST_OBJECT_UNLOCK (self);
405 406 407
    g_list_free_full (assets, g_object_unref);
  }

408
done:
409 410
  if (data.loaded_sigid)
    g_signal_handler_disconnect (project, data.loaded_sigid);
411

412 413
  if (data.error_sigid)
    g_signal_handler_disconnect (project, data.error_sigid);
414

415 416 417
  if (data.error_asset_sigid)
    g_signal_handler_disconnect (project, data.error_asset_sigid);

418
  g_clear_object (&project);
419

420 421
  GST_INFO_OBJECT (self, "Timeline properly loaded: %" GST_PTR_FORMAT,
      data.timeline);
422 423 424 425 426 427 428 429

  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;
  }
430

431
  g_main_context_pop_thread_default (ctx);
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459

  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)) {
        GError *err = NULL;
        gchar *filename = NULL, *uri = NULL;
460
        GError *error = NULL;
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
        gint f = g_file_open_tmp (NULL, &filename, &err);

        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;
        }

480
        uri = gst_filename_to_uri (filename, NULL);
481
        GST_INFO_OBJECT (self, "Pre loading the timeline.");
482

483 484
        ges_demux_create_timeline (self, uri, &error);
        if (error)
485 486 487 488 489 490 491
          goto error;

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

493 494
      error:
        ret = FALSE;
495 496 497 498 499
        gst_element_post_message (GST_ELEMENT (self),
            gst_message_new_error (parent, error,
                "Could not create timeline from description"));
        g_clear_error (&error);

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 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
        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 ();
  self->sinkpad = gst_pad_new_from_static_template (&sink_template, "sink");
  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));
}