Jean-Marc Valin
c64b321e7a
DRED API update
...
output() renamed to decode(), dred objects using alloc() and free(),
OpusDRED now passed as cost for decoding.
2023-06-16 13:02:16 -04:00
Jean-Marc Valin
e0c6eae8cc
Update the API to add an OpusDREDDecoder
2023-06-16 13:01:39 -04:00
Jean-Marc Valin
4402b00fd3
Add API doc, change DRED offsets to be samples
2023-06-16 13:01:34 -04:00
Jean-Marc Valin
75f0dbcad0
Cleanup, remove "old" DRED API
2023-06-16 13:01:33 -04:00
Jean-Marc Valin
5e2440fafc
Complete switching to DRED object
2023-06-16 13:01:33 -04:00
Jean-Marc Valin
ebfa29c7e1
Remove opus_dred_init()
2023-06-16 13:01:33 -04:00
Jean-Marc Valin
1312642f08
More DRED refactoring
...
progressive decode, avoid storing DRED decoder state
2023-06-16 13:01:32 -04:00
Jean-Marc Valin
906ee4b236
DRED refactoring/renaming
2023-06-16 13:01:32 -04:00
Jean-Marc Valin
5ad2aebd90
Code for inserting/extracting DRED in/from packets
2023-06-16 13:01:20 -04:00
Mark Harris
51fb8955e4
doc: Use consistent alternative notation
...
Signed-off-by: Mark Harris <mark.hsj@gmail.com>
2022-07-05 20:14:10 -07:00
Alexander Traud
99afa9c48e
Fix opus.h for doxygen when referencing alternative values
...
Doxygen was not able to resolve the references because it looked
for OPUS_APPLICATION_VOIP/@ref.
Signed-off-by: Mark Harris <mark.hsj@gmail.com>
2022-07-05 19:51:04 -07:00
Mark Harris
19966ccd4b
Fix opus_packet_parse() non-null arg attribute
...
It is the size array that must be non-null.
2018-05-03 23:02:49 -07:00
Mark Harris
1c311423c8
Packets indicating DTX may be up to 2 bytes
2016-07-08 11:13:42 -07:00
Ralph Giles
5b712da9c2
Document the motivation for the 120 ms repacketizer limit.
...
See the mailing list discussion at
http://lists.xiph.org/pipermail/opus/2014-December/002802.html
2014-12-20 12:37:48 -08:00
Jean-Marc Valin
f183566752
Adds functions for multistream padding/unpadding and single-stream unpadding
...
These are all completely untested.
2013-11-18 16:46:38 -05:00
Jean-Marc Valin
c5635d284b
Adds packet padding that works for all codes and fixes 40/60 ms CBR.
...
Padding is now handled by the repacketizer.
2013-11-13 23:22:37 -05:00
Jean-Marc Valin
359306985b
Change few remaining instances of short to opus_int16
2013-05-18 02:50:40 -04:00
Jean-Marc Valin
74d43f0a36
Minor soft clipping doc fix
2013-03-18 17:06:43 -04:00
Jean-Marc Valin
d9aa6e046b
Oops, fixed API name from previous commit
2013-03-01 16:07:02 -05:00
Jean-Marc Valin
32c4a0c96e
Applies soft-clipping to the int decoder API.
...
opus_decode() and opus_multistream_decode() now apply soft clipping
before converting to 16-bit int. This should produce better a higher
quality result than hard clipping like we were doing before. The _float()
API isn't affected, but the clipping function is exported so users can
manually apply the soft clipping.
2013-03-01 15:23:01 -05:00
Ralph Giles
256c9595d8
Document that opus_packet_get_nb_frames, etc. can return OPUS_BAD_ARG.
...
NB they only check for len < 1, not for null data.
2012-12-11 10:17:11 -08:00
Jean-Marc Valin
d0fd9d4baa
Implements opus_packet_get_nb_samples()
2012-12-04 15:45:31 -05:00
Jean-Marc Valin
7fcd66c40d
Changes the PLC behaviour and fixes the FEC behaviour on concatenated packets
...
PLC and FEC now return exactly the number of samples specified for the
buffer rather than (usually) returning the size of the last packet.
Doc and tests are updated accordingly.
2012-12-04 15:07:45 -05:00
Gregory Maxwell
696d68c0c3
Fix typo in documentation for opus_decoder_create().
2012-10-06 10:51:04 -04:00
Gregory Maxwell
9fec9bb391
Belabor OPUS_SET_BITRATE instead of max_packet, as this is a common trap.
2012-09-27 18:36:51 -04:00
Philip Jägenstedt
6d9c16d142
Fix common misspellings
...
I stumbled upon the typo in README.draft, so took the opportunity to
grep for common misspellings using List_of_common_misspellings.txt for
hunspell.
2012-09-27 09:16:30 -04:00
Gregory Maxwell
d8b0a24201
Docbug: Replace opus_encode_frame with opus_encode_float in doxygen.
2012-09-24 21:11:00 -04:00
Gregory Maxwell
cc71cded76
Replace 'maximum frame size' with 'maximum packet duration' in the docs.
...
This could be confusing/misleading.
2012-09-19 09:43:52 -04:00
Jean-Marc Valin
1d13ff6a97
Fixes multistream doc
2012-09-10 21:53:39 -04:00
Timothy B. Terriberry
77ebbdf986
Expand documentation for the multistream API.
...
This patch also includes some small edits/additions to the main API
documentation.
2012-09-10 16:25:45 -04:00
Jean-Marc Valin
1491fa81f4
Fixes to the new repacketizer doc
2012-09-10 16:24:33 -04:00
Timothy B. Terriberry
ddd551e06d
Add documentation for the repacketizer API.
...
This patch also includes some small edits for the main API
documentation.
2012-09-10 08:22:46 -04:00
Gregory Maxwell
bf7c1605f7
Fix opus_encode allowed frame sizes docs, reported by Stefan Hacker.
2012-08-06 09:24:03 -04:00
Gregory Maxwell
b0c120b214
Add some more api docs.
2012-07-21 17:24:11 -04:00
Gregory Maxwell
595b334f26
Pretty up the HTML doxygen output.
2012-06-11 01:42:32 -04:00
Gregory Maxwell
daa14598eb
Add brief descriptions to the encode/decode groups to avoid weird autobreif strings.
2012-06-10 21:30:01 -04:00
Gregory Maxwell
1f65ce89b0
Correct documentation in opus_custom.h.
2012-06-10 21:15:02 -04:00
Gregory Maxwell
c64f4a4265
Update headers to cause warnings on unused returns and null args.
...
In places where an ignored return or a null-arg is a sure indication
of a bug add the GCC warning attributes. The null arg annotation
is not enable for Opus itself because it will cause the compiler
to optimize out some null checks. I don't trust our callers
quite that much.
2012-06-01 15:58:17 -04:00
Gregory Maxwell
d445f02f65
Tweak doxygen input so that the manpage names won't conflict.
2012-05-20 19:33:38 -04:00
Gregory Maxwell
fdd0c52b40
Minor doc improvement wrt OPUS_APPLICATION_RESTRICTED_LOWDELAY.
2012-05-17 19:45:28 -04:00
Jean-Marc Valin
ab5a049705
Merge commit ' 390c89225d
'
2012-04-24 13:39:22 -04:00
Jean-Marc Valin
cb05e7cd96
s/FOUNDATION/COPYRIGHT OWNER/ in CELT code and "glue code"
...
Also added 3rd clause to "master" COPYING file
2012-04-20 16:41:42 -04:00
Ralph Giles
f40285212c
Improve decoder_create documentation.
...
The parameter descriptions look like they were copied
from encoder_create. Update them for the decode side
and repeat the clarifications about what sample rates
are allowed and what they mean.
2012-04-02 11:21:41 -04:00
Ralph Giles
1e0ba0f40a
Fix typos in the API documentation.
...
opus_decode() takes a sixth 'enable_fec' option. Naive invocations
shoudl set this to zero.
2012-03-05 17:09:54 -08:00
Gregory Maxwell
e7028175af
40/60ms MDCT/Hybrid were not able to reach maximum bitrate. Now they can.
...
Also change the packet length in the API from int to opus_int32
because repacketized frames are able to go beyond 32767 bytes
in size.
2012-03-05 17:59:50 -05:00
Ralph Giles
10ebc02ecf
Misc documentation fixes (no code change)
...
We use macros to encapsulate the appropriate type and size
information for the different CTL requests, but the macros
still need to be used with the _ctl() function call and an
encoder or decoder instance structure. As such, just listing
the macro defines is confusing. Adding some examples outside
the OpusEncoder overview page should help with this.
Also document that OPUS_SET_APPLICATION can take
OPUS_APPLICATION_RESTRICTED_LOWDELAY.
2011-11-25 23:25:38 -05:00
Jean-Marc Valin
4923f3f80e
Moves the main headers from src/ to include/
2011-10-26 21:36:57 -04:00