src/core/sdpmsg.h

   1 /**
   2  * @file sdpmsg.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2014-2017 SIPE Project <http://sipe.sourceforge.net/>
   7  * Copyright (C) 2010 Jakub Adam <jakub.adam@ktknet.cz>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program 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
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 struct sdpmsg {
  25         gchar           *ip;    /* currently this has to be an IPv4 address */
  26         GSList          *media;
  27         SipeIceVersion   ice_version;
  28 };
  29
  30 struct sdpmedia {
  31         gchar           *name;
  32         gchar           *ip;    /* currently this has to be an IPv4 address */
  33         guint            port;
  34
  35         GSList          *attributes;
  36         GSList          *candidates;
  37         GSList          *codecs;
  38         GSList          *remote_candidates;
  39
  40         guchar          *encryption_key;
  41         int              encryption_key_id;
  42         gboolean         encryption_active;
  43 };
  44
  45 struct sdpcandidate {
  46         gchar                   *foundation;
  47         SipeComponentType        component;
  48         SipeCandidateType        type;
  49         SipeNetworkProtocol      protocol;
  50         guint32                  priority;
  51         gchar                   *ip; /* currently this has to be an IPv4 address */
  52         guint                    port;
  53         gchar                   *base_ip;
  54         guint                    base_port;
  55         gchar                   *username;
  56         gchar                   *password;
  57 };
  58
  59 struct sdpcodec {
  60         gint             id;
  61         gchar           *name;
  62         gint             clock_rate;
  63         gint             channels;
  64         SipeMediaType    type;
  65         GSList          *parameters;
  66 };
  67
  68 /**
  69  * Parses SDP message into @c sdpmsg structure.
  70  *
  71  * @param msg SDP message as character string
  72  *
  73  * @return New @c sdpmsg or NULL if message can not be parsed.
  74  */
  75 struct sdpmsg *sdpmsg_parse_msg(const gchar *msg);
  76
  77 /**
  78  * Creates a SDP message from the @c sdpmsg structure.
  79  *
  80  * @param msg a @c sdpmsg
  81  *
  82  * @return SDP message as a character string that must be g_free'd after use.
  83  */
  84 gchar *sdpmsg_to_string(const struct sdpmsg *msg);
  85
  86 /**
  87  * Deallocates @c sdpmsg.
  88  */
  89 void sdpmsg_free(struct sdpmsg *msg);
  90
  91 /**
  92  * Deallocates @c sdpcandidate.
  93  */
  94 void sdpcandidate_free(struct sdpcandidate *candidate);
  95
  96 /**
  97  * Deallocates @c sdpcodec.
  98  */
  99 void sdpcodec_free(struct sdpcodec *codec);
 100
 101 /**
 102  * Deallocates @c sdpmedia.
 103  */
 104 void sdpmedia_free(struct sdpmedia *media);