Asterisk - The Open Source Telephony Project GIT-master-0bf3178
opus.h
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2013, Digium, Inc.
5 *
6 * Lorenzo Miniero <lorenzo@meetecho.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19/*!
20 * \file
21 * \brief Codec opus externals and format attributes
22 *
23 * RFC - https://tools.ietf.org/rfc/rfc7587.txt
24 */
25#ifndef _AST_FORMAT_OPUS_H_
26#define _AST_FORMAT_OPUS_H_
27
28/*! \brief Maximum sampling rate an endpoint is capable of receiving */
29#define CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE "maxplaybackrate"
30/*! \brief An alias for maxplaybackrate (used in older versions) */
31#define CODEC_OPUS_ATTR_MAX_CODED_AUDIO_BANDWIDTH "maxcodedaudiobandwidth"
32/*! \brief Maximum sampling rate an endpoint is capable of sending */
33#define CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE "sprop-maxcapturerate"
34/*! \brief Maximum duration of packet (in milliseconds) */
35#define CODEC_OPUS_ATTR_MAX_PTIME "maxptime"
36/*! \brief Duration of packet (in milliseconds) */
37#define CODEC_OPUS_ATTR_PTIME "ptime"
38/*! \brief Maximum average received bit rate (in bits per second) */
39#define CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE "maxaveragebitrate"
40/*! \brief Decode stereo (1) vs mono (0) */
41#define CODEC_OPUS_ATTR_STEREO "stereo"
42/*! \brief Likeliness of sender producing stereo (1) vs mono (0) */
43#define CODEC_OPUS_ATTR_SPROP_STEREO "sprop-stereo"
44/*! \brief Decoder prefers a constant (1) vs variable (0) bitrate */
45#define CODEC_OPUS_ATTR_CBR "cbr"
46/*! \brief Use forward error correction (1) or not (0) */
47#define CODEC_OPUS_ATTR_FEC "useinbandfec"
48/*! \brief Use discontinuous transmission (1) or not (0) */
49#define CODEC_OPUS_ATTR_DTX "usedtx"
50/*! \brief Custom data object */
51#define CODEC_OPUS_ATTR_DATA "data"
52
53/*! \brief Default attribute values */
54#define CODEC_OPUS_DEFAULT_SAMPLE_RATE 48000
55#define CODEC_OPUS_DEFAULT_MAX_PLAYBACK_RATE 48000
56#define CODEC_OPUS_DEFAULT_MAX_PTIME 120
57#define CODEC_OPUS_DEFAULT_PTIME 20
58#define CODEC_OPUS_DEFAULT_BITRATE -1000 /* OPUS_AUTO */
59#define CODEC_OPUS_DEFAULT_CBR 0
60#define CODEC_OPUS_DEFAULT_FEC 0
61#define CODEC_OPUS_DEFAULT_DTX 0
62#define CODEC_OPUS_DEFAULT_STEREO 0
63
64#endif /* _AST_FORMAT_OPUS_H */