/usr/include/pjmedia-codec/opus.h is in libpjproject-dev 2.7.2~dfsg-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 | /* $Id: opus.h 5239 2016-02-04 06:11:58Z ming $ */
/*
* Copyright (C) 2015-2016 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2012-2015 Zaark Technology AB
*
* 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
*/
/* This file is the header of Opus codec wrapper and was contributed by
* Zaark Technology AB
*/
#ifndef __PJMEDIA_CODEC_OPUS_H__
#define __PJMEDIA_CODEC_OPUS_H__
/**
* @file opus.h
* @brief Opus codec.
*/
#include <pjmedia-codec/types.h>
PJ_BEGIN_DECL
/**
* @defgroup PJMED_OPUS Opus Codec Family
* @ingroup PJMEDIA_CODEC_CODECS
* @brief Opus codec wrapper
* @{
*
* This section describes functions to initialize and register Opus codec
* factory to the codec manager. After the codec factory has been registered,
* application can use @ref PJMEDIA_CODEC API to manipulate the codec.
*
* Opus codec uses multiple bit rates, and supports fullband (48 kHz
* sampling rate), super wideband (24 kHz sampling rate), wideband (16 kHz
* sampling rate), medium band (12kHz sampling rate), and narrowband
* (8 kHz sampling rate).
*
*
* \section codec_setting Codec Settings
*
* General codec settings for this codec such as VAD and PLC can be
* manipulated through the <tt>setting</tt> field in #pjmedia_codec_param
* (see the documentation of #pjmedia_codec_param for more info).
*
* For Opus codec specific settings, such as sample rate,
* channel count, bit rate, complexity, and CBR, can be configured
* in #pjmedia_codec_opus_config.
* The default setting of sample rate is specified in
* #PJMEDIA_CODEC_OPUS_DEFAULT_SAMPLE_RATE. The default setting of
* bitrate is specified in #PJMEDIA_CODEC_OPUS_DEFAULT_BIT_RATE.
* And the default setting of complexity is specified in
* #PJMEDIA_CODEC_OPUS_DEFAULT_COMPLEXITY.
*
* After modifying any of these settings, application needs to call
* #pjmedia_codec_opus_set_default_param(), which will generate the
* appropriate decoding fmtp attributes.
*
* Here is an example of modifying the codec settings:
\code
pjmedia_codec_param param;
pjmedia_codec_opus_config opus_cfg;
pjmedia_codec_mgr_get_default_param(.., ¶m);
pjmedia_codec_opus_get_config(&opus_cfg);
...
// Set VAD
param.setting.vad = 1;
// Set PLC
param.setting.vad = 1;
// Set sample rate
opus_cfg.sample_rate = 16000;
// Set channel count
opus_cfg.channel_cnt = 2;
// Set bit rate
opus_cfg.bit_rate = 20000;
...
pjmedia_codec_opus_set_default_param(&opus_cfg, ¶m);
\endcode
*
*/
/**
* Opus codec configuration.
*/
typedef struct pjmedia_codec_opus_config
{
unsigned sample_rate; /**< Sample rate in Hz. */
unsigned channel_cnt; /**< Number of channels. */
unsigned bit_rate; /**< Encoder bit rate in bps. */
unsigned packet_loss; /**< Encoder's expected packet loss pct. */
unsigned complexity; /**< Encoder complexity, 0-10(10 is highest)*/
pj_bool_t cbr; /**< Constant bit rate? */
} pjmedia_codec_opus_config;
/**
* Initialize and register Opus codec factory to pjmedia endpoint.
*
* @param endpt The pjmedia endpoint.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_codec_opus_init( pjmedia_endpt *endpt );
/**
* Unregister Opus codec factory from pjmedia endpoint and deinitialize
* the Opus codec library.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_codec_opus_deinit( void );
/**
* Get the default Opus configuration.
*
* @param cfg Opus codec configuration.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_codec_opus_get_config( pjmedia_codec_opus_config *cfg );
/**
* Set the default Opus configuration and set the default Opus codec param.
* Note that the function will call #pjmedia_codec_mgr_set_default_param().
*
* @param cfg Opus codec configuration.
* @param param The new default Opus codec parameter.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_codec_opus_set_default_param(const pjmedia_codec_opus_config *cfg,
pjmedia_codec_param *param );
PJ_END_DECL
/**
* @}
*/
#endif /* __PJMEDIA_CODEC_OPUS_H__ */
|