candidate.c 5.22 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * This file is part of the Nice GLib ICE library.
 *
 * (C) 2006, 2007 Collabora Ltd.
 *  Contact: Dafydd Harries
 * (C) 2006, 2007 Nokia Corporation. All rights reserved.
 *  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
 *   Kai Vehmanen, Nokia
27 28 29 30 31 32 33 34 35 36 37
 *
 * 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
38

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

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif

48 49
#include <string.h>

Dafydd Harries's avatar
Dafydd Harries committed
50
#include "agent.h"
51
#include "component.h"
Dafydd Harries's avatar
Dafydd Harries committed
52

Kai Vehmanen's avatar
Kai Vehmanen committed
53 54 55
/* (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 
56
 * candidates, and relayed candidates."" (ID-19) */
Dafydd Harries's avatar
Dafydd Harries committed
57

58
NICEAPI_EXPORT NiceCandidate *
59
nice_candidate_new (NiceCandidateType type)
Dafydd Harries's avatar
Dafydd Harries committed
60
{
61
  NiceCandidate *candidate;
Dafydd Harries's avatar
Dafydd Harries committed
62

63
  candidate = g_slice_new0 (NiceCandidate);
Dafydd Harries's avatar
Dafydd Harries committed
64 65 66 67 68
  candidate->type = type;
  return candidate;
}


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

74 75 76 77 78 79
  if (candidate->username)
    g_free (candidate->username);

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

80
  g_slice_free (NiceCandidate, candidate);
Dafydd Harries's avatar
Dafydd Harries committed
81 82 83
}


84
NICEAPI_EXPORT gfloat
85
nice_candidate_jingle_priority (NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
86 87 88
{
  switch (candidate->type)
    {
89 90 91 92
    case NICE_CANDIDATE_TYPE_HOST:             return 1.0;
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE: return 0.9;
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:   return 0.9;
    case NICE_CANDIDATE_TYPE_RELAYED:          return 0.5;
Dafydd Harries's avatar
Dafydd Harries committed
93 94 95 96 97 98
    }

  /* appease GCC */
  return 0;
}

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
NICEAPI_EXPORT gfloat
nice_candidate_msn_priority (NiceCandidate *candidate)
{
  switch (candidate->type)
    {
    case NICE_CANDIDATE_TYPE_HOST:             return 0.830;
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE: return 0.550;
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:   return 0.550;
    case NICE_CANDIDATE_TYPE_RELAYED:          return 0.450;
    }

  /* appease GCC */
  return 0;
}

Dafydd Harries's avatar
Dafydd Harries committed
114

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


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

  switch (candidate->type)
    {
Youness Alaoui's avatar
Youness Alaoui committed
144
    case NICE_CANDIDATE_TYPE_HOST:
145
      type_preference = NICE_CANDIDATE_TYPE_PREF_HOST; break;
Youness Alaoui's avatar
Youness Alaoui committed
146
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:
147 148 149
      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
150
    case NICE_CANDIDATE_TYPE_RELAYED:
151
      type_preference = NICE_CANDIDATE_TYPE_PREF_RELAYED; break;
Dafydd Harries's avatar
Dafydd Harries committed
152 153
    }

154 155
  /* 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
156 157
}

Youness Alaoui's avatar
Youness Alaoui committed
158 159
/**
 * Calculates the pair priority as specified in ICE
160
 * sect 5.7.2. "Computing Pair Priority and Ordering Pairs" (ID-19).
161
 */
162
NICEAPI_EXPORT guint64
163 164 165 166 167 168 169
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);
}
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

/**
 * 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;
}