3 * gstv4lmjpegsink.c: hardware MJPEG video sink plugin
5 * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
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.
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.
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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
28 #include "v4lmjpegsink_calls.h"
30 GST_DEBUG_CATEGORY_STATIC (v4lmjpegsink_debug);
31 #define GST_CAT_DEFAULT v4lmjpegsink_debug
33 /* v4lmjpegsink signals and args */
36 SIGNAL_FRAME_DISPLAYED,
53 static void gst_v4lmjpegsink_base_init (gpointer g_class);
54 static void gst_v4lmjpegsink_class_init (GstV4lMjpegSinkClass * klass);
55 static void gst_v4lmjpegsink_init (GstV4lMjpegSink * v4lmjpegsink);
57 /* the chain of buffers */
58 static GstPadLinkReturn gst_v4lmjpegsink_sinkconnect (GstPad * pad,
59 const GstCaps * vscapslist);
60 static void gst_v4lmjpegsink_chain (GstPad * pad, GstData * _data);
62 /* get/set gst object functions */
63 static void gst_v4lmjpegsink_set_property (GObject * object,
64 guint prop_id, const GValue * value, GParamSpec * pspec);
65 static void gst_v4lmjpegsink_get_property (GObject * object,
66 guint prop_id, GValue * value, GParamSpec * pspec);
67 static GstStateChangeReturn gst_v4lmjpegsink_change_state (GstElement *
69 static void gst_v4lmjpegsink_set_clock (GstElement * element, GstClock * clock);
72 static GstElementClass *parent_class = NULL;
73 static guint gst_v4lmjpegsink_signals[LAST_SIGNAL] = { 0 };
77 gst_v4lmjpegsink_get_type (void)
79 static GType v4lmjpegsink_type = 0;
81 if (!v4lmjpegsink_type) {
82 static const GTypeInfo v4lmjpegsink_info = {
83 sizeof (GstV4lMjpegSinkClass),
84 gst_v4lmjpegsink_base_init,
86 (GClassInitFunc) gst_v4lmjpegsink_class_init,
89 sizeof (GstV4lMjpegSink),
91 (GInstanceInitFunc) gst_v4lmjpegsink_init,
95 g_type_register_static (GST_TYPE_V4LELEMENT, "GstV4lMjpegSink",
96 &v4lmjpegsink_info, 0);
98 return v4lmjpegsink_type;
102 gst_v4lmjpegsink_base_init (gpointer g_class)
104 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
107 GST_STATIC_CAPS ("image/jpeg, "
108 "width = (int) [ 1, MAX ], "
109 "height = (int) [ 1, MAX ], " "framerate = (fraction) [ 0, MAX ]")
111 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
113 gst_element_class_set_details_simple (gstelement_class,
114 "Video (video4linux/MJPEG) sink", "Sink/Video",
115 "Writes MJPEG-encoded frames to a zoran MJPEG/video4linux device",
116 "GStreamer maintainers <gstreamer-devel@lists.sourceforge.net>");
118 gst_element_class_add_pad_template (gstelement_class,
119 gst_static_pad_template_get (&sink_template));
123 gst_v4lmjpegsink_class_init (GstV4lMjpegSinkClass * klass)
125 GObjectClass *gobject_class;
126 GstElementClass *gstelement_class;
128 gobject_class = (GObjectClass *) klass;
129 gstelement_class = (GstElementClass *) klass;
131 parent_class = g_type_class_peek_parent (klass);
133 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_NUMBUFS,
134 g_param_spec_int ("num-buffers", "num-buffers", "num-buffers",
135 G_MININT, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
136 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BUFSIZE,
137 g_param_spec_int ("buffer-size", "buffer-size", "buffer-size",
138 G_MININT, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
140 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_X_OFFSET,
141 g_param_spec_int ("x-offset", "x-offset", "x-offset",
142 G_MININT, G_MAXINT, 0, G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
143 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_Y_OFFSET,
144 g_param_spec_int ("y-offset", "y-offset", "y-offset",
145 G_MININT, G_MAXINT, 0, G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
147 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAMES_DISPLAYED,
148 g_param_spec_int ("frames-displayed", "frames-displayed",
149 "frames-displayed", G_MININT, G_MAXINT, 0,
150 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
151 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAME_TIME,
152 g_param_spec_int ("frame-time", "frame-time", "frame-time", G_MININT,
153 G_MAXINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
155 GST_DEBUG_CATEGORY_INIT (v4lmjpegsink_debug, "v4lmjpegsink", 0,
156 "V4L MJPEG sink element");
157 gobject_class->set_property = gst_v4lmjpegsink_set_property;
158 gobject_class->get_property = gst_v4lmjpegsink_get_property;
160 gst_v4lmjpegsink_signals[SIGNAL_FRAME_DISPLAYED] =
161 g_signal_new ("frame-displayed", G_TYPE_FROM_CLASS (klass),
162 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstV4lMjpegSinkClass,
163 frame_displayed), NULL, NULL, g_cclosure_marshal_VOID__VOID,
166 gstelement_class->change_state = gst_v4lmjpegsink_change_state;
167 gstelement_class->set_clock = gst_v4lmjpegsink_set_clock;
172 gst_v4lmjpegsink_init (GstV4lMjpegSink * v4lmjpegsink)
174 GstElementClass *klass = GST_ELEMENT_GET_CLASS (v4lmjpegsink);
176 v4lmjpegsink->sinkpad =
177 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
179 gst_element_add_pad (GST_ELEMENT (v4lmjpegsink), v4lmjpegsink->sinkpad);
181 gst_pad_set_chain_function (v4lmjpegsink->sinkpad, gst_v4lmjpegsink_chain);
182 gst_pad_set_link_function (v4lmjpegsink->sinkpad,
183 gst_v4lmjpegsink_sinkconnect);
185 v4lmjpegsink->clock = NULL;
187 v4lmjpegsink->width = -1;
188 v4lmjpegsink->height = -1;
190 v4lmjpegsink->x_offset = -1;
191 v4lmjpegsink->y_offset = -1;
193 v4lmjpegsink->numbufs = 64;
194 v4lmjpegsink->bufsize = 256;
196 GST_OBJECT_FLAG_SET (v4lmjpegsink, GST_ELEMENT_THREAD_SUGGESTED);
200 static GstPadLinkReturn
201 gst_v4lmjpegsink_sinkconnect (GstPad * pad, const GstCaps * vscapslist)
203 GstV4lMjpegSink *v4lmjpegsink;
204 GstStructure *structure;
206 v4lmjpegsink = GST_V4LMJPEGSINK (gst_pad_get_parent (pad));
208 /* in case the buffers are active (which means that we already
209 * did capsnego before and didn't clean up), clean up anyways */
210 if (GST_V4L_IS_ACTIVE (GST_V4LELEMENT (v4lmjpegsink)))
211 if (!gst_v4lmjpegsink_playback_deinit (v4lmjpegsink))
212 return GST_PAD_LINK_REFUSED;
214 structure = gst_caps_get_structure (vscapslist, 0);
216 gst_structure_get_int (structure, "width", &v4lmjpegsink->width);
217 gst_structure_get_int (structure, "height", &v4lmjpegsink->height);
219 if (!gst_v4lmjpegsink_set_playback (v4lmjpegsink, v4lmjpegsink->width, v4lmjpegsink->height, v4lmjpegsink->x_offset, v4lmjpegsink->y_offset, GST_V4LELEMENT (v4lmjpegsink)->vchan.norm, 0)) /* TODO: interlacing */
220 return GST_PAD_LINK_REFUSED;
222 /* set buffer info */
223 if (!gst_v4lmjpegsink_set_buffer (v4lmjpegsink,
224 v4lmjpegsink->numbufs, v4lmjpegsink->bufsize))
225 return GST_PAD_LINK_REFUSED;
226 if (!gst_v4lmjpegsink_playback_init (v4lmjpegsink))
227 return GST_PAD_LINK_REFUSED;
229 return GST_PAD_LINK_OK;
235 gst_v4lmjpegsink_set_clock (GstElement * element, GstClock * clock)
237 GstV4lMjpegSink *v4mjpegsink = GST_V4LMJPEGSINK (element);
239 v4mjpegsink->clock = clock;
244 gst_v4lmjpegsink_chain (GstPad * pad, GstData * _data)
246 GstBuffer *buf = GST_BUFFER (_data);
247 GstV4lMjpegSink *v4lmjpegsink;
250 g_return_if_fail (pad != NULL);
251 g_return_if_fail (GST_IS_PAD (pad));
252 g_return_if_fail (buf != NULL);
254 v4lmjpegsink = GST_V4LMJPEGSINK (gst_pad_get_parent (pad));
256 if (v4lmjpegsink->clock) {
257 GST_DEBUG ("videosink: clock wait: %" G_GUINT64_FORMAT,
258 GST_BUFFER_TIMESTAMP (buf));
260 gst_element_wait (GST_ELEMENT (v4lmjpegsink), GST_BUFFER_TIMESTAMP (buf));
263 if (GST_BUFFER_POOL (buf) == v4lmjpegsink->bufferpool) {
264 num = GPOINTER_TO_INT (GST_BUFFER_POOL_PRIVATE (buf));
265 gst_v4lmjpegsink_play_frame (v4lmjpegsink, num);
269 if (GST_BUFFER_SIZE (buf) > v4lmjpegsink->breq.size) {
270 GST_ELEMENT_ERROR (v4lmjpegsink, RESOURCE, WRITE, (NULL),
271 ("Buffer too big (%d KB), max. buffersize is %ld KB",
272 GST_BUFFER_SIZE (buf) / 1024, v4lmjpegsink->breq.size / 1024));
276 /* put JPEG data to the device */
277 gst_v4lmjpegsink_wait_frame (v4lmjpegsink, &num);
278 memcpy (gst_v4lmjpegsink_get_buffer (v4lmjpegsink, num),
279 GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf));
280 gst_v4lmjpegsink_play_frame (v4lmjpegsink, num);
285 g_signal_emit (G_OBJECT (v4lmjpegsink),
286 gst_v4lmjpegsink_signals[SIGNAL_FRAME_DISPLAYED], 0);
288 gst_buffer_unref (buf);
294 gst_v4lmjpegsink_buffer_new (GstBufferPool * pool,
295 guint64 offset, guint size, gpointer user_data)
297 GstV4lMjpegSink *v4lmjpegsink = GST_V4LMJPEGSINK (user_data);
298 GstBuffer *buffer = NULL;
302 if (!GST_V4L_IS_ACTIVE (GST_V4LELEMENT (v4lmjpegsink)))
304 if (v4lmjpegsink->breq.size < size) {
305 GST_DEBUG ("Requested buffer size is too large (%d > %ld)",
306 size, v4lmjpegsink->breq.size);
309 if (!gst_v4lmjpegsink_wait_frame (v4lmjpegsink, &num))
311 data = gst_v4lmjpegsink_get_buffer (v4lmjpegsink, num);
314 buffer = gst_buffer_new ();
315 GST_BUFFER_DATA (buffer) = data;
316 GST_BUFFER_MAXSIZE (buffer) = v4lmjpegsink->breq.size;
317 GST_BUFFER_SIZE (buffer) = size;
318 GST_BUFFER_POOL (buffer) = pool;
319 GST_BUFFER_POOL_PRIVATE (buffer) = GINT_TO_POINTER (num);
321 /* with this flag set, we don't need our own buffer_free() function */
322 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_DONTFREE);
330 gst_v4lmjpegsink_set_property (GObject * object,
331 guint prop_id, const GValue * value, GParamSpec * pspec)
333 GstV4lMjpegSink *v4lmjpegsink;
335 g_return_if_fail (GST_IS_V4LMJPEGSINK (object));
337 v4lmjpegsink = GST_V4LMJPEGSINK (object);
341 v4lmjpegsink->numbufs = g_value_get_int (value);
344 v4lmjpegsink->bufsize = g_value_get_int (value);
347 v4lmjpegsink->x_offset = g_value_get_int (value);
350 v4lmjpegsink->y_offset = g_value_get_int (value);
353 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
360 gst_v4lmjpegsink_get_property (GObject * object,
361 guint prop_id, GValue * value, GParamSpec * pspec)
363 GstV4lMjpegSink *v4lmjpegsink;
365 v4lmjpegsink = GST_V4LMJPEGSINK (object);
368 case ARG_FRAMES_DISPLAYED:
369 g_value_set_int (value, v4lmjpegsink->frames_displayed);
372 g_value_set_int (value, v4lmjpegsink->frame_time / 1000000);
375 g_value_set_int (value, v4lmjpegsink->numbufs);
378 g_value_set_int (value, v4lmjpegsink->bufsize);
381 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
387 static GstStateChangeReturn
388 gst_v4lmjpegsink_change_state (GstElement * element, GstStateChange transition)
390 GstV4lMjpegSink *v4lmjpegsink;
391 GstStateChangeReturn parent_value;
393 g_return_val_if_fail (GST_IS_V4LMJPEGSINK (element),
394 GST_STATE_CHANGE_FAILURE);
395 v4lmjpegsink = GST_V4LMJPEGSINK (element);
397 /* set up change state */
398 switch (transition) {
399 case GST_STATE_CHANGE_READY_TO_PAUSED:
400 /* we used to do buffer setup here, but that's now done
401 * right after capsnego */
403 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
405 if (!gst_v4lmjpegsink_playback_start (v4lmjpegsink))
406 return GST_STATE_CHANGE_FAILURE;
408 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
409 /* de-queue all queued buffers */
410 if (!gst_v4lmjpegsink_playback_stop (v4lmjpegsink))
411 return GST_STATE_CHANGE_FAILURE;
413 case GST_STATE_CHANGE_PAUSED_TO_READY:
414 /* stop playback, unmap all buffers */
415 if (!gst_v4lmjpegsink_playback_deinit (v4lmjpegsink))
416 return GST_STATE_CHANGE_FAILURE;
420 if (GST_ELEMENT_CLASS (parent_class)->change_state) {
422 GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
424 parent_value = GST_STATE_CHANGE_FAILURE;
427 if (GST_ELEMENT_CLASS (parent_class)->change_state)
430 return GST_STATE_CHANGE_SUCCESS;