blob: 0705690ad4c5986025f4f74428a6f848dbc0bd31 [file] [log] [blame]
Nanang Izzuddin8cdba462009-01-29 20:06:28 +00001/* $Id$ */
2/*
3 * Copyright (C) 2008-2009 Teluu Inc. (http://www.teluu.com)
4 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20#ifndef __PJMEDIA_CODECS_PASSTHROUGH_H__
21#define __PJMEDIA_CODECS_PASSTHROUGH_H__
22
23/**
24 * @file pjmedia-codec/passthrough.h
25 * @brief Passthrough codecs.
26 */
27
28#include <pjmedia-codec/types.h>
29
30/**
31 * @defgroup PJMED_PASSTHROUGH_CODEC Passthrough Codecs
32 * @ingroup PJMEDIA_CODEC
33 * @brief Implementation of passthrough codecs
34 * @{
35 *
36 * This section describes functions to register and register passthrough
37 * codecs factory to the codec manager. After the codec factory has been
38 * registered, application can use @ref PJMEDIA_CODEC API to manipulate
39 * the codec. This codec factory contains various codecs, e.g: G.729, iLBC,
40 * AMR, and G.711.
41 *
42 * Passthrough codecs are codecs wrapper that does not perform encoding
43 * or decoding, it just pack and parse encoded audio data from/into RTP
44 * payload. This will accomodate pjmedia ports which work with encoded
45 * audio data, e.g: encoded audio files, sound device with capability
46 * of playing/recording encoded audio data.
47 */
48
49PJ_BEGIN_DECL
50
51/**
52 * Initialize and register passthrough codecs factory to pjmedia endpoint.
53 *
54 * @param endpt The pjmedia endpoint.
55 *
56 * @return PJ_SUCCESS on success.
57 */
58PJ_DECL(pj_status_t) pjmedia_codec_passthrough_init( pjmedia_endpt *endpt );
59
60
61
62/**
63 * Unregister passthrough codecs factory from pjmedia endpoint.
64 *
65 * @return PJ_SUCCESS on success.
66 */
67PJ_DECL(pj_status_t) pjmedia_codec_passthrough_deinit(void);
68
69
70PJ_END_DECL
71
72
73/**
74 * @}
75 */
76
77#endif /* __PJMEDIA_CODECS_PASSTHROUGH_H__ */
78