/usr/include/pjmedia/conference.h is in libpjproject-dev 2.1.0.0.ast20130823-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 | /* $Id: conference.h 3664 2011-07-19 03:42:28Z nanang $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJMEDIA_CONF_H__
#define __PJMEDIA_CONF_H__
/**
* @file conference.h
* @brief Conference bridge.
*/
#include <pjmedia/port.h>
/**
* @defgroup PJMEDIA_CONF Conference Bridge
* @ingroup PJMEDIA_PORT
* @brief Audio conference bridge implementation
* @{
*
* This describes the conference bridge implementation in PJMEDIA. The
* conference bridge provides powerful and very efficient mechanism to
* route the audio flow and mix the audio signal when required.
*
* Some more information about the media flow when conference bridge is
* used is described in http://www.pjsip.org/trac/wiki/media-flow .
*/
PJ_BEGIN_DECL
/**
* The conference bridge signature in pjmedia_port_info.
*/
#define PJMEDIA_CONF_BRIDGE_SIGNATURE PJMEDIA_SIG_PORT_CONF
/**
* The audio switchboard signature in pjmedia_port_info.
*/
#define PJMEDIA_CONF_SWITCH_SIGNATURE PJMEDIA_SIG_PORT_CONF_SWITCH
/**
* Opaque type for conference bridge.
*/
typedef struct pjmedia_conf pjmedia_conf;
/**
* Conference port info.
*/
typedef struct pjmedia_conf_port_info
{
unsigned slot; /**< Slot number. */
pj_str_t name; /**< Port name. */
pjmedia_format format; /**< Format. */
pjmedia_port_op tx_setting; /**< Transmit settings. */
pjmedia_port_op rx_setting; /**< Receive settings. */
unsigned listener_cnt; /**< Number of listeners. */
unsigned *listener_slots; /**< Array of listeners. */
unsigned transmitter_cnt; /**< Number of transmitter. */
unsigned clock_rate; /**< Clock rate of the port. */
unsigned channel_count; /**< Number of channels. */
unsigned samples_per_frame; /**< Samples per frame */
unsigned bits_per_sample; /**< Bits per sample. */
int tx_adj_level; /**< Tx level adjustment. */
int rx_adj_level; /**< Rx level adjustment. */
} pjmedia_conf_port_info;
/**
* Conference port options. The values here can be combined in bitmask to
* be specified when the conference bridge is created.
*/
enum pjmedia_conf_option
{
PJMEDIA_CONF_NO_MIC = 1, /**< Disable audio streams from the
microphone device. */
PJMEDIA_CONF_NO_DEVICE = 2, /**< Do not create sound device. */
PJMEDIA_CONF_SMALL_FILTER=4,/**< Use small filter table when resampling */
PJMEDIA_CONF_USE_LINEAR=8 /**< Use linear resampling instead of filter
based. */
};
/**
* Create conference bridge with the specified parameters. The sampling rate,
* samples per frame, and bits per sample will be used for the internal
* operation of the bridge (e.g. when mixing audio frames). However, ports
* with different configuration may be connected to the bridge. In this case,
* the bridge is able to perform sampling rate conversion, and buffering in
* case the samples per frame is different.
*
* For this version of PJMEDIA, only 16bits per sample is supported.
*
* For this version of PJMEDIA, the channel count of the ports MUST match
* the channel count of the bridge.
*
* Under normal operation (i.e. when PJMEDIA_CONF_NO_DEVICE option is NOT
* specified), the bridge internally create an instance of sound device
* and connect the sound device to port zero of the bridge.
*
* If PJMEDIA_CONF_NO_DEVICE options is specified, no sound device will
* be created in the conference bridge. Application MUST acquire the port
* interface of the bridge by calling #pjmedia_conf_get_master_port(), and
* connect this port interface to a sound device port by calling
* #pjmedia_snd_port_connect(), or to a master port (pjmedia_master_port)
* if application doesn't want to instantiate any sound devices.
*
* The sound device or master port are crucial for the bridge's operation,
* because it provides the bridge with necessary clock to process the audio
* frames periodically. Internally, the bridge runs when get_frame() to
* port zero is called.
*
* @param pool Pool to use to allocate the bridge and
* additional buffers for the sound device.
* @param max_slots Maximum number of slots/ports to be created in
* the bridge. Note that the bridge internally uses
* one port for the sound device, so the actual
* maximum number of ports will be less one than
* this value.
* @param sampling_rate Set the sampling rate of the bridge. This value
* is also used to set the sampling rate of the
* sound device.
* @param channel_count Number of channels in the PCM stream. Normally
* the value will be 1 for mono, but application may
* specify a value of 2 for stereo. Note that all
* ports that will be connected to the bridge MUST
* have the same number of channels as the bridge.
* @param samples_per_frame Set the number of samples per frame. This value
* is also used to set the sound device.
* @param bits_per_sample Set the number of bits per sample. This value
* is also used to set the sound device. Currently
* only 16bit per sample is supported.
* @param options Bitmask options to be set for the bridge. The
* options are constructed from #pjmedia_conf_option
* enumeration.
* @param p_conf Pointer to receive the conference bridge instance.
*
* @return PJ_SUCCESS if conference bridge can be created.
*/
PJ_DECL(pj_status_t) pjmedia_conf_create( pj_pool_t *pool,
unsigned max_slots,
unsigned sampling_rate,
unsigned channel_count,
unsigned samples_per_frame,
unsigned bits_per_sample,
unsigned options,
pjmedia_conf **p_conf );
/**
* Destroy conference bridge.
*
* @param conf The conference bridge.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_destroy( pjmedia_conf *conf );
/**
* Get the master port interface of the conference bridge. The master port
* corresponds to the port zero of the bridge. This is only usefull when
* application wants to manage the sound device by itself, instead of
* allowing the bridge to automatically create a sound device implicitly.
*
* This function will only return a port interface if PJMEDIA_CONF_NO_DEVICE
* option was specified when the bridge was created.
*
* Application can connect the port returned by this function to a
* sound device by calling #pjmedia_snd_port_connect().
*
* @param conf The conference bridge.
*
* @return The port interface of port zero of the bridge,
* only when PJMEDIA_CONF_NO_DEVICE options was
* specified when the bridge was created.
*/
PJ_DECL(pjmedia_port*) pjmedia_conf_get_master_port(pjmedia_conf *conf);
/**
* Set master port name.
*
* @param conf The conference bridge.
* @param name Name to be assigned.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_set_port0_name(pjmedia_conf *conf,
const pj_str_t *name);
/**
* Add media port to the conference bridge.
*
* By default, the new conference port will have both TX and RX enabled,
* but it is not connected to any other ports. Application SHOULD call
* #pjmedia_conf_connect_port() to enable audio transmission and receipt
* to/from this port.
*
* Once the media port is connected to other port(s) in the bridge,
* the bridge will continuosly call get_frame() and put_frame() to the
* port, allowing media to flow to/from the port.
*
* @param conf The conference bridge.
* @param pool Pool to allocate buffers for this port.
* @param strm_port Stream port interface.
* @param name Optional name for the port. If this value is NULL,
* the name will be taken from the name in the port
* info.
* @param p_slot Pointer to receive the slot index of the port in
* the conference bridge.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_add_port( pjmedia_conf *conf,
pj_pool_t *pool,
pjmedia_port *strm_port,
const pj_str_t *name,
unsigned *p_slot );
/**
* <i><b>Warning:</b> This API has been deprecated since 1.3 and will be
* removed in the future release, use @ref PJMEDIA_SPLITCOMB instead.</i>
*
* Create and add a passive media port to the conference bridge. Unlike
* "normal" media port that is added with #pjmedia_conf_add_port(), media
* port created with this function will not have its get_frame() and
* put_frame() called by the bridge; instead, application MUST continuosly
* call these functions to the port, to allow media to flow from/to the
* port.
*
* Upon return of this function, application will be given two objects:
* the slot number of the port in the bridge, and pointer to the media
* port where application MUST start calling get_frame() and put_frame()
* to the port.
*
* @param conf The conference bridge.
* @param pool Pool to allocate buffers etc for this port.
* @param name Name to be assigned to the port.
* @param clock_rate Clock rate/sampling rate.
* @param channel_count Number of channels.
* @param samples_per_frame Number of samples per frame.
* @param bits_per_sample Number of bits per sample.
* @param options Options (should be zero at the moment).
* @param p_slot Pointer to receive the slot index of the port in
* the conference bridge.
* @param p_port Pointer to receive the port instance.
*
* @return PJ_SUCCESS on success, or the appropriate error
* code.
*/
PJ_DECL(pj_status_t) pjmedia_conf_add_passive_port( pjmedia_conf *conf,
pj_pool_t *pool,
const pj_str_t *name,
unsigned clock_rate,
unsigned channel_count,
unsigned samples_per_frame,
unsigned bits_per_sample,
unsigned options,
unsigned *p_slot,
pjmedia_port **p_port );
/**
* Change TX and RX settings for the port.
*
* @param conf The conference bridge.
* @param slot Port number/slot in the conference bridge.
* @param tx Settings for the transmission TO this port.
* @param rx Settings for the receipt FROM this port.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_configure_port( pjmedia_conf *conf,
unsigned slot,
pjmedia_port_op tx,
pjmedia_port_op rx);
/**
* Enable unidirectional audio from the specified source slot to the
* specified sink slot.
*
* @param conf The conference bridge.
* @param src_slot Source slot.
* @param sink_slot Sink slot.
* @param level This argument is reserved for future improvements
* where it is possible to adjust the level of signal
* transmitted in a specific connection. For now,
* this argument MUST be zero.
*
* @return PJ_SUCCES on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_connect_port( pjmedia_conf *conf,
unsigned src_slot,
unsigned sink_slot,
int level );
/**
* Disconnect unidirectional audio from the specified source to the specified
* sink slot.
*
* @param conf The conference bridge.
* @param src_slot Source slot.
* @param sink_slot Sink slot.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_disconnect_port( pjmedia_conf *conf,
unsigned src_slot,
unsigned sink_slot );
/**
* Get number of ports currently registered to the conference bridge.
*
* @param conf The conference bridge.
*
* @return Number of ports currently registered to the conference
* bridge.
*/
PJ_DECL(unsigned) pjmedia_conf_get_port_count(pjmedia_conf *conf);
/**
* Get total number of ports connections currently set up in the bridge.
*
* @param conf The conference bridge.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(unsigned) pjmedia_conf_get_connect_count(pjmedia_conf *conf);
/**
* Remove the specified port from the conference bridge.
*
* @param conf The conference bridge.
* @param slot The port index to be removed.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_remove_port( pjmedia_conf *conf,
unsigned slot );
/**
* Enumerate occupied ports in the bridge.
*
* @param conf The conference bridge.
* @param ports Array of port numbers to be filled in.
* @param count On input, specifies the maximum number of ports
* in the array. On return, it will be filled with
* the actual number of ports.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_enum_ports( pjmedia_conf *conf,
unsigned ports[],
unsigned *count );
/**
* Get port info.
*
* @param conf The conference bridge.
* @param slot Port index.
* @param info Pointer to receive the info.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_get_port_info( pjmedia_conf *conf,
unsigned slot,
pjmedia_conf_port_info *info);
/**
* Get occupied ports info.
*
* @param conf The conference bridge.
* @param size On input, contains maximum number of infos
* to be retrieved. On output, contains the actual
* number of infos that have been copied.
* @param info Array of info.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_get_ports_info(pjmedia_conf *conf,
unsigned *size,
pjmedia_conf_port_info info[]
);
/**
* Get last signal level transmitted to or received from the specified port.
* This will retrieve the "real-time" signal level of the audio as they are
* transmitted or received by the specified port. Application may call this
* function periodically to display the signal level to a VU meter.
*
* The signal level is an integer value in zero to 255, with zero indicates
* no signal, and 255 indicates the loudest signal level.
*
* @param conf The conference bridge.
* @param slot Slot number.
* @param tx_level Optional argument to receive the level of signal
* transmitted to the specified port (i.e. the direction
* is from the bridge to the port).
* @param rx_level Optional argument to receive the level of signal
* received from the port (i.e. the direction is from the
* port to the bridge).
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_get_signal_level(pjmedia_conf *conf,
unsigned slot,
unsigned *tx_level,
unsigned *rx_level);
/**
* Adjust the level of signal received from the specified port.
* Application may adjust the level to make signal received from the port
* either louder or more quiet. The level adjustment is calculated with this
* formula: <b><tt>output = input * (adj_level+128) / 128</tt></b>. Using
* this, zero indicates no adjustment, the value -128 will mute the signal,
* and the value of +128 will make the signal 100% louder, +256 will make it
* 200% louder, etc.
*
* The level adjustment value will stay with the port until the port is
* removed from the bridge or new adjustment value is set. The current
* level adjustment value is reported in the media port info when
* the #pjmedia_conf_get_port_info() function is called.
*
* @param conf The conference bridge.
* @param slot Slot number of the port.
* @param adj_level Adjustment level, which must be greater than or equal
* to -128. A value of zero means there is no level
* adjustment to be made, the value -128 will mute the
* signal, and the value of +128 will make the signal
* 100% louder, +256 will make it 200% louder, etc.
* See the function description for the formula.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_adjust_rx_level( pjmedia_conf *conf,
unsigned slot,
int adj_level );
/**
* Adjust the level of signal to be transmitted to the specified port.
* Application may adjust the level to make signal transmitted to the port
* either louder or more quiet. The level adjustment is calculated with this
* formula: <b><tt>output = input * (adj_level+128) / 128</tt></b>. Using
* this, zero indicates no adjustment, the value -128 will mute the signal,
* and the value of +128 will make the signal 100% louder, +256 will make it
* 200% louder, etc.
*
* The level adjustment value will stay with the port until the port is
* removed from the bridge or new adjustment value is set. The current
* level adjustment value is reported in the media port info when
* the #pjmedia_conf_get_port_info() function is called.
*
* @param conf The conference bridge.
* @param slot Slot number of the port.
* @param adj_level Adjustment level, which must be greater than or equal
* to -128. A value of zero means there is no level
* adjustment to be made, the value -128 will mute the
* signal, and the value of +128 will make the signal
* 100% louder, +256 will make it 200% louder, etc.
* See the function description for the formula.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_conf_adjust_tx_level( pjmedia_conf *conf,
unsigned slot,
int adj_level );
PJ_END_DECL
/**
* @}
*/
#endif /* __PJMEDIA_CONF_H__ */
|