summaryrefslogtreecommitdiff
path: root/lib/rbcodec/codecs/libopus/opus.h
diff options
context:
space:
mode:
authorWilliam Wilgus <me.theuser@yahoo.com>2019-01-04 02:01:18 -0600
committerSolomon Peachy <pizza@shaftnet.org>2021-04-23 14:23:04 +0000
commit14c6bb798d6bebc80f07e863236adbaf8d156a9c (patch)
tree551a4b641906c2626af844fa3239c1b2b1ff0ad3 /lib/rbcodec/codecs/libopus/opus.h
parent75d93937965ec4df70d37df6d4feea04577c996b (diff)
downloadrockbox-14c6bb798d6bebc80f07e863236adbaf8d156a9c.tar.gz
rockbox-14c6bb798d6bebc80f07e863236adbaf8d156a9c.zip
Sync opus codec to upstream git
Change-Id: I0cfcc0005c4ad7bfbb1aaf454188ce70fb043dc1
Diffstat (limited to 'lib/rbcodec/codecs/libopus/opus.h')
-rw-r--r--lib/rbcodec/codecs/libopus/opus.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/rbcodec/codecs/libopus/opus.h b/lib/rbcodec/codecs/libopus/opus.h
index 93a53a2ffc..d282f21d25 100644
--- a/lib/rbcodec/codecs/libopus/opus.h
+++ b/lib/rbcodec/codecs/libopus/opus.h
@@ -142,7 +142,7 @@ extern "C" {
142 * 142 *
143 * opus_encode() and opus_encode_float() return the number of bytes actually written to the packet. 143 * opus_encode() and opus_encode_float() return the number of bytes actually written to the packet.
144 * The return value <b>can be negative</b>, which indicates that an error has occurred. If the return value 144 * The return value <b>can be negative</b>, which indicates that an error has occurred. If the return value
145 * is 1 byte, then the packet does not need to be transmitted (DTX). 145 * is 2 bytes or less, then the packet does not need to be transmitted (DTX).
146 * 146 *
147 * Once the encoder state if no longer needed, it can be destroyed with 147 * Once the encoder state if no longer needed, it can be destroyed with
148 * 148 *
@@ -531,7 +531,7 @@ OPUS_EXPORT int opus_packet_parse(
531 const unsigned char *frames[48], 531 const unsigned char *frames[48],
532 opus_int16 size[48], 532 opus_int16 size[48],
533 int *payload_offset 533 int *payload_offset
534) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4); 534) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(5);
535 535
536/** Gets the bandwidth of an Opus packet. 536/** Gets the bandwidth of an Opus packet.
537 * @param [in] data <tt>char*</tt>: Opus packet 537 * @param [in] data <tt>char*</tt>: Opus packet
@@ -616,7 +616,10 @@ OPUS_EXPORT void opus_pcm_soft_clip(float *pcm, int frame_size, int channels, fl
616 * merged. Splitting valid Opus packets is always guaranteed to succeed, 616 * merged. Splitting valid Opus packets is always guaranteed to succeed,
617 * whereas merging valid packets only succeeds if all frames have the same 617 * whereas merging valid packets only succeeds if all frames have the same
618 * mode, bandwidth, and frame size, and when the total duration of the merged 618 * mode, bandwidth, and frame size, and when the total duration of the merged
619 * packet is no more than 120 ms. 619 * packet is no more than 120 ms. The 120 ms limit comes from the
620 * specification and limits decoder memory requirements at a point where
621 * framing overhead becomes negligible.
622 *
620 * The repacketizer currently only operates on elementary Opus 623 * The repacketizer currently only operates on elementary Opus
621 * streams. It will not manipualte multistream packets successfully, except in 624 * streams. It will not manipualte multistream packets successfully, except in
622 * the degenerate case where they consist of data from a single stream. 625 * the degenerate case where they consist of data from a single stream.