blob: c12320b9bb1b16cb39aacc2345bbe1d81f0076e3 [file] [log] [blame]
Benny Prijonoa837c302006-04-27 22:36:40 +00001/* $Id$ */
2/*
Benny Prijonoa771a512007-02-19 01:13:53 +00003 * Copyright (C)2003-2007 Benny Prijono <benny@prijono.org>
Benny Prijonoa837c302006-04-27 22:36:40 +00004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19#ifndef __PJMEDIA_CODEC_L16_H__
20#define __PJMEDIA_CODEC_L16_H__
21
22#include <pjmedia-codec/types.h>
23
24
Benny Prijono37235af2006-06-18 02:02:36 +000025/**
Benny Prijono1ec70b32006-06-20 15:39:07 +000026 * @defgroup PJMED_L16 L16 Codec Family
Benny Prijono37235af2006-06-18 02:02:36 +000027 * @ingroup PJMEDIA_CODEC
28 * @brief 16bit linear codecs (useful for debugging)
29 * @{
30 * This section describes functions to register and register L16 codec
31 * factory to the codec manager. After the codec factory has been registered,
32 * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
33 *
34 * Note that the L16 codec factory registers several (about fourteen!)
35 * L16 codec types to codec manager (different combinations of clock
36 * rate and number of channels).
37 */
38
Benny Prijonoa837c302006-04-27 22:36:40 +000039PJ_BEGIN_DECL
40
41
42/**
43 * Initialize and register L16 codec factory to pjmedia endpoint.
44 *
45 * @param endpt The pjmedia endpoint.
46 * @param options Must be zero for now.
47 *
48 * @return PJ_SUCCESS on success.
49 */
50PJ_DECL(pj_status_t) pjmedia_codec_l16_init( pjmedia_endpt *endpt,
51 unsigned options);
52
53
54
55/**
56 * Unregister L16 codec factory from pjmedia endpoint.
57 *
58 * @return PJ_SUCCESS on success.
59 */
60PJ_DECL(pj_status_t) pjmedia_codec_l16_deinit(void);
61
62
63PJ_END_DECL
64
65
66#endif /* __PJMEDIA_CODEC_L16_H__ */
67