gstreamer/gst-libs/gst/rtp/gstrtpbasepayload.h
Stian Selnes f766b85b96 rtpbasepayload: rtpbasedepayload: Add source-info property
Add a source-info property that will read/write meta to the buffers
about RTP source information. The GstRTPSourceMeta can be used to
transport information about the origin of a buffer, e.g. the sources
that is included in a mixed audio buffer.

A new function gst_rtp_base_payload_allocate_output_buffer() is added
for payloaders to use to allocate the output RTP buffer with the correct
number of CSRCs according to the meta and fill it.

RTPSourceMeta does not make sense on RTP buffers since the information
is in the RTP header. So the payloader will strip the meta from the
output buffer.

https://bugzilla.gnome.org/show_bug.cgi?id=761947
2018-10-10 14:38:01 -04:00

197 lines
6.7 KiB
C

/* GStreamer
* Copyright (C) <2005> Wim Taymans <wim@fluendo.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_RTP_BASE_PAYLOAD_H__
#define __GST_RTP_BASE_PAYLOAD_H__
#include <gst/gst.h>
#include <gst/rtp/rtp-prelude.h>
G_BEGIN_DECLS
#define GST_TYPE_RTP_BASE_PAYLOAD \
(gst_rtp_base_payload_get_type())
#define GST_RTP_BASE_PAYLOAD(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_RTP_BASE_PAYLOAD,GstRTPBasePayload))
#define GST_RTP_BASE_PAYLOAD_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_RTP_BASE_PAYLOAD,GstRTPBasePayloadClass))
#define GST_RTP_BASE_PAYLOAD_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTP_BASE_PAYLOAD, GstRTPBasePayloadClass))
#define GST_IS_RTP_BASE_PAYLOAD(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_RTP_BASE_PAYLOAD))
#define GST_IS_RTP_BASE_PAYLOAD_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_RTP_BASE_PAYLOAD))
#define GST_RTP_BASE_PAYLOAD_CAST(obj) \
((GstRTPBasePayload*)(obj))
typedef struct _GstRTPBasePayload GstRTPBasePayload;
typedef struct _GstRTPBasePayloadPrivate GstRTPBasePayloadPrivate;
typedef struct _GstRTPBasePayloadClass GstRTPBasePayloadClass;
/**
* GST_RTP_BASE_PAYLOAD_SINKPAD:
* @payload: a #GstRTPBasePayload
*
* Get access to the sinkpad of @payload.
*/
#define GST_RTP_BASE_PAYLOAD_SINKPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)->sinkpad)
/**
* GST_RTP_BASE_PAYLOAD_SRCPAD:
* @payload: a #GstRTPBasePayload
*
* Get access to the srcpad of @payload.
*/
#define GST_RTP_BASE_PAYLOAD_SRCPAD(payload) (GST_RTP_BASE_PAYLOAD (payload)->srcpad)
/**
* GST_RTP_BASE_PAYLOAD_PT:
* @payload: a #GstRTPBasePayload
*
* Get access to the configured payload type of @payload.
*/
#define GST_RTP_BASE_PAYLOAD_PT(payload) (GST_RTP_BASE_PAYLOAD (payload)->pt)
/**
* GST_RTP_BASE_PAYLOAD_MTU:
* @payload: a #GstRTPBasePayload
*
* Get access to the configured MTU of @payload.
*/
#define GST_RTP_BASE_PAYLOAD_MTU(payload) (GST_RTP_BASE_PAYLOAD (payload)->mtu)
struct _GstRTPBasePayload
{
GstElement element;
/*< private >*/
GstPad *sinkpad;
GstPad *srcpad;
guint32 ts_base;
guint16 seqnum_base;
gchar *media;
gchar *encoding_name;
gboolean dynamic;
guint32 clock_rate;
gint32 ts_offset;
guint32 timestamp;
gint16 seqnum_offset;
guint16 seqnum;
gint64 max_ptime;
guint pt;
guint ssrc;
guint current_ssrc;
guint mtu;
GstSegment segment;
guint64 min_ptime;
guint64 ptime; /* in ns */
guint64 ptime_multiple; /* in ns */
/*< private >*/
GstRTPBasePayloadPrivate *priv;
gpointer _gst_reserved[GST_PADDING];
};
/**
* GstRTPBasePayloadClass:
* @parent_class: the parent class
* @get_caps: get desired caps
* @set_caps: configure the payloader
* @handle_buffer: process data
* @sink_event: custom event handling on the sinkpad
* @src_event: custom event handling on the srcpad
* @query: custom query handling
*
* Base class for audio RTP payloader.
*/
struct _GstRTPBasePayloadClass
{
GstElementClass parent_class;
/* query accepted caps */
GstCaps * (*get_caps) (GstRTPBasePayload *payload, GstPad * pad, GstCaps * filter);
/* receive caps on the sink pad, configure the payloader. */
gboolean (*set_caps) (GstRTPBasePayload *payload, GstCaps *caps);
/* handle a buffer, perform 0 or more gst_rtp_base_payload_push() on
* the RTP buffers. This function takes ownership of the buffer. */
GstFlowReturn (*handle_buffer) (GstRTPBasePayload *payload,
GstBuffer *buffer);
/* handle events and queries */
gboolean (*sink_event) (GstRTPBasePayload *payload, GstEvent * event);
gboolean (*src_event) (GstRTPBasePayload *payload, GstEvent * event);
gboolean (*query) (GstRTPBasePayload *payload, GstPad *pad, GstQuery * query);
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
GST_RTP_API
GType gst_rtp_base_payload_get_type (void);
GST_RTP_API
void gst_rtp_base_payload_set_options (GstRTPBasePayload *payload,
const gchar *media,
gboolean dynamic,
const gchar *encoding_name,
guint32 clock_rate);
GST_RTP_API
gboolean gst_rtp_base_payload_set_outcaps (GstRTPBasePayload *payload,
const gchar *fieldname, ...);
GST_RTP_API
gboolean gst_rtp_base_payload_is_filled (GstRTPBasePayload *payload,
guint size, GstClockTime duration);
GST_RTP_API
GstFlowReturn gst_rtp_base_payload_push (GstRTPBasePayload *payload,
GstBuffer *buffer);
GST_RTP_API
GstFlowReturn gst_rtp_base_payload_push_list (GstRTPBasePayload *payload,
GstBufferList *list);
GST_RTP_API
GstBuffer * gst_rtp_base_payload_allocate_output_buffer (GstRTPBasePayload * payload,
guint payload_len, guint8 pad_len,
guint8 csrc_count);
GST_RTP_API
void gst_rtp_base_payload_set_source_info_enabled (GstRTPBasePayload * payload,
gboolean enable);
GST_RTP_API
gboolean gst_rtp_base_payload_is_source_info_enabled (GstRTPBasePayload * payload);
GST_RTP_API
guint gst_rtp_base_payload_get_source_count (GstRTPBasePayload * payload,
GstBuffer * buffer);
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTPBasePayload, gst_object_unref)
#endif
G_END_DECLS
#endif /* __GST_RTP_BASE_PAYLOAD_H__ */