candidate.c 5.17 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
  g_slice_free (NiceCandidate, candidate);
Dafydd Harries's avatar
Dafydd Harries committed
84 85 86
}


87
guint32
88
nice_candidate_jingle_priority (NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
89 90 91
{
  switch (candidate->type)
    {
92 93 94 95
    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;
Dafydd Harries's avatar
Dafydd Harries committed
96 97 98 99 100 101
    }

  /* appease GCC */
  return 0;
}

102
guint32
103 104 105 106
nice_candidate_msn_priority (NiceCandidate *candidate)
{
  switch (candidate->type)
    {
107 108 109 110
    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;
111 112 113 114 115 116
    }

  /* appease GCC */
  return 0;
}

Dafydd Harries's avatar
Dafydd Harries committed
117

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


138
guint32
139
nice_candidate_ice_priority (const NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
140 141 142 143 144
{
  guint8 type_preference = 0;

  switch (candidate->type)
    {
Youness Alaoui's avatar
Youness Alaoui committed
145
    case NICE_CANDIDATE_TYPE_HOST:
146
      type_preference = NICE_CANDIDATE_TYPE_PREF_HOST; break;
Youness Alaoui's avatar
Youness Alaoui committed
147
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:
148 149 150
      type_preference = NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE; break;
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE:
      type_preference = NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE; break;
Youness Alaoui's avatar
Youness Alaoui committed
151
    case NICE_CANDIDATE_TYPE_RELAYED:
152
      type_preference = NICE_CANDIDATE_TYPE_PREF_RELAYED; break;
Dafydd Harries's avatar
Dafydd Harries committed
153 154
    }

155 156
  /* return _candidate_ice_priority (type_preference, 1, candidate->component_id); */
  return nice_candidate_ice_priority_full (type_preference, 1, candidate->component_id);
Dafydd Harries's avatar
Dafydd Harries committed
157 158
}

159
/*
Youness Alaoui's avatar
Youness Alaoui committed
160
 * Calculates the pair priority as specified in ICE
161
 * sect 5.7.2. "Computing Pair Priority and Ordering Pairs" (ID-19).
162
 */
163
guint64
164 165 166 167 168 169 170
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;

  return ((guint64)1 << 32) * min + 2 * max + (o_prio > a_prio ? 1 : 0);
}
171

172
/*
173 174 175 176 177 178 179 180 181 182 183 184 185 186
 * Copies a candidate
 */
NICEAPI_EXPORT NiceCandidate *
nice_candidate_copy (const NiceCandidate *candidate)
{
  NiceCandidate *copy = nice_candidate_new (candidate->type);

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

  copy->username = g_strdup (copy->username);
  copy->password = g_strdup (copy->password);

  return copy;
}