gstmultifilesrc.c 9.13 KB
Newer Older
David Schleef's avatar
David Schleef committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/* GStreamer
 * Copyright (C) 2006 David A. Schleef <ds@schleef.org>
 *
 * gstmultifilesrc.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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
/**
 * SECTION:element-multifilesrc
23
 * @short_description: Read buffers from sequentially-named files
David Schleef's avatar
David Schleef committed
24
25
 * @see_also: #GstFileSrc
 *
26
27
28
 * <refsect2>
 * <para>
 * Reads buffers from sequentially named files. If used together with an image
29
30
 * decoder, one needs to use the GstMultiFileSrc::caps property or a capsfilter
 * to force to caps containing a framerate. Otherwise image decoders send EOS
31
32
33
34
35
 * after the first picture.
 * </para>
 * <title>Example launch line</title>
 * <para>
 * <programlisting>
36
37
38
 * gst-launch multifilesrc location="img.%04d.png" index=0 caps="image/png,framerate=\(fraction\)12/1" ! \
 *     pngdec ! ffmpegcolorspace ! theoraenc ! oggmux ! \
 *     filesink location="images.ogg"
39
 * </programlisting>
40
41
 * This pipeline creates a video file "images.ogg" by joining multiple PNG
 * files named img.0000.png, img.0001.png, etc.
42
 * </para>
43
44
45
46
 * <para>
 * File names are created by replacing "%%d" with the index using printf().
 * </para>
 * </refsect2>
47
*/
David Schleef's avatar
David Schleef committed
48
49
50
51
52

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

53
#include "gstmultifilesrc.h"
David Schleef's avatar
David Schleef committed
54
55
56
57
58
59
60
61
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
87
88
89
90


static GstFlowReturn gst_multi_file_src_create (GstPushSrc * src,
    GstBuffer ** buffer);

static void gst_multi_file_src_dispose (GObject * object);

static void gst_multi_file_src_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec);
static void gst_multi_file_src_get_property (GObject * object, guint prop_id,
    GValue * value, GParamSpec * pspec);
static GstCaps *gst_multi_file_src_getcaps (GstBaseSrc * src);


static GstStaticPadTemplate gst_multi_file_src_pad_template =
GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS_ANY);

GST_DEBUG_CATEGORY_STATIC (gst_multi_file_src_debug);
#define GST_CAT_DEFAULT gst_multi_file_src_debug

static const GstElementDetails gst_multi_file_src_details =
GST_ELEMENT_DETAILS ("Multi-File Source",
    "Source/File",
    "Read stream from files",
    "David Schleef <ds@schleef.org>");

enum
{
  ARG_0,
  ARG_LOCATION,
  ARG_INDEX,
  ARG_CAPS
};

91
92
93
#define DEFAULT_LOCATION "%05d"
#define DEFAULT_INDEX 0

David Schleef's avatar
David Schleef committed
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

GST_BOILERPLATE (GstMultiFileSrc, gst_multi_file_src, GstPushSrc,
    GST_TYPE_PUSH_SRC);

static void
gst_multi_file_src_base_init (gpointer g_class)
{
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);

  GST_DEBUG_CATEGORY_INIT (gst_multi_file_src_debug, "multifilesrc", 0,
      "multifilesrc element");

  gst_element_class_add_pad_template (gstelement_class,
      gst_static_pad_template_get (&gst_multi_file_src_pad_template));
  gst_element_class_set_details (gstelement_class, &gst_multi_file_src_details);
}

static void
gst_multi_file_src_class_init (GstMultiFileSrcClass * klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  GstPushSrcClass *gstpushsrc_class = GST_PUSH_SRC_CLASS (klass);
  GstBaseSrcClass *gstbasesrc_class = GST_BASE_SRC_CLASS (klass);

  gobject_class->set_property = gst_multi_file_src_set_property;
  gobject_class->get_property = gst_multi_file_src_get_property;

  g_object_class_install_property (gobject_class, ARG_LOCATION,
      g_param_spec_string ("location", "File Location",
123
124
125
          "Pattern to create file names of input files.  File names are "
          "created by calling sprintf() with the pattern and the current "
          "index.", DEFAULT_LOCATION, G_PARAM_READWRITE));
David Schleef's avatar
David Schleef committed
126
127
  g_object_class_install_property (gobject_class, ARG_INDEX,
      g_param_spec_int ("index", "File Index",
128
129
130
          "Index to use with location property to create file names.  The "
          "index is incremented by one for each buffer read.",
          0, INT_MAX, DEFAULT_INDEX, G_PARAM_READWRITE));
David Schleef's avatar
David Schleef committed
131
132
  g_object_class_install_property (gobject_class, ARG_CAPS,
      g_param_spec_boxed ("caps", "Caps",
133
134
          "Caps describing the format of the data.",
          GST_TYPE_CAPS, G_PARAM_READWRITE));
David Schleef's avatar
David Schleef committed
135
136
137
138
139
140
141
142

  gobject_class->dispose = gst_multi_file_src_dispose;

  gstpushsrc_class->create = gst_multi_file_src_create;

  gstbasesrc_class->get_caps = gst_multi_file_src_getcaps;

  if (sizeof (off_t) < 8) {
143
144
    GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT,
        sizeof (off_t));
David Schleef's avatar
David Schleef committed
145
146
147
148
  }
}

static void
149
gst_multi_file_src_init (GstMultiFileSrc * multifilesrc,
David Schleef's avatar
David Schleef committed
150
151
152
153
    GstMultiFileSrcClass * g_class)
{
  GstPad *pad;

154
  pad = GST_BASE_SRC_PAD (multifilesrc);
David Schleef's avatar
David Schleef committed
155

156
157
  multifilesrc->index = DEFAULT_INDEX;
  multifilesrc->filename = g_strdup (DEFAULT_LOCATION);
158
  multifilesrc->successful_read = FALSE;
David Schleef's avatar
David Schleef committed
159
160
161
162
163
164
165
166
167
168
169
}

static void
gst_multi_file_src_dispose (GObject * object)
{
  GstMultiFileSrc *src = GST_MULTI_FILE_SRC (object);

  g_free (src->filename);
  src->filename = NULL;
  if (src->caps)
    gst_caps_unref (src->caps);
170
171

  G_OBJECT_CLASS (parent_class)->dispose (object);
David Schleef's avatar
David Schleef committed
172
173
174
175
176
177
178
}

static GstCaps *
gst_multi_file_src_getcaps (GstBaseSrc * src)
{
  GstMultiFileSrc *multi_file_src = GST_MULTI_FILE_SRC (src);

179
  GST_DEBUG_OBJECT (src, "returning %" GST_PTR_FORMAT, multi_file_src->caps);
David Schleef's avatar
David Schleef committed
180
181
182
183
184
185
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

  if (multi_file_src->caps) {
    return gst_caps_ref (multi_file_src->caps);
  } else {
    return gst_caps_new_any ();
  }
}

static gboolean
gst_multi_file_src_set_location (GstMultiFileSrc * src, const gchar * location)
{
  g_free (src->filename);
  if (location != NULL) {
    src->filename = g_strdup (location);
  } else {
    src->filename = NULL;
  }

  return TRUE;
}
static void
gst_multi_file_src_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec)
{
  GstMultiFileSrc *src = GST_MULTI_FILE_SRC (object);

  switch (prop_id) {
    case ARG_LOCATION:
      gst_multi_file_src_set_location (src, g_value_get_string (value));
      break;
    case ARG_INDEX:
      src->index = g_value_get_int (value);
      break;
    case ARG_CAPS:
    {
      const GstCaps *caps = gst_value_get_caps (value);
      GstCaps *new_caps;

      if (caps == NULL) {
        new_caps = gst_caps_new_any ();
      } else {
        new_caps = gst_caps_copy (caps);
      }
      gst_caps_replace (&src->caps, new_caps);
      gst_pad_set_caps (GST_BASE_SRC_PAD (src), new_caps);
    }
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
gst_multi_file_src_get_property (GObject * object, guint prop_id,
    GValue * value, GParamSpec * pspec)
{
  GstMultiFileSrc *src = GST_MULTI_FILE_SRC (object);

  switch (prop_id) {
    case ARG_LOCATION:
      g_value_set_string (value, src->filename);
      break;
    case ARG_INDEX:
      g_value_set_int (value, src->index);
      break;
    case ARG_CAPS:
      gst_value_set_caps (value, src->caps);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static gchar *
256
gst_multi_file_src_get_filename (GstMultiFileSrc * multifilesrc)
David Schleef's avatar
David Schleef committed
257
258
259
{
  gchar *filename;

260
  filename = g_strdup_printf (multifilesrc->filename, multifilesrc->index);
David Schleef's avatar
David Schleef committed
261
262
263
264
265
266
267

  return filename;
}

static GstFlowReturn
gst_multi_file_src_create (GstPushSrc * src, GstBuffer ** buffer)
{
268
  GstMultiFileSrc *multifilesrc;
David Schleef's avatar
David Schleef committed
269
270
271
272
273
274
  guint size;
  gchar *filename;
  FILE *file;
  GstBuffer *buf;
  int ret;

275
  multifilesrc = GST_MULTI_FILE_SRC (src);
David Schleef's avatar
David Schleef committed
276

277
  filename = gst_multi_file_src_get_filename (multifilesrc);
David Schleef's avatar
David Schleef committed
278

279
  GST_DEBUG_OBJECT (multifilesrc, "reading from file \"%s\".", filename);
280

David Schleef's avatar
David Schleef committed
281
282
  file = fopen (filename, "rb");
  if (!file) {
283
284
285
286
287
288
289
    if (multifilesrc->successful_read) {
      /* If we've read at least one buffer successfully, not finding the
       * next file is EOS. */
      return GST_FLOW_UNEXPECTED;
    } else {
      goto handle_error;
    }
David Schleef's avatar
David Schleef committed
290
291
292
293
294
295
296
297
298
299
300
301
302
  }

  fseek (file, 0, SEEK_END);
  size = ftell (file);
  fseek (file, 0, SEEK_SET);

  buf = gst_buffer_new_and_alloc (size);

  ret = fread (GST_BUFFER_DATA (buf), size, 1, file);
  if (ret < 1) {
    goto handle_error;
  }

303
  multifilesrc->successful_read = TRUE;
304
  multifilesrc->index++;
David Schleef's avatar
David Schleef committed
305
306

  GST_BUFFER_SIZE (buf) = size;
307
308
309
310
  GST_BUFFER_OFFSET (buf) = multifilesrc->offset;
  GST_BUFFER_OFFSET_END (buf) = multifilesrc->offset + size;
  multifilesrc->offset += size;
  gst_buffer_set_caps (buf, multifilesrc->caps);
David Schleef's avatar
David Schleef committed
311

312
  GST_DEBUG_OBJECT (multifilesrc, "read file \"%s\".", filename);
David Schleef's avatar
David Schleef committed
313

314
  fclose (file);
David Schleef's avatar
David Schleef committed
315
316
317
318
319
320
321
322
  g_free (filename);
  *buffer = buf;
  return GST_FLOW_OK;

handle_error:
  {
    switch (errno) {
      default:{
323
        GST_ELEMENT_ERROR (multifilesrc, RESOURCE, READ,
David Schleef's avatar
David Schleef committed
324
325
326
327
328
329
330
331
            ("Error while reading from file \"%s\".", filename),
            ("%s", g_strerror (errno)));
      }
    }
    g_free (filename);
    return GST_FLOW_ERROR;
  }
}