opus.h File Reference

Codec opus externals and format attributes. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	CODEC_OPUS_ATTR_CBR   "cbr"
	Decoder prefers a constant (1) vs variable (0) bitrate. More...
#define	CODEC_OPUS_ATTR_DATA   "data"
	Custom data object. More...
#define	CODEC_OPUS_ATTR_DTX   "usedtx"
	Use discontinuous transmission (1) or not (0) More...
#define	CODEC_OPUS_ATTR_FEC   "useinbandfec"
	Use forward error correction (1) or not (0) More...
#define	CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE   "maxaveragebitrate"
	Maximum average received bit rate (in bits per second) More...
#define	CODEC_OPUS_ATTR_MAX_CODED_AUDIO_BANDWIDTH   "maxcodedaudiobandwidth"
	An alias for maxplaybackrate (used in older versions) More...
#define	CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE   "maxplaybackrate"
	Maximum sampling rate an endpoint is capable of receiving. More...
#define	CODEC_OPUS_ATTR_MAX_PTIME   "maxptime"
	Maximum duration of packet (in milliseconds) More...
#define	CODEC_OPUS_ATTR_PTIME   "ptime"
	Duration of packet (in milliseconds) More...
#define	CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE   "sprop-maxcapturerate"
	Maximum sampling rate an endpoint is capable of sending. More...
#define	CODEC_OPUS_ATTR_SPROP_STEREO   "sprop-stereo"
	Likeliness of sender producing stereo (1) vs mono (0) More...
#define	CODEC_OPUS_ATTR_STEREO   "stereo"
	Decode stereo (1) vs mono (0) More...
#define	CODEC_OPUS_DEFAULT_BITRATE   -1000 /* OPUS_AUTO */
#define	CODEC_OPUS_DEFAULT_CBR   0
#define	CODEC_OPUS_DEFAULT_DTX   0
#define	CODEC_OPUS_DEFAULT_FEC   0
#define	CODEC_OPUS_DEFAULT_MAX_PLAYBACK_RATE   48000
#define	CODEC_OPUS_DEFAULT_MAX_PTIME   120
#define	CODEC_OPUS_DEFAULT_PTIME   20
#define	CODEC_OPUS_DEFAULT_SAMPLE_RATE   48000
	Default attribute values. More...
#define	CODEC_OPUS_DEFAULT_STEREO   0

Detailed Description

Codec opus externals and format attributes.

RFC - https://tools.ietf.org/rfc/rfc7587.txt

Definition in file opus.h.

Macro Definition Documentation

CODEC_OPUS_ATTR_CBR

#define CODEC_OPUS_ATTR_CBR   "cbr"

Decoder prefers a constant (1) vs variable (0) bitrate.

Definition at line 45 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_DATA

#define CODEC_OPUS_ATTR_DATA   "data"

Custom data object.

Definition at line 51 of file opus.h.

Referenced by opus_get(), and opus_set().

CODEC_OPUS_ATTR_DTX

#define CODEC_OPUS_ATTR_DTX   "usedtx"

Use discontinuous transmission (1) or not (0)

Definition at line 49 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_FEC

#define CODEC_OPUS_ATTR_FEC   "useinbandfec"

Use forward error correction (1) or not (0)

Definition at line 47 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE

#define CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE   "maxaveragebitrate"

Maximum average received bit rate (in bits per second)

Definition at line 39 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_MAX_CODED_AUDIO_BANDWIDTH

#define CODEC_OPUS_ATTR_MAX_CODED_AUDIO_BANDWIDTH   "maxcodedaudiobandwidth"

An alias for maxplaybackrate (used in older versions)

Definition at line 31 of file opus.h.

Referenced by opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE

#define CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE   "maxplaybackrate"

Maximum sampling rate an endpoint is capable of receiving.

Definition at line 29 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_MAX_PTIME

#define CODEC_OPUS_ATTR_MAX_PTIME   "maxptime"

Maximum duration of packet (in milliseconds)

Definition at line 35 of file opus.h.

Referenced by opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_PTIME

#define CODEC_OPUS_ATTR_PTIME   "ptime"

Duration of packet (in milliseconds)

Definition at line 37 of file opus.h.

Referenced by opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE

#define CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE   "sprop-maxcapturerate"

Maximum sampling rate an endpoint is capable of sending.

Definition at line 33 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_SPROP_STEREO

#define CODEC_OPUS_ATTR_SPROP_STEREO   "sprop-stereo"

Likeliness of sender producing stereo (1) vs mono (0)

Definition at line 43 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_ATTR_STEREO

#define CODEC_OPUS_ATTR_STEREO   "stereo"

Decode stereo (1) vs mono (0)

Definition at line 41 of file opus.h.

Referenced by opus_generate_sdp_fmtp(), opus_get(), opus_parse_sdp_fmtp(), and opus_set().

CODEC_OPUS_DEFAULT_BITRATE

#define CODEC_OPUS_DEFAULT_BITRATE   -1000 /* OPUS_AUTO */

Definition at line 58 of file opus.h.

Referenced by opus_generate_sdp_fmtp().

CODEC_OPUS_DEFAULT_CBR

#define CODEC_OPUS_DEFAULT_CBR   0

Definition at line 59 of file opus.h.

Referenced by opus_generate_sdp_fmtp().

CODEC_OPUS_DEFAULT_DTX

#define CODEC_OPUS_DEFAULT_DTX   0

Definition at line 61 of file opus.h.

Referenced by opus_generate_sdp_fmtp().

CODEC_OPUS_DEFAULT_FEC

#define CODEC_OPUS_DEFAULT_FEC   0

Definition at line 60 of file opus.h.

Referenced by opus_generate_sdp_fmtp().

CODEC_OPUS_DEFAULT_MAX_PLAYBACK_RATE

#define CODEC_OPUS_DEFAULT_MAX_PLAYBACK_RATE   48000

Definition at line 55 of file opus.h.

CODEC_OPUS_DEFAULT_MAX_PTIME

#define CODEC_OPUS_DEFAULT_MAX_PTIME   120

Definition at line 56 of file opus.h.

CODEC_OPUS_DEFAULT_PTIME

#define CODEC_OPUS_DEFAULT_PTIME   20

Definition at line 57 of file opus.h.

CODEC_OPUS_DEFAULT_SAMPLE_RATE

#define CODEC_OPUS_DEFAULT_SAMPLE_RATE   48000

Default attribute values.

Definition at line 54 of file opus.h.

Referenced by opus_generate_sdp_fmtp().

CODEC_OPUS_DEFAULT_STEREO

#define CODEC_OPUS_DEFAULT_STEREO   0

Definition at line 62 of file opus.h.

Referenced by opus_generate_sdp_fmtp().