2 * Copyright (C) 2006 David A. Schleef <ds@schleef.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
22 * SECTION:element-multifilesrc
23 * @see_also: #GstFileSrc
25 * Reads buffers from sequentially named files. If used together with an image
26 * decoder, one needs to use the #GstMultiFileSrc:caps property or a capsfilter
27 * to force to caps containing a framerate. Otherwise image decoders send EOS
28 * after the first picture.
30 * File names are created by replacing "\%d" with the index using printf().
33 * <title>Example launch line</title>
35 * gst-launch multifilesrc location="img.%04d.png" index=0 caps="image/png,framerate=\(fraction\)12/1" ! \
36 * pngdec ! ffmpegcolorspace ! theoraenc ! oggmux ! \
37 * filesink location="images.ogg"
38 * ]| This pipeline creates a video file "images.ogg" by joining multiple PNG
39 * files named img.0000.png, img.0001.png, etc.
47 #include "gstmultifilesrc.h"
50 static GstFlowReturn gst_multi_file_src_create (GstPushSrc * src,
53 static void gst_multi_file_src_dispose (GObject * object);
55 static void gst_multi_file_src_set_property (GObject * object, guint prop_id,
56 const GValue * value, GParamSpec * pspec);
57 static void gst_multi_file_src_get_property (GObject * object, guint prop_id,
58 GValue * value, GParamSpec * pspec);
59 static GstCaps *gst_multi_file_src_getcaps (GstBaseSrc * src, GstCaps * filter);
60 static gboolean gst_multi_file_src_query (GstBaseSrc * src, GstQuery * query);
63 static GstStaticPadTemplate gst_multi_file_src_pad_template =
64 GST_STATIC_PAD_TEMPLATE ("src",
69 GST_DEBUG_CATEGORY_STATIC (gst_multi_file_src_debug);
70 #define GST_CAT_DEFAULT gst_multi_file_src_debug
83 #define DEFAULT_LOCATION "%05d"
84 #define DEFAULT_INDEX 0
86 #define gst_multi_file_src_parent_class parent_class
87 G_DEFINE_TYPE (GstMultiFileSrc, gst_multi_file_src, GST_TYPE_PUSH_SRC);
91 gst_multi_file_src_class_init (GstMultiFileSrcClass * klass)
93 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
94 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
95 GstPushSrcClass *gstpushsrc_class = GST_PUSH_SRC_CLASS (klass);
96 GstBaseSrcClass *gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
98 gobject_class->set_property = gst_multi_file_src_set_property;
99 gobject_class->get_property = gst_multi_file_src_get_property;
101 g_object_class_install_property (gobject_class, ARG_LOCATION,
102 g_param_spec_string ("location", "File Location",
103 "Pattern to create file names of input files. File names are "
104 "created by calling sprintf() with the pattern and the current "
105 "index.", DEFAULT_LOCATION,
106 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
107 g_object_class_install_property (gobject_class, ARG_INDEX,
108 g_param_spec_int ("index", "File Index",
109 "Index to use with location property to create file names. The "
110 "index is incremented by one for each buffer read.",
111 0, INT_MAX, DEFAULT_INDEX,
112 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
113 g_object_class_install_property (gobject_class, ARG_START_INDEX,
114 g_param_spec_int ("start-index", "Start Index",
115 "Start value of index. The initial value of index can be set "
116 "either by setting index or start-index. When the end of the loop "
117 "is reached, the index will be set to the value start-index.",
118 0, INT_MAX, DEFAULT_INDEX,
119 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
120 g_object_class_install_property (gobject_class, ARG_STOP_INDEX,
121 g_param_spec_int ("stop-index", "Start Index",
122 "Stop value of index. The special value -1 means no stop.",
123 -1, INT_MAX, DEFAULT_INDEX,
124 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
125 g_object_class_install_property (gobject_class, ARG_CAPS,
126 g_param_spec_boxed ("caps", "Caps",
127 "Caps describing the format of the data.",
128 GST_TYPE_CAPS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
129 g_object_class_install_property (gobject_class, ARG_LOOP,
130 g_param_spec_boolean ("loop", "Loop",
131 "Whether to repeat from the beginning when all files have been read.",
132 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
134 gobject_class->dispose = gst_multi_file_src_dispose;
136 gstbasesrc_class->get_caps = gst_multi_file_src_getcaps;
137 gstbasesrc_class->query = gst_multi_file_src_query;
139 gstpushsrc_class->create = gst_multi_file_src_create;
141 if (sizeof (off_t) < 8) {
142 GST_LOG ("No large file support, sizeof (off_t) = %" G_GSIZE_FORMAT,
146 GST_DEBUG_CATEGORY_INIT (gst_multi_file_src_debug, "multifilesrc", 0,
147 "multifilesrc element");
149 gst_element_class_add_pad_template (gstelement_class,
150 gst_static_pad_template_get (&gst_multi_file_src_pad_template));
151 gst_element_class_set_details_simple (gstelement_class, "Multi-File Source",
153 "Read a sequentially named set of files into buffers",
154 "David Schleef <ds@schleef.org>");
158 gst_multi_file_src_init (GstMultiFileSrc * multifilesrc)
160 multifilesrc->start_index = DEFAULT_INDEX;
161 multifilesrc->index = DEFAULT_INDEX;
162 multifilesrc->stop_index = -1;
163 multifilesrc->filename = g_strdup (DEFAULT_LOCATION);
164 multifilesrc->successful_read = FALSE;
168 gst_multi_file_src_dispose (GObject * object)
170 GstMultiFileSrc *src = GST_MULTI_FILE_SRC (object);
172 g_free (src->filename);
173 src->filename = NULL;
175 gst_caps_unref (src->caps);
177 G_OBJECT_CLASS (parent_class)->dispose (object);
181 gst_multi_file_src_getcaps (GstBaseSrc * src, GstCaps * filter)
183 GstMultiFileSrc *multi_file_src = GST_MULTI_FILE_SRC (src);
185 GST_DEBUG_OBJECT (src, "returning %" GST_PTR_FORMAT, multi_file_src->caps);
187 if (multi_file_src->caps) {
189 return gst_caps_intersect_full (filter, multi_file_src->caps,
190 GST_CAPS_INTERSECT_FIRST);
192 return gst_caps_ref (multi_file_src->caps);
195 return gst_caps_ref (filter);
197 return gst_caps_new_any ();
202 gst_multi_file_src_query (GstBaseSrc * src, GstQuery * query)
205 GstMultiFileSrc *mfsrc;
207 mfsrc = GST_MULTI_FILE_SRC (src);
209 switch (GST_QUERY_TYPE (query)) {
210 case GST_QUERY_POSITION:
214 gst_query_parse_position (query, &format, NULL);
216 case GST_FORMAT_BUFFERS:
217 case GST_FORMAT_DEFAULT:
218 gst_query_set_position (query, GST_FORMAT_BUFFERS, mfsrc->index);
222 res = GST_BASE_SRC_CLASS (parent_class)->query (src, query);
228 res = GST_BASE_SRC_CLASS (parent_class)->query (src, query);
235 gst_multi_file_src_set_location (GstMultiFileSrc * src, const gchar * location)
237 g_free (src->filename);
238 if (location != NULL) {
239 src->filename = g_strdup (location);
241 src->filename = NULL;
248 gst_multi_file_src_set_property (GObject * object, guint prop_id,
249 const GValue * value, GParamSpec * pspec)
251 GstMultiFileSrc *src = GST_MULTI_FILE_SRC (object);
255 gst_multi_file_src_set_location (src, g_value_get_string (value));
258 src->index = g_value_get_int (value);
260 case ARG_START_INDEX:
261 src->start_index = g_value_get_int (value);
264 src->stop_index = g_value_get_int (value);
268 const GstCaps *caps = gst_value_get_caps (value);
272 new_caps = gst_caps_new_any ();
274 new_caps = gst_caps_copy (caps);
276 gst_caps_replace (&src->caps, new_caps);
277 gst_pad_set_caps (GST_BASE_SRC_PAD (src), new_caps);
281 src->loop = g_value_get_boolean (value);
284 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
290 gst_multi_file_src_get_property (GObject * object, guint prop_id,
291 GValue * value, GParamSpec * pspec)
293 GstMultiFileSrc *src = GST_MULTI_FILE_SRC (object);
297 g_value_set_string (value, src->filename);
300 g_value_set_int (value, src->index);
302 case ARG_START_INDEX:
303 g_value_set_int (value, src->start_index);
306 g_value_set_int (value, src->stop_index);
309 gst_value_set_caps (value, src->caps);
312 g_value_set_boolean (value, src->loop);
315 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
321 gst_multi_file_src_get_filename (GstMultiFileSrc * multifilesrc)
325 GST_DEBUG ("%d", multifilesrc->index);
326 filename = g_strdup_printf (multifilesrc->filename, multifilesrc->index);
332 gst_multi_file_src_create (GstPushSrc * src, GstBuffer ** buffer)
334 GstMultiFileSrc *multifilesrc;
340 GError *error = NULL;
342 multifilesrc = GST_MULTI_FILE_SRC (src);
344 if (multifilesrc->index < multifilesrc->start_index) {
345 multifilesrc->index = multifilesrc->start_index;
347 filename = gst_multi_file_src_get_filename (multifilesrc);
349 GST_DEBUG_OBJECT (multifilesrc, "reading from file \"%s\".", filename);
351 ret = g_file_get_contents (filename, &data, &size, &error);
353 if (multifilesrc->successful_read) {
354 /* If we've read at least one buffer successfully, not finding the
355 * next file is EOS. */
358 g_error_free (error);
360 if (multifilesrc->loop) {
362 multifilesrc->index = multifilesrc->start_index;
364 filename = gst_multi_file_src_get_filename (multifilesrc);
365 ret = g_file_get_contents (filename, &data, &size, &error);
369 g_error_free (error);
381 multifilesrc->successful_read = TRUE;
382 multifilesrc->index++;
383 if (multifilesrc->stop_index != -1 &&
384 multifilesrc->index >= multifilesrc->stop_index) {
385 multifilesrc->index = multifilesrc->start_index;
388 buf = gst_buffer_new ();
389 gst_buffer_append_memory (buf,
390 gst_memory_new_wrapped (0, data, size, 0, size, data, g_free));
391 GST_BUFFER_OFFSET (buf) = multifilesrc->offset;
392 GST_BUFFER_OFFSET_END (buf) = multifilesrc->offset + size;
393 multifilesrc->offset += size;
395 GST_DEBUG_OBJECT (multifilesrc, "read file \"%s\".", filename);
404 GST_ELEMENT_ERROR (multifilesrc, RESOURCE, READ,
405 ("Error while reading from file \"%s\".", filename),
406 ("%s", error->message));
407 g_error_free (error);
409 GST_ELEMENT_ERROR (multifilesrc, RESOURCE, READ,
410 ("Error while reading from file \"%s\".", filename),
411 ("%s", g_strerror (errno)));
414 return GST_FLOW_ERROR;