tests/examples/app/appsrc-seekable.c

   1 /* GStreamer
   2  *
   3  * appsrc-seekable.c: example for using appsrc in seekable mode.
   4  *
   5  * Copyright (C) 2008 Wim Taymans <wim.taymans@gmail.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <gst/gst.h>
  28
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <stdlib.h>
  32
  33 GST_DEBUG_CATEGORY (appsrc_playbin_debug);
  34 #define GST_CAT_DEFAULT appsrc_playbin_debug
  35
  36 /*
  37  * an example application of using appsrc in seekable mode. When the
  38  * appsrc requests data with the need-data signal, we retrieve a buffer and
  39  * push it to appsrc. We can also use the method as demonstrated in
  40  * appsrc-stream.c, ie. pushing buffers when we can.
  41  *
  42  * This is a good example how one would deal with a remote http server that
  43  * supports range requests.
  44  *
  45  * Appsrc in seekable mode needs seeking support and we must thus connect
  46  * to the seek signal to perform any seeks when requested.
  47  *
  48  * In seekable mode we should set the size of the source material.
  49  */
  50 typedef struct _App App;
  51
  52 struct _App
  53 {
  54   GstElement *playbin;
  55   GstElement *appsrc;
  56
  57   GMainLoop *loop;
  58
  59   GMappedFile *file;
  60   guint8 *data;
  61   gsize length;
  62   guint64 offset;
  63 };
  64
  65 App s_app;
  66
  67 #define CHUNK_SIZE  4096
  68
  69 /* This method is called by the need-data signal callback, we feed data into the
  70  * appsrc with an arbitrary size.
  71  */
  72 static void
  73 feed_data (GstElement * appsrc, guint size, App * app)
  74 {
  75   GstBuffer *buffer;
  76   guint len;
  77   GstFlowReturn ret;
  78
  79   if (app->offset >= app->length) {
  80     /* we are EOS, send end-of-stream */
  81     g_signal_emit_by_name (app->appsrc, "end-of-stream", &ret);
  82     return;
  83   }
  84
  85   /* read any amount of data, we are allowed to return less if we are EOS */
  86   buffer = gst_buffer_new ();
  87
  88   len = CHUNK_SIZE;
  89   if (app->offset + len > app->length)
  90     len = app->length - app->offset;
  91
  92   gst_buffer_append_memory (buffer,
  93       gst_memory_new_wrapped (GST_MEMORY_FLAG_READONLY,
  94           app->data, app->length, app->offset, len, NULL, NULL));
  95
  96   GST_DEBUG ("feed buffer %p, offset %" G_GUINT64_FORMAT "-%u", buffer,
  97       app->offset, len);
  98   g_signal_emit_by_name (app->appsrc, "push-buffer", buffer, &ret);
  99   gst_buffer_unref (buffer);
 100
 101   app->offset += len;
 102
 103   return;
 104 }
 105
 106 /* called when appsrc wants us to return data from a new position with the next
 107  * call to push-buffer. */
 108 static gboolean
 109 seek_data (GstElement * appsrc, guint64 position, App * app)
 110 {
 111   GST_DEBUG ("seek to offset %" G_GUINT64_FORMAT, position);
 112   app->offset = position;
 113
 114   return TRUE;
 115 }
 116
 117 /* this callback is called when playbin has constructed a source object to read
 118  * from. Since we provided the appsrc:// uri to playbin, this will be the
 119  * appsrc that we must handle. We set up some signals to push data into appsrc
 120  * and one to perform a seek. */
 121 static void
 122 found_source (GObject * object, GObject * orig, GParamSpec * pspec, App * app)
 123 {
 124   /* get a handle to the appsrc */
 125   g_object_get (orig, pspec->name, &app->appsrc, NULL);
 126
 127   GST_DEBUG ("got appsrc %p", app->appsrc);
 128
 129   /* we can set the length in appsrc. This allows some elements to estimate the
 130    * total duration of the stream. It's a good idea to set the property when you
 131    * can but it's not required. */
 132   g_object_set (app->appsrc, "size", (gint64) app->length, NULL);
 133   /* we are seekable in push mode, this means that the element usually pushes
 134    * out buffers of an undefined size and that seeks happen only occasionally
 135    * and only by request of the user. */
 136   gst_util_set_object_arg (G_OBJECT (app->appsrc), "stream-type", "seekable");
 137
 138   /* configure the appsrc, we will push a buffer to appsrc when it needs more
 139    * data */
 140   g_signal_connect (app->appsrc, "need-data", G_CALLBACK (feed_data), app);
 141   g_signal_connect (app->appsrc, "seek-data", G_CALLBACK (seek_data), app);
 142 }
 143
 144 static gboolean
 145 bus_message (GstBus * bus, GstMessage * message, App * app)
 146 {
 147   GST_DEBUG ("got message %s",
 148       gst_message_type_get_name (GST_MESSAGE_TYPE (message)));
 149
 150   switch (GST_MESSAGE_TYPE (message)) {
 151     case GST_MESSAGE_ERROR:
 152       g_error ("received error");
 153       g_main_loop_quit (app->loop);
 154       break;
 155     case GST_MESSAGE_EOS:
 156       g_main_loop_quit (app->loop);
 157       break;
 158     default:
 159       break;
 160   }
 161   return TRUE;
 162 }
 163
 164 int
 165 main (int argc, char *argv[])
 166 {
 167   App *app = &s_app;
 168   GError *error = NULL;
 169   GstBus *bus;
 170
 171   gst_init (&argc, &argv);
 172
 173   GST_DEBUG_CATEGORY_INIT (appsrc_playbin_debug, "appsrc-playbin", 0,
 174       "appsrc playbin example");
 175
 176   if (argc < 2) {
 177     g_print ("usage: %s <filename>\n", argv[0]);
 178     return -1;
 179   }
 180
 181   /* try to open the file as an mmapped file */
 182   app->file = g_mapped_file_new (argv[1], FALSE, &error);
 183   if (error) {
 184     g_print ("failed to open file: %s\n", error->message);
 185     g_error_free (error);
 186     return -2;
 187   }
 188   /* get some vitals, this will be used to read data from the mmapped file and
 189    * feed it to appsrc. */
 190   app->length = g_mapped_file_get_length (app->file);
 191   app->data = (guint8 *) g_mapped_file_get_contents (app->file);
 192   app->offset = 0;
 193
 194   /* create a mainloop to get messages */
 195   app->loop = g_main_loop_new (NULL, TRUE);
 196
 197   app->playbin = gst_element_factory_make ("playbin", NULL);
 198   g_assert (app->playbin);
 199
 200   bus = gst_pipeline_get_bus (GST_PIPELINE (app->playbin));
 201
 202   /* add watch for messages */
 203   gst_bus_add_watch (bus, (GstBusFunc) bus_message, app);
 204
 205   /* set to read from appsrc */
 206   g_object_set (app->playbin, "uri", "appsrc://", NULL);
 207
 208   /* get notification when the source is created so that we get a handle to it
 209    * and can configure it */
 210   g_signal_connect (app->playbin, "deep-notify::source",
 211       (GCallback) found_source, app);
 212
 213   /* go to playing and wait in a mainloop. */
 214   gst_element_set_state (app->playbin, GST_STATE_PLAYING);
 215
 216   /* this mainloop is stopped when we receive an error or EOS */
 217   g_main_loop_run (app->loop);
 218
 219   GST_DEBUG ("stopping");
 220
 221   gst_element_set_state (app->playbin, GST_STATE_NULL);
 222
 223   /* free the file */
 224   g_mapped_file_unref (app->file);
 225
 226   gst_object_unref (bus);
 227   g_main_loop_unref (app->loop);
 228
 229   return 0;
 230 }