1 /* GStreamer
2 * Copyright (C) 2011 David A. Schleef <ds@schleef.org>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin Street, Suite 500,
17 * Boston, MA 02110-1335, USA.
18 */
19 /**
20 * SECTION:element-gstintervideosrc
21 * @title: gstintervideosrc
22 *
23 * The intervideosrc element is a video source element. It is used
24 * in connection with a intervideosink element in a different pipeline,
25 * similar to interaudiosink and interaudiosrc.
26 *
27 * ## Example launch line
28 * |[
29 * gst-launch-1.0 -v intervideosrc ! queue ! xvimagesink
30 * ]|
31 *
32 * The intersubsrc element cannot be used effectively with gst-launch-1.0,
33 * as it requires a second pipeline in the application to send subtitles.
34 *
35 */
36
37 #ifdef HAVE_CONFIG_H
38 #include "config.h"
39 #endif
40
41 #include <gst/gst.h>
42 #include <gst/base/gstbasesrc.h>
43 #include <gst/video/video.h>
44 #include "gstintervideosrc.h"
45 #include <string.h>
46
47 GST_DEBUG_CATEGORY_STATIC (gst_inter_video_src_debug_category);
48 #define GST_CAT_DEFAULT gst_inter_video_src_debug_category
49
50 /* prototypes */
51 static void gst_inter_video_src_set_property (GObject * object,
52 guint property_id, const GValue * value, GParamSpec * pspec);
53 static void gst_inter_video_src_get_property (GObject * object,
54 guint property_id, GValue * value, GParamSpec * pspec);
55 static void gst_inter_video_src_finalize (GObject * object);
56
57 static GstCaps *gst_inter_video_src_get_caps (GstBaseSrc * src,
58 GstCaps * filter);
59 static gboolean gst_inter_video_src_set_caps (GstBaseSrc * src, GstCaps * caps);
60 static GstCaps *gst_inter_video_src_fixate (GstBaseSrc * src, GstCaps * caps);
61 static gboolean gst_inter_video_src_start (GstBaseSrc * src);
62 static gboolean gst_inter_video_src_stop (GstBaseSrc * src);
63 static void
64 gst_inter_video_src_get_times (GstBaseSrc * src, GstBuffer * buffer,
65 GstClockTime * start, GstClockTime * end);
66 static GstFlowReturn
67 gst_inter_video_src_create (GstBaseSrc * src, guint64 offset, guint size,
68 GstBuffer ** buf);
69
70 enum
71 {
72 PROP_0,
73 PROP_CHANNEL,
74 PROP_TIMEOUT
75 };
76
77 #define DEFAULT_CHANNEL ("default")
78 #define DEFAULT_TIMEOUT (GST_SECOND)
79
80 /* pad templates */
81 static GstStaticPadTemplate gst_inter_video_src_src_template =
82 GST_STATIC_PAD_TEMPLATE ("src",
83 GST_PAD_SRC,
84 GST_PAD_ALWAYS,
85 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE (GST_VIDEO_FORMATS_ALL))
86 );
87
88
89 /* class initialization */
90 #define parent_class gst_inter_video_src_parent_class
91 G_DEFINE_TYPE (GstInterVideoSrc, gst_inter_video_src, GST_TYPE_BASE_SRC);
92
93 static void
gst_inter_video_src_class_init(GstInterVideoSrcClass * klass)94 gst_inter_video_src_class_init (GstInterVideoSrcClass * klass)
95 {
96 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
97 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
98 GstBaseSrcClass *base_src_class = GST_BASE_SRC_CLASS (klass);
99
100 GST_DEBUG_CATEGORY_INIT (gst_inter_video_src_debug_category, "intervideosrc",
101 0, "debug category for intervideosrc element");
102
103 gst_element_class_add_static_pad_template (element_class,
104 &gst_inter_video_src_src_template);
105
106 gst_element_class_set_static_metadata (element_class,
107 "Internal video source",
108 "Source/Video",
109 "Virtual video source for internal process communication",
110 "David Schleef <ds@schleef.org>");
111
112 gobject_class->set_property = gst_inter_video_src_set_property;
113 gobject_class->get_property = gst_inter_video_src_get_property;
114 gobject_class->finalize = gst_inter_video_src_finalize;
115 base_src_class->get_caps = GST_DEBUG_FUNCPTR (gst_inter_video_src_get_caps);
116 base_src_class->set_caps = GST_DEBUG_FUNCPTR (gst_inter_video_src_set_caps);
117 base_src_class->fixate = GST_DEBUG_FUNCPTR (gst_inter_video_src_fixate);
118 base_src_class->start = GST_DEBUG_FUNCPTR (gst_inter_video_src_start);
119 base_src_class->stop = GST_DEBUG_FUNCPTR (gst_inter_video_src_stop);
120 base_src_class->get_times = GST_DEBUG_FUNCPTR (gst_inter_video_src_get_times);
121 base_src_class->create = GST_DEBUG_FUNCPTR (gst_inter_video_src_create);
122
123 g_object_class_install_property (gobject_class, PROP_CHANNEL,
124 g_param_spec_string ("channel", "Channel",
125 "Channel name to match inter src and sink elements",
126 DEFAULT_CHANNEL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
127
128 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
129 g_param_spec_uint64 ("timeout", "Timeout",
130 "Timeout after which to start outputting black frames",
131 0, G_MAXUINT64, DEFAULT_TIMEOUT,
132 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
133 }
134
135 static void
gst_inter_video_src_init(GstInterVideoSrc * intervideosrc)136 gst_inter_video_src_init (GstInterVideoSrc * intervideosrc)
137 {
138 gst_base_src_set_format (GST_BASE_SRC (intervideosrc), GST_FORMAT_TIME);
139 gst_base_src_set_live (GST_BASE_SRC (intervideosrc), TRUE);
140
141 intervideosrc->channel = g_strdup (DEFAULT_CHANNEL);
142 intervideosrc->timeout = DEFAULT_TIMEOUT;
143 }
144
145 void
gst_inter_video_src_set_property(GObject * object,guint property_id,const GValue * value,GParamSpec * pspec)146 gst_inter_video_src_set_property (GObject * object, guint property_id,
147 const GValue * value, GParamSpec * pspec)
148 {
149 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (object);
150
151 switch (property_id) {
152 case PROP_CHANNEL:
153 g_free (intervideosrc->channel);
154 intervideosrc->channel = g_value_dup_string (value);
155 break;
156 case PROP_TIMEOUT:
157 intervideosrc->timeout = g_value_get_uint64 (value);
158 break;
159 default:
160 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
161 break;
162 }
163 }
164
165 void
gst_inter_video_src_get_property(GObject * object,guint property_id,GValue * value,GParamSpec * pspec)166 gst_inter_video_src_get_property (GObject * object, guint property_id,
167 GValue * value, GParamSpec * pspec)
168 {
169 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (object);
170
171 switch (property_id) {
172 case PROP_CHANNEL:
173 g_value_set_string (value, intervideosrc->channel);
174 break;
175 case PROP_TIMEOUT:
176 g_value_set_uint64 (value, intervideosrc->timeout);
177 break;
178 default:
179 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
180 break;
181 }
182 }
183
184 void
gst_inter_video_src_finalize(GObject * object)185 gst_inter_video_src_finalize (GObject * object)
186 {
187 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (object);
188
189 /* clean up object here */
190 g_free (intervideosrc->channel);
191
192 G_OBJECT_CLASS (gst_inter_video_src_parent_class)->finalize (object);
193 }
194
195 static GstCaps *
gst_inter_video_src_get_caps(GstBaseSrc * src,GstCaps * filter)196 gst_inter_video_src_get_caps (GstBaseSrc * src, GstCaps * filter)
197 {
198 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (src);
199 GstCaps *caps;
200
201 GST_DEBUG_OBJECT (intervideosrc, "get_caps");
202
203 if (!intervideosrc->surface)
204 return GST_BASE_SRC_CLASS (parent_class)->get_caps (src, filter);
205
206 g_mutex_lock (&intervideosrc->surface->mutex);
207 if (intervideosrc->surface->video_info.finfo) {
208 caps = gst_video_info_to_caps (&intervideosrc->surface->video_info);
209 gst_caps_set_simple (caps, "framerate", GST_TYPE_FRACTION_RANGE, 1,
210 G_MAXINT, G_MAXINT, 1, NULL);
211
212 if (filter) {
213 GstCaps *tmp;
214
215 tmp = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
216 gst_caps_unref (caps);
217 caps = tmp;
218 }
219 } else {
220 caps = NULL;
221 }
222 g_mutex_unlock (&intervideosrc->surface->mutex);
223
224 if (caps)
225 return caps;
226 else
227 return GST_BASE_SRC_CLASS (parent_class)->get_caps (src, filter);
228 }
229
230 static gboolean
gst_inter_video_src_set_caps(GstBaseSrc * base,GstCaps * caps)231 gst_inter_video_src_set_caps (GstBaseSrc * base, GstCaps * caps)
232 {
233 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (base);
234 GstVideoConverter *converter;
235 GstVideoFrame src_frame, dest_frame;
236 GstBuffer *src, *dest;
237 GstVideoInfo black_info;
238
239 GST_DEBUG_OBJECT (intervideosrc, "set_caps");
240
241 if (!gst_video_info_from_caps (&intervideosrc->info, caps)) {
242 GST_ERROR_OBJECT (intervideosrc, "Failed to parse caps %" GST_PTR_FORMAT,
243 caps);
244 return FALSE;
245 }
246
247 /* Create a black frame */
248 gst_buffer_replace (&intervideosrc->black_frame, NULL);
249 gst_video_info_set_format (&black_info, GST_VIDEO_FORMAT_ARGB,
250 intervideosrc->info.width, intervideosrc->info.height);
251 black_info.fps_n = intervideosrc->info.fps_n;
252 black_info.fps_d = intervideosrc->info.fps_d;
253 src = gst_buffer_new_and_alloc (black_info.size);
254 dest = gst_buffer_new_and_alloc (intervideosrc->info.size);
255 gst_buffer_memset (src, 0, 0, black_info.size);
256 gst_video_frame_map (&src_frame, &black_info, src, GST_MAP_READ);
257 gst_video_frame_map (&dest_frame, &intervideosrc->info, dest, GST_MAP_WRITE);
258 converter = gst_video_converter_new (&black_info, &intervideosrc->info, NULL);
259 gst_video_converter_frame (converter, &src_frame, &dest_frame);
260 gst_video_converter_free (converter);
261 gst_video_frame_unmap (&src_frame);
262 gst_video_frame_unmap (&dest_frame);
263 gst_buffer_unref (src);
264 intervideosrc->black_frame = dest;
265
266 return TRUE;
267 }
268
269 static gboolean
gst_inter_video_src_start(GstBaseSrc * src)270 gst_inter_video_src_start (GstBaseSrc * src)
271 {
272 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (src);
273
274 GST_DEBUG_OBJECT (intervideosrc, "start");
275
276 intervideosrc->surface = gst_inter_surface_get (intervideosrc->channel);
277 intervideosrc->timestamp_offset = 0;
278 intervideosrc->n_frames = 0;
279
280 return TRUE;
281 }
282
283 static gboolean
gst_inter_video_src_stop(GstBaseSrc * src)284 gst_inter_video_src_stop (GstBaseSrc * src)
285 {
286 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (src);
287
288 GST_DEBUG_OBJECT (intervideosrc, "stop");
289
290 gst_inter_surface_unref (intervideosrc->surface);
291 intervideosrc->surface = NULL;
292 gst_buffer_replace (&intervideosrc->black_frame, NULL);
293
294 return TRUE;
295 }
296
297 static void
gst_inter_video_src_get_times(GstBaseSrc * src,GstBuffer * buffer,GstClockTime * start,GstClockTime * end)298 gst_inter_video_src_get_times (GstBaseSrc * src, GstBuffer * buffer,
299 GstClockTime * start, GstClockTime * end)
300 {
301 GST_DEBUG_OBJECT (src, "get_times");
302
303 /* for live sources, sync on the timestamp of the buffer */
304 if (gst_base_src_is_live (src)) {
305 GstClockTime timestamp = GST_BUFFER_PTS (buffer);
306
307 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
308 /* get duration to calculate end time */
309 GstClockTime duration = GST_BUFFER_DURATION (buffer);
310
311 if (GST_CLOCK_TIME_IS_VALID (duration)) {
312 *end = timestamp + duration;
313 }
314 *start = timestamp;
315 }
316 } else {
317 *start = -1;
318 *end = -1;
319 }
320 }
321
322 static GstFlowReturn
gst_inter_video_src_create(GstBaseSrc * src,guint64 offset,guint size,GstBuffer ** buf)323 gst_inter_video_src_create (GstBaseSrc * src, guint64 offset, guint size,
324 GstBuffer ** buf)
325 {
326 GstInterVideoSrc *intervideosrc = GST_INTER_VIDEO_SRC (src);
327 GstCaps *caps;
328 GstBuffer *buffer;
329 guint64 frames;
330 gboolean is_gap = FALSE;
331
332 GST_DEBUG_OBJECT (intervideosrc, "create");
333
334 caps = NULL;
335 buffer = NULL;
336
337 frames = gst_util_uint64_scale_ceil (intervideosrc->timeout,
338 GST_VIDEO_INFO_FPS_N (&intervideosrc->info),
339 GST_VIDEO_INFO_FPS_D (&intervideosrc->info) * GST_SECOND);
340
341 g_mutex_lock (&intervideosrc->surface->mutex);
342 if (intervideosrc->surface->video_info.finfo) {
343 GstVideoInfo tmp_info = intervideosrc->surface->video_info;
344
345 /* We negotiate the framerate ourselves */
346 tmp_info.fps_n = intervideosrc->info.fps_n;
347 tmp_info.fps_d = intervideosrc->info.fps_d;
348 if (intervideosrc->info.flags & GST_VIDEO_FLAG_VARIABLE_FPS)
349 tmp_info.flags |= GST_VIDEO_FLAG_VARIABLE_FPS;
350 else
351 tmp_info.flags &= ~GST_VIDEO_FLAG_VARIABLE_FPS;
352
353 if (!gst_video_info_is_equal (&tmp_info, &intervideosrc->info)) {
354 caps = gst_video_info_to_caps (&tmp_info);
355 intervideosrc->timestamp_offset +=
356 gst_util_uint64_scale (GST_SECOND * intervideosrc->n_frames,
357 GST_VIDEO_INFO_FPS_D (&intervideosrc->info),
358 GST_VIDEO_INFO_FPS_N (&intervideosrc->info));
359 intervideosrc->n_frames = 0;
360 }
361 }
362
363 if (intervideosrc->surface->video_buffer) {
364 /* We have a buffer to push */
365 buffer = gst_buffer_ref (intervideosrc->surface->video_buffer);
366
367 /* Can only be true if timeout > 0 */
368 if (intervideosrc->surface->video_buffer_count == frames) {
369 gst_buffer_unref (intervideosrc->surface->video_buffer);
370 intervideosrc->surface->video_buffer = NULL;
371 }
372 }
373
374 if (intervideosrc->surface->video_buffer_count != 0 &&
375 intervideosrc->surface->video_buffer_count != (frames + 1)) {
376 /* This is a repeat of the stored buffer or of a black frame */
377 is_gap = TRUE;
378 }
379
380 intervideosrc->surface->video_buffer_count++;
381 g_mutex_unlock (&intervideosrc->surface->mutex);
382
383 if (caps) {
384 gboolean ret;
385 GstStructure *s;
386 GstCaps *downstream_caps;
387 GstCaps *tmp, *negotiated_caps;
388 gint fps_n = 0, fps_d = 1;
389
390 /* Negotiate a framerate with downstream */
391 downstream_caps = gst_pad_get_allowed_caps (GST_BASE_SRC_PAD (src));
392
393 /* Remove all framerates */
394 tmp = gst_caps_copy (caps);
395 s = gst_caps_get_structure (tmp, 0);
396 gst_structure_get_fraction (s, "framerate", &fps_n, &fps_d);
397 if (fps_n == 0)
398 gst_structure_get_fraction (s, "max-framerate", &fps_n, &fps_d);
399 gst_structure_remove_field (s, "framerate");
400 gst_structure_remove_field (s, "max-framerate");
401
402 negotiated_caps =
403 gst_caps_intersect_full (downstream_caps, tmp,
404 GST_CAPS_INTERSECT_FIRST);
405 gst_caps_unref (tmp);
406 gst_caps_unref (downstream_caps);
407
408 if (gst_caps_is_empty (negotiated_caps)) {
409 GST_ERROR_OBJECT (src, "Failed to negotiate caps %" GST_PTR_FORMAT, caps);
410 if (buffer)
411 gst_buffer_unref (buffer);
412 gst_caps_unref (caps);
413 return GST_FLOW_NOT_NEGOTIATED;
414 }
415 gst_caps_unref (caps);
416 caps = NULL;
417
418 /* Prefer what the source produces, otherwise 30 fps */
419 if (fps_n == 0) {
420 fps_n = 30;
421 fps_d = 1;
422 }
423
424 negotiated_caps = gst_caps_truncate (negotiated_caps);
425 s = gst_caps_get_structure (negotiated_caps, 0);
426 if (!gst_structure_has_field (s, "framerate"))
427 gst_structure_set (s, "framerate", GST_TYPE_FRACTION, fps_n, fps_d, NULL);
428 else
429 gst_structure_fixate_field_nearest_fraction (s, "framerate", fps_n,
430 fps_d);
431
432 ret = gst_base_src_set_caps (src, negotiated_caps);
433 if (!ret) {
434 GST_ERROR_OBJECT (src, "Failed to set caps %" GST_PTR_FORMAT,
435 negotiated_caps);
436 if (buffer)
437 gst_buffer_unref (buffer);
438 gst_caps_unref (negotiated_caps);
439 return GST_FLOW_NOT_NEGOTIATED;
440 }
441 gst_caps_unref (negotiated_caps);
442 }
443
444 if (buffer == NULL) {
445 GST_DEBUG_OBJECT (intervideosrc, "Creating black frame");
446 buffer = gst_buffer_copy (intervideosrc->black_frame);
447 }
448
449 buffer = gst_buffer_make_writable (buffer);
450
451 if (is_gap)
452 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_GAP);
453
454 GST_BUFFER_PTS (buffer) = intervideosrc->timestamp_offset +
455 gst_util_uint64_scale (GST_SECOND * intervideosrc->n_frames,
456 GST_VIDEO_INFO_FPS_D (&intervideosrc->info),
457 GST_VIDEO_INFO_FPS_N (&intervideosrc->info));
458 GST_BUFFER_DTS (buffer) = GST_CLOCK_TIME_NONE;
459 GST_DEBUG_OBJECT (intervideosrc, "create ts %" GST_TIME_FORMAT,
460 GST_TIME_ARGS (GST_BUFFER_PTS (buffer)));
461 GST_BUFFER_DURATION (buffer) = intervideosrc->timestamp_offset +
462 gst_util_uint64_scale (GST_SECOND * (intervideosrc->n_frames + 1),
463 GST_VIDEO_INFO_FPS_D (&intervideosrc->info),
464 GST_VIDEO_INFO_FPS_N (&intervideosrc->info)) - GST_BUFFER_PTS (buffer);
465 GST_BUFFER_OFFSET (buffer) = intervideosrc->n_frames;
466 GST_BUFFER_OFFSET_END (buffer) = -1;
467 GST_BUFFER_FLAG_UNSET (buffer, GST_BUFFER_FLAG_DISCONT);
468 if (intervideosrc->n_frames == 0) {
469 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
470 }
471 intervideosrc->n_frames++;
472
473 *buf = buffer;
474
475 return GST_FLOW_OK;
476 }
477
478 static GstCaps *
gst_inter_video_src_fixate(GstBaseSrc * src,GstCaps * caps)479 gst_inter_video_src_fixate (GstBaseSrc * src, GstCaps * caps)
480 {
481 GstStructure *structure;
482
483 GST_DEBUG_OBJECT (src, "fixate");
484
485 caps = gst_caps_make_writable (caps);
486 caps = gst_caps_truncate (caps);
487 structure = gst_caps_get_structure (caps, 0);
488
489 gst_structure_fixate_field_string (structure, "format", "I420");
490 gst_structure_fixate_field_nearest_int (structure, "width", 320);
491 gst_structure_fixate_field_nearest_int (structure, "height", 240);
492 gst_structure_fixate_field_nearest_fraction (structure, "framerate", 30, 1);
493 if (gst_structure_has_field (structure, "pixel-aspect-ratio"))
494 gst_structure_fixate_field_nearest_fraction (structure,
495 "pixel-aspect-ratio", 1, 1);
496 if (gst_structure_has_field (structure, "color-matrix"))
497 gst_structure_fixate_field_string (structure, "color-matrix", "sdtv");
498 if (gst_structure_has_field (structure, "chroma-site"))
499 gst_structure_fixate_field_string (structure, "chroma-site", "mpeg2");
500
501 if (gst_structure_has_field (structure, "interlaced"))
502 gst_structure_fixate_field_boolean (structure, "interlaced", FALSE);
503
504 return caps;
505 }
506