Mercurial > pidgin
view libpurple/media.h @ 30666:735418d84442
Allow parsing info about ourselves from a UBX payload. This is probably not
entirely correct, as it may or may not get looped when we change one of
these settings ourselves.
author | Elliott Sales de Andrade <qulogic@pidgin.im> |
---|---|
date | Wed, 09 Dec 2009 21:48:07 +0000 |
parents | 713987ae3215 |
children | 2b9983e5cb8d c52dbc5503d0 |
line wrap: on
line source
/** * @file media.h Media API * @ingroup core */ /* purple * * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef _PURPLE_MEDIA_H_ #define _PURPLE_MEDIA_H_ #include <glib.h> #include <glib-object.h> G_BEGIN_DECLS #define PURPLE_TYPE_MEDIA_CANDIDATE (purple_media_candidate_get_type()) #define PURPLE_MEDIA_CANDIDATE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate)) #define PURPLE_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate)) #define PURPLE_IS_MEDIA_CANDIDATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_CANDIDATE)) #define PURPLE_IS_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_CANDIDATE)) #define PURPLE_MEDIA_CANDIDATE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate)) #define PURPLE_TYPE_MEDIA_CODEC (purple_media_codec_get_type()) #define PURPLE_MEDIA_CODEC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec)) #define PURPLE_MEDIA_CODEC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec)) #define PURPLE_IS_MEDIA_CODEC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_CODEC)) #define PURPLE_IS_MEDIA_CODEC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_CODEC)) #define PURPLE_MEDIA_CODEC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec)) #define PURPLE_TYPE_MEDIA_SESSION_TYPE (purple_media_session_type_get_type()) #define PURPLE_TYPE_MEDIA (purple_media_get_type()) #define PURPLE_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA, PurpleMedia)) #define PURPLE_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA, PurpleMediaClass)) #define PURPLE_IS_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA)) #define PURPLE_IS_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA)) #define PURPLE_MEDIA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA, PurpleMediaClass)) #define PURPLE_TYPE_MEDIA_CANDIDATE_TYPE (purple_media_candidate_type_get_type()) #define PURPLE_TYPE_MEDIA_NETWORK_PROTOCOL (purple_media_network_protocol_get_type()) #define PURPLE_MEDIA_TYPE_STATE (purple_media_state_changed_get_type()) #define PURPLE_MEDIA_TYPE_INFO_TYPE (purple_media_info_type_get_type()) /** An opaque structure representing a media call. */ typedef struct _PurpleMedia PurpleMedia; /** An opaque structure representing a network candidate (IP Address and port pair). */ typedef struct _PurpleMediaCandidate PurpleMediaCandidate; /** An opaque structure representing an audio or video codec. */ typedef struct _PurpleMediaCodec PurpleMediaCodec; /** Media caps */ typedef enum { PURPLE_MEDIA_CAPS_NONE = 0, PURPLE_MEDIA_CAPS_AUDIO = 1, PURPLE_MEDIA_CAPS_AUDIO_SINGLE_DIRECTION = 1 << 1, PURPLE_MEDIA_CAPS_VIDEO = 1 << 2, PURPLE_MEDIA_CAPS_VIDEO_SINGLE_DIRECTION = 1 << 3, PURPLE_MEDIA_CAPS_AUDIO_VIDEO = 1 << 4, PURPLE_MEDIA_CAPS_MODIFY_SESSION = 1 << 5, PURPLE_MEDIA_CAPS_CHANGE_DIRECTION = 1 << 6, } PurpleMediaCaps; /** Media session types */ typedef enum { PURPLE_MEDIA_NONE = 0, PURPLE_MEDIA_RECV_AUDIO = 1 << 0, PURPLE_MEDIA_SEND_AUDIO = 1 << 1, PURPLE_MEDIA_RECV_VIDEO = 1 << 2, PURPLE_MEDIA_SEND_VIDEO = 1 << 3, PURPLE_MEDIA_AUDIO = PURPLE_MEDIA_RECV_AUDIO | PURPLE_MEDIA_SEND_AUDIO, PURPLE_MEDIA_VIDEO = PURPLE_MEDIA_RECV_VIDEO | PURPLE_MEDIA_SEND_VIDEO } PurpleMediaSessionType; /** Media state-changed types */ typedef enum { PURPLE_MEDIA_STATE_NEW = 0, PURPLE_MEDIA_STATE_CONNECTED, PURPLE_MEDIA_STATE_END, } PurpleMediaState; /** Media info types */ typedef enum { PURPLE_MEDIA_INFO_HANGUP = 0, PURPLE_MEDIA_INFO_ACCEPT, PURPLE_MEDIA_INFO_REJECT, PURPLE_MEDIA_INFO_MUTE, PURPLE_MEDIA_INFO_UNMUTE, PURPLE_MEDIA_INFO_PAUSE, PURPLE_MEDIA_INFO_UNPAUSE, PURPLE_MEDIA_INFO_HOLD, PURPLE_MEDIA_INFO_UNHOLD, } PurpleMediaInfoType; typedef enum { PURPLE_MEDIA_CANDIDATE_TYPE_HOST, PURPLE_MEDIA_CANDIDATE_TYPE_SRFLX, PURPLE_MEDIA_CANDIDATE_TYPE_PRFLX, PURPLE_MEDIA_CANDIDATE_TYPE_RELAY, PURPLE_MEDIA_CANDIDATE_TYPE_MULTICAST, } PurpleMediaCandidateType; typedef enum { PURPLE_MEDIA_COMPONENT_NONE = 0, PURPLE_MEDIA_COMPONENT_RTP = 1, PURPLE_MEDIA_COMPONENT_RTCP = 2, } PurpleMediaComponentType; typedef enum { PURPLE_MEDIA_NETWORK_PROTOCOL_UDP, PURPLE_MEDIA_NETWORK_PROTOCOL_TCP, } PurpleMediaNetworkProtocol; #include "signals.h" #include "util.h" #ifdef __cplusplus extern "C" { #endif /** * Gets the media session type's GType * * @return The media session type's GType. * * @since 2.6.0 */ GType purple_media_session_type_get_type(void); /** * Gets the media candidate type's GType * * @return The media candidate type's GType. * * @since 2.6.0 */ GType purple_media_candidate_type_get_type(void); /** * Gets the media network protocol's GType * * @return The media network protocol's GType. * * @since 2.6.0 */ GType purple_media_network_protocol_get_type(void); /** * Gets the media class's GType * * @return The media class's GType. * * @since 2.6.0 */ GType purple_media_get_type(void); /** * Gets the type of the state-changed enum * * @return The state-changed enum's GType * * @since 2.6.0 */ GType purple_media_state_changed_get_type(void); /** * Gets the type of the info type enum * * @return The info type enum's GType * * @since 2.6.0 */ GType purple_media_info_type_get_type(void); /** * Gets the type of the media candidate structure. * * @return The media canditate's GType * * @since 2.6.0 */ GType purple_media_candidate_get_type(void); /** * Creates a PurpleMediaCandidate instance. * * @param foundation The foundation of the candidate. * @param component_id The component this candidate is for. * @param type The type of candidate. * @param proto The protocol this component is for. * @param ip The IP address of this component. * @param port The network port. * * @return The newly created PurpleMediaCandidate instance. * * @since 2.6.0 */ PurpleMediaCandidate *purple_media_candidate_new( const gchar *foundation, guint component_id, PurpleMediaCandidateType type, PurpleMediaNetworkProtocol proto, const gchar *ip, guint port); /** * Copies a GList of PurpleMediaCandidate and its contents. * * @param candidates The list of candidates to be copied. * * @return The copy of the GList. * * @since 2.6.0 */ GList *purple_media_candidate_list_copy(GList *candidates); /** * Frees a GList of PurpleMediaCandidate and its contents. * * @param candidates The list of candidates to be freed. * * @since 2.6.0 */ void purple_media_candidate_list_free(GList *candidates); gchar *purple_media_candidate_get_foundation(PurpleMediaCandidate *candidate); guint purple_media_candidate_get_component_id(PurpleMediaCandidate *candidate); gchar *purple_media_candidate_get_ip(PurpleMediaCandidate *candidate); guint16 purple_media_candidate_get_port(PurpleMediaCandidate *candidate); gchar *purple_media_candidate_get_base_ip(PurpleMediaCandidate *candidate); guint16 purple_media_candidate_get_base_port(PurpleMediaCandidate *candidate); PurpleMediaNetworkProtocol purple_media_candidate_get_protocol( PurpleMediaCandidate *candidate); guint32 purple_media_candidate_get_priority(PurpleMediaCandidate *candidate); PurpleMediaCandidateType purple_media_candidate_get_candidate_type( PurpleMediaCandidate *candidate); gchar *purple_media_candidate_get_username(PurpleMediaCandidate *candidate); gchar *purple_media_candidate_get_password(PurpleMediaCandidate *candidate); guint purple_media_candidate_get_ttl(PurpleMediaCandidate *candidate); /** * Gets the type of the media codec structure. * * @return The media codec's GType * * @since 2.6.0 */ GType purple_media_codec_get_type(void); /** * Creates a new PurpleMediaCodec instance. * * @param id Codec identifier. * @param encoding_name Name of the media type this encodes. * @param media_type PurpleMediaSessionType of this codec. * @param clock_rate The clock rate this codec encodes at, if applicable. * * @return The newly created PurpleMediaCodec. * * @since 2.6.0 */ PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name, PurpleMediaSessionType media_type, guint clock_rate); guint purple_media_codec_get_id(PurpleMediaCodec *codec); gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec); guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec); guint purple_media_codec_get_channels(PurpleMediaCodec *codec); GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec); /** * Creates a string representation of the codec. * * @param codec The codec to create the string of. * * @return The new string representation. * * @since 2.6.0 */ gchar *purple_media_codec_to_string(const PurpleMediaCodec *codec); /** * Adds an optional parameter to the codec. * * @param codec The codec to add the parameter to. * @param name The name of the parameter to add. * @param value The value of the parameter to add. * * @since 2.6.0 */ void purple_media_codec_add_optional_parameter(PurpleMediaCodec *codec, const gchar *name, const gchar *value); /** * Removes an optional parameter from the codec. * * @param codec The codec to remove the parameter from. * @param param A pointer to the parameter to remove. * * @since 2.6.0 */ void purple_media_codec_remove_optional_parameter(PurpleMediaCodec *codec, PurpleKeyValuePair *param); /** * Gets an optional parameter based on the values given. * * @param codec The codec to find the parameter in. * @param name The name of the parameter to search for. * @param value The value to search for or NULL. * * @return The value found or NULL. * * @since 2.6.0 */ PurpleKeyValuePair *purple_media_codec_get_optional_parameter( PurpleMediaCodec *codec, const gchar *name, const gchar *value); /** * Copies a GList of PurpleMediaCodec and its contents. * * @param codecs The list of codecs to be copied. * * @return The copy of the GList. * * @since 2.6.0 */ GList *purple_media_codec_list_copy(GList *codecs); /** * Frees a GList of PurpleMediaCodec and its contents. * * @param codecs The list of codecs to be freed. * * @since 2.6.0 */ void purple_media_codec_list_free(GList *codecs); /** * Gets a list of session IDs. * * @param media The media session from which to retrieve session IDs. * * @return GList of session IDs. The caller must free the list. * * @since 2.6.0 */ GList *purple_media_get_session_ids(PurpleMedia *media); /** * Gets the PurpleAccount this media session is on. * * @param media The media session to retrieve the account from. * * @return The account retrieved. * * @since 2.6.0 */ PurpleAccount *purple_media_get_account(PurpleMedia *media); /** * Gets the prpl data from the media session. * * @param media The media session to retrieve the prpl data from. * * @return The prpl data retrieved. * * @since 2.6.0 */ gpointer purple_media_get_prpl_data(PurpleMedia *media); /** * Sets the prpl data on the media session. * * @param media The media session to set the prpl data on. * @param prpl_data The data to set on the media session. * * @since 2.6.0 */ void purple_media_set_prpl_data(PurpleMedia *media, gpointer prpl_data); /** * Signals an error in the media session. * * @param media The media object to set the state on. * @param error The format of the error message to send in the signal. * @param ... The arguments to plug into the format. * * @since 2.6.0 */ void purple_media_error(PurpleMedia *media, const gchar *error, ...); /** * Ends all streams that match the given parameters * * @param media The media object with which to end streams. * @param session_id The session to end streams on. * @param participant The participant to end streams with. * * @since 2.6.0 */ void purple_media_end(PurpleMedia *media, const gchar *session_id, const gchar *participant); /** * Signals different information about the given stream. * * @param media The media instance to containing the stream to signal. * @param type The type of info being signaled. * @param session_id The id of the session of the stream being signaled. * @param participant The participant of the stream being signaled. * @param local TRUE if the info originated locally, FALSE if on the remote end. * * @since 2.6.0 */ void purple_media_stream_info(PurpleMedia *media, PurpleMediaInfoType type, const gchar *session_id, const gchar *participant, gboolean local); /** * Adds a stream to a session. * * It only adds a stream to one audio session or video session as * the @c sess_id must be unique between sessions. * * @param media The media object to find the session in. * @param sess_id The session id of the session to add the stream to. * @param who The name of the remote user to add the stream for. * @param type The type of stream to create. * @param initiator Whether or not the local user initiated the stream. * @param transmitter The transmitter to use for the stream. * @param num_params The number of parameters to pass to Farsight. * @param params The parameters to pass to Farsight. * * @return @c TRUE The stream was added successfully, @c FALSE otherwise. * * @since 2.6.0 */ gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id, const gchar *who, PurpleMediaSessionType type, gboolean initiator, const gchar *transmitter, guint num_params, GParameter *params); /** * Gets the session type from a session * * @param media The media object to find the session in. * @param sess_id The session id of the session to get the type from. * * @return The retreived session type. * * @since 2.6.0 */ PurpleMediaSessionType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id); /** * Gets the PurpleMediaManager this media session is a part of. * * @param media The media object to get the manager instance from. * * @return The PurpleMediaManager instance retrieved. * * @since 2.6.0 */ struct _PurpleMediaManager *purple_media_get_manager(PurpleMedia *media); /** * Gets the codecs from a session. * * @param media The media object to find the session in. * @param sess_id The session id of the session to get the codecs from. * * @return The retreieved codecs. * * @since 2.6.0 */ GList *purple_media_get_codecs(PurpleMedia *media, const gchar *sess_id); /** * Adds remote candidates to the stream. * * @param media The media object to find the session in. * @param sess_id The session id of the session find the stream in. * @param participant The name of the remote user to add the candidates for. * @param remote_candidates The remote candidates to add. * * @since 2.6.0 */ void purple_media_add_remote_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *remote_candidates); /** * Gets the local candidates from a stream. * * @param media The media object to find the session in. * @param sess_id The session id of the session to find the stream in. * @param participant The name of the remote user to get the candidates from. * * @since 2.6.0 */ GList *purple_media_get_local_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant); #if 0 /* * These two functions aren't being used and I'd rather not lock in the API * until they are needed. If they ever are. */ /** * Gets the active local candidates for the stream. * * @param media The media object to find the session in. * @param sess_id The session id of the session to find the stream in. * @param participant The name of the remote user to get the active candidate * from. * * @return The active candidates retrieved. */ GList *purple_media_get_active_local_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant); /** * Gets the active remote candidates for the stream. * * @param media The media object to find the session in. * @param sess_id The session id of the session to find the stream in. * @param participant The name of the remote user to get the remote candidate * from. * * @return The remote candidates retrieved. */ GList *purple_media_get_active_remote_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant); #endif /** * Sets remote candidates from the stream. * * @param media The media object to find the session in. * @param sess_id The session id of the session find the stream in. * @param participant The name of the remote user to set the candidates from. * @param codecs The list of remote codecs to set. * * @return @c TRUE The codecs were set successfully, or @c FALSE otherwise. * * @since 2.6.0 */ gboolean purple_media_set_remote_codecs(PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *codecs); /** * Returns whether or not the candidates for set of streams are prepared * * @param media The media object to find the remote user in. * @param session_id The session id of the session to check. * @param participant The remote user to check for. * * @return @c TRUE All streams for the given session_id/participant combination have candidates prepared, @c FALSE otherwise. * * @since 2.6.0 */ gboolean purple_media_candidates_prepared(PurpleMedia *media, const gchar *session_id, const gchar *participant); /** * Sets the send codec for the a session. * * @param media The media object to find the session in. * @param sess_id The session id of the session to set the codec for. * @param codec The codec to set the session to stream. * * @return @c TRUE The codec was successfully changed, or @c FALSE otherwise. * * @since 2.6.0 */ gboolean purple_media_set_send_codec(PurpleMedia *media, const gchar *sess_id, PurpleMediaCodec *codec); /** * Gets whether a session's codecs are ready to be used. * * @param media The media object to find the session in. * @param sess_id The session id of the session to check. * * @return @c TRUE The codecs are ready, or @c FALSE otherwise. * * @since 2.6.0 */ gboolean purple_media_codecs_ready(PurpleMedia *media, const gchar *sess_id); /** * Gets whether the local user is the conference/session/stream's initiator. * * @param media The media instance to find the session in. * @param sess_id The session id of the session to check. * @param participant The participant of the stream to check. * * @return TRUE if the local user is the stream's initator, else FALSE. * * @since 2.6.0 */ gboolean purple_media_is_initiator(PurpleMedia *media, const gchar *sess_id, const gchar *participant); /** * Gets whether a streams selected have been accepted. * * @param media The media object to find the session in. * @param sess_id The session id of the session to check. * @param participant The participant to check. * * @return @c TRUE The selected streams have been accepted, or @c FALSE otherwise. * * @since 2.6.0 */ gboolean purple_media_accepted(PurpleMedia *media, const gchar *sess_id, const gchar *participant); /** * Sets the input volume of all the selected sessions. * * @param media The media object the sessions are in. * @param session_id The session to select (if any). * @param level The level to set the volume to. * * @since 2.6.0 */ void purple_media_set_input_volume(PurpleMedia *media, const gchar *session_id, double level); /** * Sets the output volume of all the selected streams. * * @param media The media object the streams are in. * @param session_id The session to limit the streams to (if any). * @param participant The participant to limit the streams to (if any). * @param level The level to set the volume to. * * @since 2.6.0 */ void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id, const gchar *participant, double level); /** * Sets a video output window for the given session/stream. * * @param media The media instance to set the output window on. * @param session_id The session to set the output window on. * @param participant Optionally, the participant to set the output window on. * @param window_id The window id use for embedding the video in. * * @return An id to reference the output window. * * @since 2.6.0 */ gulong purple_media_set_output_window(PurpleMedia *media, const gchar *session_id, const gchar *participant, gulong window_id); /** * Removes all output windows from a given media session. * * @param media The instance to remove all output windows from. * * @since 2.6.0 */ void purple_media_remove_output_windows(PurpleMedia *media); #ifdef __cplusplus } #endif G_END_DECLS #endif /* _PURPLE_MEDIA_H_ */