2 * Copyright (C) 2008 David Schleef <ds@schleef.org>
3 * Copyright (C) 2011 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>.
4 * Copyright (C) 2011 Nokia Corporation. All rights reserved.
5 * Contact: Stefan Kost <stefan.kost@nokia.com>
6 * Copyright (C) 2012 Collabora Ltd.
7 * Author : Edward Hervey <edward@collabora.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
26 * SECTION:gstvideoencoder
27 * @short_description: Base class for video encoders
30 * This base class is for video encoders turning raw video into
33 * GstVideoEncoder and subclass should cooperate as follows.
36 * <itemizedlist><title>Configuration</title>
38 * Initially, GstVideoEncoder calls @start when the encoder element
39 * is activated, which allows subclass to perform any global setup.
42 * GstVideoEncoder calls @set_format to inform subclass of the format
43 * of input video data that it is about to receive. Subclass should
44 * setup for encoding and configure base class as appropriate
45 * (e.g. latency). While unlikely, it might be called more than once,
46 * if changing input parameters require reconfiguration. Baseclass
47 * will ensure that processing of current configuration is finished.
50 * GstVideoEncoder calls @stop at end of all processing.
56 * <title>Data processing</title>
58 * Base class collects input data and metadata into a frame and hands
59 * this to subclass' @handle_frame.
62 * If codec processing results in encoded data, subclass should call
63 * @gst_video_encoder_finish_frame to have encoded data pushed
67 * If implemented, baseclass calls subclass @pre_push just prior to
68 * pushing to allow subclasses to modify some metadata on the buffer.
69 * If it returns GST_FLOW_OK, the buffer is pushed downstream.
72 * GstVideoEncoderClass will handle both srcpad and sinkpad events.
73 * Sink events will be passed to subclass if @event callback has been
79 * <itemizedlist><title>Shutdown phase</title>
81 * GstVideoEncoder class calls @stop to inform the subclass that data
82 * parsing will be stopped.
88 * Subclass is responsible for providing pad template caps for
89 * source and sink pads. The pads need to be named "sink" and "src". It should
90 * also be able to provide fixed src pad caps in @getcaps by the time it calls
91 * @gst_video_encoder_finish_frame.
93 * Things that subclass need to take care of:
95 * <listitem><para>Provide pad templates</para></listitem>
97 * Provide source pad caps before pushing the first buffer
100 * Accept data in @handle_frame and provide encoded results to
101 * @gst_video_encoder_finish_frame.
113 * * Change _set_output_format() to steal the reference of the provided caps
114 * * Calculate actual latency based on input/output timestamp/frame_number
115 * and if it exceeds the recorded one, save it and emit a GST_MESSAGE_LATENCY
118 /* FIXME 0.11: suppress warnings for deprecated API such as GStaticRecMutex
119 * with newer GLib versions (>= 2.31.0) */
120 #define GLIB_DISABLE_DEPRECATION_WARNINGS
122 #include "gstvideoencoder.h"
123 #include "gstvideoutils.h"
125 #include <gst/video/gstvideometa.h>
126 #include <gst/video/gstvideopool.h>
130 GST_DEBUG_CATEGORY (videoencoder_debug);
131 #define GST_CAT_DEFAULT videoencoder_debug
133 #define GST_VIDEO_ENCODER_GET_PRIVATE(obj) \
134 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_VIDEO_ENCODER, \
135 GstVideoEncoderPrivate))
137 struct _GstVideoEncoderPrivate
139 guint64 presentation_frame_number;
140 int distance_from_sync;
142 /* FIXME : (and introduce a context ?) */
150 GList *current_frame_events;
153 gboolean new_headers; /* Whether new headers were just set */
155 GList *force_key_unit; /* List of pending forced keyunits */
157 guint32 system_frame_number;
159 GList *frames; /* Protected with OBJECT_LOCK */
160 GstVideoCodecState *input_state;
161 GstVideoCodecState *output_state;
162 gboolean output_state_changed;
167 GstAllocator *allocator;
168 GstAllocationParams params;
171 typedef struct _ForcedKeyUnitEvent ForcedKeyUnitEvent;
172 struct _ForcedKeyUnitEvent
174 GstClockTime running_time;
175 gboolean pending; /* TRUE if this was requested already */
176 gboolean all_headers;
181 forced_key_unit_event_free (ForcedKeyUnitEvent * evt)
183 g_slice_free (ForcedKeyUnitEvent, evt);
186 static ForcedKeyUnitEvent *
187 forced_key_unit_event_new (GstClockTime running_time, gboolean all_headers,
190 ForcedKeyUnitEvent *evt = g_slice_new0 (ForcedKeyUnitEvent);
192 evt->running_time = running_time;
193 evt->all_headers = all_headers;
199 static GstElementClass *parent_class = NULL;
200 static void gst_video_encoder_class_init (GstVideoEncoderClass * klass);
201 static void gst_video_encoder_init (GstVideoEncoder * enc,
202 GstVideoEncoderClass * klass);
204 static void gst_video_encoder_finalize (GObject * object);
206 static gboolean gst_video_encoder_setcaps (GstVideoEncoder * enc,
208 static GstCaps *gst_video_encoder_sink_getcaps (GstVideoEncoder * encoder,
210 static gboolean gst_video_encoder_src_event (GstPad * pad, GstObject * parent,
212 static gboolean gst_video_encoder_sink_event (GstPad * pad, GstObject * parent,
214 static GstFlowReturn gst_video_encoder_chain (GstPad * pad, GstObject * parent,
216 static GstStateChangeReturn gst_video_encoder_change_state (GstElement *
217 element, GstStateChange transition);
218 static gboolean gst_video_encoder_sink_query (GstPad * pad, GstObject * parent,
220 static gboolean gst_video_encoder_src_query (GstPad * pad, GstObject * parent,
222 static GstVideoCodecFrame *gst_video_encoder_new_frame (GstVideoEncoder *
223 encoder, GstBuffer * buf, GstClockTime pts, GstClockTime dts,
224 GstClockTime duration);
226 static gboolean gst_video_encoder_sink_event_default (GstVideoEncoder * encoder,
228 static gboolean gst_video_encoder_src_event_default (GstVideoEncoder * encoder,
230 static gboolean gst_video_encoder_decide_allocation_default (GstVideoEncoder *
231 encoder, GstQuery * query);
232 static gboolean gst_video_encoder_propose_allocation_default (GstVideoEncoder *
233 encoder, GstQuery * query);
235 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
236 * method to get to the padtemplates */
238 gst_video_encoder_get_type (void)
240 static volatile gsize type = 0;
242 if (g_once_init_enter (&type)) {
244 static const GTypeInfo info = {
245 sizeof (GstVideoEncoderClass),
248 (GClassInitFunc) gst_video_encoder_class_init,
251 sizeof (GstVideoEncoder),
253 (GInstanceInitFunc) gst_video_encoder_init,
255 const GInterfaceInfo preset_interface_info = {
256 NULL, /* interface_init */
257 NULL, /* interface_finalize */
258 NULL /* interface_data */
261 _type = g_type_register_static (GST_TYPE_ELEMENT,
262 "GstVideoEncoder", &info, G_TYPE_FLAG_ABSTRACT);
263 g_type_add_interface_static (_type, GST_TYPE_PRESET,
264 &preset_interface_info);
265 g_once_init_leave (&type, _type);
271 gst_video_encoder_class_init (GstVideoEncoderClass * klass)
273 GObjectClass *gobject_class;
274 GstElementClass *gstelement_class;
276 gobject_class = G_OBJECT_CLASS (klass);
277 gstelement_class = GST_ELEMENT_CLASS (klass);
279 GST_DEBUG_CATEGORY_INIT (videoencoder_debug, "videoencoder", 0,
280 "Base Video Encoder");
282 parent_class = g_type_class_peek_parent (klass);
284 g_type_class_add_private (klass, sizeof (GstVideoEncoderPrivate));
286 gobject_class->finalize = gst_video_encoder_finalize;
288 gstelement_class->change_state =
289 GST_DEBUG_FUNCPTR (gst_video_encoder_change_state);
291 klass->sink_event = gst_video_encoder_sink_event_default;
292 klass->src_event = gst_video_encoder_src_event_default;
293 klass->propose_allocation = gst_video_encoder_propose_allocation_default;
294 klass->decide_allocation = gst_video_encoder_decide_allocation_default;
298 gst_video_encoder_reset (GstVideoEncoder * encoder)
300 GstVideoEncoderPrivate *priv = encoder->priv;
303 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
305 priv->presentation_frame_number = 0;
306 priv->distance_from_sync = 0;
308 g_list_foreach (priv->force_key_unit, (GFunc) forced_key_unit_event_free,
310 g_list_free (priv->force_key_unit);
311 priv->force_key_unit = NULL;
313 priv->drained = TRUE;
314 priv->min_latency = 0;
315 priv->max_latency = 0;
317 g_list_foreach (priv->headers, (GFunc) gst_event_unref, NULL);
318 g_list_free (priv->headers);
319 priv->headers = NULL;
320 priv->new_headers = FALSE;
322 g_list_foreach (priv->current_frame_events, (GFunc) gst_event_unref, NULL);
323 g_list_free (priv->current_frame_events);
324 priv->current_frame_events = NULL;
326 for (g = priv->frames; g; g = g->next) {
327 gst_video_codec_frame_unref ((GstVideoCodecFrame *) g->data);
329 g_list_free (priv->frames);
335 if (priv->input_state)
336 gst_video_codec_state_unref (priv->input_state);
337 priv->input_state = NULL;
338 if (priv->output_state)
339 gst_video_codec_state_unref (priv->output_state);
340 priv->output_state = NULL;
342 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
346 gst_video_encoder_init (GstVideoEncoder * encoder, GstVideoEncoderClass * klass)
348 GstVideoEncoderPrivate *priv;
349 GstPadTemplate *pad_template;
352 GST_DEBUG_OBJECT (encoder, "gst_video_encoder_init");
354 priv = encoder->priv = GST_VIDEO_ENCODER_GET_PRIVATE (encoder);
357 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "sink");
358 g_return_if_fail (pad_template != NULL);
360 encoder->sinkpad = pad = gst_pad_new_from_template (pad_template, "sink");
362 gst_pad_set_chain_function (pad, GST_DEBUG_FUNCPTR (gst_video_encoder_chain));
363 gst_pad_set_event_function (pad,
364 GST_DEBUG_FUNCPTR (gst_video_encoder_sink_event));
365 gst_pad_set_query_function (pad,
366 GST_DEBUG_FUNCPTR (gst_video_encoder_sink_query));
367 gst_element_add_pad (GST_ELEMENT (encoder), encoder->sinkpad);
370 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
371 g_return_if_fail (pad_template != NULL);
373 encoder->srcpad = pad = gst_pad_new_from_template (pad_template, "src");
375 gst_pad_set_query_function (pad,
376 GST_DEBUG_FUNCPTR (gst_video_encoder_src_query));
377 gst_pad_set_event_function (pad,
378 GST_DEBUG_FUNCPTR (gst_video_encoder_src_event));
379 gst_element_add_pad (GST_ELEMENT (encoder), encoder->srcpad);
381 gst_segment_init (&encoder->input_segment, GST_FORMAT_TIME);
382 gst_segment_init (&encoder->output_segment, GST_FORMAT_TIME);
384 g_rec_mutex_init (&encoder->stream_lock);
386 priv->at_eos = FALSE;
387 priv->headers = NULL;
388 priv->new_headers = FALSE;
390 gst_video_encoder_reset (encoder);
394 gst_video_encoded_video_convert (gint64 bytes, gint64 time,
395 GstFormat src_format, gint64 src_value, GstFormat * dest_format,
398 gboolean res = FALSE;
400 g_return_val_if_fail (dest_format != NULL, FALSE);
401 g_return_val_if_fail (dest_value != NULL, FALSE);
403 if (G_UNLIKELY (src_format == *dest_format || src_value == 0 ||
406 *dest_value = src_value;
410 if (bytes <= 0 || time <= 0) {
411 GST_DEBUG ("not enough metadata yet to convert");
415 switch (src_format) {
416 case GST_FORMAT_BYTES:
417 switch (*dest_format) {
418 case GST_FORMAT_TIME:
419 *dest_value = gst_util_uint64_scale (src_value, time, bytes);
426 case GST_FORMAT_TIME:
427 switch (*dest_format) {
428 case GST_FORMAT_BYTES:
429 *dest_value = gst_util_uint64_scale (src_value, bytes, time);
437 GST_DEBUG ("unhandled conversion from %d to %d", src_format,
447 * gst_video_encoder_set_headers:
448 * @encoder: a #GstVideoEncoder
449 * @headers: (transfer full) (element-type GstBuffer): a list of #GstBuffer containing the codec header
451 * Set the codec headers to be sent downstream whenever requested.
454 gst_video_encoder_set_headers (GstVideoEncoder * video_encoder, GList * headers)
456 GST_VIDEO_ENCODER_STREAM_LOCK (video_encoder);
458 GST_DEBUG_OBJECT (video_encoder, "new headers %p", headers);
459 if (video_encoder->priv->headers) {
460 g_list_foreach (video_encoder->priv->headers, (GFunc) gst_buffer_unref,
462 g_list_free (video_encoder->priv->headers);
464 video_encoder->priv->headers = headers;
465 video_encoder->priv->new_headers = TRUE;
467 GST_VIDEO_ENCODER_STREAM_UNLOCK (video_encoder);
471 gst_video_encoder_drain (GstVideoEncoder * enc)
473 GstVideoEncoderPrivate *priv;
474 GstVideoEncoderClass *enc_class;
477 enc_class = GST_VIDEO_ENCODER_GET_CLASS (enc);
480 GST_DEBUG_OBJECT (enc, "draining");
483 GST_DEBUG_OBJECT (enc, "already drained");
487 if (enc_class->reset) {
488 GST_DEBUG_OBJECT (enc, "requesting subclass to finish");
489 ret = enc_class->reset (enc, TRUE);
491 /* everything should be away now */
493 /* not fatal/impossible though if subclass/enc eats stuff */
494 g_list_foreach (priv->frames, (GFunc) gst_video_codec_frame_unref, NULL);
495 g_list_free (priv->frames);
502 static GstVideoCodecState *
503 _new_output_state (GstCaps * caps, GstVideoCodecState * reference)
505 GstVideoCodecState *state;
507 state = g_slice_new0 (GstVideoCodecState);
508 state->ref_count = 1;
509 gst_video_info_init (&state->info);
510 gst_video_info_set_format (&state->info, GST_VIDEO_FORMAT_ENCODED, 0, 0);
515 GstVideoInfo *tgt, *ref;
518 ref = &reference->info;
520 /* Copy over extra fields from reference state */
521 tgt->interlace_mode = ref->interlace_mode;
522 tgt->flags = ref->flags;
523 tgt->width = ref->width;
524 tgt->height = ref->height;
525 tgt->chroma_site = ref->chroma_site;
526 tgt->colorimetry = ref->colorimetry;
527 tgt->par_n = ref->par_n;
528 tgt->par_d = ref->par_d;
529 tgt->fps_n = ref->fps_n;
530 tgt->fps_d = ref->fps_d;
536 static GstVideoCodecState *
537 _new_input_state (GstCaps * caps)
539 GstVideoCodecState *state;
541 state = g_slice_new0 (GstVideoCodecState);
542 state->ref_count = 1;
543 gst_video_info_init (&state->info);
544 if (G_UNLIKELY (!gst_video_info_from_caps (&state->info, caps)))
546 state->caps = gst_caps_ref (caps);
552 g_slice_free (GstVideoCodecState, state);
558 gst_video_encoder_setcaps (GstVideoEncoder * encoder, GstCaps * caps)
560 GstVideoEncoderClass *encoder_class;
561 GstVideoCodecState *state;
563 gboolean samecaps = FALSE;
565 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (encoder);
567 /* subclass should do something here ... */
568 g_return_val_if_fail (encoder_class->set_format != NULL, FALSE);
570 GST_DEBUG_OBJECT (encoder, "setcaps %" GST_PTR_FORMAT, caps);
572 state = _new_input_state (caps);
573 if (G_UNLIKELY (!state))
576 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
578 if (encoder->priv->input_state)
580 gst_video_info_is_equal (&state->info,
581 &encoder->priv->input_state->info);
584 /* arrange draining pending frames */
585 gst_video_encoder_drain (encoder);
587 /* and subclass should be ready to configure format at any time around */
588 ret = encoder_class->set_format (encoder, state);
590 if (encoder->priv->input_state)
591 gst_video_codec_state_unref (encoder->priv->input_state);
592 encoder->priv->input_state = state;
594 gst_video_codec_state_unref (state);
596 /* no need to stir things up */
597 GST_DEBUG_OBJECT (encoder,
598 "new video format identical to configured format");
599 gst_video_codec_state_unref (state);
603 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
606 GST_WARNING_OBJECT (encoder, "rejected caps %" GST_PTR_FORMAT, caps);
612 GST_WARNING_OBJECT (encoder, "Failed to parse caps");
618 * gst_video_encoder_proxy_getcaps:
619 * @enc: a #GstVideoEncoder
620 * @caps: initial caps
621 * @filter: filter caps
623 * Returns caps that express @caps (or sink template caps if @caps == NULL)
624 * restricted to resolution/format/... combinations supported by downstream
625 * elements (e.g. muxers).
627 * Returns: a #GstCaps owned by caller
630 gst_video_encoder_proxy_getcaps (GstVideoEncoder * encoder, GstCaps * caps,
635 GstCaps *fcaps, *filter_caps;
638 /* Allow downstream to specify width/height/framerate/PAR constraints
639 * and forward them upstream for video converters to handle
642 caps ? gst_caps_ref (caps) :
643 gst_pad_get_pad_template_caps (encoder->sinkpad);
644 allowed = gst_pad_get_allowed_caps (encoder->srcpad);
646 if (!allowed || gst_caps_is_empty (allowed) || gst_caps_is_any (allowed)) {
651 GST_LOG_OBJECT (encoder, "template caps %" GST_PTR_FORMAT, templ_caps);
652 GST_LOG_OBJECT (encoder, "allowed caps %" GST_PTR_FORMAT, allowed);
654 filter_caps = gst_caps_new_empty ();
656 for (i = 0; i < gst_caps_get_size (templ_caps); i++) {
658 gst_structure_get_name_id (gst_caps_get_structure (templ_caps, i));
660 for (j = 0; j < gst_caps_get_size (allowed); j++) {
661 const GstStructure *allowed_s = gst_caps_get_structure (allowed, j);
665 s = gst_structure_new_id_empty (q_name);
666 if ((val = gst_structure_get_value (allowed_s, "width")))
667 gst_structure_set_value (s, "width", val);
668 if ((val = gst_structure_get_value (allowed_s, "height")))
669 gst_structure_set_value (s, "height", val);
670 if ((val = gst_structure_get_value (allowed_s, "framerate")))
671 gst_structure_set_value (s, "framerate", val);
672 if ((val = gst_structure_get_value (allowed_s, "pixel-aspect-ratio")))
673 gst_structure_set_value (s, "pixel-aspect-ratio", val);
675 filter_caps = gst_caps_merge_structure (filter_caps, s);
679 fcaps = gst_caps_intersect (filter_caps, templ_caps);
680 gst_caps_unref (filter_caps);
681 gst_caps_unref (templ_caps);
684 GST_LOG_OBJECT (encoder, "intersecting with %" GST_PTR_FORMAT, filter);
685 filter_caps = gst_caps_intersect (fcaps, filter);
686 gst_caps_unref (fcaps);
691 gst_caps_replace (&allowed, NULL);
693 GST_LOG_OBJECT (encoder, "proxy caps %" GST_PTR_FORMAT, fcaps);
699 gst_video_encoder_sink_getcaps (GstVideoEncoder * encoder, GstCaps * filter)
701 GstVideoEncoderClass *klass;
704 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
707 caps = klass->getcaps (encoder, filter);
709 caps = gst_video_encoder_proxy_getcaps (encoder, NULL, filter);
711 GST_LOG_OBJECT (encoder, "Returning caps %" GST_PTR_FORMAT, caps);
717 gst_video_encoder_decide_allocation_default (GstVideoEncoder * encoder,
720 GstAllocator *allocator = NULL;
721 GstAllocationParams params;
722 gboolean update_allocator;
724 /* we got configuration from our peer or the decide_allocation method,
726 if (gst_query_get_n_allocation_params (query) > 0) {
727 /* try the allocator */
728 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
729 update_allocator = TRUE;
732 gst_allocation_params_init (¶ms);
733 update_allocator = FALSE;
736 if (update_allocator)
737 gst_query_set_nth_allocation_param (query, 0, allocator, ¶ms);
739 gst_query_add_allocation_param (query, allocator, ¶ms);
741 gst_object_unref (allocator);
747 gst_video_encoder_propose_allocation_default (GstVideoEncoder * encoder,
755 gst_query_parse_allocation (query, &caps, NULL);
760 if (!gst_video_info_from_caps (&info, caps))
763 size = GST_VIDEO_INFO_SIZE (&info);
765 if (gst_query_get_n_allocation_pools (query) == 0) {
766 GstStructure *structure;
767 GstAllocator *allocator = NULL;
768 GstAllocationParams params = { 0, 0, 0, 15, };
770 if (gst_query_get_n_allocation_params (query) > 0)
771 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
773 gst_query_add_allocation_param (query, allocator, ¶ms);
775 pool = gst_video_buffer_pool_new ();
777 structure = gst_buffer_pool_get_config (pool);
778 gst_buffer_pool_config_set_params (structure, caps, size, 0, 0);
779 gst_buffer_pool_config_set_allocator (structure, allocator, ¶ms);
782 gst_object_unref (allocator);
784 if (!gst_buffer_pool_set_config (pool, structure))
787 gst_query_add_allocation_pool (query, pool, size, 0, 0);
788 gst_object_unref (pool);
789 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL);
797 GST_ERROR_OBJECT (encoder, "failed to set config");
798 gst_object_unref (pool);
804 gst_video_encoder_sink_query (GstPad * pad, GstObject * parent,
807 GstVideoEncoder *encoder;
808 gboolean res = FALSE;
810 encoder = GST_VIDEO_ENCODER (parent);
812 switch (GST_QUERY_TYPE (query)) {
815 GstCaps *filter, *caps;
817 gst_query_parse_caps (query, &filter);
818 caps = gst_video_encoder_sink_getcaps (encoder, filter);
819 gst_query_set_caps_result (query, caps);
820 gst_caps_unref (caps);
824 case GST_QUERY_ALLOCATION:
826 GstVideoEncoderClass *klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
828 if (klass->propose_allocation)
829 res = klass->propose_allocation (encoder, query);
833 res = gst_pad_query_default (pad, parent, query);
840 gst_video_encoder_finalize (GObject * object)
842 GstVideoEncoder *encoder;
844 GST_DEBUG_OBJECT (object, "finalize");
846 encoder = GST_VIDEO_ENCODER (object);
847 if (encoder->priv->headers) {
848 g_list_foreach (encoder->priv->headers, (GFunc) gst_buffer_unref, NULL);
849 g_list_free (encoder->priv->headers);
851 g_rec_mutex_clear (&encoder->stream_lock);
853 if (encoder->priv->allocator) {
854 gst_object_unref (encoder->priv->allocator);
855 encoder->priv->allocator = NULL;
858 G_OBJECT_CLASS (parent_class)->finalize (object);
862 gst_video_encoder_push_event (GstVideoEncoder * encoder, GstEvent * event)
864 switch (GST_EVENT_TYPE (event)) {
865 case GST_EVENT_SEGMENT:
869 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
871 gst_event_copy_segment (event, &segment);
873 GST_DEBUG_OBJECT (encoder, "segment %" GST_SEGMENT_FORMAT, &segment);
875 if (segment.format != GST_FORMAT_TIME) {
876 GST_DEBUG_OBJECT (encoder, "received non TIME segment");
877 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
881 encoder->output_segment = segment;
882 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
889 return gst_pad_push_event (encoder->srcpad, event);
893 gst_video_encoder_sink_event_default (GstVideoEncoder * encoder,
896 GstVideoEncoderClass *encoder_class;
897 gboolean ret = FALSE;
899 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (encoder);
901 switch (GST_EVENT_TYPE (event)) {
906 gst_event_parse_caps (event, &caps);
908 encoder->priv->do_caps = TRUE;
909 gst_event_unref (event);
915 GstFlowReturn flow_ret;
917 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
918 encoder->priv->at_eos = TRUE;
920 if (encoder_class->finish) {
921 flow_ret = encoder_class->finish (encoder);
923 flow_ret = GST_FLOW_OK;
926 ret = (flow_ret == GST_FLOW_OK);
927 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
930 case GST_EVENT_SEGMENT:
934 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
936 gst_event_copy_segment (event, &segment);
938 GST_DEBUG_OBJECT (encoder, "segment %" GST_SEGMENT_FORMAT, &segment);
940 if (segment.format != GST_FORMAT_TIME) {
941 GST_DEBUG_OBJECT (encoder, "received non TIME newsegment");
942 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
946 encoder->priv->at_eos = FALSE;
948 encoder->input_segment = segment;
950 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
953 case GST_EVENT_CUSTOM_DOWNSTREAM:
955 if (gst_video_event_is_force_key_unit (event)) {
956 GstClockTime running_time;
957 gboolean all_headers;
960 if (gst_video_event_parse_downstream_force_key_unit (event,
961 NULL, NULL, &running_time, &all_headers, &count)) {
962 ForcedKeyUnitEvent *fevt;
964 GST_OBJECT_LOCK (encoder);
965 fevt = forced_key_unit_event_new (running_time, all_headers, count);
966 encoder->priv->force_key_unit =
967 g_list_append (encoder->priv->force_key_unit, fevt);
968 GST_OBJECT_UNLOCK (encoder);
970 GST_DEBUG_OBJECT (encoder,
971 "force-key-unit event: running-time %" GST_TIME_FORMAT
972 ", all_headers %d, count %u",
973 GST_TIME_ARGS (running_time), all_headers, count);
975 gst_event_unref (event);
985 /* Forward non-serialized events and EOS/FLUSH_STOP immediately.
986 * For EOS this is required because no buffer or serialized event
987 * will come after EOS and nothing could trigger another
988 * _finish_frame() call. *
989 * If the subclass handles sending of EOS manually it can simply
990 * not chain up to the parent class' event handler
992 * For FLUSH_STOP this is required because it is expected
993 * to be forwarded immediately and no buffers are queued anyway.
996 if (!GST_EVENT_IS_SERIALIZED (event)
997 || GST_EVENT_TYPE (event) == GST_EVENT_EOS
998 || GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP) {
999 ret = gst_video_encoder_push_event (encoder, event);
1001 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1002 encoder->priv->current_frame_events =
1003 g_list_prepend (encoder->priv->current_frame_events, event);
1004 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1013 gst_video_encoder_sink_event (GstPad * pad, GstObject * parent,
1016 GstVideoEncoder *enc;
1017 GstVideoEncoderClass *klass;
1018 gboolean ret = TRUE;
1020 enc = GST_VIDEO_ENCODER (parent);
1021 klass = GST_VIDEO_ENCODER_GET_CLASS (enc);
1023 GST_DEBUG_OBJECT (enc, "received event %d, %s", GST_EVENT_TYPE (event),
1024 GST_EVENT_TYPE_NAME (event));
1026 if (klass->sink_event)
1027 ret = klass->sink_event (enc, event);
1033 gst_video_encoder_src_event_default (GstVideoEncoder * encoder,
1036 gboolean ret = FALSE;
1038 switch (GST_EVENT_TYPE (event)) {
1039 case GST_EVENT_CUSTOM_UPSTREAM:
1041 if (gst_video_event_is_force_key_unit (event)) {
1042 GstClockTime running_time;
1043 gboolean all_headers;
1046 if (gst_video_event_parse_upstream_force_key_unit (event,
1047 &running_time, &all_headers, &count)) {
1048 ForcedKeyUnitEvent *fevt;
1050 GST_OBJECT_LOCK (encoder);
1051 fevt = forced_key_unit_event_new (running_time, all_headers, count);
1052 encoder->priv->force_key_unit =
1053 g_list_append (encoder->priv->force_key_unit, fevt);
1054 GST_OBJECT_UNLOCK (encoder);
1056 GST_DEBUG_OBJECT (encoder,
1057 "force-key-unit event: running-time %" GST_TIME_FORMAT
1058 ", all_headers %d, count %u",
1059 GST_TIME_ARGS (running_time), all_headers, count);
1061 gst_event_unref (event);
1073 gst_pad_event_default (encoder->srcpad, GST_OBJECT_CAST (encoder),
1080 gst_video_encoder_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
1082 GstVideoEncoder *encoder;
1083 GstVideoEncoderClass *klass;
1084 gboolean ret = FALSE;
1086 encoder = GST_VIDEO_ENCODER (parent);
1087 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1089 GST_LOG_OBJECT (encoder, "handling event: %" GST_PTR_FORMAT, event);
1091 if (klass->src_event)
1092 ret = klass->src_event (encoder, event);
1098 gst_video_encoder_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
1100 GstVideoEncoderPrivate *priv;
1101 GstVideoEncoder *enc;
1104 enc = GST_VIDEO_ENCODER (parent);
1107 GST_LOG_OBJECT (enc, "handling query: %" GST_PTR_FORMAT, query);
1109 switch (GST_QUERY_TYPE (query)) {
1110 case GST_QUERY_CONVERT:
1112 GstFormat src_fmt, dest_fmt;
1113 gint64 src_val, dest_val;
1115 gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1117 gst_video_encoded_video_convert (priv->bytes, priv->time, src_fmt,
1118 src_val, &dest_fmt, &dest_val);
1121 gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1124 case GST_QUERY_LATENCY:
1127 GstClockTime min_latency, max_latency;
1129 res = gst_pad_peer_query (enc->sinkpad, query);
1131 gst_query_parse_latency (query, &live, &min_latency, &max_latency);
1132 GST_DEBUG_OBJECT (enc, "Peer latency: live %d, min %"
1133 GST_TIME_FORMAT " max %" GST_TIME_FORMAT, live,
1134 GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
1136 GST_OBJECT_LOCK (enc);
1137 min_latency += priv->min_latency;
1138 if (enc->priv->max_latency == GST_CLOCK_TIME_NONE) {
1139 max_latency = GST_CLOCK_TIME_NONE;
1140 } else if (max_latency != GST_CLOCK_TIME_NONE) {
1141 max_latency += enc->priv->max_latency;
1143 GST_OBJECT_UNLOCK (enc);
1145 gst_query_set_latency (query, live, min_latency, max_latency);
1150 res = gst_pad_query_default (pad, parent, query);
1155 GST_DEBUG_OBJECT (enc, "query failed");
1159 static GstVideoCodecFrame *
1160 gst_video_encoder_new_frame (GstVideoEncoder * encoder, GstBuffer * buf,
1161 GstClockTime pts, GstClockTime dts, GstClockTime duration)
1163 GstVideoEncoderPrivate *priv = encoder->priv;
1164 GstVideoCodecFrame *frame;
1166 frame = g_slice_new0 (GstVideoCodecFrame);
1168 frame->ref_count = 1;
1170 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1171 frame->system_frame_number = priv->system_frame_number;
1172 priv->system_frame_number++;
1174 frame->presentation_frame_number = priv->presentation_frame_number;
1175 priv->presentation_frame_number++;
1176 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1178 frame->events = priv->current_frame_events;
1179 priv->current_frame_events = NULL;
1180 frame->input_buffer = buf;
1183 frame->duration = duration;
1189 static GstFlowReturn
1190 gst_video_encoder_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
1192 GstVideoEncoder *encoder;
1193 GstVideoEncoderPrivate *priv;
1194 GstVideoEncoderClass *klass;
1195 GstVideoCodecFrame *frame;
1196 GstClockTime pts, dts, duration;
1197 GstFlowReturn ret = GST_FLOW_OK;
1198 guint64 start, stop, cstart, cstop;
1200 encoder = GST_VIDEO_ENCODER (parent);
1201 priv = encoder->priv;
1202 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1204 g_return_val_if_fail (klass->handle_frame != NULL, GST_FLOW_ERROR);
1206 if (G_UNLIKELY (encoder->priv->do_caps)) {
1207 GstCaps *caps = gst_pad_get_current_caps (encoder->sinkpad);
1209 goto not_negotiated;
1210 if (!gst_video_encoder_setcaps (encoder, caps)) {
1211 gst_caps_unref (caps);
1212 goto not_negotiated;
1214 encoder->priv->do_caps = FALSE;
1217 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1219 pts = GST_BUFFER_PTS (buf);
1220 dts = GST_BUFFER_DTS (buf);
1221 duration = GST_BUFFER_DURATION (buf);
1223 GST_LOG_OBJECT (encoder,
1224 "received buffer of size %" G_GSIZE_FORMAT " with PTS %" GST_TIME_FORMAT
1225 ", PTS %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
1226 gst_buffer_get_size (buf), GST_TIME_ARGS (pts), GST_TIME_ARGS (dts),
1227 GST_TIME_ARGS (duration));
1235 if (GST_CLOCK_TIME_IS_VALID (duration))
1236 stop = start + duration;
1238 stop = GST_CLOCK_TIME_NONE;
1240 /* Drop buffers outside of segment */
1241 if (!gst_segment_clip (&encoder->output_segment,
1242 GST_FORMAT_TIME, start, stop, &cstart, &cstop)) {
1243 GST_DEBUG_OBJECT (encoder, "clipping to segment dropped frame");
1244 gst_buffer_unref (buf);
1249 gst_video_encoder_new_frame (encoder, buf, cstart, dts, cstop - cstart);
1251 GST_OBJECT_LOCK (encoder);
1252 if (priv->force_key_unit) {
1253 ForcedKeyUnitEvent *fevt = NULL;
1254 GstClockTime running_time;
1258 gst_segment_to_running_time (&encoder->output_segment, GST_FORMAT_TIME,
1261 for (l = priv->force_key_unit; l; l = l->next) {
1262 ForcedKeyUnitEvent *tmp = l->data;
1264 /* Skip pending keyunits */
1268 /* Simple case, keyunit ASAP */
1269 if (tmp->running_time == GST_CLOCK_TIME_NONE) {
1274 /* Event for before this frame */
1275 if (tmp->running_time <= running_time) {
1282 GST_DEBUG_OBJECT (encoder,
1283 "Forcing a key unit at running time %" GST_TIME_FORMAT,
1284 GST_TIME_ARGS (running_time));
1285 GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME (frame);
1286 if (fevt->all_headers)
1287 GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME_HEADERS (frame);
1288 fevt->pending = TRUE;
1291 GST_OBJECT_UNLOCK (encoder);
1293 gst_video_codec_frame_ref (frame);
1294 priv->frames = g_list_append (priv->frames, frame);
1296 /* new data, more finish needed */
1297 priv->drained = FALSE;
1299 GST_LOG_OBJECT (encoder, "passing frame pfn %d to subclass",
1300 frame->presentation_frame_number);
1302 ret = klass->handle_frame (encoder, frame);
1305 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1312 GST_ELEMENT_ERROR (encoder, CORE, NEGOTIATION, (NULL),
1313 ("encoder not initialized"));
1314 gst_buffer_unref (buf);
1315 return GST_FLOW_NOT_NEGOTIATED;
1319 static GstStateChangeReturn
1320 gst_video_encoder_change_state (GstElement * element, GstStateChange transition)
1322 GstVideoEncoder *encoder;
1323 GstVideoEncoderClass *encoder_class;
1324 GstStateChangeReturn ret;
1326 encoder = GST_VIDEO_ENCODER (element);
1327 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (element);
1329 switch (transition) {
1330 case GST_STATE_CHANGE_NULL_TO_READY:
1331 /* open device/library if needed */
1332 if (encoder_class->open && !encoder_class->open (encoder))
1335 case GST_STATE_CHANGE_READY_TO_PAUSED:
1336 /* Initialize device/library if needed */
1337 if (encoder_class->start && !encoder_class->start (encoder))
1344 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1346 switch (transition) {
1347 case GST_STATE_CHANGE_PAUSED_TO_READY:
1348 gst_video_encoder_reset (encoder);
1349 if (encoder_class->stop && !encoder_class->stop (encoder))
1352 case GST_STATE_CHANGE_READY_TO_NULL:
1353 /* close device/library if needed */
1354 if (encoder_class->close && !encoder_class->close (encoder))
1367 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1368 ("Failed to open encoder"));
1369 return GST_STATE_CHANGE_FAILURE;
1374 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1375 ("Failed to start encoder"));
1376 return GST_STATE_CHANGE_FAILURE;
1381 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1382 ("Failed to stop encoder"));
1383 return GST_STATE_CHANGE_FAILURE;
1388 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1389 ("Failed to close encoder"));
1390 return GST_STATE_CHANGE_FAILURE;
1395 * gst_video_encoder_negotiate:
1396 * @encoder: a #GstVideoEncoder
1398 * Negotiate with downstream elements to currently configured #GstVideoCodecState.
1400 * Returns: #TRUE if the negotiation succeeded, else #FALSE.
1403 gst_video_encoder_negotiate (GstVideoEncoder * encoder)
1405 GstVideoEncoderClass *klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1406 GstAllocator *allocator;
1407 GstAllocationParams params;
1409 GstVideoCodecState *state = encoder->priv->output_state;
1410 GstVideoInfo *info = &state->info;
1411 GstQuery *query = NULL;
1413 g_return_val_if_fail (state->caps != NULL, FALSE);
1415 if (encoder->priv->output_state_changed) {
1416 state->caps = gst_caps_make_writable (state->caps);
1419 gst_caps_set_simple (state->caps, "width", G_TYPE_INT, info->width,
1420 "height", G_TYPE_INT, info->height,
1421 "pixel-aspect-ratio", GST_TYPE_FRACTION,
1422 info->par_n, info->par_d, NULL);
1423 if (info->flags & GST_VIDEO_FLAG_VARIABLE_FPS && info->fps_n != 0) {
1424 /* variable fps with a max-framerate */
1425 gst_caps_set_simple (state->caps, "framerate", GST_TYPE_FRACTION, 0, 1,
1426 "max-framerate", GST_TYPE_FRACTION, info->fps_n, info->fps_d, NULL);
1428 /* no variable fps or no max-framerate */
1429 gst_caps_set_simple (state->caps, "framerate", GST_TYPE_FRACTION,
1430 info->fps_n, info->fps_d, NULL);
1432 if (state->codec_data)
1433 gst_caps_set_simple (state->caps, "codec_data", GST_TYPE_BUFFER,
1434 state->codec_data, NULL);
1435 encoder->priv->output_state_changed = FALSE;
1438 ret = gst_pad_set_caps (encoder->srcpad, state->caps);
1442 query = gst_query_new_allocation (state->caps, TRUE);
1443 if (!gst_pad_peer_query (encoder->srcpad, query)) {
1444 GST_DEBUG_OBJECT (encoder, "didn't get downstream ALLOCATION hints");
1447 g_assert (klass->decide_allocation != NULL);
1448 ret = klass->decide_allocation (encoder, query);
1450 GST_DEBUG_OBJECT (encoder, "ALLOCATION (%d) params: %" GST_PTR_FORMAT, ret,
1454 goto no_decide_allocation;
1456 /* we got configuration from our peer or the decide_allocation method,
1458 if (gst_query_get_n_allocation_params (query) > 0) {
1459 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
1462 gst_allocation_params_init (¶ms);
1465 if (encoder->priv->allocator)
1466 gst_object_unref (encoder->priv->allocator);
1467 encoder->priv->allocator = allocator;
1468 encoder->priv->params = params;
1472 gst_query_unref (query);
1477 no_decide_allocation:
1479 GST_WARNING_OBJECT (encoder, "Subclass failed to decide allocation");
1485 * gst_video_encoder_allocate_output_buffer:
1486 * @encoder: a #GstVideoEncoder
1487 * @size: size of the buffer
1489 * Helper function that allocates a buffer to hold an encoded video frame
1490 * for @encoder's current #GstVideoCodecState.
1492 * Returns: (transfer full): allocated buffer
1495 gst_video_encoder_allocate_output_buffer (GstVideoEncoder * encoder, gsize size)
1499 g_return_val_if_fail (size > 0, NULL);
1501 GST_DEBUG ("alloc src buffer");
1503 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1504 if (G_UNLIKELY (encoder->priv->output_state_changed
1505 || (encoder->priv->output_state
1506 && gst_pad_check_reconfigure (encoder->srcpad))))
1507 gst_video_encoder_negotiate (encoder);
1510 gst_buffer_new_allocate (encoder->priv->allocator, size,
1511 &encoder->priv->params);
1513 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1519 * gst_video_encoder_allocate_output_frame:
1520 * @encoder: a #GstVideoEncoder
1521 * @frame: a #GstVideoCodecFrame
1522 * @size: size of the buffer
1524 * Helper function that allocates a buffer to hold an encoded video frame for @encoder's
1525 * current #GstVideoCodecState. Subclass should already have configured video
1526 * state and set src pad caps.
1528 * The buffer allocated here is owned by the frame and you should only
1529 * keep references to the frame, not the buffer.
1531 * Returns: %GST_FLOW_OK if an output buffer could be allocated
1534 gst_video_encoder_allocate_output_frame (GstVideoEncoder *
1535 encoder, GstVideoCodecFrame * frame, gsize size)
1537 g_return_val_if_fail (frame->output_buffer == NULL, GST_FLOW_ERROR);
1538 g_return_val_if_fail (size > 0, GST_FLOW_ERROR);
1540 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1541 if (G_UNLIKELY (encoder->priv->output_state_changed
1542 || (encoder->priv->output_state
1543 && gst_pad_check_reconfigure (encoder->srcpad))))
1544 gst_video_encoder_negotiate (encoder);
1546 GST_LOG_OBJECT (encoder, "alloc buffer size %d", size);
1548 frame->output_buffer =
1549 gst_buffer_new_allocate (encoder->priv->allocator, size,
1550 &encoder->priv->params);
1552 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1554 return frame->output_buffer ? GST_FLOW_OK : GST_FLOW_ERROR;
1558 * gst_video_encoder_finish_frame:
1559 * @encoder: a #GstVideoEncoder
1560 * @frame: (transfer full): an encoded #GstVideoCodecFrame
1562 * @frame must have a valid encoded data buffer, whose metadata fields
1563 * are then appropriately set according to frame data or no buffer at
1564 * all if the frame should be dropped.
1565 * It is subsequently pushed downstream or provided to @pre_push.
1566 * In any case, the frame is considered finished and released.
1568 * After calling this function the output buffer of the frame is to be
1569 * considered read-only. This function will also change the metadata
1572 * Returns: a #GstFlowReturn resulting from sending data downstream
1575 gst_video_encoder_finish_frame (GstVideoEncoder * encoder,
1576 GstVideoCodecFrame * frame)
1578 GstVideoEncoderPrivate *priv = encoder->priv;
1579 GstFlowReturn ret = GST_FLOW_OK;
1580 GstVideoEncoderClass *encoder_class;
1582 gboolean send_headers = FALSE;
1583 gboolean discont = (frame->presentation_frame_number == 0);
1585 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1587 GST_LOG_OBJECT (encoder,
1588 "finish frame fpn %d", frame->presentation_frame_number);
1590 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1592 if (G_UNLIKELY (priv->output_state_changed || (priv->output_state
1593 && gst_pad_check_reconfigure (encoder->srcpad))))
1594 gst_video_encoder_negotiate (encoder);
1597 if (G_UNLIKELY (priv->output_state == NULL))
1598 goto no_output_state;
1600 /* Push all pending events that arrived before this frame */
1601 for (l = priv->frames; l; l = l->next) {
1602 GstVideoCodecFrame *tmp = l->data;
1607 for (k = g_list_last (tmp->events); k; k = k->prev)
1608 gst_video_encoder_push_event (encoder, k->data);
1609 g_list_free (tmp->events);
1617 /* no buffer data means this frame is skipped/dropped */
1618 if (!frame->output_buffer) {
1619 GST_DEBUG_OBJECT (encoder, "skipping frame %" GST_TIME_FORMAT,
1620 GST_TIME_ARGS (frame->pts));
1624 if (GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT (frame) && priv->force_key_unit) {
1625 GstClockTime stream_time, running_time;
1627 ForcedKeyUnitEvent *fevt = NULL;
1631 gst_segment_to_running_time (&encoder->output_segment, GST_FORMAT_TIME,
1634 GST_OBJECT_LOCK (encoder);
1635 for (l = priv->force_key_unit; l; l = l->next) {
1636 ForcedKeyUnitEvent *tmp = l->data;
1638 /* Skip non-pending keyunits */
1642 /* Simple case, keyunit ASAP */
1643 if (tmp->running_time == GST_CLOCK_TIME_NONE) {
1648 /* Event for before this frame */
1649 if (tmp->running_time <= running_time) {
1656 priv->force_key_unit = g_list_remove (priv->force_key_unit, fevt);
1658 GST_OBJECT_UNLOCK (encoder);
1662 gst_segment_to_stream_time (&encoder->output_segment, GST_FORMAT_TIME,
1665 ev = gst_video_event_new_downstream_force_key_unit
1666 (frame->pts, stream_time, running_time,
1667 fevt->all_headers, fevt->count);
1669 gst_video_encoder_push_event (encoder, ev);
1671 if (fevt->all_headers)
1672 send_headers = TRUE;
1674 GST_DEBUG_OBJECT (encoder,
1675 "Forced key unit: running-time %" GST_TIME_FORMAT
1676 ", all_headers %d, count %u",
1677 GST_TIME_ARGS (running_time), fevt->all_headers, fevt->count);
1678 forced_key_unit_event_free (fevt);
1682 if (GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT (frame)) {
1683 priv->distance_from_sync = 0;
1684 GST_BUFFER_FLAG_UNSET (frame->output_buffer, GST_BUFFER_FLAG_DELTA_UNIT);
1685 /* For keyframes, DTS = PTS */
1686 frame->dts = frame->pts;
1688 GST_BUFFER_FLAG_SET (frame->output_buffer, GST_BUFFER_FLAG_DELTA_UNIT);
1691 frame->distance_from_sync = priv->distance_from_sync;
1692 priv->distance_from_sync++;
1694 GST_BUFFER_PTS (frame->output_buffer) = frame->pts;
1695 GST_BUFFER_DTS (frame->output_buffer) = frame->dts;
1696 GST_BUFFER_DURATION (frame->output_buffer) = frame->duration;
1698 /* update rate estimate */
1699 priv->bytes += gst_buffer_get_size (frame->output_buffer);
1700 if (GST_CLOCK_TIME_IS_VALID (frame->duration)) {
1701 priv->time += frame->duration;
1703 /* better none than nothing valid */
1704 priv->time = GST_CLOCK_TIME_NONE;
1707 if (G_UNLIKELY (send_headers || priv->new_headers)) {
1708 GList *tmp, *copy = NULL;
1710 GST_DEBUG_OBJECT (encoder, "Sending headers");
1712 /* First make all buffers metadata-writable */
1713 for (tmp = priv->headers; tmp; tmp = tmp->next) {
1714 GstBuffer *tmpbuf = GST_BUFFER (tmp->data);
1716 copy = g_list_append (copy, gst_buffer_make_writable (tmpbuf));
1718 g_list_free (priv->headers);
1719 priv->headers = copy;
1721 for (tmp = priv->headers; tmp; tmp = tmp->next) {
1722 GstBuffer *tmpbuf = GST_BUFFER (tmp->data);
1724 gst_buffer_ref (tmpbuf);
1725 priv->bytes += gst_buffer_get_size (tmpbuf);
1726 if (G_UNLIKELY (discont)) {
1727 GST_LOG_OBJECT (encoder, "marking discont");
1728 GST_BUFFER_FLAG_SET (tmpbuf, GST_BUFFER_FLAG_DISCONT);
1732 gst_pad_push (encoder->srcpad, tmpbuf);
1734 priv->new_headers = FALSE;
1737 if (G_UNLIKELY (discont)) {
1738 GST_LOG_OBJECT (encoder, "marking discont");
1739 GST_BUFFER_FLAG_SET (frame->output_buffer, GST_BUFFER_FLAG_DISCONT);
1742 if (encoder_class->pre_push)
1743 ret = encoder_class->pre_push (encoder, frame);
1745 /* A reference always needs to be owned by the frame on the buffer.
1746 * For that reason, we use a complete sub-buffer (zero-cost) to push
1748 * The original buffer will be free-ed only when downstream AND the
1749 * current implementation are done with the frame. */
1750 if (ret == GST_FLOW_OK)
1751 ret = gst_pad_push (encoder->srcpad, gst_buffer_ref (frame->output_buffer));
1756 /* unref once from the list */
1757 l = g_list_find (priv->frames, frame);
1759 gst_video_codec_frame_unref (frame);
1760 priv->frames = g_list_delete_link (priv->frames, l);
1762 /* unref because this function takes ownership */
1763 gst_video_codec_frame_unref (frame);
1765 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1772 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1773 GST_ERROR_OBJECT (encoder, "Output state was not configured");
1774 return GST_FLOW_ERROR;
1779 * gst_video_encoder_get_output_state:
1780 * @encoder: a #GstVideoEncoder
1782 * Get the current #GstVideoCodecState
1784 * Returns: (transfer full): #GstVideoCodecState describing format of video data.
1786 GstVideoCodecState *
1787 gst_video_encoder_get_output_state (GstVideoEncoder * encoder)
1789 GstVideoCodecState *state;
1791 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1792 state = gst_video_codec_state_ref (encoder->priv->output_state);
1793 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1799 * gst_video_encoder_set_output_state:
1800 * @encoder: a #GstVideoEncoder
1801 * @caps: (transfer full): the #GstCaps to use for the output
1802 * @reference: (allow-none) (transfer none): An optional reference @GstVideoCodecState
1804 * Creates a new #GstVideoCodecState with the specified caps as the output state
1806 * Any previously set output state on @decoder will be replaced by the newly
1809 * The specified @caps should not contain any resolution, pixel-aspect-ratio,
1810 * framerate, codec-data, .... Those should be specified instead in the returned
1811 * #GstVideoCodecState.
1813 * If the subclass wishes to copy over existing fields (like pixel aspect ratio,
1814 * or framerate) from an existing #GstVideoCodecState, it can be provided as a
1817 * If the subclass wishes to override some fields from the output state (like
1818 * pixel-aspect-ratio or framerate) it can do so on the returned #GstVideoCodecState.
1820 * The new output state will only take effect (set on pads and buffers) starting
1821 * from the next call to #gst_video_encoder_finish_frame().
1823 * Returns: (transfer full): the newly configured output state.
1825 GstVideoCodecState *
1826 gst_video_encoder_set_output_state (GstVideoEncoder * encoder, GstCaps * caps,
1827 GstVideoCodecState * reference)
1829 GstVideoEncoderPrivate *priv = encoder->priv;
1830 GstVideoCodecState *state;
1832 g_return_val_if_fail (caps != NULL, NULL);
1834 state = _new_output_state (caps, reference);
1836 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1837 if (priv->output_state)
1838 gst_video_codec_state_unref (priv->output_state);
1839 priv->output_state = gst_video_codec_state_ref (state);
1841 priv->output_state_changed = TRUE;
1842 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1848 * gst_video_encoder_set_latency:
1849 * @encoder: a #GstVideoEncoder
1850 * @min_latency: minimum latency
1851 * @max_latency: maximum latency
1853 * Informs baseclass of encoding latency.
1856 gst_video_encoder_set_latency (GstVideoEncoder * encoder,
1857 GstClockTime min_latency, GstClockTime max_latency)
1859 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
1860 g_return_if_fail (max_latency >= min_latency);
1862 GST_OBJECT_LOCK (encoder);
1863 encoder->priv->min_latency = min_latency;
1864 encoder->priv->max_latency = max_latency;
1865 GST_OBJECT_UNLOCK (encoder);
1867 gst_element_post_message (GST_ELEMENT_CAST (encoder),
1868 gst_message_new_latency (GST_OBJECT_CAST (encoder)));
1872 * gst_video_encoder_get_latency:
1873 * @encoder: a #GstVideoEncoder
1874 * @min_latency: (out) (allow-none): address of variable in which to store the
1875 * configured minimum latency, or %NULL
1876 * @max_latency: (out) (allow-none): address of variable in which to store the
1877 * configured maximum latency, or %NULL
1879 * Query the configured encoding latency. Results will be returned via
1880 * @min_latency and @max_latency.
1883 gst_video_encoder_get_latency (GstVideoEncoder * encoder,
1884 GstClockTime * min_latency, GstClockTime * max_latency)
1886 GST_OBJECT_LOCK (encoder);
1888 *min_latency = encoder->priv->min_latency;
1890 *max_latency = encoder->priv->max_latency;
1891 GST_OBJECT_UNLOCK (encoder);
1895 * gst_video_encoder_get_oldest_frame:
1896 * @encoder: a #GstVideoEncoder
1898 * Get the oldest unfinished pending #GstVideoCodecFrame
1900 * Returns: (transfer full): oldest unfinished pending #GstVideoCodecFrame
1902 GstVideoCodecFrame *
1903 gst_video_encoder_get_oldest_frame (GstVideoEncoder * encoder)
1905 GstVideoCodecFrame *frame = NULL;
1907 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1908 if (encoder->priv->frames)
1909 frame = gst_video_codec_frame_ref (encoder->priv->frames->data);
1910 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1912 return (GstVideoCodecFrame *) frame;
1916 * gst_video_encoder_get_frame:
1917 * @encoder: a #GstVideoEnccoder
1918 * @frame_number: system_frame_number of a frame
1920 * Get a pending unfinished #GstVideoCodecFrame
1922 * Returns: (transfer full): pending unfinished #GstVideoCodecFrame identified by @frame_number.
1924 GstVideoCodecFrame *
1925 gst_video_encoder_get_frame (GstVideoEncoder * encoder, int frame_number)
1928 GstVideoCodecFrame *frame = NULL;
1930 GST_DEBUG_OBJECT (encoder, "frame_number : %d", frame_number);
1932 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1933 for (g = encoder->priv->frames; g; g = g->next) {
1934 GstVideoCodecFrame *tmp = g->data;
1936 if (tmp->system_frame_number == frame_number) {
1937 frame = gst_video_codec_frame_ref (tmp);
1941 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);