1 /* GStreamer Smart Video Encoder element
2 * Copyright (C) <2010> Edward Hervey <bilboed@gmail.com>
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.
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.
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., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * * Implement get_caps/set_caps (store/forward caps)
22 * * Adjust template caps to the formats we can support
30 #include "gstsmartencoder.h"
32 GST_DEBUG_CATEGORY_STATIC (smart_encoder_debug);
33 #define GST_CAT_DEFAULT smart_encoder_debug
35 /* FIXME : Update this with new caps */
36 /* WARNING : We can only allow formats with closed-GOP */
37 #define ALLOWED_CAPS "video/x-h263;video/x-intel-h263;"\
38 "video/mpeg,mpegversion=(int)1,systemstream=(boolean)false;"\
39 "video/mpeg,mpegversion=(int)2,systemstream=(boolean)false;"
41 static GstStaticPadTemplate src_template =
42 GST_STATIC_PAD_TEMPLATE ("src", GST_PAD_SRC,
44 GST_STATIC_CAPS (ALLOWED_CAPS)
47 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
50 GST_STATIC_CAPS (ALLOWED_CAPS)
53 static GQuark INTERNAL_ELEMENT;
55 /* GstSmartEncoder signals and args */
71 INTERNAL_ELEMENT = g_quark_from_string ("internal-element");
74 G_DEFINE_TYPE_EXTENDED (GstSmartEncoder, gst_smart_encoder, GST_TYPE_ELEMENT, 0,
77 static void gst_smart_encoder_dispose (GObject * object);
79 static gboolean setup_recoder_pipeline (GstSmartEncoder * smart_encoder);
81 static GstFlowReturn gst_smart_encoder_chain (GstPad * pad, GstBuffer * buf);
82 static gboolean smart_encoder_sink_event (GstPad * pad, GstEvent * event);
83 static gboolean smart_encoder_sink_query (GstPad * pad, GstObject * parent,
85 static GstCaps *smart_encoder_sink_getcaps (GstPad * pad, GstCaps * filter);
86 static GstStateChangeReturn
87 gst_smart_encoder_change_state (GstElement * element,
88 GstStateChange transition);
91 gst_smart_encoder_class_init (GstSmartEncoderClass * klass)
93 GObjectClass *gobject_class;
94 GstElementClass *element_class;
96 element_class = (GstElementClass *) klass;
97 gobject_class = G_OBJECT_CLASS (klass);
99 gst_smart_encoder_parent_class = g_type_class_peek_parent (klass);
101 gst_element_class_add_pad_template (element_class,
102 gst_static_pad_template_get (&src_template));
103 gst_element_class_add_pad_template (element_class,
104 gst_static_pad_template_get (&sink_template));
106 gst_element_class_set_details_simple (element_class, "Smart Video Encoder",
107 "Codec/Recoder/Video",
108 "Re-encodes portions of Video that lay on segment boundaries",
109 "Edward Hervey <bilboed@gmail.com>");
111 gobject_class->dispose = (GObjectFinalizeFunc) (gst_smart_encoder_dispose);
112 element_class->change_state = gst_smart_encoder_change_state;
114 GST_DEBUG_CATEGORY_INIT (smart_encoder_debug, "smartencoder", 0,
119 smart_encoder_reset (GstSmartEncoder * smart_encoder)
121 gst_segment_init (smart_encoder->segment, GST_FORMAT_UNDEFINED);
123 if (smart_encoder->encoder) {
124 /* Clean up/remove elements */
125 gst_element_set_state (smart_encoder->encoder, GST_STATE_NULL);
126 gst_element_set_state (smart_encoder->decoder, GST_STATE_NULL);
127 gst_element_set_bus (smart_encoder->encoder, NULL);
128 gst_element_set_bus (smart_encoder->decoder, NULL);
129 gst_pad_set_active (smart_encoder->internal_srcpad, FALSE);
130 gst_pad_set_active (smart_encoder->internal_sinkpad, FALSE);
131 gst_object_unref (smart_encoder->encoder);
132 gst_object_unref (smart_encoder->decoder);
133 gst_object_unref (smart_encoder->internal_srcpad);
134 gst_object_unref (smart_encoder->internal_sinkpad);
136 smart_encoder->encoder = NULL;
137 smart_encoder->decoder = NULL;
138 smart_encoder->internal_sinkpad = NULL;
139 smart_encoder->internal_srcpad = NULL;
142 if (smart_encoder->newsegment) {
143 gst_event_unref (smart_encoder->newsegment);
144 smart_encoder->newsegment = NULL;
150 gst_smart_encoder_init (GstSmartEncoder * smart_encoder)
152 smart_encoder->sinkpad =
153 gst_pad_new_from_static_template (&sink_template, "sink");
154 gst_pad_set_chain_function (smart_encoder->sinkpad, gst_smart_encoder_chain);
155 gst_pad_set_event_function (smart_encoder->sinkpad, smart_encoder_sink_event);
156 gst_pad_set_query_function (smart_encoder->sinkpad, smart_encoder_sink_query);
157 gst_element_add_pad (GST_ELEMENT (smart_encoder), smart_encoder->sinkpad);
159 smart_encoder->srcpad =
160 gst_pad_new_from_static_template (&src_template, "src");
161 gst_pad_use_fixed_caps (smart_encoder->srcpad);
162 gst_element_add_pad (GST_ELEMENT (smart_encoder), smart_encoder->srcpad);
164 smart_encoder->segment = gst_segment_new ();
166 smart_encoder_reset (smart_encoder);
170 gst_smart_encoder_dispose (GObject * object)
172 GstSmartEncoder *smart_encoder = (GstSmartEncoder *) object;
174 if (smart_encoder->segment)
175 gst_segment_free (smart_encoder->segment);
176 smart_encoder->segment = NULL;
177 if (smart_encoder->available_caps)
178 gst_caps_unref (smart_encoder->available_caps);
179 smart_encoder->available_caps = NULL;
180 G_OBJECT_CLASS (gst_smart_encoder_parent_class)->dispose (object);
184 gst_smart_encoder_reencode_gop (GstSmartEncoder * smart_encoder)
186 GstFlowReturn res = GST_FLOW_OK;
189 if (smart_encoder->encoder == NULL) {
190 if (!setup_recoder_pipeline (smart_encoder))
191 return GST_FLOW_ERROR;
194 /* Activate elements */
195 /* Set elements to PAUSED */
196 gst_element_set_state (smart_encoder->encoder, GST_STATE_PAUSED);
197 gst_element_set_state (smart_encoder->decoder, GST_STATE_PAUSED);
199 GST_INFO ("Pushing Flush start/stop to clean decoder/encoder");
200 gst_pad_push_event (smart_encoder->internal_srcpad,
201 gst_event_new_flush_start ());
202 gst_pad_push_event (smart_encoder->internal_srcpad,
203 gst_event_new_flush_stop (TRUE));
205 /* push newsegment */
206 GST_INFO ("Pushing newsegment %" GST_PTR_FORMAT, smart_encoder->newsegment);
207 gst_pad_push_event (smart_encoder->internal_srcpad,
208 gst_event_ref (smart_encoder->newsegment));
210 /* Push buffers through our pads */
211 GST_DEBUG ("Pushing pending buffers");
213 for (tmp = smart_encoder->pending_gop; tmp; tmp = tmp->next) {
214 GstBuffer *buf = (GstBuffer *) tmp->data;
216 res = gst_pad_push (smart_encoder->internal_srcpad, buf);
217 if (G_UNLIKELY (res != GST_FLOW_OK))
221 if (G_UNLIKELY (res != GST_FLOW_OK)) {
222 GST_WARNING ("Error pushing pending buffers : %s", gst_flow_get_name (res));
223 /* Remove pending bfufers */
224 for (tmp = smart_encoder->pending_gop; tmp; tmp = tmp->next) {
225 gst_buffer_unref ((GstBuffer *) tmp->data);
228 GST_INFO ("Pushing out EOS to flush out decoder/encoder");
229 gst_pad_push_event (smart_encoder->internal_srcpad, gst_event_new_eos ());
232 /* Activate elements */
233 /* Set elements to PAUSED */
234 gst_element_set_state (smart_encoder->encoder, GST_STATE_NULL);
235 gst_element_set_state (smart_encoder->decoder, GST_STATE_NULL);
237 g_list_free (smart_encoder->pending_gop);
238 smart_encoder->pending_gop = NULL;
244 gst_smart_encoder_push_pending_gop (GstSmartEncoder * smart_encoder)
246 guint64 cstart, cstop;
248 GstFlowReturn res = GST_FLOW_OK;
250 GST_DEBUG ("Pushing pending GOP (%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
251 ")", GST_TIME_ARGS (smart_encoder->gop_start),
252 GST_TIME_ARGS (smart_encoder->gop_stop));
254 /* If GOP is entirely within segment, just push downstream */
255 if (gst_segment_clip (smart_encoder->segment, GST_FORMAT_TIME,
256 smart_encoder->gop_start, smart_encoder->gop_stop, &cstart, &cstop)) {
257 if ((cstart != smart_encoder->gop_start)
258 || (cstop != smart_encoder->gop_stop)) {
259 GST_DEBUG ("GOP needs to be re-encoded from %" GST_TIME_FORMAT " to %"
260 GST_TIME_FORMAT, GST_TIME_ARGS (cstart), GST_TIME_ARGS (cstop));
261 res = gst_smart_encoder_reencode_gop (smart_encoder);
263 /* The whole GOP is within the segment, push all pending buffers downstream */
264 GST_DEBUG ("GOP doesn't need to be modified, pushing downstream");
265 for (tmp = smart_encoder->pending_gop; tmp; tmp = tmp->next) {
266 GstBuffer *buf = (GstBuffer *) tmp->data;
267 res = gst_pad_push (smart_encoder->srcpad, buf);
268 if (G_UNLIKELY (res != GST_FLOW_OK))
273 /* The whole GOP is outside the segment, there's most likely
274 * a bug somewhere. */
276 ("GOP is entirely outside of the segment, upstream gave us too much data");
277 for (tmp = smart_encoder->pending_gop; tmp; tmp = tmp->next) {
278 gst_buffer_unref ((GstBuffer *) tmp->data);
282 if (smart_encoder->pending_gop) {
283 g_list_free (smart_encoder->pending_gop);
284 smart_encoder->pending_gop = NULL;
286 smart_encoder->gop_start = GST_CLOCK_TIME_NONE;
287 smart_encoder->gop_stop = GST_CLOCK_TIME_NONE;
293 gst_smart_encoder_chain (GstPad * pad, GstBuffer * buf)
295 GstSmartEncoder *smart_encoder;
296 GstFlowReturn res = GST_FLOW_OK;
297 gboolean discont, keyframe;
299 smart_encoder = GST_SMART_ENCODER (gst_object_get_parent (GST_OBJECT (pad)));
301 discont = GST_BUFFER_IS_DISCONT (buf);
302 keyframe = !GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLAG_DELTA_UNIT);
304 GST_DEBUG ("New buffer %s %s %" GST_TIME_FORMAT,
305 discont ? "discont" : "",
306 keyframe ? "keyframe" : "", GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
309 GST_DEBUG ("Got a keyframe");
311 /* If there's a pending GOP, flush it out */
312 if (smart_encoder->pending_gop) {
314 smart_encoder->gop_stop = GST_BUFFER_TIMESTAMP (buf);
317 res = gst_smart_encoder_push_pending_gop (smart_encoder);
318 if (G_UNLIKELY (res != GST_FLOW_OK))
322 /* Mark gop_start for new gop */
323 smart_encoder->gop_start = GST_BUFFER_TIMESTAMP (buf);
327 smart_encoder->pending_gop = g_list_append (smart_encoder->pending_gop, buf);
328 /* Update GOP stop position */
329 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
330 smart_encoder->gop_stop = GST_BUFFER_TIMESTAMP (buf);
331 if (GST_BUFFER_DURATION_IS_VALID (buf))
332 smart_encoder->gop_stop += GST_BUFFER_DURATION (buf);
335 GST_DEBUG ("Buffer stored , Current GOP : %" GST_TIME_FORMAT " -- %"
336 GST_TIME_FORMAT, GST_TIME_ARGS (smart_encoder->gop_start),
337 GST_TIME_ARGS (smart_encoder->gop_stop));
340 gst_object_unref (smart_encoder);
345 smart_encoder_sink_event (GstPad * pad, GstEvent * event)
348 GstSmartEncoder *smart_encoder = GST_SMART_ENCODER (gst_pad_get_parent (pad));
350 switch (GST_EVENT_TYPE (event)) {
351 case GST_EVENT_FLUSH_STOP:
352 smart_encoder_reset (smart_encoder);
354 case GST_EVENT_SEGMENT:
356 gst_event_copy_segment (event, smart_encoder->segment);
358 GST_DEBUG_OBJECT (smart_encoder, "segment: %" GST_SEGMENT_FORMAT,
359 smart_encoder->segment);
360 if (smart_encoder->segment->format != GST_FORMAT_TIME)
362 ("smart_encoder can not handle streams not specified in GST_FORMAT_TIME");
364 /* And keep a copy for further usage */
365 if (smart_encoder->newsegment)
366 gst_event_unref (smart_encoder->newsegment);
367 smart_encoder->newsegment = gst_event_ref (event);
371 GST_DEBUG ("Eos, flushing remaining data");
372 gst_smart_encoder_push_pending_gop (smart_encoder);
378 res = gst_pad_push_event (smart_encoder->srcpad, event);
380 gst_object_unref (smart_encoder);
385 smart_encoder_sink_getcaps (GstPad * pad, GstCaps * filter)
387 GstCaps *peer, *tmpl, *res;
388 GstSmartEncoder *smart_encoder = GST_SMART_ENCODER (gst_pad_get_parent (pad));
390 /* Use computed caps */
391 if (smart_encoder->available_caps)
392 tmpl = gst_caps_ref (smart_encoder->available_caps);
394 tmpl = gst_static_pad_template_get_caps (&src_template);
396 /* Try getting it from downstream */
397 peer = gst_pad_peer_query_caps (smart_encoder->srcpad, tmpl);
403 gst_caps_unref (tmpl);
406 gst_object_unref (smart_encoder);
411 smart_encoder_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
415 switch (GST_QUERY_TYPE (query)) {
418 GstCaps *filter, *caps;
420 gst_query_parse_caps (query, &filter);
421 caps = smart_encoder_sink_getcaps (pad, filter);
422 gst_query_set_caps_result (query, caps);
423 gst_caps_unref (caps);
428 res = gst_pad_query_default (pad, parent, query);
434 /*****************************************
435 * Internal encoder/decoder pipeline *
436 ******************************************/
438 static GstElementFactory *
439 get_decoder_factory (GstCaps * caps)
441 GstElementFactory *fact = NULL;
442 GList *decoders, *tmp;
445 gst_element_factory_list_get_elements (GST_ELEMENT_FACTORY_TYPE_DECODER,
447 decoders = gst_element_factory_list_filter (tmp, caps, GST_PAD_SINK, FALSE);
448 gst_plugin_feature_list_free (tmp);
450 for (tmp = decoders; tmp; tmp = tmp->next) {
451 /* We just pick the first one */
452 fact = (GstElementFactory *) tmp->data;
453 gst_object_ref (fact);
457 gst_plugin_feature_list_free (decoders);
462 static GstElementFactory *
463 get_encoder_factory (GstCaps * caps)
465 GstElementFactory *fact = NULL;
466 GList *encoders, *tmp;
469 gst_element_factory_list_get_elements (GST_ELEMENT_FACTORY_TYPE_ENCODER,
471 encoders = gst_element_factory_list_filter (tmp, caps, GST_PAD_SRC, FALSE);
472 gst_plugin_feature_list_free (tmp);
474 for (tmp = encoders; tmp; tmp = tmp->next) {
475 /* We just pick the first one */
476 fact = (GstElementFactory *) tmp->data;
477 gst_object_ref (fact);
481 gst_plugin_feature_list_free (encoders);
487 get_decoder (GstCaps * caps)
489 GstElementFactory *fact = get_decoder_factory (caps);
490 GstElement *res = NULL;
493 res = gst_element_factory_create (fact, "internal-decoder");
494 gst_object_unref (fact);
500 get_encoder (GstCaps * caps)
502 GstElementFactory *fact = get_encoder_factory (caps);
503 GstElement *res = NULL;
506 res = gst_element_factory_create (fact, "internal-encoder");
507 gst_object_unref (fact);
513 internal_chain (GstPad * pad, GstBuffer * buf)
515 GstSmartEncoder *smart_encoder =
516 g_object_get_qdata ((GObject *) pad, INTERNAL_ELEMENT);
518 return gst_pad_push (smart_encoder->srcpad, buf);
522 setup_recoder_pipeline (GstSmartEncoder * smart_encoder)
528 if (G_UNLIKELY (smart_encoder->encoder))
531 GST_DEBUG ("Creating internal decoder and encoder");
533 /* Create decoder/encoder */
534 caps = gst_pad_get_current_caps (smart_encoder->sinkpad);
535 smart_encoder->decoder = get_decoder (caps);
536 if (G_UNLIKELY (smart_encoder->decoder == NULL))
538 gst_caps_unref (caps);
539 gst_element_set_bus (smart_encoder->decoder, GST_ELEMENT_BUS (smart_encoder));
541 caps = gst_pad_get_current_caps (smart_encoder->sinkpad);
542 smart_encoder->encoder = get_encoder (caps);
543 if (G_UNLIKELY (smart_encoder->encoder == NULL))
545 gst_caps_unref (caps);
546 gst_element_set_bus (smart_encoder->encoder, GST_ELEMENT_BUS (smart_encoder));
548 GST_DEBUG ("Creating internal pads");
550 /* Create internal pads */
552 /* Source pad which we'll use to feed data to decoders */
553 smart_encoder->internal_srcpad = gst_pad_new ("internal_src", GST_PAD_SRC);
554 g_object_set_qdata ((GObject *) smart_encoder->internal_srcpad,
555 INTERNAL_ELEMENT, smart_encoder);
556 gst_pad_set_active (smart_encoder->internal_srcpad, TRUE);
558 /* Sink pad which will get the buffers from the encoder.
559 * Note: We don't need an event function since we'll be discarding all
561 smart_encoder->internal_sinkpad = gst_pad_new ("internal_sink", GST_PAD_SINK);
562 g_object_set_qdata ((GObject *) smart_encoder->internal_sinkpad,
563 INTERNAL_ELEMENT, smart_encoder);
564 gst_pad_set_chain_function (smart_encoder->internal_sinkpad, internal_chain);
565 gst_pad_set_active (smart_encoder->internal_sinkpad, TRUE);
567 GST_DEBUG ("Linking pads to elements");
569 /* Link everything */
570 tmppad = gst_element_get_static_pad (smart_encoder->encoder, "src");
571 if (GST_PAD_LINK_FAILED (gst_pad_link (tmppad,
572 smart_encoder->internal_sinkpad)))
573 goto sinkpad_link_fail;
574 gst_object_unref (tmppad);
576 if (!gst_element_link (smart_encoder->decoder, smart_encoder->encoder))
577 goto encoder_decoder_link_fail;
579 tmppad = gst_element_get_static_pad (smart_encoder->decoder, "sink");
580 if (GST_PAD_LINK_FAILED (gst_pad_link (smart_encoder->internal_srcpad,
582 goto srcpad_link_fail;
583 gst_object_unref (tmppad);
585 GST_DEBUG ("Done creating internal elements/pads");
591 GST_WARNING ("Couldn't find a decoder for %" GST_PTR_FORMAT, caps);
592 gst_caps_unref (caps);
598 GST_WARNING ("Couldn't find an encoder for %" GST_PTR_FORMAT, caps);
599 gst_caps_unref (caps);
605 gst_object_unref (tmppad);
606 GST_WARNING ("Couldn't link internal srcpad to decoder");
612 gst_object_unref (tmppad);
613 GST_WARNING ("Couldn't link encoder to internal sinkpad");
617 encoder_decoder_link_fail:
619 GST_WARNING ("Couldn't link decoder to encoder");
624 static GstStateChangeReturn
625 gst_smart_encoder_find_elements (GstSmartEncoder * smart_encoder)
628 GstCaps *tmpl, *st, *res;
629 GstElementFactory *dec, *enc;
630 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
632 if (G_UNLIKELY (smart_encoder->available_caps))
635 /* Iterate over all pad template caps and see if we have both an
636 * encoder and a decoder for those media types */
637 tmpl = gst_static_pad_template_get_caps (&src_template);
638 res = gst_caps_new_empty ();
639 n = gst_caps_get_size (tmpl);
641 for (i = 0; i < n; i++) {
642 st = gst_caps_copy_nth (tmpl, i);
643 GST_DEBUG_OBJECT (smart_encoder,
644 "Checking for available decoder and encoder for %" GST_PTR_FORMAT, st);
645 if (!(dec = get_decoder_factory (st))) {
649 gst_object_unref (dec);
650 if (!(enc = get_encoder_factory (st))) {
654 gst_object_unref (enc);
655 GST_DEBUG_OBJECT (smart_encoder, "OK");
656 gst_caps_append (res, st);
659 gst_caps_unref (tmpl);
661 if (gst_caps_is_empty (res))
662 ret = GST_STATE_CHANGE_FAILURE;
664 smart_encoder->available_caps = res;
666 GST_DEBUG_OBJECT (smart_encoder, "Done, available_caps:%" GST_PTR_FORMAT,
667 smart_encoder->available_caps);
673 /******************************************
674 * GstElement vmethod implementations *
675 ******************************************/
677 static GstStateChangeReturn
678 gst_smart_encoder_change_state (GstElement * element, GstStateChange transition)
680 GstSmartEncoder *smart_encoder;
681 GstStateChangeReturn ret;
683 g_return_val_if_fail (GST_IS_SMART_ENCODER (element),
684 GST_STATE_CHANGE_FAILURE);
686 smart_encoder = GST_SMART_ENCODER (element);
688 switch (transition) {
689 case GST_STATE_CHANGE_NULL_TO_READY:
690 /* Figure out which elements are available */
692 gst_smart_encoder_find_elements (smart_encoder)) ==
693 GST_STATE_CHANGE_FAILURE)
701 GST_ELEMENT_CLASS (gst_smart_encoder_parent_class)->change_state (element,
704 switch (transition) {
705 case GST_STATE_CHANGE_PAUSED_TO_READY:
706 smart_encoder_reset (smart_encoder);