candidate.c 4.5 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

Dafydd Harries's avatar
Dafydd Harries committed
48
#include "agent.h"
49
#include "component.h"
Dafydd Harries's avatar
Dafydd Harries committed
50

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

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

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


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

72 73 74 75 76 77
  if (candidate->username)
    g_free (candidate->username);

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

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


82
NICEAPI_EXPORT gfloat
83
nice_candidate_jingle_priority (NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
84 85 86
{
  switch (candidate->type)
    {
87 88 89 90
    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
91 92 93 94 95 96 97
    }

  /* appease GCC */
  return 0;
}


Kai Vehmanen's avatar
Kai Vehmanen committed
98
/**
99
 * ICE 4.1.2.1. "Recommended Formula" (ID-19):
Kai Vehmanen's avatar
Kai Vehmanen committed
100 101
 * returns number between 1 and 0x7effffff 
 */
Dafydd Harries's avatar
Dafydd Harries committed
102
G_GNUC_CONST
103
NICEAPI_EXPORT guint32
104
nice_candidate_ice_priority_full (
Dafydd Harries's avatar
Dafydd Harries committed
105 106 107 108
  // must be ∈ (0, 126) (max 2^7 - 2)
  guint type_preference,
  // must be ∈ (0, 65535) (max 2^16 - 1)
  guint local_preference,
109
  // must be ∈ (0, 255) (max 2 ^ 8 - 1)
Dafydd Harries's avatar
Dafydd Harries committed
110 111 112 113 114 115 116 117 118
  guint component_id)
{
  return (
      0x1000000 * type_preference +
      0x100 * local_preference +
      (0x100 - component_id));
}


119
G_GNUC_CONST
120
NICEAPI_EXPORT guint32
121
nice_candidate_ice_priority (const NiceCandidate *candidate)
Dafydd Harries's avatar
Dafydd Harries committed
122 123 124 125 126
{
  guint8 type_preference = 0;

  switch (candidate->type)
    {
127 128 129 130 131 132 133 134
    case NICE_CANDIDATE_TYPE_HOST:             
      type_preference = NICE_CANDIDATE_TYPE_PREF_HOST; break;
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:   
      type_preference = NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE; break;
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE:
      type_preference = NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE; break;
    case NICE_CANDIDATE_TYPE_RELAYED:         
      type_preference = NICE_CANDIDATE_TYPE_PREF_RELAYED; break;
Dafydd Harries's avatar
Dafydd Harries committed
135 136
    }

137 138
  /* 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
139 140
}

141
/** 
Kai Vehmanen's avatar
Kai Vehmanen committed
142
 * Calculates the pair priority as specified in ICE 
143
 * sect 5.7.2. "Computing Pair Priority and Ordering Pairs" (ID-19).
144
 */
145
NICEAPI_EXPORT guint64
146 147 148 149 150 151 152
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);
}