mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-09-23 04:20:17 +00:00
9fab555cc5
For NTP and PTP clocks we signal the actual clock that is used and signal the direct media clock offset. For all other clocks we at least signal that it's the local sender clock. This allows receivers to know which clock was used to generate the media and its RTP timestamps. Receivers can then implement network synchronization, either absolute or at least relative by getting the sender clock rate directly via NTP/PTP instead of estimating it from RTP timestamps and packet receive times. https://bugzilla.gnome.org/show_bug.cgi?id=760005
296 lines
13 KiB
C
296 lines
13 KiB
C
/* GStreamer
|
|
* Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.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.
|
|
*/
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/rtsp/rtsp.h>
|
|
#include <gst/net/gstnet.h>
|
|
|
|
#ifndef __GST_RTSP_MEDIA_H__
|
|
#define __GST_RTSP_MEDIA_H__
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/* types for the media */
|
|
#define GST_TYPE_RTSP_MEDIA (gst_rtsp_media_get_type ())
|
|
#define GST_IS_RTSP_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA))
|
|
#define GST_IS_RTSP_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA))
|
|
#define GST_RTSP_MEDIA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
|
|
#define GST_RTSP_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMedia))
|
|
#define GST_RTSP_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
|
|
#define GST_RTSP_MEDIA_CAST(obj) ((GstRTSPMedia*)(obj))
|
|
#define GST_RTSP_MEDIA_CLASS_CAST(klass) ((GstRTSPMediaClass*)(klass))
|
|
|
|
typedef struct _GstRTSPMedia GstRTSPMedia;
|
|
typedef struct _GstRTSPMediaClass GstRTSPMediaClass;
|
|
typedef struct _GstRTSPMediaPrivate GstRTSPMediaPrivate;
|
|
|
|
/**
|
|
* GstRTSPMediaStatus:
|
|
* @GST_RTSP_MEDIA_STATUS_UNPREPARED: media pipeline not prerolled
|
|
* @GST_RTSP_MEDIA_STATUS_UNPREPARING: media pipeline is busy doing a clean
|
|
* shutdown.
|
|
* @GST_RTSP_MEDIA_STATUS_PREPARING: media pipeline is prerolling
|
|
* @GST_RTSP_MEDIA_STATUS_PREPARED: media pipeline is prerolled
|
|
* @GST_RTSP_MEDIA_STATUS_SUSPENDED: media is suspended
|
|
* @GST_RTSP_MEDIA_STATUS_ERROR: media pipeline is in error
|
|
*
|
|
* The state of the media pipeline.
|
|
*/
|
|
typedef enum {
|
|
GST_RTSP_MEDIA_STATUS_UNPREPARED = 0,
|
|
GST_RTSP_MEDIA_STATUS_UNPREPARING = 1,
|
|
GST_RTSP_MEDIA_STATUS_PREPARING = 2,
|
|
GST_RTSP_MEDIA_STATUS_PREPARED = 3,
|
|
GST_RTSP_MEDIA_STATUS_SUSPENDED = 4,
|
|
GST_RTSP_MEDIA_STATUS_ERROR = 5
|
|
} GstRTSPMediaStatus;
|
|
|
|
/**
|
|
* GstRTSPSuspendMode:
|
|
* @GST_RTSP_SUSPEND_MODE_NONE: Media is not suspended
|
|
* @GST_RTSP_SUSPEND_MODE_PAUSE: Media is PAUSED in suspend
|
|
* @GST_RTSP_SUSPEND_MODE_RESET: The media is set to NULL when suspended
|
|
*
|
|
* The suspend mode of the media pipeline. A media pipeline is suspended right
|
|
* after creating the SDP and when the client performs a PAUSED request.
|
|
*/
|
|
typedef enum {
|
|
GST_RTSP_SUSPEND_MODE_NONE = 0,
|
|
GST_RTSP_SUSPEND_MODE_PAUSE = 1,
|
|
GST_RTSP_SUSPEND_MODE_RESET = 2
|
|
} GstRTSPSuspendMode;
|
|
|
|
/**
|
|
* GstRTSPTransportMode:
|
|
* @GST_RTSP_TRANSPORT_MODE_PLAY: Transport supports PLAY mode
|
|
* @GST_RTSP_TRANSPORT_MODE_RECORD: Transport supports RECORD mode
|
|
*
|
|
* The supported modes of the media.
|
|
*/
|
|
typedef enum {
|
|
GST_RTSP_TRANSPORT_MODE_PLAY = 1,
|
|
GST_RTSP_TRANSPORT_MODE_RECORD = 2,
|
|
} GstRTSPTransportMode;
|
|
|
|
/**
|
|
* GstRTSPPublishClockMode:
|
|
* @GST_RTSP_PUBLISH_CLOCK_MODE_NONE: Publish nothing
|
|
* @GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK: Publish the clock but not the offset
|
|
* @GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK_AND_OFFSET: Publish the clock and offset
|
|
*
|
|
* Whether the clock and possibly RTP/clock offset should be published according to RFC7273.
|
|
*/
|
|
typedef enum {
|
|
GST_RTSP_PUBLISH_CLOCK_MODE_NONE,
|
|
GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK,
|
|
GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK_AND_OFFSET
|
|
} GstRTSPPublishClockMode;
|
|
|
|
#define GST_TYPE_RTSP_TRANSPORT_MODE (gst_rtsp_transport_mode_get_type())
|
|
GType gst_rtsp_transport_mode_get_type (void);
|
|
|
|
#define GST_TYPE_RTSP_SUSPEND_MODE (gst_rtsp_suspend_mode_get_type())
|
|
GType gst_rtsp_suspend_mode_get_type (void);
|
|
|
|
#define GST_TYPE_RTSP_PUBLISH_CLOCK_MODE (gst_rtsp_publish_clock_mode_get_type())
|
|
GType gst_rtsp_publish_clock_mode_get_type (void);
|
|
|
|
#include "rtsp-stream.h"
|
|
#include "rtsp-thread-pool.h"
|
|
#include "rtsp-permissions.h"
|
|
#include "rtsp-address-pool.h"
|
|
#include "rtsp-sdp.h"
|
|
|
|
/**
|
|
* GstRTSPMedia:
|
|
*
|
|
* A class that contains the GStreamer element along with a list of
|
|
* #GstRTSPStream objects that can produce data.
|
|
*
|
|
* This object is usually created from a #GstRTSPMediaFactory.
|
|
*/
|
|
struct _GstRTSPMedia {
|
|
GObject parent;
|
|
|
|
/*< private >*/
|
|
GstRTSPMediaPrivate *priv;
|
|
gpointer _gst_reserved[GST_PADDING];
|
|
};
|
|
|
|
/**
|
|
* GstRTSPMediaClass:
|
|
* @handle_message: handle a message
|
|
* @prepare: the default implementation adds all elements and sets the
|
|
* pipeline's state to GST_STATE_PAUSED (or GST_STATE_PLAYING
|
|
* in case of NO_PREROLL elements).
|
|
* @unprepare: the default implementation sets the pipeline's state
|
|
* to GST_STATE_NULL and removes all elements.
|
|
* @suspend: the default implementation sets the pipeline's state to
|
|
* GST_STATE_NULL GST_STATE_PAUSED depending on the selected
|
|
* suspend mode.
|
|
* @unsuspend: the default implementation reverts the suspend operation.
|
|
* The pipeline will be prerolled again if it's state was
|
|
* set to GST_STATE_NULL in suspend.
|
|
* @convert_range: convert a range to the given unit
|
|
* @query_position: query the current position in the pipeline
|
|
* @query_stop: query when playback will stop
|
|
*
|
|
* The RTSP media class
|
|
*/
|
|
struct _GstRTSPMediaClass {
|
|
GObjectClass parent_class;
|
|
|
|
/* vmethods */
|
|
gboolean (*handle_message) (GstRTSPMedia *media, GstMessage *message);
|
|
gboolean (*prepare) (GstRTSPMedia *media, GstRTSPThread *thread);
|
|
gboolean (*unprepare) (GstRTSPMedia *media);
|
|
gboolean (*suspend) (GstRTSPMedia *media);
|
|
gboolean (*unsuspend) (GstRTSPMedia *media);
|
|
gboolean (*convert_range) (GstRTSPMedia *media, GstRTSPTimeRange *range,
|
|
GstRTSPRangeUnit unit);
|
|
gboolean (*query_position) (GstRTSPMedia *media, gint64 *position);
|
|
gboolean (*query_stop) (GstRTSPMedia *media, gint64 *stop);
|
|
GstElement * (*create_rtpbin) (GstRTSPMedia *media);
|
|
gboolean (*setup_rtpbin) (GstRTSPMedia *media, GstElement *rtpbin);
|
|
gboolean (*setup_sdp) (GstRTSPMedia *media, GstSDPMessage *sdp, GstSDPInfo *info);
|
|
|
|
/* signals */
|
|
void (*new_stream) (GstRTSPMedia *media, GstRTSPStream * stream);
|
|
void (*removed_stream) (GstRTSPMedia *media, GstRTSPStream * stream);
|
|
|
|
void (*prepared) (GstRTSPMedia *media);
|
|
void (*unprepared) (GstRTSPMedia *media);
|
|
|
|
void (*target_state) (GstRTSPMedia *media, GstState state);
|
|
void (*new_state) (GstRTSPMedia *media, GstState state);
|
|
|
|
gboolean (*handle_sdp) (GstRTSPMedia *media, GstSDPMessage *sdp);
|
|
|
|
/*< private >*/
|
|
gpointer _gst_reserved[GST_PADDING_LARGE-1];
|
|
};
|
|
|
|
GType gst_rtsp_media_get_type (void);
|
|
|
|
/* creating the media */
|
|
GstRTSPMedia * gst_rtsp_media_new (GstElement *element);
|
|
GstElement * gst_rtsp_media_get_element (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_take_pipeline (GstRTSPMedia *media, GstPipeline *pipeline);
|
|
|
|
GstRTSPMediaStatus gst_rtsp_media_get_status (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_permissions (GstRTSPMedia *media,
|
|
GstRTSPPermissions *permissions);
|
|
GstRTSPPermissions * gst_rtsp_media_get_permissions (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_shared (GstRTSPMedia *media, gboolean shared);
|
|
gboolean gst_rtsp_media_is_shared (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_stop_on_disconnect (GstRTSPMedia *media, gboolean stop_on_disconnect);
|
|
gboolean gst_rtsp_media_is_stop_on_disconnect (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_transport_mode (GstRTSPMedia *media, GstRTSPTransportMode mode);
|
|
GstRTSPTransportMode gst_rtsp_media_get_transport_mode (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_reusable (GstRTSPMedia *media, gboolean reusable);
|
|
gboolean gst_rtsp_media_is_reusable (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_profiles (GstRTSPMedia *media, GstRTSPProfile profiles);
|
|
GstRTSPProfile gst_rtsp_media_get_profiles (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_protocols (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
|
|
GstRTSPLowerTrans gst_rtsp_media_get_protocols (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
|
|
gboolean gst_rtsp_media_is_eos_shutdown (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_address_pool (GstRTSPMedia *media, GstRTSPAddressPool *pool);
|
|
GstRTSPAddressPool * gst_rtsp_media_get_address_pool (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_multicast_iface (GstRTSPMedia *media, const gchar *multicast_iface);
|
|
gchar * gst_rtsp_media_get_multicast_iface (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_buffer_size (GstRTSPMedia *media, guint size);
|
|
guint gst_rtsp_media_get_buffer_size (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_retransmission_time (GstRTSPMedia *media, GstClockTime time);
|
|
GstClockTime gst_rtsp_media_get_retransmission_time (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_latency (GstRTSPMedia *media, guint latency);
|
|
guint gst_rtsp_media_get_latency (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_use_time_provider (GstRTSPMedia *media, gboolean time_provider);
|
|
gboolean gst_rtsp_media_is_time_provider (GstRTSPMedia *media);
|
|
GstNetTimeProvider * gst_rtsp_media_get_time_provider (GstRTSPMedia *media,
|
|
const gchar *address, guint16 port);
|
|
|
|
void gst_rtsp_media_set_clock (GstRTSPMedia *media, GstClock * clock);
|
|
|
|
|
|
void gst_rtsp_media_set_publish_clock_mode (GstRTSPMedia * media, GstRTSPPublishClockMode mode);
|
|
GstRTSPPublishClockMode gst_rtsp_media_get_publish_clock_mode (GstRTSPMedia * media);
|
|
|
|
/* prepare the media for playback */
|
|
gboolean gst_rtsp_media_prepare (GstRTSPMedia *media, GstRTSPThread *thread);
|
|
gboolean gst_rtsp_media_unprepare (GstRTSPMedia *media);
|
|
|
|
void gst_rtsp_media_set_suspend_mode (GstRTSPMedia *media, GstRTSPSuspendMode mode);
|
|
GstRTSPSuspendMode gst_rtsp_media_get_suspend_mode (GstRTSPMedia *media);
|
|
|
|
gboolean gst_rtsp_media_suspend (GstRTSPMedia *media);
|
|
gboolean gst_rtsp_media_unsuspend (GstRTSPMedia *media);
|
|
|
|
gboolean gst_rtsp_media_setup_sdp (GstRTSPMedia * media, GstSDPMessage * sdp,
|
|
GstSDPInfo * info);
|
|
|
|
gboolean gst_rtsp_media_handle_sdp (GstRTSPMedia * media, GstSDPMessage * sdp);
|
|
|
|
|
|
/* creating streams */
|
|
void gst_rtsp_media_collect_streams (GstRTSPMedia *media);
|
|
GstRTSPStream * gst_rtsp_media_create_stream (GstRTSPMedia *media,
|
|
GstElement *payloader,
|
|
GstPad *pad);
|
|
|
|
/* dealing with the media */
|
|
GstClock * gst_rtsp_media_get_clock (GstRTSPMedia *media);
|
|
GstClockTime gst_rtsp_media_get_base_time (GstRTSPMedia *media);
|
|
|
|
guint gst_rtsp_media_n_streams (GstRTSPMedia *media);
|
|
GstRTSPStream * gst_rtsp_media_get_stream (GstRTSPMedia *media, guint idx);
|
|
GstRTSPStream * gst_rtsp_media_find_stream (GstRTSPMedia *media, const gchar * control);
|
|
|
|
gboolean gst_rtsp_media_seek (GstRTSPMedia *media, GstRTSPTimeRange *range);
|
|
gchar * gst_rtsp_media_get_range_string (GstRTSPMedia *media,
|
|
gboolean play,
|
|
GstRTSPRangeUnit unit);
|
|
|
|
gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state,
|
|
GPtrArray *transports);
|
|
void gst_rtsp_media_set_pipeline_state (GstRTSPMedia * media,
|
|
GstState state);
|
|
|
|
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTSPMedia, gst_object_unref)
|
|
#endif
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_RTSP_MEDIA_H__ */
|