candidate.c 7.22 KB
Newer Older
1 2 3
/*
 * This file is part of the Nice GLib ICE library.
 *
4 5 6
 * (C) 2006-2009 Collabora Ltd.
 *  Contact: Youness Alaoui
 * (C) 2006-2009 Nokia Corporation. All rights reserved.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *  Contact: Kai Vehmanen
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Nice GLib ICE library.
 *
 * The Initial Developers of the Original Code are Collabora Ltd and Nokia
 * Corporation. All Rights Reserved.
 *
 * Contributors:
 *   Dafydd Harries, Collabora Ltd.
26
 *   Youness Alaoui, Collabora Ltd.
27
 *   Kai Vehmanen, Nokia
28 29 30 31 32 33 34 35 36 37 38
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of LGPL are applicable instead of those above. If you
 * wish to allow use of your version of this file only under the terms of the
 * LGPL and not to allow others to use your version of this file under the
 * MPL, indicate your decision by deleting the provisions above and replace
 * them with the notice and other provisions required by the LGPL. If you do
 * not delete the provisions above, a recipient may use your version of this
 * file under either the MPL or the LGPL.
 */
Dafydd Harries's avatar
Dafydd Harries committed
39

40
/*
41 42 43 44 45 46
 * @file candidate.c
 * @brief ICE candidate functions
 */

#ifdef HAVE_CONFIG_H
# include <config.h>
47 48
#else
#define NICEAPI_EXPORT
49 50
#endif

51 52
#include <string.h>

Dafydd Harries's avatar
Dafydd Harries committed
53
#include "agent.h"
54
#include "component.h"
Dafydd Harries's avatar
Dafydd Harries committed
55

Kai Vehmanen's avatar
Kai Vehmanen committed
56 57 58
/* (ICE 4.1.1 "Gathering Candidates") ""Every candidate is a transport
 * address. It also has a type and a base. Three types are defined and 
 * gathered by this specification - host candidates, server reflexive 
59
 * candidates, and relayed candidates."" (ID-19) */
Dafydd Harries's avatar
Dafydd Harries committed
60

61
NICEAPI_EXPORT NiceCandidate *
62
nice_candidate_new (NiceCandidateType type)
Dafydd Harries's avatar
Dafydd Harries committed
63
{
64
  NiceCandidate *candidate;
Dafydd Harries's avatar
Dafydd Harries committed
65

66
  candidate = g_slice_new0 (NiceCandidate);
Dafydd Harries's avatar
Dafydd Harries committed
67 68 69 70 71
  candidate->type = type;
  return candidate;
}


72
NICEAPI_EXPORT void
73
nice_candidate_free (NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
74
{
75 76
  /* better way of checking if socket is allocated? */

77 78 79 80 81 82
  if (candidate->username)
    g_free (candidate->username);

  if (candidate->password)
    g_free (candidate->password);

83 84 85
  if (candidate->turn)
    turn_server_unref (candidate->turn);

86
  g_slice_free (NiceCandidate, candidate);
Dafydd Harries's avatar
Dafydd Harries committed
87 88 89
}


90
guint32
91
nice_candidate_jingle_priority (NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
92 93 94
{
  switch (candidate->type)
    {
95 96 97 98
    case NICE_CANDIDATE_TYPE_HOST:             return 1000;
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE: return 900;
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:   return 900;
    case NICE_CANDIDATE_TYPE_RELAYED:          return 500;
99
    default:                                   return 0;
Dafydd Harries's avatar
Dafydd Harries committed
100 101 102
    }
}

103
guint32
104 105 106 107
nice_candidate_msn_priority (NiceCandidate *candidate)
{
  switch (candidate->type)
    {
108 109 110 111
    case NICE_CANDIDATE_TYPE_HOST:             return 830;
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE: return 550;
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:   return 550;
    case NICE_CANDIDATE_TYPE_RELAYED:          return 450;
112
    default:                                   return 0;
113 114 115
    }
}

Dafydd Harries's avatar
Dafydd Harries committed
116

117
/*
118
 * ICE 4.1.2.1. "Recommended Formula" (ID-19):
Kai Vehmanen's avatar
Kai Vehmanen committed
119 120
 * returns number between 1 and 0x7effffff 
 */
121
guint32
122
nice_candidate_ice_priority_full (
Dafydd Harries's avatar
Dafydd Harries committed
123 124 125 126
  // must be ∈ (0, 126) (max 2^7 - 2)
  guint type_preference,
  // must be ∈ (0, 65535) (max 2^16 - 1)
  guint local_preference,
127
  // must be ∈ (0, 255) (max 2 ^ 8 - 1)
Dafydd Harries's avatar
Dafydd Harries committed
128 129 130 131 132 133 134 135
  guint component_id)
{
  return (
      0x1000000 * type_preference +
      0x100 * local_preference +
      (0x100 - component_id));
}

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
static guint32
nice_candidate_ice_local_priority_full (guint direction_preference,
    guint other_preference)
{
  return (0x2000 * direction_preference +
      other_preference);
}

static guint16
nice_candidate_ice_local_priority (const NiceCandidate *candidate)
{
  guint direction_preference;

  switch (candidate->transport)
    {
      case NICE_CANDIDATE_TRANSPORT_TCP_ACTIVE:
        if (candidate->type == NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE ||
            candidate->type == NICE_CANDIDATE_TYPE_PREF_NAT_ASSISTED)
          direction_preference = 4;
        else
          direction_preference = 6;
        break;
      case NICE_CANDIDATE_TRANSPORT_TCP_PASSIVE:
        if (candidate->type == NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE ||
            candidate->type == NICE_CANDIDATE_TYPE_PREF_NAT_ASSISTED)
          direction_preference = 2;
        else
          direction_preference = 4;
        break;
      case NICE_CANDIDATE_TRANSPORT_TCP_SO:
        if (candidate->type == NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE ||
            candidate->type == NICE_CANDIDATE_TYPE_PREF_NAT_ASSISTED)
          direction_preference = 6;
        else
          direction_preference = 2;
        break;
      case NICE_CANDIDATE_TRANSPORT_UDP:
      default:
        return 1;
        break;
    }

  return nice_candidate_ice_local_priority_full (direction_preference, 1);
}
Dafydd Harries's avatar
Dafydd Harries committed
180

181
guint32
182 183
nice_candidate_ice_priority (const NiceCandidate *candidate,
    gboolean reliable, gboolean nat_assisted)
Dafydd Harries's avatar
Dafydd Harries committed
184
{
185
  guint8 type_preference;
186
  guint16 local_preference;
Dafydd Harries's avatar
Dafydd Harries committed
187 188 189

  switch (candidate->type)
    {
Youness Alaoui's avatar
Youness Alaoui committed
190
    case NICE_CANDIDATE_TYPE_HOST:
191 192
      type_preference = NICE_CANDIDATE_TYPE_PREF_HOST;
      break;
Youness Alaoui's avatar
Youness Alaoui committed
193
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:
194 195
      type_preference = NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE;
      break;
196
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE:
197 198 199 200 201
      if (nat_assisted)
        type_preference = NICE_CANDIDATE_TYPE_PREF_NAT_ASSISTED;
      else
        type_preference = NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE;
      break;
Youness Alaoui's avatar
Youness Alaoui committed
202
    case NICE_CANDIDATE_TYPE_RELAYED:
203 204
      type_preference = NICE_CANDIDATE_TYPE_PREF_RELAYED;
      break;
205
    default:
206 207
      type_preference = 0;
      break;
Dafydd Harries's avatar
Dafydd Harries committed
208 209
    }

210 211 212
  if ((reliable && candidate->transport == NICE_CANDIDATE_TRANSPORT_UDP) ||
      (!reliable && candidate->transport != NICE_CANDIDATE_TRANSPORT_UDP)) {
    type_preference = type_preference / 2;
213 214 215 216 217
  }
  local_preference = nice_candidate_ice_local_priority (candidate);

  return nice_candidate_ice_priority_full (type_preference, local_preference,
      candidate->component_id);
Dafydd Harries's avatar
Dafydd Harries committed
218 219
}

220
/*
Youness Alaoui's avatar
Youness Alaoui committed
221
 * Calculates the pair priority as specified in ICE
222
 * sect 5.7.2. "Computing Pair Priority and Ordering Pairs" (ID-19).
223
 */
224
guint64
225 226 227 228
nice_candidate_pair_priority (guint32 o_prio, guint32 a_prio)
{
  guint32 max = o_prio > a_prio ? o_prio : a_prio;
  guint32 min = o_prio < a_prio ? o_prio : a_prio;
229 230 231
  /* These two constants are here explictly to make some version of GCC happy */
  const guint64 one = 1;
  const guint64 thirtytwo = 32;
232

233
  return (one << thirtytwo) * min + 2 * max + (o_prio > a_prio ? 1 : 0);
234
}
235

236
/*
237 238 239 240 241 242 243 244 245
 * Copies a candidate
 */
NICEAPI_EXPORT NiceCandidate *
nice_candidate_copy (const NiceCandidate *candidate)
{
  NiceCandidate *copy = nice_candidate_new (candidate->type);

  memcpy (copy, candidate, sizeof(NiceCandidate));

246
  copy->turn = NULL;
247 248 249 250 251
  copy->username = g_strdup (copy->username);
  copy->password = g_strdup (copy->password);

  return copy;
}