FarsightStream

typedef struct _FarsightStream FarsightStream;

A object that represents and manages a single real-time audio/video stream.

enum FarsightCandidateType

typedef enum
{
  FARSIGHT_CANDIDATE_TYPE_LOCAL,   /* A local address */
  FARSIGHT_CANDIDATE_TYPE_DERIVED, /* An address derived by some method such as 
                                    * STUN which should reach the local client
                                    */
  FARSIGHT_CANDIDATE_TYPE_RELAY    /* An external stream relay */
} FarsightCandidateType;

An enum for the type of candidate used/reported

enum FarsightNetworkProtocol

typedef enum
{
  FARSIGHT_NETWORK_PROTOCOL_UDP,
  FARSIGHT_NETWORK_PROTOCOL_TCP
} FarsightNetworkProtocol;

An enum for the base IP protocol used for a FarsightStream

FarsightTransportInfo

typedef struct {
  const gchar *candidate_id;
  guint component;
  const gchar *ip;
  guint16 port;
  FarsightNetworkProtocol proto;
  const gchar *proto_subtype;
  const gchar *proto_profile;
  float preference;
  FarsightCandidateType type;
  const gchar *username;
  const gchar *password;
} FarsightTransportInfo;

Struct to hold information about a possible stream network transport.

enum FarsightStreamDirection

typedef enum
{
  FARSIGHT_STREAM_DIRECTION_NONE = 0,
  FARSIGHT_STREAM_DIRECTION_SENDONLY = 1,
  FARSIGHT_STREAM_DIRECTION_RECEIVEONLY = 2,
  FARSIGHT_STREAM_DIRECTION_BOTH = 3,
  FARSIGHT_STREAM_DIRECTION_LAST
} FarsightStreamDirection;

Enum for the direction of a FarsightStream

enum FarsightStreamState

typedef enum
{
  FARSIGHT_STREAM_STATE_DISCONNECTED,
  FARSIGHT_STREAM_STATE_CONNECTING,
  FARSIGHT_STREAM_STATE_CONNECTED
} FarsightStreamState;

An enum used to signal the state of a FarsightStream

enum FarsightStreamError

typedef enum
{
  FARSIGHT_STREAM_ERROR_EOS,
  FARSIGHT_STREAM_UNKNOWN_ERROR,
  FARSIGHT_STREAM_ERROR_UNKNOWN = FARSIGHT_STREAM_UNKNOWN_ERROR,
  FARSIGHT_STREAM_ERROR_TIMEOUT,
  FARSIGHT_STREAM_ERROR_NETWORK,
  FARSIGHT_STREAM_ERROR_PIPELINE_SETUP,
  FARSIGHT_STREAM_ERROR_RESOURCE,
  FARSIGHT_STREAM_ERROR_LAST = FARSIGHT_STREAM_ERROR_RESOURCE
} FarsightStreamError;

An enum used to signal errors that occur on a FarsightStream

enum FarsightStreamDTMFEvent

typedef enum
{
  FARSIGHT_DTMF_EVENT_0 = 0,
  FARSIGHT_DTMF_EVENT_1 = 1,
  FARSIGHT_DTMF_EVENT_2 = 2,
  FARSIGHT_DTMF_EVENT_3 = 3,
  FARSIGHT_DTMF_EVENT_4 = 4,
  FARSIGHT_DTMF_EVENT_5 = 5,
  FARSIGHT_DTMF_EVENT_6 = 6,
  FARSIGHT_DTMF_EVENT_7 = 7,
  FARSIGHT_DTMF_EVENT_8 = 8,
  FARSIGHT_DTMF_EVENT_9 = 9,
  FARSIGHT_DTMF_EVENT_STAR = 10,
  FARSIGHT_DTMF_EVENT_POUND = 11,
  FARSIGHT_DTMF_EVENT_A = 12,
  FARSIGHT_DTMF_EVENT_B = 13,
  FARSIGHT_DTMF_EVENT_C = 14,
  FARSIGHT_DTMF_EVENT_D = 15
} FarsightStreamDTMFEvent;

An enum that represents the different DTMF event that can be sent to a FarsightStream. The values corresponds those those defined in RFC 4733 The rest of the possibles values are in the IANA registry at: http://www.iana.org/assignments/audio-telephone-event-registry

enum FarsightStreamDTMFMethod

typedef enum
{
  FARSIGHT_DTMF_METHOD_AUTO = 0,
  FARSIGHT_DTMF_METHOD_RTP_RFC4733,
  FARSIGHT_DTMF_METHOD_SOUND
} FarsightStreamDTMFMethod;

An enum that represents the different ways a DTMF event can be sent

FarsightStreamClass

typedef struct {
  GObjectClass parent_class;

  /*virtual methods */
  void (* prepare_transports) (FarsightStream *self);
  GstElement * (* get_pipeline) (FarsightStream *self);
  gboolean (* set_pipeline) (FarsightStream *self, GstElement *pipeline);
  G_CONST_RETURN GList * (* get_native_candidate_list) (FarsightStream *self);
  GList * (* get_native_candidate) (FarsightStream *self,
                                    const gchar* candidate_id);
  void (* set_remote_candidate_list) (FarsightStream *self, 
                                      const GList *remote_candidates);
  void (* add_remote_candidate) (FarsightStream *self,
                                 const GList *remote_candidate);
  void (* remove_remote_candidate) (FarsightStream *self, 
                                    const gchar *remote_candidate_id);
  gboolean (* set_active_candidate_pair) (FarsightStream *self,
                                          const gchar *native_candidate_id,
                                          const gchar *remote_candidiate_id);

  /* void (*set_local_codec_selection) (FarsightStream *self, const GList *ids); */
  G_CONST_RETURN GList * (* get_local_codecs) (FarsightStream *self);
  gboolean (* set_remote_codecs) (FarsightStream *self,
                              const GList *codecs);
  GList *(* get_codec_intersection) (FarsightStream *self);
  void (* set_codec_preference_list) (FarsightStream *self,
          const GArray *codec_pref);
  void (* set_active_codec) (FarsightStream *self, 
                             gint id);
  gint (* get_active_codec) (FarsightStream *self);
  gboolean (* set_sink) (FarsightStream *self, 
                         GstElement *sink);
  gboolean (* set_sink_filter) (FarsightStream *self, 
                         GstCaps *filter);
  GstElement * (* get_sink) (FarsightStream *self);
  gboolean (* set_source) (FarsightStream *self, 
                          GstElement *source);
  gboolean (* set_source_filter) (FarsightStream *self, 
                         GstCaps *filter);
  GstElement * (* get_source) (FarsightStream *self);
  gboolean (* start) (FarsightStream *self);
  void (* stop) (FarsightStream *self);
  gboolean (*set_sending) (FarsightStream *self, gboolean sending);
  
  gboolean (* start_telephony_event) (FarsightStream *self, 
                                      guint8 ev,
                                      guint8 volume,
                                      FarsightStreamDTMFMethod method);
  gboolean (* stop_telephony_event) (FarsightStream *self,
                                     FarsightStreamDTMFMethod method);

  gboolean (*preload_receive_pipeline) (FarsightStream *self,
                                        gint payload_type);

  gpointer _padding[1];         /* padding for binary-compatible expansion */
} FarsightStreamClass;

farsight_stream_prepare_transports ()

void        farsight_stream_prepare_transports
                                            (FarsightStream *self);

Prepare a stream for connection. This function should enumerate local interfaces, open any ports and determine external ip/ports (STUN), start relay server (TURN).

It should also set a callback function for taking appropriate action when a new local interface has been detected by connecting to signal new-native-candiate.

farsight_stream_add_remote_candidate ()

void        farsight_stream_add_remote_candidate
                                            (FarsightStream *self,
                                             const GList *remote_candidate);

Adds the given list of transports (forming one candidate) to the list of remote candidates

farsight_stream_get_native_candidate ()

GList*      farsight_stream_get_native_candidate
                                            (FarsightStream *self,
                                             const gchar *candidate_id);

Returns a specific native candidate

farsight_stream_get_native_candidate_list ()

const GList* farsight_stream_get_native_candidate_list
                                            (FarsightStream *self);

Get list of native candidates for this stream

farsight_stream_remove_remote_candidate ()

void        farsight_stream_remove_remote_candidate
                                            (FarsightStream *self,
                                             const gchar *remote_candidate_id);

Removes the given remote candidate from the remote candidate list

farsight_stream_set_remote_candidate_list ()

void        farsight_stream_set_remote_candidate_list
                                            (FarsightStream *self,
                                             const GList *remote_candidates);

Sets a list of remote candidates

farsight_stream_set_active_candidate_pair ()

gboolean    farsight_stream_set_active_candidate_pair
                                            (FarsightStream *self,
                                             const gchar *native_candidate_id,
                                             const gchar *remote_candidate_id);

Sets the given candidate pair as the active candidate pair, and emits the "new-active-candidate-pair" signal.

farsight_stream_set_remote_codecs ()

gboolean    farsight_stream_set_remote_codecs
                                            (FarsightStream *self,
                                             const GList *codecs);

Set the selection of codecs that the remote end claims to understand

farsight_stream_get_active_codec ()

gint        farsight_stream_get_active_codec
                                            (FarsightStream *self);

Get the codec to use for this stream.

farsight_stream_set_active_codec ()

void        farsight_stream_set_active_codec
                                            (FarsightStream *self,
                                             gint id);

Set the codec to use for this stream. There should now be enough information to build the pipeline.

farsight_stream_set_codec_preference_list ()

void        farsight_stream_set_codec_preference_list
                                            (FarsightStream *self,
                                             const GArray *codec_pref);

Set a list of prefered codecs (optional)

farsight_stream_get_local_codecs ()

const GList* farsight_stream_get_local_codecs
                                            (FarsightStream *self);

Get the selection of local codec ids to restrict this stream to using

farsight_stream_get_codec_intersection ()

GList*      farsight_stream_get_codec_intersection
                                            (FarsightStream *self);

Get the intersection of local and remote codecs.

farsight_stream_set_sink ()

gboolean    farsight_stream_set_sink        (FarsightStream *self,
                                             GstElement *sink);

Set the GStreamer sink for this stream. If sink is NULL it will block the incoming stream and remove the old sink. If called with a new sink it will replace the old one. If there is a user specified pipeline, the sink won't be added into the Farsight bin.

farsight_stream_get_sink ()

GstElement* farsight_stream_get_sink        (FarsightStream *self);

Get the GStreamer sink for this stream

farsight_stream_set_sink_filter ()

gboolean    farsight_stream_set_sink_filter (FarsightStream *self,
                                             GstCaps *filter);

Set the GStreamer sink link filter for this stream

farsight_stream_set_source ()

gboolean    farsight_stream_set_source      (FarsightStream *self,
                                             GstElement *source);

Set the GStreamer source for this stream. If the element does not have a parent, it will be added into the Farsight stream bin. So if you need to set a parent for the source, do it before calling this function.

farsight_stream_get_source ()

GstElement* farsight_stream_get_source      (FarsightStream *self);

Get the GStreamer source for this stream

farsight_stream_set_source_filter ()

gboolean    farsight_stream_set_source_filter
                                            (FarsightStream *self,
                                             GstCaps *filter);

Set the GStreamer source link filter for this stream

farsight_stream_get_pipeline ()

GstElement* farsight_stream_get_pipeline    (FarsightStream *self);

Get the FarsightStream working pipeline. This will return the pipeline set by the user or the pipeline created by Farsight if not set by the user.

farsight_stream_set_pipeline ()

gboolean    farsight_stream_set_pipeline    (FarsightStream *self,
                                             GstElement *pipeline);

This function is used if the user wants to create the GstPipeline himself. This means Farsight will use this pipeline instead of creating it's own. It will create a GstBin and insert it into the given pipeline. This is usefull when the user wants all the different Farsight streams to be part of the same global pipeline (i.e. Tee the same source to various streams) If the pipeline is set by the user, the sources will not be added into the Farsight bin.

NOTE: This has to be called before farsight_stream_prepare_transports() in order to be used.

farsight_stream_get_media_type ()

FarsightMediaType farsight_stream_get_media_type
                                            (FarsightStream *self);

Get the FarsightStream media type

farsight_stream_start ()

gboolean    farsight_stream_start           (FarsightStream *self);

Start the FarsightStream streaming to the network

farsight_stream_stop ()

void        farsight_stream_stop            (FarsightStream *self);

Stop the FarsightStream streaming to the network

farsight_stream_get_direction ()

FarsightStreamDirection farsight_stream_get_direction
                                            (FarsightStream *self);

Get the FarsightStream requested direction

farsight_stream_get_current_direction ()

FarsightStreamDirection farsight_stream_get_current_direction
                                            (FarsightStream *self);

Get the FarsightStream current direction

farsight_stream_get_state ()

FarsightStreamState farsight_stream_get_state
                                            (FarsightStream *self);

Get the current FarsightStream state

farsight_stream_signal_error ()

void        farsight_stream_signal_error    (FarsightStream *self,
                                             FarsightStreamError err,
                                             const gchar *mesg);

Used by subclasses of FarsightStream to emit an error signal

farsight_stream_signal_native_candidates_prepared ()

void        farsight_stream_signal_native_candidates_prepared
                                            (FarsightStream *self);

Used by subclasses of FarsightStream to emit an native-candidates-prepared signal

farsight_stream_signal_new_active_candidate_pair ()

void        farsight_stream_signal_new_active_candidate_pair
                                            (FarsightStream *self,
                                             const gchar *native_candidate_id,
                                             const gchar *remote_candidate_id);

Used by subclasses of FarsightStream to emit an new-active-candidate-pair signal

farsight_stream_signal_new_native_candidate ()

void        farsight_stream_signal_new_native_candidate
                                            (FarsightStream *self,
                                             const gchar *candidate_id);

Used by subclasses of FarsightStream to emit an new-native-candidate signal

farsight_stream_signal_codec_changed ()

void        farsight_stream_signal_codec_changed
                                            (FarsightStream *self,
                                             int codec_id);

Used by subclasses of FarsightStream to emit an codec-changed signal

farsight_stream_signal_state_changed ()

void        farsight_stream_signal_state_changed
                                            (FarsightStream *self,
                                             FarsightStreamState state,
                                             FarsightStreamDirection direction);

Used by subclasses of FarsightStream to emit an state-changed signal

farsight_stream_set_sending ()

gboolean    farsight_stream_set_sending     (FarsightStream *self,
                                             gboolean sending);

This function will tell Farsight to stop sending. This will block the source pad that is given to Farsight.

farsight_stream_start_telephony_event ()

gboolean    farsight_stream_start_telephony_event
                                            (FarsightStream *self,
                                             guint8 ev,
                                             guint8 volume);

This function will start sending a telephony event (such as a DTMF tone) on the FarsightStream, you have to call the function farsight_stream_stop_telephony_event() to stop it. This function will use any available method, if you want to use a specific method only, use farsight_stream_start_telephony_event_full()

farsight_stream_stop_telephony_event ()

gboolean    farsight_stream_stop_telephony_event
                                            (FarsightStream *self);

This function will stop sending a telephony event started by farsight_stream_start_telephony_event(). If the event was being sent for less than 50ms, it will be sent for 50ms minimum. If the duration was a positive and the event is not over, it will cut it short.

farsight_stream_start_telephony_event_full ()

gboolean    farsight_stream_start_telephony_event_full
                                            (FarsightStream *self,
                                             guint8 ev,
                                             guint8 volume,
                                             FarsightStreamDTMFMethod method);

This function will start sending a telephony event (such as a DTMF tone) on the FarsightStream, you have to call the function farsight_stream_stop_telephony_event_full() to stop it.

farsight_stream_stop_telephony_event_full ()

gboolean    farsight_stream_stop_telephony_event_full
                                            (FarsightStream *self,
                                             FarsightStreamDTMFMethod method);

This function will stop sending a telephony event started by farsight_stream_start_telephony_event_full(). If the event was being sent for less than 50ms, it will be sent for 50ms minimum. If the duration was a positive and the event is not over, it will cut it short. The type parameters has to be the same type that was passed to

farsight_stream_preload_receive_pipeline ()

gboolean    farsight_stream_preload_receive_pipeline
                                            (FarsightStream *self,
                                             gint payload_type);

This function will preload a codec instead of loading it when the first codec arrives. It is particularly useful with DSP and other slow to load and initialise codecs. It must be called after farsight_stream_set_remote_codecs().

The "direction" property

  "direction"            guint                 : Read / Write / Construct Only

The direction of this stream. This should only be set at stream creation time.

Allowed values: <= 4

Default value: 3

The "media-type" property

  "media-type"           guint                 : Read / Write / Construct Only

The media type to be used by this stream specifed by FarsightMediaType.

Allowed values: <= 1

Default value: 0

The "codec-changed" signal

void        user_function                  (FarsightStream *self,
                                            gint            codec_id,
                                            gpointer        user_data)      : Run last

emitted if we automatically choose a new codec for some reason (e.g. high packet loss)

The "error" signal

void        user_function                  (FarsightStream *self,
                                            gint            type,
                                            gchar          *message,
                                            gpointer        user_data)      : Run last

This signal is emitted in any error condition

The "native-candidates-prepared" signal

void        user_function                  (FarsightStream *self,
                                            gpointer        user_data)      : Run last

This signal is emitted when the native candidates have been prepared. This usually means all of the local ports have been opened, local interfaces have been found, and/or external ports have been found, and/or relay server has been setup, or anything else the protocol needs. After emission of this signal, farsight_stream_get_native_candidate_list should return meaningful data

The "new-active-candidate-pair" signal

void        user_function                  (FarsightStream *self,
                                            gchar          *native_candidate_id,
                                            gchar          *remote_candidate_id,
                                            gpointer        user_data)                : Run last

Emitted when this FarsightStream has chosen a new active candidate pair to use to connect to the remote client.

The "new-native-candidate" signal

void        user_function                  (FarsightStream *self,
                                            gchar          *candidate_id,
                                            gpointer        user_data)         : Run last

This signal is emitted when the a new native candidate is found. After emission of this signal, farsight_stream_get_native_candidates should return meaningful data. This does not mean that the candidate has been prepared.

The "sink-pad-ready" signal

void        user_function                  (FarsightStream *self,
                                            gpointer        pad,
                                            gpointer        user_data)      : Run last

This signal is emitted when a sink pad has been created on the Farsight stream bin.

Note : This signal is only valid when a user-defined pipeline has been provided by the user to farsight using farsight_stream_set_pipeline.

The "state-changed" signal

void        user_function                  (FarsightStream *self,
                                            gint            state,
                                            gint            direction,
                                            gpointer        user_data)      : Run last

This signal is emitted when we change FarsightStreamState.