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., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, 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 * * Calculate actual latency based on input/output timestamp/frame_number
114 * and if it exceeds the recorded one, save it and emit a GST_MESSAGE_LATENCY
117 #include <gst/video/video.h>
118 #include "gstvideoencoder.h"
119 #include "gstvideoutils.h"
121 #include <gst/video/gstvideometa.h>
122 #include <gst/video/gstvideopool.h>
126 GST_DEBUG_CATEGORY (videoencoder_debug);
127 #define GST_CAT_DEFAULT videoencoder_debug
129 #define GST_VIDEO_ENCODER_GET_PRIVATE(obj) \
130 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_VIDEO_ENCODER, \
131 GstVideoEncoderPrivate))
133 struct _GstVideoEncoderPrivate
135 guint64 presentation_frame_number;
136 int distance_from_sync;
138 /* FIXME : (and introduce a context ?) */
146 GList *current_frame_events;
149 gboolean new_headers; /* Whether new headers were just set */
151 GList *force_key_unit; /* List of pending forced keyunits */
153 guint32 system_frame_number;
155 GList *frames; /* Protected with OBJECT_LOCK */
156 GstVideoCodecState *input_state;
157 GstVideoCodecState *output_state;
158 gboolean output_state_changed;
163 GstAllocator *allocator;
164 GstAllocationParams params;
167 gboolean tags_changed;
170 typedef struct _ForcedKeyUnitEvent ForcedKeyUnitEvent;
171 struct _ForcedKeyUnitEvent
173 GstClockTime running_time;
174 gboolean pending; /* TRUE if this was requested already */
175 gboolean all_headers;
180 forced_key_unit_event_free (ForcedKeyUnitEvent * evt)
182 g_slice_free (ForcedKeyUnitEvent, evt);
185 static ForcedKeyUnitEvent *
186 forced_key_unit_event_new (GstClockTime running_time, gboolean all_headers,
189 ForcedKeyUnitEvent *evt = g_slice_new0 (ForcedKeyUnitEvent);
191 evt->running_time = running_time;
192 evt->all_headers = all_headers;
198 static GstElementClass *parent_class = NULL;
199 static void gst_video_encoder_class_init (GstVideoEncoderClass * klass);
200 static void gst_video_encoder_init (GstVideoEncoder * enc,
201 GstVideoEncoderClass * klass);
203 static void gst_video_encoder_finalize (GObject * object);
205 static gboolean gst_video_encoder_setcaps (GstVideoEncoder * enc,
207 static GstCaps *gst_video_encoder_sink_getcaps (GstVideoEncoder * encoder,
209 static gboolean gst_video_encoder_src_event (GstPad * pad, GstObject * parent,
211 static gboolean gst_video_encoder_sink_event (GstPad * pad, GstObject * parent,
213 static GstFlowReturn gst_video_encoder_chain (GstPad * pad, GstObject * parent,
215 static GstStateChangeReturn gst_video_encoder_change_state (GstElement *
216 element, GstStateChange transition);
217 static gboolean gst_video_encoder_sink_query (GstPad * pad, GstObject * parent,
219 static gboolean gst_video_encoder_src_query (GstPad * pad, GstObject * parent,
221 static GstVideoCodecFrame *gst_video_encoder_new_frame (GstVideoEncoder *
222 encoder, GstBuffer * buf, GstClockTime pts, GstClockTime dts,
223 GstClockTime duration);
225 static gboolean gst_video_encoder_sink_event_default (GstVideoEncoder * encoder,
227 static gboolean gst_video_encoder_src_event_default (GstVideoEncoder * encoder,
229 static gboolean gst_video_encoder_decide_allocation_default (GstVideoEncoder *
230 encoder, GstQuery * query);
231 static gboolean gst_video_encoder_propose_allocation_default (GstVideoEncoder *
232 encoder, GstQuery * query);
233 static gboolean gst_video_encoder_negotiate_default (GstVideoEncoder * encoder);
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;
295 klass->negotiate = gst_video_encoder_negotiate_default;
299 gst_video_encoder_reset (GstVideoEncoder * encoder)
301 GstVideoEncoderPrivate *priv = encoder->priv;
304 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
306 priv->presentation_frame_number = 0;
307 priv->distance_from_sync = 0;
309 g_list_foreach (priv->force_key_unit, (GFunc) forced_key_unit_event_free,
311 g_list_free (priv->force_key_unit);
312 priv->force_key_unit = NULL;
314 priv->drained = TRUE;
315 priv->min_latency = 0;
316 priv->max_latency = 0;
318 g_list_foreach (priv->headers, (GFunc) gst_event_unref, NULL);
319 g_list_free (priv->headers);
320 priv->headers = NULL;
321 priv->new_headers = FALSE;
323 g_list_foreach (priv->current_frame_events, (GFunc) gst_event_unref, NULL);
324 g_list_free (priv->current_frame_events);
325 priv->current_frame_events = NULL;
327 for (g = priv->frames; g; g = g->next) {
328 gst_video_codec_frame_unref ((GstVideoCodecFrame *) g->data);
330 g_list_free (priv->frames);
336 if (priv->input_state)
337 gst_video_codec_state_unref (priv->input_state);
338 priv->input_state = NULL;
339 if (priv->output_state)
340 gst_video_codec_state_unref (priv->output_state);
341 priv->output_state = NULL;
344 gst_tag_list_unref (priv->tags);
346 priv->tags_changed = FALSE;
348 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
352 gst_video_encoder_init (GstVideoEncoder * encoder, GstVideoEncoderClass * klass)
354 GstVideoEncoderPrivate *priv;
355 GstPadTemplate *pad_template;
358 GST_DEBUG_OBJECT (encoder, "gst_video_encoder_init");
360 priv = encoder->priv = GST_VIDEO_ENCODER_GET_PRIVATE (encoder);
363 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "sink");
364 g_return_if_fail (pad_template != NULL);
366 encoder->sinkpad = pad = gst_pad_new_from_template (pad_template, "sink");
368 gst_pad_set_chain_function (pad, GST_DEBUG_FUNCPTR (gst_video_encoder_chain));
369 gst_pad_set_event_function (pad,
370 GST_DEBUG_FUNCPTR (gst_video_encoder_sink_event));
371 gst_pad_set_query_function (pad,
372 GST_DEBUG_FUNCPTR (gst_video_encoder_sink_query));
373 gst_element_add_pad (GST_ELEMENT (encoder), encoder->sinkpad);
376 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
377 g_return_if_fail (pad_template != NULL);
379 encoder->srcpad = pad = gst_pad_new_from_template (pad_template, "src");
381 gst_pad_set_query_function (pad,
382 GST_DEBUG_FUNCPTR (gst_video_encoder_src_query));
383 gst_pad_set_event_function (pad,
384 GST_DEBUG_FUNCPTR (gst_video_encoder_src_event));
385 gst_element_add_pad (GST_ELEMENT (encoder), encoder->srcpad);
387 gst_segment_init (&encoder->input_segment, GST_FORMAT_TIME);
388 gst_segment_init (&encoder->output_segment, GST_FORMAT_TIME);
390 g_rec_mutex_init (&encoder->stream_lock);
392 priv->at_eos = FALSE;
393 priv->headers = NULL;
394 priv->new_headers = FALSE;
396 gst_video_encoder_reset (encoder);
400 gst_video_encoded_video_convert (gint64 bytes, gint64 time,
401 GstFormat src_format, gint64 src_value, GstFormat * dest_format,
404 gboolean res = FALSE;
406 g_return_val_if_fail (dest_format != NULL, FALSE);
407 g_return_val_if_fail (dest_value != NULL, FALSE);
409 if (G_UNLIKELY (src_format == *dest_format || src_value == 0 ||
412 *dest_value = src_value;
416 if (bytes <= 0 || time <= 0) {
417 GST_DEBUG ("not enough metadata yet to convert");
421 switch (src_format) {
422 case GST_FORMAT_BYTES:
423 switch (*dest_format) {
424 case GST_FORMAT_TIME:
425 *dest_value = gst_util_uint64_scale (src_value, time, bytes);
432 case GST_FORMAT_TIME:
433 switch (*dest_format) {
434 case GST_FORMAT_BYTES:
435 *dest_value = gst_util_uint64_scale (src_value, bytes, time);
443 GST_DEBUG ("unhandled conversion from %d to %d", src_format,
453 * gst_video_encoder_set_headers:
454 * @encoder: a #GstVideoEncoder
455 * @headers: (transfer full) (element-type GstBuffer): a list of #GstBuffer containing the codec header
457 * Set the codec headers to be sent downstream whenever requested.
460 gst_video_encoder_set_headers (GstVideoEncoder * video_encoder, GList * headers)
462 GST_VIDEO_ENCODER_STREAM_LOCK (video_encoder);
464 GST_DEBUG_OBJECT (video_encoder, "new headers %p", headers);
465 if (video_encoder->priv->headers) {
466 g_list_foreach (video_encoder->priv->headers, (GFunc) gst_buffer_unref,
468 g_list_free (video_encoder->priv->headers);
470 video_encoder->priv->headers = headers;
471 video_encoder->priv->new_headers = TRUE;
473 GST_VIDEO_ENCODER_STREAM_UNLOCK (video_encoder);
477 gst_video_encoder_drain (GstVideoEncoder * enc)
479 GstVideoEncoderPrivate *priv;
480 GstVideoEncoderClass *enc_class;
483 enc_class = GST_VIDEO_ENCODER_GET_CLASS (enc);
486 GST_DEBUG_OBJECT (enc, "draining");
489 GST_DEBUG_OBJECT (enc, "already drained");
493 if (enc_class->reset) {
494 GST_DEBUG_OBJECT (enc, "requesting subclass to finish");
495 ret = enc_class->reset (enc, TRUE);
497 /* everything should be away now */
499 /* not fatal/impossible though if subclass/enc eats stuff */
500 g_list_foreach (priv->frames, (GFunc) gst_video_codec_frame_unref, NULL);
501 g_list_free (priv->frames);
508 static GstVideoCodecState *
509 _new_output_state (GstCaps * caps, GstVideoCodecState * reference)
511 GstVideoCodecState *state;
513 state = g_slice_new0 (GstVideoCodecState);
514 state->ref_count = 1;
515 gst_video_info_init (&state->info);
516 gst_video_info_set_format (&state->info, GST_VIDEO_FORMAT_ENCODED, 0, 0);
521 GstVideoInfo *tgt, *ref;
524 ref = &reference->info;
526 /* Copy over extra fields from reference state */
527 tgt->interlace_mode = ref->interlace_mode;
528 tgt->flags = ref->flags;
529 tgt->width = ref->width;
530 tgt->height = ref->height;
531 tgt->chroma_site = ref->chroma_site;
532 tgt->colorimetry = ref->colorimetry;
533 tgt->par_n = ref->par_n;
534 tgt->par_d = ref->par_d;
535 tgt->fps_n = ref->fps_n;
536 tgt->fps_d = ref->fps_d;
542 static GstVideoCodecState *
543 _new_input_state (GstCaps * caps)
545 GstVideoCodecState *state;
547 state = g_slice_new0 (GstVideoCodecState);
548 state->ref_count = 1;
549 gst_video_info_init (&state->info);
550 if (G_UNLIKELY (!gst_video_info_from_caps (&state->info, caps)))
552 state->caps = gst_caps_ref (caps);
558 g_slice_free (GstVideoCodecState, state);
564 gst_video_encoder_setcaps (GstVideoEncoder * encoder, GstCaps * caps)
566 GstVideoEncoderClass *encoder_class;
567 GstVideoCodecState *state;
570 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (encoder);
572 /* subclass should do something here ... */
573 g_return_val_if_fail (encoder_class->set_format != NULL, FALSE);
575 GST_DEBUG_OBJECT (encoder, "setcaps %" GST_PTR_FORMAT, caps);
577 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
579 if (encoder->priv->input_state) {
580 GST_DEBUG_OBJECT (encoder,
581 "Checking if caps changed old %" GST_PTR_FORMAT " new %" GST_PTR_FORMAT,
582 encoder->priv->input_state->caps, caps);
583 if (gst_caps_is_equal (encoder->priv->input_state->caps, caps))
584 goto caps_not_changed;
587 state = _new_input_state (caps);
588 if (G_UNLIKELY (!state))
591 if (encoder->priv->input_state
592 && gst_video_info_is_equal (&state->info,
593 &encoder->priv->input_state->info)) {
594 gst_video_codec_state_unref (state);
595 goto caps_not_changed;
598 /* arrange draining pending frames */
599 gst_video_encoder_drain (encoder);
601 /* and subclass should be ready to configure format at any time around */
602 ret = encoder_class->set_format (encoder, state);
604 if (encoder->priv->input_state)
605 gst_video_codec_state_unref (encoder->priv->input_state);
606 encoder->priv->input_state = state;
608 gst_video_codec_state_unref (state);
611 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
614 GST_WARNING_OBJECT (encoder, "rejected caps %" GST_PTR_FORMAT, caps);
620 GST_DEBUG_OBJECT (encoder, "Caps did not change - ignore");
621 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
628 GST_WARNING_OBJECT (encoder, "Failed to parse caps");
629 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
635 * gst_video_encoder_proxy_getcaps:
636 * @enc: a #GstVideoEncoder
637 * @caps: initial caps
638 * @filter: filter caps
640 * Returns caps that express @caps (or sink template caps if @caps == NULL)
641 * restricted to resolution/format/... combinations supported by downstream
642 * elements (e.g. muxers).
644 * Returns: a #GstCaps owned by caller
647 gst_video_encoder_proxy_getcaps (GstVideoEncoder * encoder, GstCaps * caps,
652 GstCaps *fcaps, *filter_caps;
655 /* Allow downstream to specify width/height/framerate/PAR constraints
656 * and forward them upstream for video converters to handle
659 caps ? gst_caps_ref (caps) :
660 gst_pad_get_pad_template_caps (encoder->sinkpad);
661 allowed = gst_pad_get_allowed_caps (encoder->srcpad);
663 if (!allowed || gst_caps_is_empty (allowed) || gst_caps_is_any (allowed)) {
668 GST_LOG_OBJECT (encoder, "template caps %" GST_PTR_FORMAT, templ_caps);
669 GST_LOG_OBJECT (encoder, "allowed caps %" GST_PTR_FORMAT, allowed);
671 filter_caps = gst_caps_new_empty ();
673 for (i = 0; i < gst_caps_get_size (templ_caps); i++) {
675 gst_structure_get_name_id (gst_caps_get_structure (templ_caps, i));
677 for (j = 0; j < gst_caps_get_size (allowed); j++) {
678 const GstStructure *allowed_s = gst_caps_get_structure (allowed, j);
682 s = gst_structure_new_id_empty (q_name);
683 if ((val = gst_structure_get_value (allowed_s, "width")))
684 gst_structure_set_value (s, "width", val);
685 if ((val = gst_structure_get_value (allowed_s, "height")))
686 gst_structure_set_value (s, "height", val);
687 if ((val = gst_structure_get_value (allowed_s, "framerate")))
688 gst_structure_set_value (s, "framerate", val);
689 if ((val = gst_structure_get_value (allowed_s, "pixel-aspect-ratio")))
690 gst_structure_set_value (s, "pixel-aspect-ratio", val);
692 filter_caps = gst_caps_merge_structure (filter_caps, s);
696 fcaps = gst_caps_intersect (filter_caps, templ_caps);
697 gst_caps_unref (filter_caps);
698 gst_caps_unref (templ_caps);
701 GST_LOG_OBJECT (encoder, "intersecting with %" GST_PTR_FORMAT, filter);
702 filter_caps = gst_caps_intersect (fcaps, filter);
703 gst_caps_unref (fcaps);
708 gst_caps_replace (&allowed, NULL);
710 GST_LOG_OBJECT (encoder, "proxy caps %" GST_PTR_FORMAT, fcaps);
716 gst_video_encoder_sink_getcaps (GstVideoEncoder * encoder, GstCaps * filter)
718 GstVideoEncoderClass *klass;
721 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
724 caps = klass->getcaps (encoder, filter);
726 caps = gst_video_encoder_proxy_getcaps (encoder, NULL, filter);
728 GST_LOG_OBJECT (encoder, "Returning caps %" GST_PTR_FORMAT, caps);
734 gst_video_encoder_decide_allocation_default (GstVideoEncoder * encoder,
737 GstAllocator *allocator = NULL;
738 GstAllocationParams params;
739 gboolean update_allocator;
741 /* we got configuration from our peer or the decide_allocation method,
743 if (gst_query_get_n_allocation_params (query) > 0) {
744 /* try the allocator */
745 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
746 update_allocator = TRUE;
749 gst_allocation_params_init (¶ms);
750 update_allocator = FALSE;
753 if (update_allocator)
754 gst_query_set_nth_allocation_param (query, 0, allocator, ¶ms);
756 gst_query_add_allocation_param (query, allocator, ¶ms);
758 gst_object_unref (allocator);
764 gst_video_encoder_propose_allocation_default (GstVideoEncoder * encoder,
772 gst_query_parse_allocation (query, &caps, NULL);
777 if (!gst_video_info_from_caps (&info, caps))
780 size = GST_VIDEO_INFO_SIZE (&info);
782 if (gst_query_get_n_allocation_pools (query) == 0) {
783 GstStructure *structure;
784 GstAllocator *allocator = NULL;
785 GstAllocationParams params = { 0, 15, 0, 0 };
787 if (gst_query_get_n_allocation_params (query) > 0)
788 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
790 gst_query_add_allocation_param (query, allocator, ¶ms);
792 pool = gst_video_buffer_pool_new ();
794 structure = gst_buffer_pool_get_config (pool);
795 gst_buffer_pool_config_set_params (structure, caps, size, 0, 0);
796 gst_buffer_pool_config_set_allocator (structure, allocator, ¶ms);
799 gst_object_unref (allocator);
801 if (!gst_buffer_pool_set_config (pool, structure))
804 gst_query_add_allocation_pool (query, pool, size, 0, 0);
805 gst_object_unref (pool);
806 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL);
814 GST_ERROR_OBJECT (encoder, "failed to set config");
815 gst_object_unref (pool);
821 gst_video_encoder_sink_query (GstPad * pad, GstObject * parent,
824 GstVideoEncoder *encoder;
825 gboolean res = FALSE;
827 encoder = GST_VIDEO_ENCODER (parent);
829 switch (GST_QUERY_TYPE (query)) {
832 GstCaps *filter, *caps;
834 gst_query_parse_caps (query, &filter);
835 caps = gst_video_encoder_sink_getcaps (encoder, filter);
836 gst_query_set_caps_result (query, caps);
837 gst_caps_unref (caps);
841 case GST_QUERY_ALLOCATION:
843 GstVideoEncoderClass *klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
845 if (klass->propose_allocation)
846 res = klass->propose_allocation (encoder, query);
850 res = gst_pad_query_default (pad, parent, query);
857 gst_video_encoder_finalize (GObject * object)
859 GstVideoEncoder *encoder;
861 GST_DEBUG_OBJECT (object, "finalize");
863 encoder = GST_VIDEO_ENCODER (object);
864 if (encoder->priv->headers) {
865 g_list_foreach (encoder->priv->headers, (GFunc) gst_buffer_unref, NULL);
866 g_list_free (encoder->priv->headers);
868 g_rec_mutex_clear (&encoder->stream_lock);
870 if (encoder->priv->allocator) {
871 gst_object_unref (encoder->priv->allocator);
872 encoder->priv->allocator = NULL;
875 G_OBJECT_CLASS (parent_class)->finalize (object);
879 gst_video_encoder_push_event (GstVideoEncoder * encoder, GstEvent * event)
881 switch (GST_EVENT_TYPE (event)) {
882 case GST_EVENT_SEGMENT:
886 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
888 gst_event_copy_segment (event, &segment);
890 GST_DEBUG_OBJECT (encoder, "segment %" GST_SEGMENT_FORMAT, &segment);
892 if (segment.format != GST_FORMAT_TIME) {
893 GST_DEBUG_OBJECT (encoder, "received non TIME segment");
894 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
898 encoder->output_segment = segment;
899 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
906 return gst_pad_push_event (encoder->srcpad, event);
910 gst_video_encoder_sink_event_default (GstVideoEncoder * encoder,
913 GstVideoEncoderClass *encoder_class;
914 gboolean ret = FALSE;
916 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (encoder);
918 switch (GST_EVENT_TYPE (event)) {
923 gst_event_parse_caps (event, &caps);
925 encoder->priv->do_caps = TRUE;
926 gst_event_unref (event);
932 GstFlowReturn flow_ret;
934 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
935 encoder->priv->at_eos = TRUE;
937 if (encoder_class->finish) {
938 flow_ret = encoder_class->finish (encoder);
940 flow_ret = GST_FLOW_OK;
943 ret = (flow_ret == GST_FLOW_OK);
944 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
947 case GST_EVENT_SEGMENT:
951 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
953 gst_event_copy_segment (event, &segment);
955 GST_DEBUG_OBJECT (encoder, "segment %" GST_SEGMENT_FORMAT, &segment);
957 if (segment.format != GST_FORMAT_TIME) {
958 GST_DEBUG_OBJECT (encoder, "received non TIME newsegment");
959 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
963 encoder->priv->at_eos = FALSE;
965 encoder->input_segment = segment;
967 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
970 case GST_EVENT_CUSTOM_DOWNSTREAM:
972 if (gst_video_event_is_force_key_unit (event)) {
973 GstClockTime running_time;
974 gboolean all_headers;
977 if (gst_video_event_parse_downstream_force_key_unit (event,
978 NULL, NULL, &running_time, &all_headers, &count)) {
979 ForcedKeyUnitEvent *fevt;
981 GST_OBJECT_LOCK (encoder);
982 fevt = forced_key_unit_event_new (running_time, all_headers, count);
983 encoder->priv->force_key_unit =
984 g_list_append (encoder->priv->force_key_unit, fevt);
985 GST_OBJECT_UNLOCK (encoder);
987 GST_DEBUG_OBJECT (encoder,
988 "force-key-unit event: running-time %" GST_TIME_FORMAT
989 ", all_headers %d, count %u",
990 GST_TIME_ARGS (running_time), all_headers, count);
992 gst_event_unref (event);
1002 gst_event_parse_tag (event, &tags);
1004 if (gst_tag_list_get_scope (tags) == GST_TAG_SCOPE_STREAM) {
1005 tags = gst_tag_list_copy (tags);
1007 /* FIXME: make generic based on GST_TAG_FLAG_ENCODED */
1008 gst_tag_list_remove_tag (tags, GST_TAG_CODEC);
1009 gst_tag_list_remove_tag (tags, GST_TAG_AUDIO_CODEC);
1010 gst_tag_list_remove_tag (tags, GST_TAG_VIDEO_CODEC);
1011 gst_tag_list_remove_tag (tags, GST_TAG_SUBTITLE_CODEC);
1012 gst_tag_list_remove_tag (tags, GST_TAG_CONTAINER_FORMAT);
1013 gst_tag_list_remove_tag (tags, GST_TAG_BITRATE);
1014 gst_tag_list_remove_tag (tags, GST_TAG_NOMINAL_BITRATE);
1015 gst_tag_list_remove_tag (tags, GST_TAG_MAXIMUM_BITRATE);
1016 gst_tag_list_remove_tag (tags, GST_TAG_MINIMUM_BITRATE);
1017 gst_tag_list_remove_tag (tags, GST_TAG_ENCODER);
1018 gst_tag_list_remove_tag (tags, GST_TAG_ENCODER_VERSION);
1020 gst_video_encoder_merge_tags (encoder, tags, GST_TAG_MERGE_REPLACE);
1021 gst_tag_list_unref (tags);
1022 gst_event_unref (event);
1032 /* Forward non-serialized events and EOS/FLUSH_STOP immediately.
1033 * For EOS this is required because no buffer or serialized event
1034 * will come after EOS and nothing could trigger another
1035 * _finish_frame() call. *
1036 * If the subclass handles sending of EOS manually it can simply
1037 * not chain up to the parent class' event handler
1039 * For FLUSH_STOP this is required because it is expected
1040 * to be forwarded immediately and no buffers are queued anyway.
1043 if (!GST_EVENT_IS_SERIALIZED (event)
1044 || GST_EVENT_TYPE (event) == GST_EVENT_EOS
1045 || GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP) {
1046 ret = gst_video_encoder_push_event (encoder, event);
1048 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1049 encoder->priv->current_frame_events =
1050 g_list_prepend (encoder->priv->current_frame_events, event);
1051 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1060 gst_video_encoder_sink_event (GstPad * pad, GstObject * parent,
1063 GstVideoEncoder *enc;
1064 GstVideoEncoderClass *klass;
1065 gboolean ret = TRUE;
1067 enc = GST_VIDEO_ENCODER (parent);
1068 klass = GST_VIDEO_ENCODER_GET_CLASS (enc);
1070 GST_DEBUG_OBJECT (enc, "received event %d, %s", GST_EVENT_TYPE (event),
1071 GST_EVENT_TYPE_NAME (event));
1073 if (klass->sink_event)
1074 ret = klass->sink_event (enc, event);
1080 gst_video_encoder_src_event_default (GstVideoEncoder * encoder,
1083 gboolean ret = FALSE;
1085 switch (GST_EVENT_TYPE (event)) {
1086 case GST_EVENT_CUSTOM_UPSTREAM:
1088 if (gst_video_event_is_force_key_unit (event)) {
1089 GstClockTime running_time;
1090 gboolean all_headers;
1093 if (gst_video_event_parse_upstream_force_key_unit (event,
1094 &running_time, &all_headers, &count)) {
1095 ForcedKeyUnitEvent *fevt;
1097 GST_OBJECT_LOCK (encoder);
1098 fevt = forced_key_unit_event_new (running_time, all_headers, count);
1099 encoder->priv->force_key_unit =
1100 g_list_append (encoder->priv->force_key_unit, fevt);
1101 GST_OBJECT_UNLOCK (encoder);
1103 GST_DEBUG_OBJECT (encoder,
1104 "force-key-unit event: running-time %" GST_TIME_FORMAT
1105 ", all_headers %d, count %u",
1106 GST_TIME_ARGS (running_time), all_headers, count);
1108 gst_event_unref (event);
1120 gst_pad_event_default (encoder->srcpad, GST_OBJECT_CAST (encoder),
1127 gst_video_encoder_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
1129 GstVideoEncoder *encoder;
1130 GstVideoEncoderClass *klass;
1131 gboolean ret = FALSE;
1133 encoder = GST_VIDEO_ENCODER (parent);
1134 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1136 GST_LOG_OBJECT (encoder, "handling event: %" GST_PTR_FORMAT, event);
1138 if (klass->src_event)
1139 ret = klass->src_event (encoder, event);
1145 gst_video_encoder_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
1147 GstVideoEncoderPrivate *priv;
1148 GstVideoEncoder *enc;
1151 enc = GST_VIDEO_ENCODER (parent);
1154 GST_LOG_OBJECT (enc, "handling query: %" GST_PTR_FORMAT, query);
1156 switch (GST_QUERY_TYPE (query)) {
1157 case GST_QUERY_CONVERT:
1159 GstFormat src_fmt, dest_fmt;
1160 gint64 src_val, dest_val;
1162 gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1164 gst_video_encoded_video_convert (priv->bytes, priv->time, src_fmt,
1165 src_val, &dest_fmt, &dest_val);
1168 gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1171 case GST_QUERY_LATENCY:
1174 GstClockTime min_latency, max_latency;
1176 res = gst_pad_peer_query (enc->sinkpad, query);
1178 gst_query_parse_latency (query, &live, &min_latency, &max_latency);
1179 GST_DEBUG_OBJECT (enc, "Peer latency: live %d, min %"
1180 GST_TIME_FORMAT " max %" GST_TIME_FORMAT, live,
1181 GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
1183 GST_OBJECT_LOCK (enc);
1184 min_latency += priv->min_latency;
1185 if (enc->priv->max_latency == GST_CLOCK_TIME_NONE) {
1186 max_latency = GST_CLOCK_TIME_NONE;
1187 } else if (max_latency != GST_CLOCK_TIME_NONE) {
1188 max_latency += enc->priv->max_latency;
1190 GST_OBJECT_UNLOCK (enc);
1192 gst_query_set_latency (query, live, min_latency, max_latency);
1197 res = gst_pad_query_default (pad, parent, query);
1202 GST_DEBUG_OBJECT (enc, "query failed");
1206 static GstVideoCodecFrame *
1207 gst_video_encoder_new_frame (GstVideoEncoder * encoder, GstBuffer * buf,
1208 GstClockTime pts, GstClockTime dts, GstClockTime duration)
1210 GstVideoEncoderPrivate *priv = encoder->priv;
1211 GstVideoCodecFrame *frame;
1213 frame = g_slice_new0 (GstVideoCodecFrame);
1215 frame->ref_count = 1;
1217 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1218 frame->system_frame_number = priv->system_frame_number;
1219 priv->system_frame_number++;
1221 frame->presentation_frame_number = priv->presentation_frame_number;
1222 priv->presentation_frame_number++;
1223 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1225 frame->events = priv->current_frame_events;
1226 priv->current_frame_events = NULL;
1227 frame->input_buffer = buf;
1230 frame->duration = duration;
1231 frame->abidata.ABI.ts = pts;
1237 static GstFlowReturn
1238 gst_video_encoder_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
1240 GstVideoEncoder *encoder;
1241 GstVideoEncoderPrivate *priv;
1242 GstVideoEncoderClass *klass;
1243 GstVideoCodecFrame *frame;
1244 GstClockTime pts, duration;
1245 GstFlowReturn ret = GST_FLOW_OK;
1246 guint64 start, stop, cstart, cstop;
1248 encoder = GST_VIDEO_ENCODER (parent);
1249 priv = encoder->priv;
1250 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1252 g_return_val_if_fail (klass->handle_frame != NULL, GST_FLOW_ERROR);
1254 if (G_UNLIKELY (encoder->priv->do_caps)) {
1255 GstCaps *caps = gst_pad_get_current_caps (encoder->sinkpad);
1257 goto not_negotiated;
1258 if (!gst_video_encoder_setcaps (encoder, caps)) {
1259 gst_caps_unref (caps);
1260 goto not_negotiated;
1262 gst_caps_unref (caps);
1263 encoder->priv->do_caps = FALSE;
1266 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1268 pts = GST_BUFFER_PTS (buf);
1269 duration = GST_BUFFER_DURATION (buf);
1271 GST_LOG_OBJECT (encoder,
1272 "received buffer of size %" G_GSIZE_FORMAT " with PTS %" GST_TIME_FORMAT
1273 ", DTS %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
1274 gst_buffer_get_size (buf), GST_TIME_ARGS (pts),
1275 GST_TIME_ARGS (GST_BUFFER_DTS (buf)), GST_TIME_ARGS (duration));
1283 if (GST_CLOCK_TIME_IS_VALID (duration))
1284 stop = start + duration;
1286 stop = GST_CLOCK_TIME_NONE;
1288 /* Drop buffers outside of segment */
1289 if (!gst_segment_clip (&encoder->input_segment,
1290 GST_FORMAT_TIME, start, stop, &cstart, &cstop)) {
1291 GST_DEBUG_OBJECT (encoder, "clipping to segment dropped frame");
1292 gst_buffer_unref (buf);
1296 /* incoming DTS is not really relevant and does not make sense anyway,
1297 * so pass along _NONE and maybe come up with something better later on */
1298 frame = gst_video_encoder_new_frame (encoder, buf, cstart,
1299 GST_CLOCK_TIME_NONE, cstop - cstart);
1301 GST_OBJECT_LOCK (encoder);
1302 if (priv->force_key_unit) {
1303 ForcedKeyUnitEvent *fevt = NULL;
1304 GstClockTime running_time;
1308 gst_segment_to_running_time (&encoder->output_segment, GST_FORMAT_TIME,
1311 for (l = priv->force_key_unit; l; l = l->next) {
1312 ForcedKeyUnitEvent *tmp = l->data;
1314 /* Skip pending keyunits */
1318 /* Simple case, keyunit ASAP */
1319 if (tmp->running_time == GST_CLOCK_TIME_NONE) {
1324 /* Event for before this frame */
1325 if (tmp->running_time <= running_time) {
1332 GST_DEBUG_OBJECT (encoder,
1333 "Forcing a key unit at running time %" GST_TIME_FORMAT,
1334 GST_TIME_ARGS (running_time));
1335 GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME (frame);
1336 if (fevt->all_headers)
1337 GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME_HEADERS (frame);
1338 fevt->pending = TRUE;
1341 GST_OBJECT_UNLOCK (encoder);
1343 gst_video_codec_frame_ref (frame);
1344 priv->frames = g_list_append (priv->frames, frame);
1346 /* new data, more finish needed */
1347 priv->drained = FALSE;
1349 GST_LOG_OBJECT (encoder, "passing frame pfn %d to subclass",
1350 frame->presentation_frame_number);
1352 ret = klass->handle_frame (encoder, frame);
1355 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1362 GST_ELEMENT_ERROR (encoder, CORE, NEGOTIATION, (NULL),
1363 ("encoder not initialized"));
1364 gst_buffer_unref (buf);
1365 return GST_FLOW_NOT_NEGOTIATED;
1369 static GstStateChangeReturn
1370 gst_video_encoder_change_state (GstElement * element, GstStateChange transition)
1372 GstVideoEncoder *encoder;
1373 GstVideoEncoderClass *encoder_class;
1374 GstStateChangeReturn ret;
1376 encoder = GST_VIDEO_ENCODER (element);
1377 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (element);
1379 switch (transition) {
1380 case GST_STATE_CHANGE_NULL_TO_READY:
1381 /* open device/library if needed */
1382 if (encoder_class->open && !encoder_class->open (encoder))
1385 case GST_STATE_CHANGE_READY_TO_PAUSED:
1386 /* Initialize device/library if needed */
1387 if (encoder_class->start && !encoder_class->start (encoder))
1394 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1396 switch (transition) {
1397 case GST_STATE_CHANGE_PAUSED_TO_READY:
1398 gst_video_encoder_reset (encoder);
1399 if (encoder_class->stop && !encoder_class->stop (encoder))
1402 case GST_STATE_CHANGE_READY_TO_NULL:
1403 /* close device/library if needed */
1404 if (encoder_class->close && !encoder_class->close (encoder))
1417 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1418 ("Failed to open encoder"));
1419 return GST_STATE_CHANGE_FAILURE;
1424 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1425 ("Failed to start encoder"));
1426 return GST_STATE_CHANGE_FAILURE;
1431 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1432 ("Failed to stop encoder"));
1433 return GST_STATE_CHANGE_FAILURE;
1438 GST_ELEMENT_ERROR (encoder, LIBRARY, INIT, (NULL),
1439 ("Failed to close encoder"));
1440 return GST_STATE_CHANGE_FAILURE;
1445 gst_video_encoder_negotiate_default (GstVideoEncoder * encoder)
1447 GstVideoEncoderClass *klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1448 GstAllocator *allocator;
1449 GstAllocationParams params;
1451 GstVideoCodecState *state = encoder->priv->output_state;
1452 GstVideoInfo *info = &state->info;
1453 GstQuery *query = NULL;
1454 GstVideoCodecFrame *frame;
1456 g_return_val_if_fail (state->caps != NULL, FALSE);
1458 if (encoder->priv->output_state_changed) {
1459 state->caps = gst_caps_make_writable (state->caps);
1462 gst_caps_set_simple (state->caps, "width", G_TYPE_INT, info->width,
1463 "height", G_TYPE_INT, info->height,
1464 "pixel-aspect-ratio", GST_TYPE_FRACTION,
1465 info->par_n, info->par_d, NULL);
1466 if (info->flags & GST_VIDEO_FLAG_VARIABLE_FPS && info->fps_n != 0) {
1467 /* variable fps with a max-framerate */
1468 gst_caps_set_simple (state->caps, "framerate", GST_TYPE_FRACTION, 0, 1,
1469 "max-framerate", GST_TYPE_FRACTION, info->fps_n, info->fps_d, NULL);
1471 /* no variable fps or no max-framerate */
1472 gst_caps_set_simple (state->caps, "framerate", GST_TYPE_FRACTION,
1473 info->fps_n, info->fps_d, NULL);
1475 if (state->codec_data)
1476 gst_caps_set_simple (state->caps, "codec_data", GST_TYPE_BUFFER,
1477 state->codec_data, NULL);
1478 encoder->priv->output_state_changed = FALSE;
1481 /* Push all pending pre-caps events of the oldest frame before
1483 frame = encoder->priv->frames ? encoder->priv->frames->data : NULL;
1484 if (frame || encoder->priv->current_frame_events) {
1486 gboolean set_caps = FALSE;
1489 events = &frame->events;
1491 events = &encoder->priv->current_frame_events;
1495 for (l = g_list_last (*events); l;) {
1496 GstEvent *event = GST_EVENT (l->data);
1499 if (GST_EVENT_TYPE (event) > GST_EVENT_CAPS && !set_caps) {
1500 ret = gst_pad_set_caps (encoder->srcpad, state->caps);
1504 gst_video_encoder_push_event (encoder, event);
1507 *events = g_list_delete_link (*events, tmp);
1510 ret = gst_pad_set_caps (encoder->srcpad, state->caps);
1513 ret = gst_pad_set_caps (encoder->srcpad, state->caps);
1519 query = gst_query_new_allocation (state->caps, TRUE);
1520 if (!gst_pad_peer_query (encoder->srcpad, query)) {
1521 GST_DEBUG_OBJECT (encoder, "didn't get downstream ALLOCATION hints");
1524 g_assert (klass->decide_allocation != NULL);
1525 ret = klass->decide_allocation (encoder, query);
1527 GST_DEBUG_OBJECT (encoder, "ALLOCATION (%d) params: %" GST_PTR_FORMAT, ret,
1531 goto no_decide_allocation;
1533 /* we got configuration from our peer or the decide_allocation method,
1535 if (gst_query_get_n_allocation_params (query) > 0) {
1536 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
1539 gst_allocation_params_init (¶ms);
1542 if (encoder->priv->allocator)
1543 gst_object_unref (encoder->priv->allocator);
1544 encoder->priv->allocator = allocator;
1545 encoder->priv->params = params;
1549 gst_query_unref (query);
1554 no_decide_allocation:
1556 GST_WARNING_OBJECT (encoder, "Subclass failed to decide allocation");
1562 * gst_video_encoder_negotiate:
1563 * @encoder: a #GstVideoEncoder
1565 * Negotiate with downstream elements to currently configured #GstVideoCodecState.
1567 * Returns: #TRUE if the negotiation succeeded, else #FALSE.
1570 gst_video_encoder_negotiate (GstVideoEncoder * encoder)
1572 GstVideoEncoderClass *klass;
1573 gboolean ret = TRUE;
1575 g_return_val_if_fail (GST_IS_VIDEO_ENCODER (encoder), FALSE);
1577 klass = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1579 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1580 if (klass->negotiate)
1581 ret = klass->negotiate (encoder);
1582 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1588 * gst_video_encoder_allocate_output_buffer:
1589 * @encoder: a #GstVideoEncoder
1590 * @size: size of the buffer
1592 * Helper function that allocates a buffer to hold an encoded video frame
1593 * for @encoder's current #GstVideoCodecState.
1595 * Returns: (transfer full): allocated buffer
1598 gst_video_encoder_allocate_output_buffer (GstVideoEncoder * encoder, gsize size)
1602 g_return_val_if_fail (size > 0, NULL);
1604 GST_DEBUG ("alloc src buffer");
1606 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1607 if (G_UNLIKELY (encoder->priv->output_state_changed
1608 || (encoder->priv->output_state
1609 && gst_pad_check_reconfigure (encoder->srcpad))))
1610 gst_video_encoder_negotiate (encoder);
1613 gst_buffer_new_allocate (encoder->priv->allocator, size,
1614 &encoder->priv->params);
1616 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1622 * gst_video_encoder_allocate_output_frame:
1623 * @encoder: a #GstVideoEncoder
1624 * @frame: a #GstVideoCodecFrame
1625 * @size: size of the buffer
1627 * Helper function that allocates a buffer to hold an encoded video frame for @encoder's
1628 * current #GstVideoCodecState. Subclass should already have configured video
1629 * state and set src pad caps.
1631 * The buffer allocated here is owned by the frame and you should only
1632 * keep references to the frame, not the buffer.
1634 * Returns: %GST_FLOW_OK if an output buffer could be allocated
1637 gst_video_encoder_allocate_output_frame (GstVideoEncoder *
1638 encoder, GstVideoCodecFrame * frame, gsize size)
1640 g_return_val_if_fail (frame->output_buffer == NULL, GST_FLOW_ERROR);
1642 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1643 if (G_UNLIKELY (encoder->priv->output_state_changed
1644 || (encoder->priv->output_state
1645 && gst_pad_check_reconfigure (encoder->srcpad))))
1646 gst_video_encoder_negotiate (encoder);
1648 GST_LOG_OBJECT (encoder, "alloc buffer size %" G_GSIZE_FORMAT, size);
1650 frame->output_buffer =
1651 gst_buffer_new_allocate (encoder->priv->allocator, size,
1652 &encoder->priv->params);
1654 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1656 return frame->output_buffer ? GST_FLOW_OK : GST_FLOW_ERROR;
1660 gst_video_encoder_release_frame (GstVideoEncoder * enc,
1661 GstVideoCodecFrame * frame)
1665 /* unref once from the list */
1666 link = g_list_find (enc->priv->frames, frame);
1668 gst_video_codec_frame_unref (frame);
1669 enc->priv->frames = g_list_delete_link (enc->priv->frames, link);
1671 /* unref because this function takes ownership */
1672 gst_video_codec_frame_unref (frame);
1676 * gst_video_encoder_finish_frame:
1677 * @encoder: a #GstVideoEncoder
1678 * @frame: (transfer full): an encoded #GstVideoCodecFrame
1680 * @frame must have a valid encoded data buffer, whose metadata fields
1681 * are then appropriately set according to frame data or no buffer at
1682 * all if the frame should be dropped.
1683 * It is subsequently pushed downstream or provided to @pre_push.
1684 * In any case, the frame is considered finished and released.
1686 * After calling this function the output buffer of the frame is to be
1687 * considered read-only. This function will also change the metadata
1690 * Returns: a #GstFlowReturn resulting from sending data downstream
1693 gst_video_encoder_finish_frame (GstVideoEncoder * encoder,
1694 GstVideoCodecFrame * frame)
1696 GstVideoEncoderPrivate *priv = encoder->priv;
1697 GstFlowReturn ret = GST_FLOW_OK;
1698 GstVideoEncoderClass *encoder_class;
1700 gboolean send_headers = FALSE;
1701 gboolean discont = (frame->presentation_frame_number == 0);
1704 encoder_class = GST_VIDEO_ENCODER_GET_CLASS (encoder);
1706 GST_LOG_OBJECT (encoder,
1707 "finish frame fpn %d", frame->presentation_frame_number);
1709 GST_LOG_OBJECT (encoder, "frame PTS %" GST_TIME_FORMAT
1710 ", DTS %" GST_TIME_FORMAT, GST_TIME_ARGS (frame->pts),
1711 GST_TIME_ARGS (frame->dts));
1713 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1715 if (G_UNLIKELY (priv->output_state_changed || (priv->output_state
1716 && gst_pad_check_reconfigure (encoder->srcpad))))
1717 gst_video_encoder_negotiate (encoder);
1719 if (G_UNLIKELY (priv->output_state == NULL))
1720 goto no_output_state;
1722 /* Push all pending events that arrived before this frame */
1723 for (l = priv->frames; l; l = l->next) {
1724 GstVideoCodecFrame *tmp = l->data;
1729 for (k = g_list_last (tmp->events); k; k = k->prev)
1730 gst_video_encoder_push_event (encoder, k->data);
1731 g_list_free (tmp->events);
1739 if (priv->tags && priv->tags_changed) {
1740 gst_video_encoder_push_event (encoder,
1741 gst_event_new_tag (gst_tag_list_ref (priv->tags)));
1742 priv->tags_changed = FALSE;
1745 /* no buffer data means this frame is skipped/dropped */
1746 if (!frame->output_buffer) {
1747 GST_DEBUG_OBJECT (encoder, "skipping frame %" GST_TIME_FORMAT,
1748 GST_TIME_ARGS (frame->pts));
1752 if (GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT (frame) && priv->force_key_unit) {
1753 GstClockTime stream_time, running_time;
1755 ForcedKeyUnitEvent *fevt = NULL;
1759 gst_segment_to_running_time (&encoder->output_segment, GST_FORMAT_TIME,
1762 GST_OBJECT_LOCK (encoder);
1763 for (l = priv->force_key_unit; l; l = l->next) {
1764 ForcedKeyUnitEvent *tmp = l->data;
1766 /* Skip non-pending keyunits */
1770 /* Simple case, keyunit ASAP */
1771 if (tmp->running_time == GST_CLOCK_TIME_NONE) {
1776 /* Event for before this frame */
1777 if (tmp->running_time <= running_time) {
1784 priv->force_key_unit = g_list_remove (priv->force_key_unit, fevt);
1786 GST_OBJECT_UNLOCK (encoder);
1790 gst_segment_to_stream_time (&encoder->output_segment, GST_FORMAT_TIME,
1793 ev = gst_video_event_new_downstream_force_key_unit
1794 (frame->pts, stream_time, running_time,
1795 fevt->all_headers, fevt->count);
1797 gst_video_encoder_push_event (encoder, ev);
1799 if (fevt->all_headers)
1800 send_headers = TRUE;
1802 GST_DEBUG_OBJECT (encoder,
1803 "Forced key unit: running-time %" GST_TIME_FORMAT
1804 ", all_headers %d, count %u",
1805 GST_TIME_ARGS (running_time), fevt->all_headers, fevt->count);
1806 forced_key_unit_event_free (fevt);
1810 if (GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT (frame)) {
1811 priv->distance_from_sync = 0;
1812 GST_BUFFER_FLAG_UNSET (frame->output_buffer, GST_BUFFER_FLAG_DELTA_UNIT);
1813 /* For keyframes, DTS = PTS */
1814 if (!GST_CLOCK_TIME_IS_VALID (frame->dts)) {
1815 frame->dts = frame->pts;
1816 } else if (GST_CLOCK_TIME_IS_VALID (frame->pts) && frame->pts != frame->dts) {
1817 GST_WARNING_OBJECT (encoder, "keyframe PTS != DTS");
1820 GST_BUFFER_FLAG_SET (frame->output_buffer, GST_BUFFER_FLAG_DELTA_UNIT);
1823 /* DTS is expected monotone ascending,
1824 * so a good guess is the lowest unsent PTS (all being OK) */
1826 GstClockTime min_ts = GST_CLOCK_TIME_NONE;
1827 GstVideoCodecFrame *oframe = NULL;
1828 gboolean seen_none = FALSE;
1830 /* some maintenance regardless */
1831 for (l = priv->frames; l; l = l->next) {
1832 GstVideoCodecFrame *tmp = l->data;
1834 if (!GST_CLOCK_TIME_IS_VALID (tmp->abidata.ABI.ts)) {
1839 if (!GST_CLOCK_TIME_IS_VALID (min_ts) || tmp->abidata.ABI.ts < min_ts) {
1840 min_ts = tmp->abidata.ABI.ts;
1844 /* save a ts if needed */
1845 if (oframe && oframe != frame) {
1846 oframe->abidata.ABI.ts = frame->abidata.ABI.ts;
1849 /* and set if needed */
1850 if (!GST_CLOCK_TIME_IS_VALID (frame->dts) && !seen_none) {
1851 frame->dts = min_ts;
1852 GST_DEBUG_OBJECT (encoder,
1853 "no valid DTS, using oldest PTS %" GST_TIME_FORMAT,
1854 GST_TIME_ARGS (frame->pts));
1858 frame->distance_from_sync = priv->distance_from_sync;
1859 priv->distance_from_sync++;
1861 GST_BUFFER_PTS (frame->output_buffer) = frame->pts;
1862 GST_BUFFER_DTS (frame->output_buffer) = frame->dts;
1863 GST_BUFFER_DURATION (frame->output_buffer) = frame->duration;
1865 /* update rate estimate */
1866 priv->bytes += gst_buffer_get_size (frame->output_buffer);
1867 if (GST_CLOCK_TIME_IS_VALID (frame->duration)) {
1868 priv->time += frame->duration;
1870 /* better none than nothing valid */
1871 priv->time = GST_CLOCK_TIME_NONE;
1874 if (G_UNLIKELY (send_headers || priv->new_headers)) {
1875 GList *tmp, *copy = NULL;
1877 GST_DEBUG_OBJECT (encoder, "Sending headers");
1879 /* First make all buffers metadata-writable */
1880 for (tmp = priv->headers; tmp; tmp = tmp->next) {
1881 GstBuffer *tmpbuf = GST_BUFFER (tmp->data);
1883 copy = g_list_append (copy, gst_buffer_make_writable (tmpbuf));
1885 g_list_free (priv->headers);
1886 priv->headers = copy;
1888 for (tmp = priv->headers; tmp; tmp = tmp->next) {
1889 GstBuffer *tmpbuf = GST_BUFFER (tmp->data);
1891 priv->bytes += gst_buffer_get_size (tmpbuf);
1892 if (G_UNLIKELY (discont)) {
1893 GST_LOG_OBJECT (encoder, "marking discont");
1894 GST_BUFFER_FLAG_SET (tmpbuf, GST_BUFFER_FLAG_DISCONT);
1898 gst_pad_push (encoder->srcpad, gst_buffer_ref (tmpbuf));
1900 priv->new_headers = FALSE;
1903 if (G_UNLIKELY (discont)) {
1904 GST_LOG_OBJECT (encoder, "marking discont");
1905 GST_BUFFER_FLAG_SET (frame->output_buffer, GST_BUFFER_FLAG_DISCONT);
1908 if (encoder_class->pre_push)
1909 ret = encoder_class->pre_push (encoder, frame);
1911 /* Get an additional ref to the buffer, which is going to be pushed
1912 * downstream, the original ref is owned by the frame */
1913 buffer = gst_buffer_ref (frame->output_buffer);
1915 /* Release frame so the buffer is writable when we push it downstream
1916 * if possible, i.e. if the subclass does not hold additional references
1919 gst_video_encoder_release_frame (encoder, frame);
1922 if (ret == GST_FLOW_OK)
1923 ret = gst_pad_push (encoder->srcpad, buffer);
1928 gst_video_encoder_release_frame (encoder, frame);
1930 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1937 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1938 GST_ERROR_OBJECT (encoder, "Output state was not configured");
1939 return GST_FLOW_ERROR;
1944 * gst_video_encoder_get_output_state:
1945 * @encoder: a #GstVideoEncoder
1947 * Get the current #GstVideoCodecState
1949 * Returns: (transfer full): #GstVideoCodecState describing format of video data.
1951 GstVideoCodecState *
1952 gst_video_encoder_get_output_state (GstVideoEncoder * encoder)
1954 GstVideoCodecState *state;
1956 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
1957 state = gst_video_codec_state_ref (encoder->priv->output_state);
1958 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
1964 * gst_video_encoder_set_output_state:
1965 * @encoder: a #GstVideoEncoder
1966 * @caps: (transfer full): the #GstCaps to use for the output
1967 * @reference: (allow-none) (transfer none): An optional reference @GstVideoCodecState
1969 * Creates a new #GstVideoCodecState with the specified caps as the output state
1971 * Any previously set output state on @encoder will be replaced by the newly
1974 * The specified @caps should not contain any resolution, pixel-aspect-ratio,
1975 * framerate, codec-data, .... Those should be specified instead in the returned
1976 * #GstVideoCodecState.
1978 * If the subclass wishes to copy over existing fields (like pixel aspect ratio,
1979 * or framerate) from an existing #GstVideoCodecState, it can be provided as a
1982 * If the subclass wishes to override some fields from the output state (like
1983 * pixel-aspect-ratio or framerate) it can do so on the returned #GstVideoCodecState.
1985 * The new output state will only take effect (set on pads and buffers) starting
1986 * from the next call to #gst_video_encoder_finish_frame().
1988 * Returns: (transfer full): the newly configured output state.
1990 GstVideoCodecState *
1991 gst_video_encoder_set_output_state (GstVideoEncoder * encoder, GstCaps * caps,
1992 GstVideoCodecState * reference)
1994 GstVideoEncoderPrivate *priv = encoder->priv;
1995 GstVideoCodecState *state;
1997 g_return_val_if_fail (caps != NULL, NULL);
1999 state = _new_output_state (caps, reference);
2001 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
2002 if (priv->output_state)
2003 gst_video_codec_state_unref (priv->output_state);
2004 priv->output_state = gst_video_codec_state_ref (state);
2006 priv->output_state_changed = TRUE;
2007 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
2013 * gst_video_encoder_set_latency:
2014 * @encoder: a #GstVideoEncoder
2015 * @min_latency: minimum latency
2016 * @max_latency: maximum latency
2018 * Informs baseclass of encoding latency.
2021 gst_video_encoder_set_latency (GstVideoEncoder * encoder,
2022 GstClockTime min_latency, GstClockTime max_latency)
2024 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
2025 g_return_if_fail (max_latency >= min_latency);
2027 GST_OBJECT_LOCK (encoder);
2028 encoder->priv->min_latency = min_latency;
2029 encoder->priv->max_latency = max_latency;
2030 GST_OBJECT_UNLOCK (encoder);
2032 gst_element_post_message (GST_ELEMENT_CAST (encoder),
2033 gst_message_new_latency (GST_OBJECT_CAST (encoder)));
2037 * gst_video_encoder_get_latency:
2038 * @encoder: a #GstVideoEncoder
2039 * @min_latency: (out) (allow-none): address of variable in which to store the
2040 * configured minimum latency, or %NULL
2041 * @max_latency: (out) (allow-none): address of variable in which to store the
2042 * configured maximum latency, or %NULL
2044 * Query the configured encoding latency. Results will be returned via
2045 * @min_latency and @max_latency.
2048 gst_video_encoder_get_latency (GstVideoEncoder * encoder,
2049 GstClockTime * min_latency, GstClockTime * max_latency)
2051 GST_OBJECT_LOCK (encoder);
2053 *min_latency = encoder->priv->min_latency;
2055 *max_latency = encoder->priv->max_latency;
2056 GST_OBJECT_UNLOCK (encoder);
2060 * gst_video_encoder_get_oldest_frame:
2061 * @encoder: a #GstVideoEncoder
2063 * Get the oldest unfinished pending #GstVideoCodecFrame
2065 * Returns: (transfer full): oldest unfinished pending #GstVideoCodecFrame
2067 GstVideoCodecFrame *
2068 gst_video_encoder_get_oldest_frame (GstVideoEncoder * encoder)
2070 GstVideoCodecFrame *frame = NULL;
2072 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
2073 if (encoder->priv->frames)
2074 frame = gst_video_codec_frame_ref (encoder->priv->frames->data);
2075 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
2077 return (GstVideoCodecFrame *) frame;
2081 * gst_video_encoder_get_frame:
2082 * @encoder: a #GstVideoEnccoder
2083 * @frame_number: system_frame_number of a frame
2085 * Get a pending unfinished #GstVideoCodecFrame
2087 * Returns: (transfer full): pending unfinished #GstVideoCodecFrame identified by @frame_number.
2089 GstVideoCodecFrame *
2090 gst_video_encoder_get_frame (GstVideoEncoder * encoder, int frame_number)
2093 GstVideoCodecFrame *frame = NULL;
2095 GST_DEBUG_OBJECT (encoder, "frame_number : %d", frame_number);
2097 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
2098 for (g = encoder->priv->frames; g; g = g->next) {
2099 GstVideoCodecFrame *tmp = g->data;
2101 if (tmp->system_frame_number == frame_number) {
2102 frame = gst_video_codec_frame_ref (tmp);
2106 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
2112 * gst_video_encoder_get_frames:
2113 * @encoder: a #GstVideoEncoder
2115 * Get all pending unfinished #GstVideoCodecFrame
2117 * Returns: (transfer full) (element-type GstVideoCodecFrame): pending unfinished #GstVideoCodecFrame.
2120 gst_video_encoder_get_frames (GstVideoEncoder * encoder)
2124 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
2125 frames = g_list_copy (encoder->priv->frames);
2126 g_list_foreach (frames, (GFunc) gst_video_codec_frame_ref, NULL);
2127 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
2133 * gst_video_encoder_merge_tags:
2134 * @encoder: a #GstVideoEncoder
2135 * @tags: a #GstTagList to merge
2136 * @mode: the #GstTagMergeMode to use
2138 * Adds tags to so-called pending tags, which will be processed
2139 * before pushing out data downstream.
2141 * Note that this is provided for convenience, and the subclass is
2142 * not required to use this and can still do tag handling on its own.
2147 gst_video_encoder_merge_tags (GstVideoEncoder * encoder,
2148 const GstTagList * tags, GstTagMergeMode mode)
2152 g_return_if_fail (GST_IS_VIDEO_ENCODER (encoder));
2153 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2155 GST_VIDEO_ENCODER_STREAM_LOCK (encoder);
2157 GST_DEBUG_OBJECT (encoder, "merging tags %" GST_PTR_FORMAT, tags);
2158 otags = encoder->priv->tags;
2159 encoder->priv->tags = gst_tag_list_merge (encoder->priv->tags, tags, mode);
2161 gst_tag_list_unref (otags);
2162 encoder->priv->tags_changed = TRUE;
2163 GST_VIDEO_ENCODER_STREAM_UNLOCK (encoder);
2167 * gst_video_encoder_get_allocator:
2168 * @encoder: a #GstVideoEncoder
2169 * @allocator: (out) (allow-none) (transfer full): the #GstAllocator
2171 * @params: (out) (allow-none) (transfer full): the
2172 * #GstAllocatorParams of @allocator
2174 * Lets #GstVideoEncoder sub-classes to know the memory @allocator
2175 * used by the base class and its @params.
2177 * Unref the @allocator after use it.
2180 gst_video_encoder_get_allocator (GstVideoEncoder * encoder,
2181 GstAllocator ** allocator, GstAllocationParams * params)
2183 g_return_if_fail (GST_IS_VIDEO_ENCODER (encoder));
2186 *allocator = encoder->priv->allocator ?
2187 gst_object_ref (encoder->priv->allocator) : NULL;
2190 *params = encoder->priv->params;