![](\"./res/SGM_app_icon_google_play.png\"){kind=icon}
\n\n \n
\n ![](\"./res/SmartGlassesManager_Screenshots_20230405.png\")
\n
OpusEncoder structure.\n * @param[in] channels int: Number of channels.\n * This must be 1 or 2.\n * @returns The size in bytes.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_encoder_get_size(int channels);\n\n/**\n */\n\n/** Allocates and initializes an encoder state.\n * There are three coding modes:\n *\n * @ref OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice\n * signals. It enhances the input signal by high-pass filtering and\n * emphasizing formants and harmonics. Optionally it includes in-band\n * forward error correction to protect against packet loss. Use this\n * mode for typical VoIP applications. Because of the enhancement,\n * even at high bitrates the output may sound different from the input.\n *\n * @ref OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most\n * non-voice signals like music. Use this mode for music and mixed\n * (music/voice) content, broadcast, and applications requiring less\n * than 15 ms of coding delay.\n *\n * @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that\n * disables the speech-optimized mode in exchange for slightly reduced delay.\n * This mode can only be set on an newly initialized or freshly reset encoder\n * because it changes the codec delay.\n *\n * This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution).\n * @param [in] Fs opus_int32: Sampling rate of input signal (Hz)\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param [in] channels int: Number of channels (1 or 2) in input signal\n * @param [in] application int: Coding mode (@ref OPUS_APPLICATION_VOIP/@ref OPUS_APPLICATION_AUDIO/@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY)\n * @param [out] error int*: @ref opus_errorcodes\n * @note Regardless of the sampling rate and number channels selected, the Opus encoder\n * can switch to a lower audio bandwidth or number of channels if the bitrate\n * selected is too low. This also means that it is safe to always use 48 kHz stereo input\n * and let the encoder optimize the encoding.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusEncoder *opus_encoder_create(\n opus_int32 Fs,\n int channels,\n int application,\n int *error\n);\n\n/** Initializes a previously allocated encoder state\n * The memory pointed to by st must be at least the size returned by opus_encoder_get_size().\n * This is intended for applications which use their own allocator instead of malloc.\n * @see opus_encoder_create(),opus_encoder_get_size()\n * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.\n * @param [in] st OpusEncoder*: Encoder state\n * @param [in] Fs opus_int32: Sampling rate of input signal (Hz)\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param [in] channels int: Number of channels (1 or 2) in input signal\n * @param [in] application int: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY)\n * @retval #OPUS_OK Success or @ref opus_errorcodes\n */\nOPUS_EXPORT int opus_encoder_init(\n OpusEncoder *st,\n opus_int32 Fs,\n int channels,\n int application\n) OPUS_ARG_NONNULL(1);\n\n/** Encodes an Opus frame.\n * @param [in] st OpusEncoder*: Encoder state\n * @param [in] pcm opus_int16*: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)\n * @param [in] frame_size int: Number of samples per channel in the\n * input signal.\n * This must be an Opus frame size for\n * the encoder's sampling rate.\n * For example, at 48 kHz the permitted\n * values are 120, 240, 480, 960, 1920,\n * and 2880.\n * Passing in a duration of less than\n * 10 ms (480 samples at 48 kHz) will\n * prevent the encoder from using the LPC\n * or hybrid modes.\n * @param [out] data unsigned char*: Output payload.\n * This must contain storage for at\n * least \\a max_data_bytes.\n * @param [in] max_data_bytes opus_int32: Size of the allocated\n * memory for the output\n * payload. This may be\n * used to impose an upper limit on\n * the instant bitrate, but should\n * not be used as the only bitrate\n * control. Use #OPUS_SET_BITRATE to\n * control the bitrate.\n * @returns The length of the encoded packet (in bytes) on success or a\n * negative error code (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode(\n OpusEncoder *st,\n const opus_int16 *pcm,\n int frame_size,\n unsigned char *data,\n opus_int32 max_data_bytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n/** Encodes an Opus frame from floating point input.\n * @param [in] st OpusEncoder*: Encoder state\n * @param [in] pcm float*: Input in float format (interleaved if 2 channels), with a normal range of +/-1.0.\n * Samples with a range beyond +/-1.0 are supported but will\n * be clipped by decoders using the integer API and should\n * only be used if it is known that the far end supports\n * extended dynamic range.\n * length is frame_size*channels*sizeof(float)\n * @param [in] frame_size int: Number of samples per channel in the\n * input signal.\n * This must be an Opus frame size for\n * the encoder's sampling rate.\n * For example, at 48 kHz the permitted\n * values are 120, 240, 480, 960, 1920,\n * and 2880.\n * Passing in a duration of less than\n * 10 ms (480 samples at 48 kHz) will\n * prevent the encoder from using the LPC\n * or hybrid modes.\n * @param [out] data unsigned char*: Output payload.\n * This must contain storage for at\n * least \\a max_data_bytes.\n * @param [in] max_data_bytes opus_int32: Size of the allocated\n * memory for the output\n * payload. This may be\n * used to impose an upper limit on\n * the instant bitrate, but should\n * not be used as the only bitrate\n * control. Use #OPUS_SET_BITRATE to\n * control the bitrate.\n * @returns The length of the encoded packet (in bytes) on success or a\n * negative error code (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode_float(\n OpusEncoder *st,\n const float *pcm,\n int frame_size,\n unsigned char *data,\n opus_int32 max_data_bytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n/** Frees an OpusEncoder allocated by opus_encoder_create().\n * @param[in] st OpusEncoder*: State to be freed.\n */\nOPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);\n\n/** Perform a CTL function on an Opus encoder.\n *\n * Generally the request and subsequent arguments are generated\n * by a convenience macro.\n * @param st OpusEncoder*: Encoder state.\n * @param request This and all remaining parameters should be replaced by one\n * of the convenience macros in @ref opus_genericctls or\n * @ref opus_encoderctls.\n * @see opus_genericctls\n * @see opus_encoderctls\n */\nOPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...) OPUS_ARG_NONNULL(1);\n/**@}*/\n\n/** @defgroup opus_decoder Opus Decoder\n * @{\n *\n * @brief This page describes the process and functions used to decode Opus.\n *\n * The decoding process also starts with creating a decoder\n * state. This can be done with:\n * @code\n * int error;\n * OpusDecoder *dec;\n * dec = opus_decoder_create(Fs, channels, &error);\n * @endcode\n * where\n * @li Fs is the sampling rate and must be 8000, 12000, 16000, 24000, or 48000\n * @li channels is the number of channels (1 or 2)\n * @li error will hold the error code in case of failure (or #OPUS_OK on success)\n * @li the return value is a newly created decoder state to be used for decoding\n *\n * While opus_decoder_create() allocates memory for the state, it's also possible\n * to initialize pre-allocated memory:\n * @code\n * int size;\n * int error;\n * OpusDecoder *dec;\n * size = opus_decoder_get_size(channels);\n * dec = malloc(size);\n * error = opus_decoder_init(dec, Fs, channels);\n * @endcode\n * where opus_decoder_get_size() returns the required size for the decoder state. Note that\n * future versions of this code may change the size, so no assuptions should be made about it.\n *\n * The decoder state is always continuous in memory and only a shallow copy is sufficient\n * to copy it (e.g. memcpy())\n *\n * To decode a frame, opus_decode() or opus_decode_float() must be called with a packet of compressed audio data:\n * @code\n * frame_size = opus_decode(dec, packet, len, decoded, max_size, 0);\n * @endcode\n * where\n *\n * @li packet is the byte array containing the compressed data\n * @li len is the exact number of bytes contained in the packet\n * @li decoded is the decoded audio data in opus_int16 (or float for opus_decode_float())\n * @li max_size is the max duration of the frame in samples (per channel) that can fit into the decoded_frame array\n *\n * opus_decode() and opus_decode_float() return the number of samples (per channel) decoded from the packet.\n * If that value is negative, then an error has occurred. This can occur if the packet is corrupted or if the audio\n * buffer is too small to hold the decoded audio.\n *\n * Opus is a stateful codec with overlapping blocks and as a result Opus\n * packets are not coded independently of each other. Packets must be\n * passed into the decoder serially and in the correct order for a correct\n * decode. Lost packets can be replaced with loss concealment by calling\n * the decoder with a null pointer and zero length for the missing packet.\n *\n * A single codec state may only be accessed from a single thread at\n * a time and any required locking must be performed by the caller. Separate\n * streams must be decoded with separate decoder states and can be decoded\n * in parallel unless the library was compiled with NONTHREADSAFE_PSEUDOSTACK\n * defined.\n *\n */\n\n/** Opus decoder state.\n * This contains the complete state of an Opus decoder.\n * It is position independent and can be freely copied.\n * @see opus_decoder_create,opus_decoder_init\n */\ntypedef struct OpusDecoder OpusDecoder;\n\n/** Gets the size of an OpusDecoder structure.\n * @param [in] channels int: Number of channels.\n * This must be 1 or 2.\n * @returns The size in bytes.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_size(int channels);\n\n/** Allocates and initializes a decoder state.\n * @param [in] Fs opus_int32: Sample rate to decode at (Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param [in] channels int: Number of channels (1 or 2) to decode\n * @param [out] error int*: #OPUS_OK Success or @ref opus_errorcodes\n *\n * Internally Opus stores data at 48000 Hz, so that should be the default\n * value for Fs. However, the decoder can efficiently decode to buffers\n * at 8, 12, 16, and 24 kHz so if for some reason the caller cannot use\n * data at the full sample rate, or knows the compressed data doesn't\n * use the full frequency range, it can request decoding at a reduced\n * rate. Likewise, the decoder is capable of filling in either mono or\n * interleaved stereo pcm buffers, at the caller's request.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusDecoder *opus_decoder_create(\n opus_int32 Fs,\n int channels,\n int *error\n);\n\n/** Initializes a previously allocated decoder state.\n * The state must be at least the size returned by opus_decoder_get_size().\n * This is intended for applications which use their own allocator instead of malloc. @see opus_decoder_create,opus_decoder_get_size\n * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.\n * @param [in] st OpusDecoder*: Decoder state.\n * @param [in] Fs opus_int32: Sampling rate to decode to (Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param [in] channels int: Number of channels (1 or 2) to decode\n * @retval #OPUS_OK Success or @ref opus_errorcodes\n */\nOPUS_EXPORT int opus_decoder_init(\n OpusDecoder *st,\n opus_int32 Fs,\n int channels\n) OPUS_ARG_NONNULL(1);\n\n/** Decode an Opus packet.\n * @param [in] st OpusDecoder*: Decoder state\n * @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss\n * @param [in] len opus_int32: Number of bytes in payload*\n * @param [out] pcm opus_int16*: Output signal (interleaved if 2 channels). length\n * is frame_size*channels*sizeof(opus_int16)\n * @param [in] frame_size Number of samples per channel of available space in \\a pcm.\n * If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will\n * not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1),\n * then frame_size needs to be exactly the duration of audio that is missing, otherwise the\n * decoder will not be in the optimal state to decode the next incoming packet. For the PLC and\n * FEC cases, frame_size must be a multiple of 2.5 ms.\n * @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be\n * decoded. If no such data is available, the frame is decoded as if it were lost.\n * @returns Number of decoded samples or @ref opus_errorcodes\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode(\n OpusDecoder *st,\n const unsigned char *data,\n opus_int32 len,\n opus_int16 *pcm,\n int frame_size,\n int decode_fec\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Decode an Opus packet with floating point output.\n * @param [in] st OpusDecoder*: Decoder state\n * @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss\n * @param [in] len opus_int32: Number of bytes in payload\n * @param [out] pcm float*: Output signal (interleaved if 2 channels). length\n * is frame_size*channels*sizeof(float)\n * @param [in] frame_size Number of samples per channel of available space in \\a pcm.\n * If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will\n * not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1),\n * then frame_size needs to be exactly the duration of audio that is missing, otherwise the\n * decoder will not be in the optimal state to decode the next incoming packet. For the PLC and\n * FEC cases, frame_size must be a multiple of 2.5 ms.\n * @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be\n * decoded. If no such data is available the frame is decoded as if it were lost.\n * @returns Number of decoded samples or @ref opus_errorcodes\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode_float(\n OpusDecoder *st,\n const unsigned char *data,\n opus_int32 len,\n float *pcm,\n int frame_size,\n int decode_fec\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Perform a CTL function on an Opus decoder.\n *\n * Generally the request and subsequent arguments are generated\n * by a convenience macro.\n * @param st OpusDecoder*: Decoder state.\n * @param request This and all remaining parameters should be replaced by one\n * of the convenience macros in @ref opus_genericctls or\n * @ref opus_decoderctls.\n * @see opus_genericctls\n * @see opus_decoderctls\n */\nOPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...) OPUS_ARG_NONNULL(1);\n\n/** Frees an OpusDecoder allocated by opus_decoder_create().\n * @param[in] st OpusDecoder*: State to be freed.\n */\nOPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);\n\n/** Parse an opus packet into one or more frames.\n * Opus_decode will perform this operation internally so most applications do\n * not need to use this function.\n * This function does not copy the frames, the returned pointers are pointers into\n * the input packet.\n * @param [in] data char*: Opus packet to be parsed\n * @param [in] len opus_int32: size of data\n * @param [out] out_toc char*: TOC pointer\n * @param [out] frames char*[48] encapsulated frames\n * @param [out] size opus_int16[48] sizes of the encapsulated frames\n * @param [out] payload_offset int*: returns the position of the payload within the packet (in bytes)\n * @returns number of frames\n */\nOPUS_EXPORT int opus_packet_parse(\n const unsigned char *data,\n opus_int32 len,\n unsigned char *out_toc,\n const unsigned char *frames[48],\n opus_int16 size[48],\n int *payload_offset\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(5);\n\n/** Gets the bandwidth of an Opus packet.\n * @param [in] data char*: Opus packet\n * @retval OPUS_BANDWIDTH_NARROWBAND Narrowband (4kHz bandpass)\n * @retval OPUS_BANDWIDTH_MEDIUMBAND Mediumband (6kHz bandpass)\n * @retval OPUS_BANDWIDTH_WIDEBAND Wideband (8kHz bandpass)\n * @retval OPUS_BANDWIDTH_SUPERWIDEBAND Superwideband (12kHz bandpass)\n * @retval OPUS_BANDWIDTH_FULLBAND Fullband (20kHz bandpass)\n * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_bandwidth(const unsigned char *data) OPUS_ARG_NONNULL(1);\n\n/** Gets the number of samples per frame from an Opus packet.\n * @param [in] data char*: Opus packet.\n * This must contain at least one byte of\n * data.\n * @param [in] Fs opus_int32: Sampling rate in Hz.\n * This must be a multiple of 400, or\n * inaccurate results will be returned.\n * @returns Number of samples per frame.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs) OPUS_ARG_NONNULL(1);\n\n/** Gets the number of channels from an Opus packet.\n * @param [in] data char*: Opus packet\n * @returns Number of channels\n * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_channels(const unsigned char *data) OPUS_ARG_NONNULL(1);\n\n/** Gets the number of frames in an Opus packet.\n * @param [in] packet char*: Opus packet\n * @param [in] len opus_int32: Length of packet\n * @returns Number of frames\n * @retval OPUS_BAD_ARG Insufficient data was passed to the function\n * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_frames(const unsigned char packet[], opus_int32 len) OPUS_ARG_NONNULL(1);\n\n/** Gets the number of samples of an Opus packet.\n * @param [in] packet char*: Opus packet\n * @param [in] len opus_int32: Length of packet\n * @param [in] Fs opus_int32: Sampling rate in Hz.\n * This must be a multiple of 400, or\n * inaccurate results will be returned.\n * @returns Number of samples\n * @retval OPUS_BAD_ARG Insufficient data was passed to the function\n * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_samples(const unsigned char packet[], opus_int32 len, opus_int32 Fs) OPUS_ARG_NONNULL(1);\n\n/** Gets the number of samples of an Opus packet.\n * @param [in] dec OpusDecoder*: Decoder state\n * @param [in] packet char*: Opus packet\n * @param [in] len opus_int32: Length of packet\n * @returns Number of samples\n * @retval OPUS_BAD_ARG Insufficient data was passed to the function\n * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], opus_int32 len) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);\n\n/** Applies soft-clipping to bring a float signal within the [-1,1] range. If\n * the signal is already in that range, nothing is done. If there are values\n * outside of [-1,1], then the signal is clipped as smoothly as possible to\n * both fit in the range and avoid creating excessive distortion in the\n * process.\n * @param [in,out] pcm float*: Input PCM and modified PCM\n * @param [in] frame_size int Number of samples per channel to process\n * @param [in] channels int: Number of channels\n * @param [in,out] softclip_mem float*: State memory for the soft clipping process (one float per channel, initialized to zero)\n */\nOPUS_EXPORT void opus_pcm_soft_clip(float *pcm, int frame_size, int channels, float *softclip_mem);\n\n\n/**@}*/\n\n/** @defgroup opus_repacketizer Repacketizer\n * @{\n *\n * The repacketizer can be used to merge multiple Opus packets into a single\n * packet or alternatively to split Opus packets that have previously been\n * merged. Splitting valid Opus packets is always guaranteed to succeed,\n * whereas merging valid packets only succeeds if all frames have the same\n * mode, bandwidth, and frame size, and when the total duration of the merged\n * packet is no more than 120 ms. The 120 ms limit comes from the\n * specification and limits decoder memory requirements at a point where\n * framing overhead becomes negligible.\n *\n * The repacketizer currently only operates on elementary Opus\n * streams. It will not manipualte multistream packets successfully, except in\n * the degenerate case where they consist of data from a single stream.\n *\n * The repacketizing process starts with creating a repacketizer state, either\n * by calling opus_repacketizer_create() or by allocating the memory yourself,\n * e.g.,\n * @code\n * OpusRepacketizer *rp;\n * rp = (OpusRepacketizer*)malloc(opus_repacketizer_get_size());\n * if (rp != NULL)\n * opus_repacketizer_init(rp);\n * @endcode\n *\n * Then the application should submit packets with opus_repacketizer_cat(),\n * extract new packets with opus_repacketizer_out() or\n * opus_repacketizer_out_range(), and then reset the state for the next set of\n * input packets via opus_repacketizer_init().\n *\n * For example, to split a sequence of packets into individual frames:\n * @code\n * unsigned char *data;\n * int len;\n * while (get_next_packet(&data, &len))\n * {\n * unsigned char out[1276];\n * opus_int32 out_len;\n * int nb_frames;\n * int err;\n * int i;\n * err = opus_repacketizer_cat(rp, data, len);\n * if (err != OPUS_OK)\n * {\n * release_packet(data);\n * return err;\n * }\n * nb_frames = opus_repacketizer_get_nb_frames(rp);\n * for (i = 0; i < nb_frames; i++)\n * {\n * out_len = opus_repacketizer_out_range(rp, i, i+1, out, sizeof(out));\n * if (out_len < 0)\n * {\n * release_packet(data);\n * return (int)out_len;\n * }\n * output_next_packet(out, out_len);\n * }\n * opus_repacketizer_init(rp);\n * release_packet(data);\n * }\n * @endcode\n *\n * Alternatively, to combine a sequence of frames into packets that each\n * contain up to TARGET_DURATION_MS milliseconds of data:\n * @code\n * // The maximum number of packets with duration TARGET_DURATION_MS occurs\n * // when the frame size is 2.5 ms, for a total of (TARGET_DURATION_MS*2/5)\n * // packets.\n * unsigned char *data[(TARGET_DURATION_MS*2/5)+1];\n * opus_int32 len[(TARGET_DURATION_MS*2/5)+1];\n * int nb_packets;\n * unsigned char out[1277*(TARGET_DURATION_MS*2/2)];\n * opus_int32 out_len;\n * int prev_toc;\n * nb_packets = 0;\n * while (get_next_packet(data+nb_packets, len+nb_packets))\n * {\n * int nb_frames;\n * int err;\n * nb_frames = opus_packet_get_nb_frames(data[nb_packets], len[nb_packets]);\n * if (nb_frames < 1)\n * {\n * release_packets(data, nb_packets+1);\n * return nb_frames;\n * }\n * nb_frames += opus_repacketizer_get_nb_frames(rp);\n * // If adding the next packet would exceed our target, or it has an\n * // incompatible TOC sequence, output the packets we already have before\n * // submitting it.\n * // N.B., The nb_packets > 0 check ensures we've submitted at least one\n * // packet since the last call to opus_repacketizer_init(). Otherwise a\n * // single packet longer than TARGET_DURATION_MS would cause us to try to\n * // output an (invalid) empty packet. It also ensures that prev_toc has\n * // been set to a valid value. Additionally, len[nb_packets] > 0 is\n * // guaranteed by the call to opus_packet_get_nb_frames() above, so the\n * // reference to data[nb_packets][0] should be valid.\n * if (nb_packets > 0 && (\n * ((prev_toc & 0xFC) != (data[nb_packets][0] & 0xFC)) ||\n * opus_packet_get_samples_per_frame(data[nb_packets], 48000)*nb_frames >\n * TARGET_DURATION_MS*48))\n * {\n * out_len = opus_repacketizer_out(rp, out, sizeof(out));\n * if (out_len < 0)\n * {\n * release_packets(data, nb_packets+1);\n * return (int)out_len;\n * }\n * output_next_packet(out, out_len);\n * opus_repacketizer_init(rp);\n * release_packets(data, nb_packets);\n * data[0] = data[nb_packets];\n * len[0] = len[nb_packets];\n * nb_packets = 0;\n * }\n * err = opus_repacketizer_cat(rp, data[nb_packets], len[nb_packets]);\n * if (err != OPUS_OK)\n * {\n * release_packets(data, nb_packets+1);\n * return err;\n * }\n * prev_toc = data[nb_packets][0];\n * nb_packets++;\n * }\n * // Output the final, partial packet.\n * if (nb_packets > 0)\n * {\n * out_len = opus_repacketizer_out(rp, out, sizeof(out));\n * release_packets(data, nb_packets);\n * if (out_len < 0)\n * return (int)out_len;\n * output_next_packet(out, out_len);\n * }\n * @endcode\n *\n * An alternate way of merging packets is to simply call opus_repacketizer_cat()\n * unconditionally until it fails. At that point, the merged packet can be\n * obtained with opus_repacketizer_out() and the input packet for which\n * opus_repacketizer_cat() needs to be re-added to a newly reinitialized\n * repacketizer state.\n */\n\ntypedef struct OpusRepacketizer OpusRepacketizer;\n\n/** Gets the size of an OpusRepacketizer structure.\n * @returns The size in bytes.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_size(void);\n\n/** (Re)initializes a previously allocated repacketizer state.\n * The state must be at least the size returned by opus_repacketizer_get_size().\n * This can be used for applications which use their own allocator instead of\n * malloc().\n * It must also be called to reset the queue of packets waiting to be\n * repacketized, which is necessary if the maximum packet duration of 120 ms\n * is reached or if you wish to submit packets with a different Opus\n * configuration (coding mode, audio bandwidth, frame size, or channel count).\n * Failure to do so will prevent a new packet from being added with\n * opus_repacketizer_cat().\n * @see opus_repacketizer_create\n * @see opus_repacketizer_get_size\n * @see opus_repacketizer_cat\n * @param rp OpusRepacketizer*: The repacketizer state to\n * (re)initialize.\n * @returns A pointer to the same repacketizer state that was passed in.\n */\nOPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1);\n\n/** Allocates memory and initializes the new repacketizer with\n * opus_repacketizer_init().\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusRepacketizer *opus_repacketizer_create(void);\n\n/** Frees an OpusRepacketizer allocated by\n * opus_repacketizer_create().\n * @param[in] rp OpusRepacketizer*: State to be freed.\n */\nOPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);\n\n/** Add a packet to the current repacketizer state.\n * This packet must match the configuration of any packets already submitted\n * for repacketization since the last call to opus_repacketizer_init().\n * This means that it must have the same coding mode, audio bandwidth, frame\n * size, and channel count.\n * This can be checked in advance by examining the top 6 bits of the first\n * byte of the packet, and ensuring they match the top 6 bits of the first\n * byte of any previously submitted packet.\n * The total duration of audio in the repacketizer state also must not exceed\n * 120 ms, the maximum duration of a single packet, after adding this packet.\n *\n * The contents of the current repacketizer state can be extracted into new\n * packets using opus_repacketizer_out() or opus_repacketizer_out_range().\n *\n * In order to add a packet with a different configuration or to add more\n * audio beyond 120 ms, you must clear the repacketizer state by calling\n * opus_repacketizer_init().\n * If a packet is too large to add to the current repacketizer state, no part\n * of it is added, even if it contains multiple frames, some of which might\n * fit.\n * If you wish to be able to add parts of such packets, you should first use\n * another repacketizer to split the packet into pieces and add them\n * individually.\n * @see opus_repacketizer_out_range\n * @see opus_repacketizer_out\n * @see opus_repacketizer_init\n * @param rp OpusRepacketizer*: The repacketizer state to which to\n * add the packet.\n * @param[in] data const unsigned char*: The packet data.\n * The application must ensure\n * this pointer remains valid\n * until the next call to\n * opus_repacketizer_init() or\n * opus_repacketizer_destroy().\n * @param len opus_int32: The number of bytes in the packet data.\n * @returns An error code indicating whether or not the operation succeeded.\n * @retval #OPUS_OK The packet's contents have been added to the repacketizer\n * state.\n * @retval #OPUS_INVALID_PACKET The packet did not have a valid TOC sequence,\n * the packet's TOC sequence was not compatible\n * with previously submitted packets (because\n * the coding mode, audio bandwidth, frame size,\n * or channel count did not match), or adding\n * this packet would increase the total amount of\n * audio stored in the repacketizer state to more\n * than 120 ms.\n */\nOPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, opus_int32 len) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);\n\n\n/** Construct a new packet from data previously submitted to the repacketizer\n * state via opus_repacketizer_cat().\n * @param rp OpusRepacketizer*: The repacketizer state from which to\n * construct the new packet.\n * @param begin int: The index of the first frame in the current\n * repacketizer state to include in the output.\n * @param end int: One past the index of the last frame in the\n * current repacketizer state to include in the\n * output.\n * @param[out] data const unsigned char*: The buffer in which to\n * store the output packet.\n * @param maxlen opus_int32: The maximum number of bytes to store in\n * the output buffer. In order to guarantee\n * success, this should be at least\n * 1276 for a single frame,\n * or for multiple frames,\n * 1277*(end-begin).\n * However, 1*(end-begin) plus\n * the size of all packet data submitted to\n * the repacketizer since the last call to\n * opus_repacketizer_init() or\n * opus_repacketizer_create() is also\n * sufficient, and possibly much smaller.\n * @returns The total size of the output packet on success, or an error code\n * on failure.\n * @retval #OPUS_BAD_ARG [begin,end) was an invalid range of\n * frames (begin < 0, begin >= end, or end >\n * opus_repacketizer_get_nb_frames()).\n * @retval #OPUS_BUFFER_TOO_SMALL \\a maxlen was insufficient to contain the\n * complete output packet.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, opus_int32 maxlen) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Return the total number of frames contained in packet data submitted to\n * the repacketizer state so far via opus_repacketizer_cat() since the last\n * call to opus_repacketizer_init() or opus_repacketizer_create().\n * This defines the valid range of packets that can be extracted with\n * opus_repacketizer_out_range() or opus_repacketizer_out().\n * @param rp OpusRepacketizer*: The repacketizer state containing the\n * frames.\n * @returns The total number of frames contained in the packet data submitted\n * to the repacketizer state.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1);\n\n/** Construct a new packet from data previously submitted to the repacketizer\n * state via opus_repacketizer_cat().\n * This is a convenience routine that returns all the data submitted so far\n * in a single packet.\n * It is equivalent to calling\n * @code\n * opus_repacketizer_out_range(rp, 0, opus_repacketizer_get_nb_frames(rp),\n * data, maxlen)\n * @endcode\n * @param rp OpusRepacketizer*: The repacketizer state from which to\n * construct the new packet.\n * @param[out] data const unsigned char*: The buffer in which to\n * store the output packet.\n * @param maxlen opus_int32: The maximum number of bytes to store in\n * the output buffer. In order to guarantee\n * success, this should be at least\n * 1277*opus_repacketizer_get_nb_frames(rp).\n * However,\n * 1*opus_repacketizer_get_nb_frames(rp)\n * plus the size of all packet data\n * submitted to the repacketizer since the\n * last call to opus_repacketizer_init() or\n * opus_repacketizer_create() is also\n * sufficient, and possibly much smaller.\n * @returns The total size of the output packet on success, or an error code\n * on failure.\n * @retval #OPUS_BUFFER_TOO_SMALL \\a maxlen was insufficient to contain the\n * complete output packet.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, opus_int32 maxlen) OPUS_ARG_NONNULL(1);\n\n/** Pads a given Opus packet to a larger size (possibly changing the TOC sequence).\n * @param[in,out] data const unsigned char*: The buffer containing the\n * packet to pad.\n * @param len opus_int32: The size of the packet.\n * This must be at least 1.\n * @param new_len opus_int32: The desired size of the packet after padding.\n * This must be at least as large as len.\n * @returns an error code\n * @retval #OPUS_OK \\a on success.\n * @retval #OPUS_BAD_ARG \\a len was less than 1 or new_len was less than len.\n * @retval #OPUS_INVALID_PACKET \\a data did not contain a valid Opus packet.\n */\nOPUS_EXPORT int opus_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len);\n\n/** Remove all padding from a given Opus packet and rewrite the TOC sequence to\n * minimize space usage.\n * @param[in,out] data const unsigned char*: The buffer containing the\n * packet to strip.\n * @param len opus_int32: The size of the packet.\n * This must be at least 1.\n * @returns The new size of the output packet on success, or an error code\n * on failure.\n * @retval #OPUS_BAD_ARG \\a len was less than 1.\n * @retval #OPUS_INVALID_PACKET \\a data did not contain a valid Opus packet.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_packet_unpad(unsigned char *data, opus_int32 len);\n\n/** Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence).\n * @param[in,out] data const unsigned char*: The buffer containing the\n * packet to pad.\n * @param len opus_int32: The size of the packet.\n * This must be at least 1.\n * @param new_len opus_int32: The desired size of the packet after padding.\n * This must be at least 1.\n * @param nb_streams opus_int32: The number of streams (not channels) in the packet.\n * This must be at least as large as len.\n * @returns an error code\n * @retval #OPUS_OK \\a on success.\n * @retval #OPUS_BAD_ARG \\a len was less than 1.\n * @retval #OPUS_INVALID_PACKET \\a data did not contain a valid Opus packet.\n */\nOPUS_EXPORT int opus_multistream_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len, int nb_streams);\n\n/** Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to\n * minimize space usage.\n * @param[in,out] data const unsigned char*: The buffer containing the\n * packet to strip.\n * @param len opus_int32: The size of the packet.\n * This must be at least 1.\n * @param nb_streams opus_int32: The number of streams (not channels) in the packet.\n * This must be at least 1.\n * @returns The new size of the output packet on success, or an error code\n * on failure.\n * @retval #OPUS_BAD_ARG \\a len was less than 1 or new_len was less than len.\n * @retval #OPUS_INVALID_PACKET \\a data did not contain a valid Opus packet.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_multistream_packet_unpad(unsigned char *data, opus_int32 len, int nb_streams);\n\n/**@}*/\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* OPUS_H */\n"
},
{
"path": "SGM_android/SmartGlassesManager/src/main/cpp/libopus/opus_custom.h",
"content": "/* Copyright (c) 2007-2008 CSIRO\n Copyright (c) 2007-2009 Xiph.Org Foundation\n Copyright (c) 2008-2012 Gregory Maxwell\n Written by Jean-Marc Valin and Gregory Maxwell */\n/*\n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions\n are met:\n\n - Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n - Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER\n OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\n LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n*/\n\n/**\n @file opus_custom.h\n @brief Opus-Custom reference implementation API\n */\n\n#ifndef OPUS_CUSTOM_H\n#define OPUS_CUSTOM_H\n\n#include \"opus_defines.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n#ifdef CUSTOM_MODES\n# define OPUS_CUSTOM_EXPORT OPUS_EXPORT\n# define OPUS_CUSTOM_EXPORT_STATIC OPUS_EXPORT\n#else\n# define OPUS_CUSTOM_EXPORT\n# ifdef OPUS_BUILD\n# define OPUS_CUSTOM_EXPORT_STATIC static OPUS_INLINE\n# else\n# define OPUS_CUSTOM_EXPORT_STATIC\n# endif\n#endif\n\n/** @defgroup opus_custom Opus Custom\n * @{\n * Opus Custom is an optional part of the Opus specification and\n * reference implementation which uses a distinct API from the regular\n * API and supports frame sizes that are not normally supported.\\ Use\n * of Opus Custom is discouraged for all but very special applications\n * for which a frame size different from 2.5, 5, 10, or 20 ms is needed\n * (for either complexity or latency reasons) and where interoperability\n * is less important.\n *\n * In addition to the interoperability limitations the use of Opus custom\n * disables a substantial chunk of the codec and generally lowers the\n * quality available at a given bitrate. Normally when an application needs\n * a different frame size from the codec it should buffer to match the\n * sizes but this adds a small amount of delay which may be important\n * in some very low latency applications. Some transports (especially\n * constant rate RF transports) may also work best with frames of\n * particular durations.\n *\n * Libopus only supports custom modes if they are enabled at compile time.\n *\n * The Opus Custom API is similar to the regular API but the\n * @ref opus_encoder_create and @ref opus_decoder_create calls take\n * an additional mode parameter which is a structure produced by\n * a call to @ref opus_custom_mode_create. Both the encoder and decoder\n * must create a mode using the same sample rate (fs) and frame size\n * (frame size) so these parameters must either be signaled out of band\n * or fixed in a particular implementation.\n *\n * Similar to regular Opus the custom modes support on the fly frame size\n * switching, but the sizes available depend on the particular frame size in\n * use. For some initial frame sizes on a single on the fly size is available.\n */\n\n/** Contains the state of an encoder. One encoder state is needed\n for each stream. It is initialized once at the beginning of the\n stream. Do *not* re-initialize the state for every frame.\n @brief Encoder state\n */\ntypedef struct OpusCustomEncoder OpusCustomEncoder;\n\n/** State of the decoder. One decoder state is needed for each stream.\n It is initialized once at the beginning of the stream. Do *not*\n re-initialize the state for every frame.\n @brief Decoder state\n */\ntypedef struct OpusCustomDecoder OpusCustomDecoder;\n\n/** The mode contains all the information necessary to create an\n encoder. Both the encoder and decoder need to be initialized\n with exactly the same mode, otherwise the output will be\n corrupted.\n @brief Mode configuration\n */\ntypedef struct OpusCustomMode OpusCustomMode;\n\n/** Creates a new mode struct. This will be passed to an encoder or\n * decoder. The mode MUST NOT BE DESTROYED until the encoders and\n * decoders that use it are destroyed as well.\n * @param [in] Fs int: Sampling rate (8000 to 96000 Hz)\n * @param [in] frame_size int: Number of samples (per channel) to encode in each\n * packet (64 - 1024, prime factorization must contain zero or more 2s, 3s, or 5s and no other primes)\n * @param [out] error int*: Returned error code (if NULL, no error will be returned)\n * @return A newly created mode\n */\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomMode *opus_custom_mode_create(opus_int32 Fs, int frame_size, int *error);\n\n/** Destroys a mode struct. Only call this after all encoders and\n * decoders using this mode are destroyed as well.\n * @param [in] mode OpusCustomMode*: Mode to be freed.\n */\nOPUS_CUSTOM_EXPORT void opus_custom_mode_destroy(OpusCustomMode *mode);\n\n\n#if !defined(OPUS_BUILD) || defined(CELT_ENCODER_C)\n\n/* Encoder */\n/** Gets the size of an OpusCustomEncoder structure.\n * @param [in] mode OpusCustomMode *: Mode configuration\n * @param [in] channels int: Number of channels\n * @returns size\n */\nOPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_encoder_get_size(\n const OpusCustomMode *mode,\n int channels\n) OPUS_ARG_NONNULL(1);\n\n# ifdef CUSTOM_MODES\n/** Initializes a previously allocated encoder state\n * The memory pointed to by st must be the size returned by opus_custom_encoder_get_size.\n * This is intended for applications which use their own allocator instead of malloc.\n * @see opus_custom_encoder_create(),opus_custom_encoder_get_size()\n * To reset a previously initialized state use the OPUS_RESET_STATE CTL.\n * @param [in] st OpusCustomEncoder*: Encoder state\n * @param [in] mode OpusCustomMode *: Contains all the information about the characteristics of\n * the stream (must be the same characteristics as used for the\n * decoder)\n * @param [in] channels int: Number of channels\n * @return OPUS_OK Success or @ref opus_errorcodes\n */\nOPUS_CUSTOM_EXPORT int opus_custom_encoder_init(\n OpusCustomEncoder *st,\n const OpusCustomMode *mode,\n int channels\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);\n# endif\n#endif\n\n\n/** Creates a new encoder state. Each stream needs its own encoder\n * state (can't be shared across simultaneous streams).\n * @param [in] mode OpusCustomMode*: Contains all the information about the characteristics of\n * the stream (must be the same characteristics as used for the\n * decoder)\n * @param [in] channels int: Number of channels\n * @param [out] error int*: Returns an error code\n * @return Newly created encoder state.\n*/\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomEncoder *opus_custom_encoder_create(\n const OpusCustomMode *mode,\n int channels,\n int *error\n) OPUS_ARG_NONNULL(1);\n\n\n/** Destroys a an encoder state.\n * @param[in] st OpusCustomEncoder*: State to be freed.\n */\nOPUS_CUSTOM_EXPORT void opus_custom_encoder_destroy(OpusCustomEncoder *st);\n\n/** Encodes a frame of audio.\n * @param [in] st OpusCustomEncoder*: Encoder state\n * @param [in] pcm float*: PCM audio in float format, with a normal range of +/-1.0.\n * Samples with a range beyond +/-1.0 are supported but will\n * be clipped by decoders using the integer API and should\n * only be used if it is known that the far end supports\n * extended dynamic range. There must be exactly\n * frame_size samples per channel.\n * @param [in] frame_size int: Number of samples per frame of input signal\n * @param [out] compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.\n * @param [in] maxCompressedBytes int: Maximum number of bytes to use for compressing the frame\n * (can change from one frame to another)\n * @return Number of bytes written to \"compressed\".\n * If negative, an error has occurred (see error codes). It is IMPORTANT that\n * the length returned be somehow transmitted to the decoder. Otherwise, no\n * decoding is possible.\n */\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode_float(\n OpusCustomEncoder *st,\n const float *pcm,\n int frame_size,\n unsigned char *compressed,\n int maxCompressedBytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n/** Encodes a frame of audio.\n * @param [in] st OpusCustomEncoder*: Encoder state\n * @param [in] pcm opus_int16*: PCM audio in signed 16-bit format (native endian).\n * There must be exactly frame_size samples per channel.\n * @param [in] frame_size int: Number of samples per frame of input signal\n * @param [out] compressed char *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.\n * @param [in] maxCompressedBytes int: Maximum number of bytes to use for compressing the frame\n * (can change from one frame to another)\n * @return Number of bytes written to \"compressed\".\n * If negative, an error has occurred (see error codes). It is IMPORTANT that\n * the length returned be somehow transmitted to the decoder. Otherwise, no\n * decoding is possible.\n */\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode(\n OpusCustomEncoder *st,\n const opus_int16 *pcm,\n int frame_size,\n unsigned char *compressed,\n int maxCompressedBytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n/** Perform a CTL function on an Opus custom encoder.\n *\n * Generally the request and subsequent arguments are generated\n * by a convenience macro.\n * @see opus_encoderctls\n */\nOPUS_CUSTOM_EXPORT int opus_custom_encoder_ctl(OpusCustomEncoder * OPUS_RESTRICT st, int request, ...) OPUS_ARG_NONNULL(1);\n\n\n#if !defined(OPUS_BUILD) || defined(CELT_DECODER_C)\n/* Decoder */\n\n/** Gets the size of an OpusCustomDecoder structure.\n * @param [in] mode OpusCustomMode *: Mode configuration\n * @param [in] channels int: Number of channels\n * @returns size\n */\nOPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_decoder_get_size(\n const OpusCustomMode *mode,\n int channels\n) OPUS_ARG_NONNULL(1);\n\n/** Initializes a previously allocated decoder state\n * The memory pointed to by st must be the size returned by opus_custom_decoder_get_size.\n * This is intended for applications which use their own allocator instead of malloc.\n * @see opus_custom_decoder_create(),opus_custom_decoder_get_size()\n * To reset a previously initialized state use the OPUS_RESET_STATE CTL.\n * @param [in] st OpusCustomDecoder*: Decoder state\n * @param [in] mode OpusCustomMode *: Contains all the information about the characteristics of\n * the stream (must be the same characteristics as used for the\n * encoder)\n * @param [in] channels int: Number of channels\n * @return OPUS_OK Success or @ref opus_errorcodes\n */\nOPUS_CUSTOM_EXPORT_STATIC int opus_custom_decoder_init(\n OpusCustomDecoder *st,\n const OpusCustomMode *mode,\n int channels\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);\n\n#endif\n\n\n/** Creates a new decoder state. Each stream needs its own decoder state (can't\n * be shared across simultaneous streams).\n * @param [in] mode OpusCustomMode: Contains all the information about the characteristics of the\n * stream (must be the same characteristics as used for the encoder)\n * @param [in] channels int: Number of channels\n * @param [out] error int*: Returns an error code\n * @return Newly created decoder state.\n */\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomDecoder *opus_custom_decoder_create(\n const OpusCustomMode *mode,\n int channels,\n int *error\n) OPUS_ARG_NONNULL(1);\n\n/** Destroys a an decoder state.\n * @param[in] st OpusCustomDecoder*: State to be freed.\n */\nOPUS_CUSTOM_EXPORT void opus_custom_decoder_destroy(OpusCustomDecoder *st);\n\n/** Decode an opus custom frame with floating point output\n * @param [in] st OpusCustomDecoder*: Decoder state\n * @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss\n * @param [in] len int: Number of bytes in payload\n * @param [out] pcm float*: Output signal (interleaved if 2 channels). length\n * is frame_size*channels*sizeof(float)\n * @param [in] frame_size Number of samples per channel of available space in *pcm.\n * @returns Number of decoded samples or @ref opus_errorcodes\n */\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode_float(\n OpusCustomDecoder *st,\n const unsigned char *data,\n int len,\n float *pcm,\n int frame_size\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Decode an opus custom frame\n * @param [in] st OpusCustomDecoder*: Decoder state\n * @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss\n * @param [in] len int: Number of bytes in payload\n * @param [out] pcm opus_int16*: Output signal (interleaved if 2 channels). length\n * is frame_size*channels*sizeof(opus_int16)\n * @param [in] frame_size Number of samples per channel of available space in *pcm.\n * @returns Number of decoded samples or @ref opus_errorcodes\n */\nOPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode(\n OpusCustomDecoder *st,\n const unsigned char *data,\n int len,\n opus_int16 *pcm,\n int frame_size\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Perform a CTL function on an Opus custom decoder.\n *\n * Generally the request and subsequent arguments are generated\n * by a convenience macro.\n * @see opus_genericctls\n */\nOPUS_CUSTOM_EXPORT int opus_custom_decoder_ctl(OpusCustomDecoder * OPUS_RESTRICT st, int request, ...) OPUS_ARG_NONNULL(1);\n\n/**@}*/\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* OPUS_CUSTOM_H */\n"
},
{
"path": "SGM_android/SmartGlassesManager/src/main/cpp/libopus/opus_defines.h",
"content": "/* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited\n Written by Jean-Marc Valin and Koen Vos */\n/*\n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions\n are met:\n\n - Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n - Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER\n OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\n LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n*/\n\n/**\n * @file opus_defines.h\n * @brief Opus reference implementation constants\n */\n\n#ifndef OPUS_DEFINES_H\n#define OPUS_DEFINES_H\n\n#include \"opus_types.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/** @defgroup opus_errorcodes Error codes\n * @{\n */\n/** No error @hideinitializer*/\n#define OPUS_OK 0\n/** One or more invalid/out of range arguments @hideinitializer*/\n#define OPUS_BAD_ARG -1\n/** Not enough bytes allocated in the buffer @hideinitializer*/\n#define OPUS_BUFFER_TOO_SMALL -2\n/** An internal error was detected @hideinitializer*/\n#define OPUS_INTERNAL_ERROR -3\n/** The compressed data passed is corrupted @hideinitializer*/\n#define OPUS_INVALID_PACKET -4\n/** Invalid/unsupported request number @hideinitializer*/\n#define OPUS_UNIMPLEMENTED -5\n/** An encoder or decoder structure is invalid or already freed @hideinitializer*/\n#define OPUS_INVALID_STATE -6\n/** Memory allocation has failed @hideinitializer*/\n#define OPUS_ALLOC_FAIL -7\n/**@}*/\n\n/** @cond OPUS_INTERNAL_DOC */\n/**Export control for opus functions */\n\n#ifndef OPUS_EXPORT\n# if defined(WIN32)\n# if defined(OPUS_BUILD) && defined(DLL_EXPORT)\n# define OPUS_EXPORT __declspec(dllexport)\n# else\n# define OPUS_EXPORT\n# endif\n# elif defined(__GNUC__) && defined(OPUS_BUILD)\n# define OPUS_EXPORT __attribute__ ((visibility (\"default\")))\n# else\n# define OPUS_EXPORT\n# endif\n#endif\n\n# if !defined(OPUS_GNUC_PREREQ)\n# if defined(__GNUC__)&&defined(__GNUC_MINOR__)\n# define OPUS_GNUC_PREREQ(_maj,_min) \\\n ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))\n# else\n# define OPUS_GNUC_PREREQ(_maj,_min) 0\n# endif\n# endif\n\n#if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )\n# if OPUS_GNUC_PREREQ(3,0)\n# define OPUS_RESTRICT __restrict__\n# elif (defined(_MSC_VER) && _MSC_VER >= 1400)\n# define OPUS_RESTRICT __restrict\n# else\n# define OPUS_RESTRICT\n# endif\n#else\n# define OPUS_RESTRICT restrict\n#endif\n\n#if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )\n# if OPUS_GNUC_PREREQ(2,7)\n# define OPUS_INLINE __inline__\n# elif (defined(_MSC_VER))\n# define OPUS_INLINE __inline\n# else\n# define OPUS_INLINE\n# endif\n#else\n# define OPUS_INLINE inline\n#endif\n\n/**Warning attributes for opus functions\n * NONNULL is not used in OPUS_BUILD to avoid the compiler optimizing out\n * some paranoid null checks. */\n#if defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)\n# define OPUS_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))\n#else\n# define OPUS_WARN_UNUSED_RESULT\n#endif\n#if !defined(OPUS_BUILD) && defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)\n# define OPUS_ARG_NONNULL(_x) __attribute__ ((__nonnull__(_x)))\n#else\n# define OPUS_ARG_NONNULL(_x)\n#endif\n\n/** These are the actual Encoder CTL ID numbers.\n * They should not be used directly by applications.\n * In general, SETs should be even and GETs should be odd.*/\n#define OPUS_SET_APPLICATION_REQUEST 4000\n#define OPUS_GET_APPLICATION_REQUEST 4001\n#define OPUS_SET_BITRATE_REQUEST 4002\n#define OPUS_GET_BITRATE_REQUEST 4003\n#define OPUS_SET_MAX_BANDWIDTH_REQUEST 4004\n#define OPUS_GET_MAX_BANDWIDTH_REQUEST 4005\n#define OPUS_SET_VBR_REQUEST 4006\n#define OPUS_GET_VBR_REQUEST 4007\n#define OPUS_SET_BANDWIDTH_REQUEST 4008\n#define OPUS_GET_BANDWIDTH_REQUEST 4009\n#define OPUS_SET_COMPLEXITY_REQUEST 4010\n#define OPUS_GET_COMPLEXITY_REQUEST 4011\n#define OPUS_SET_INBAND_FEC_REQUEST 4012\n#define OPUS_GET_INBAND_FEC_REQUEST 4013\n#define OPUS_SET_PACKET_LOSS_PERC_REQUEST 4014\n#define OPUS_GET_PACKET_LOSS_PERC_REQUEST 4015\n#define OPUS_SET_DTX_REQUEST 4016\n#define OPUS_GET_DTX_REQUEST 4017\n#define OPUS_SET_VBR_CONSTRAINT_REQUEST 4020\n#define OPUS_GET_VBR_CONSTRAINT_REQUEST 4021\n#define OPUS_SET_FORCE_CHANNELS_REQUEST 4022\n#define OPUS_GET_FORCE_CHANNELS_REQUEST 4023\n#define OPUS_SET_SIGNAL_REQUEST 4024\n#define OPUS_GET_SIGNAL_REQUEST 4025\n#define OPUS_GET_LOOKAHEAD_REQUEST 4027\n/* #define OPUS_RESET_STATE 4028 */\n#define OPUS_GET_SAMPLE_RATE_REQUEST 4029\n#define OPUS_GET_FINAL_RANGE_REQUEST 4031\n#define OPUS_GET_PITCH_REQUEST 4033\n#define OPUS_SET_GAIN_REQUEST 4034\n#define OPUS_GET_GAIN_REQUEST 4045 /* Should have been 4035 */\n#define OPUS_SET_LSB_DEPTH_REQUEST 4036\n#define OPUS_GET_LSB_DEPTH_REQUEST 4037\n#define OPUS_GET_LAST_PACKET_DURATION_REQUEST 4039\n#define OPUS_SET_EXPERT_FRAME_DURATION_REQUEST 4040\n#define OPUS_GET_EXPERT_FRAME_DURATION_REQUEST 4041\n#define OPUS_SET_PREDICTION_DISABLED_REQUEST 4042\n#define OPUS_GET_PREDICTION_DISABLED_REQUEST 4043\n/* Don't use 4045, it's already taken by OPUS_GET_GAIN_REQUEST */\n#define OPUS_SET_PHASE_INVERSION_DISABLED_REQUEST 4046\n#define OPUS_GET_PHASE_INVERSION_DISABLED_REQUEST 4047\n#define OPUS_GET_IN_DTX_REQUEST 4049\n\n/** Defines for the presence of extended APIs. */\n#define OPUS_HAVE_OPUS_PROJECTION_H\n\n/* Macros to trigger compilation errors when the wrong types are provided to a CTL */\n#define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))\n#define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))\n#define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))\n#define __opus_check_val16_ptr(ptr) ((ptr) + ((ptr) - (opus_val16*)(ptr)))\n/** @endcond */\n\n/** @defgroup opus_ctlvalues Pre-defined values for CTL interface\n * @see opus_genericctls, opus_encoderctls\n * @{\n */\n/* Values for the various encoder CTLs */\n#define OPUS_AUTO -1000 /**Fs value passed to opus_encoder_init()\n * or opus_decoder_init().\n * @param[out] x opus_int32 *: Sampling rate of encoder or decoder.\n * @hideinitializer\n */\n#define OPUS_GET_SAMPLE_RATE(x) OPUS_GET_SAMPLE_RATE_REQUEST, __opus_check_int_ptr(x)\n\n/** If set to 1, disables the use of phase inversion for intensity stereo,\n * improving the quality of mono downmixes, but slightly reducing normal\n * stereo quality. Disabling phase inversion in the decoder does not comply\n * with RFC 6716, although it does not cause any interoperability issue and\n * is expected to become part of the Opus standard once RFC 6716 is updated\n * by draft-ietf-codec-opus-update.\n * @see OPUS_GET_PHASE_INVERSION_DISABLED\n * @param[in] x opus_int32: Allowed values:\n * streams parameter used\n * to initialize the encoder.\n * @param[out] y OpusEncoder**: Returns a pointer to the given\n * encoder state.\n * @retval OPUS_BAD_ARG The index of the requested stream was out of range.\n * @hideinitializer\n */\n#define OPUS_MULTISTREAM_GET_ENCODER_STATE(x,y) OPUS_MULTISTREAM_GET_ENCODER_STATE_REQUEST, __opus_check_int(x), __opus_check_encstate_ptr(y)\n\n/** Gets the decoder state for an individual stream of a multistream decoder.\n * @param[in] x opus_int32: The index of the stream whose decoder you\n * wish to retrieve.\n * This must be non-negative and less than\n * the streams parameter used\n * to initialize the decoder.\n * @param[out] y OpusDecoder**: Returns a pointer to the given\n * decoder state.\n * @retval OPUS_BAD_ARG The index of the requested stream was out of range.\n * @hideinitializer\n */\n#define OPUS_MULTISTREAM_GET_DECODER_STATE(x,y) OPUS_MULTISTREAM_GET_DECODER_STATE_REQUEST, __opus_check_int(x), __opus_check_decstate_ptr(y)\n\n/**@}*/\n\n/** @defgroup opus_multistream Opus Multistream API\n * @{\n *\n * The multistream API allows individual Opus streams to be combined into a\n * single packet, enabling support for up to 255 channels. Unlike an\n * elementary Opus stream, the encoder and decoder must negotiate the channel\n * configuration before the decoder can successfully interpret the data in the\n * packets produced by the encoder. Some basic information, such as packet\n * duration, can be computed without any special negotiation.\n *\n * The format for multistream Opus packets is defined in\n * RFC 7845\n * and is based on the self-delimited Opus framing described in Appendix B of\n * RFC 6716.\n * Normal Opus packets are just a degenerate case of multistream Opus packets,\n * and can be encoded or decoded with the multistream API by setting\n * streams to 1 when initializing the encoder or\n * decoder.\n *\n * Multistream Opus streams can contain up to 255 elementary Opus streams.\n * These may be either \"uncoupled\" or \"coupled\", indicating that the decoder\n * is configured to decode them to either 1 or 2 channels, respectively.\n * The streams are ordered so that all coupled streams appear at the\n * beginning.\n *\n * A mapping table defines which decoded channel i\n * should be used for each input/output (I/O) channel j. This table is\n * typically provided as an unsigned char array.\n * Let i = mapping[j] be the index for I/O channel j.\n * If i < 2*coupled_streams, then I/O channel j is\n * encoded as the left channel of stream (i/2) if i\n * is even, or as the right channel of stream (i/2) if\n * i is odd. Otherwise, I/O channel j is encoded as\n * mono in stream (i - coupled_streams), unless it has the special\n * value 255, in which case it is omitted from the encoding entirely (the\n * decoder will reproduce it as silence). Each value i must either\n * be the special value 255 or be less than streams + coupled_streams.\n *\n * The output channels specified by the encoder\n * should use the\n * Vorbis\n * channel ordering. A decoder may wish to apply an additional permutation\n * to the mapping the encoder used to achieve a different output channel\n * order (e.g. for outputing in WAV order).\n *\n * Each multistream packet contains an Opus packet for each stream, and all of\n * the Opus packets in a single multistream packet must have the same\n * duration. Therefore the duration of a multistream packet can be extracted\n * from the TOC sequence of the first stream, which is located at the\n * beginning of the packet, just like an elementary Opus stream:\n *\n * @code\n * int nb_samples;\n * int nb_frames;\n * nb_frames = opus_packet_get_nb_frames(data, len);\n * if (nb_frames < 1)\n * return nb_frames;\n * nb_samples = opus_packet_get_samples_per_frame(data, 48000) * nb_frames;\n * @endcode\n *\n * The general encoding and decoding process proceeds exactly the same as in\n * the normal @ref opus_encoder and @ref opus_decoder APIs.\n * See their documentation for an overview of how to use the corresponding\n * multistream functions.\n */\n\n/** Opus multistream encoder state.\n * This contains the complete state of a multistream Opus encoder.\n * It is position independent and can be freely copied.\n * @see opus_multistream_encoder_create\n * @see opus_multistream_encoder_init\n */\ntypedef struct OpusMSEncoder OpusMSEncoder;\n\n/** Opus multistream decoder state.\n * This contains the complete state of a multistream Opus decoder.\n * It is position independent and can be freely copied.\n * @see opus_multistream_decoder_create\n * @see opus_multistream_decoder_init\n */\ntypedef struct OpusMSDecoder OpusMSDecoder;\n\n/**\\name Multistream encoder functions */\n/**@{*/\n\n/** Gets the size of an OpusMSEncoder structure.\n * @param streams int: The total number of streams to encode from the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number of coupled (2 channel) streams\n * to encode.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * encoded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @returns The size in bytes on success, or a negative error code\n * (see @ref opus_errorcodes) on error.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_multistream_encoder_get_size(\n int streams,\n int coupled_streams\n);\n\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_multistream_surround_encoder_get_size(\n int channels,\n int mapping_family\n);\n\n\n/** Allocates and initializes a multistream encoder state.\n * Call opus_multistream_encoder_destroy() to release\n * this object when finished.\n * @param Fs opus_int32: Sampling rate of the input signal (in Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param channels int: Number of channels in the input signal.\n * This must be at most 255.\n * It may be greater than the number of\n * coded channels (streams +\n * coupled_streams).\n * @param streams int: The total number of streams to encode from the\n * input.\n * This must be no more than the number of channels.\n * @param coupled_streams int: Number of coupled (2 channel) streams\n * to encode.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * encoded channels (streams +\n * coupled_streams) must be no\n * more than the number of input channels.\n * @param[in] mapping const unsigned char[channels]: Mapping from\n * encoded channels to input channels, as described in\n * @ref opus_multistream. As an extra constraint, the\n * multistream encoder does not allow encoding coupled\n * streams for which one channel is unused since this\n * is never a good idea.\n * @param application int: The target encoder application.\n * This must be one of the following:\n * streams +\n * coupled_streams).\n * @param streams int: The total number of streams to encode from the\n * input.\n * This must be no more than the number of channels.\n * @param coupled_streams int: Number of coupled (2 channel) streams\n * to encode.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * encoded channels (streams +\n * coupled_streams) must be no\n * more than the number of input channels.\n * @param[in] mapping const unsigned char[channels]: Mapping from\n * encoded channels to input channels, as described in\n * @ref opus_multistream. As an extra constraint, the\n * multistream encoder does not allow encoding coupled\n * streams for which one channel is unused since this\n * is never a good idea.\n * @param application int: The target encoder application.\n * This must be one of the following:\n * frame_size*channels\n * samples.\n * @param frame_size int: Number of samples per channel in the input\n * signal.\n * This must be an Opus frame size for the\n * encoder's sampling rate.\n * For example, at 48 kHz the permitted values\n * are 120, 240, 480, 960, 1920, and 2880.\n * Passing in a duration of less than 10 ms\n * (480 samples at 48 kHz) will prevent the\n * encoder from using the LPC or hybrid modes.\n * @param[out] data unsigned char*: Output payload.\n * This must contain storage for at\n * least \\a max_data_bytes.\n * @param [in] max_data_bytes opus_int32: Size of the allocated\n * memory for the output\n * payload. This may be\n * used to impose an upper limit on\n * the instant bitrate, but should\n * not be used as the only bitrate\n * control. Use #OPUS_SET_BITRATE to\n * control the bitrate.\n * @returns The length of the encoded packet (in bytes) on success or a\n * negative error code (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_encode(\n OpusMSEncoder *st,\n const opus_int16 *pcm,\n int frame_size,\n unsigned char *data,\n opus_int32 max_data_bytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n/** Encodes a multistream Opus frame from floating point input.\n * @param st OpusMSEncoder*: Multistream encoder state.\n * @param[in] pcm const float*: The input signal as interleaved\n * samples with a normal range of\n * +/-1.0.\n * Samples with a range beyond +/-1.0\n * are supported but will be clipped by\n * decoders using the integer API and\n * should only be used if it is known\n * that the far end supports extended\n * dynamic range.\n * This must contain\n * frame_size*channels\n * samples.\n * @param frame_size int: Number of samples per channel in the input\n * signal.\n * This must be an Opus frame size for the\n * encoder's sampling rate.\n * For example, at 48 kHz the permitted values\n * are 120, 240, 480, 960, 1920, and 2880.\n * Passing in a duration of less than 10 ms\n * (480 samples at 48 kHz) will prevent the\n * encoder from using the LPC or hybrid modes.\n * @param[out] data unsigned char*: Output payload.\n * This must contain storage for at\n * least \\a max_data_bytes.\n * @param [in] max_data_bytes opus_int32: Size of the allocated\n * memory for the output\n * payload. This may be\n * used to impose an upper limit on\n * the instant bitrate, but should\n * not be used as the only bitrate\n * control. Use #OPUS_SET_BITRATE to\n * control the bitrate.\n * @returns The length of the encoded packet (in bytes) on success or a\n * negative error code (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_encode_float(\n OpusMSEncoder *st,\n const float *pcm,\n int frame_size,\n unsigned char *data,\n opus_int32 max_data_bytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n/** Frees an OpusMSEncoder allocated by\n * opus_multistream_encoder_create().\n * @param st OpusMSEncoder*: Multistream encoder state to be freed.\n */\nOPUS_EXPORT void opus_multistream_encoder_destroy(OpusMSEncoder *st);\n\n/** Perform a CTL function on a multistream Opus encoder.\n *\n * Generally the request and subsequent arguments are generated by a\n * convenience macro.\n * @param st OpusMSEncoder*: Multistream encoder state.\n * @param request This and all remaining parameters should be replaced by one\n * of the convenience macros in @ref opus_genericctls,\n * @ref opus_encoderctls, or @ref opus_multistream_ctls.\n * @see opus_genericctls\n * @see opus_encoderctls\n * @see opus_multistream_ctls\n */\nOPUS_EXPORT int opus_multistream_encoder_ctl(OpusMSEncoder *st, int request, ...) OPUS_ARG_NONNULL(1);\n\n/**@}*/\n\n/**\\name Multistream decoder functions */\n/**@{*/\n\n/** Gets the size of an OpusMSDecoder structure.\n * @param streams int: The total number of streams coded in the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number streams to decode as coupled\n * (2 channel) streams.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * coded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @returns The size in bytes on success, or a negative error code\n * (see @ref opus_errorcodes) on error.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_multistream_decoder_get_size(\n int streams,\n int coupled_streams\n);\n\n/** Allocates and initializes a multistream decoder state.\n * Call opus_multistream_decoder_destroy() to release\n * this object when finished.\n * @param Fs opus_int32: Sampling rate to decode at (in Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param channels int: Number of channels to output.\n * This must be at most 255.\n * It may be different from the number of coded\n * channels (streams +\n * coupled_streams).\n * @param streams int: The total number of streams coded in the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number of streams to decode as coupled\n * (2 channel) streams.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * coded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @param[in] mapping const unsigned char[channels]: Mapping from\n * coded channels to output channels, as described in\n * @ref opus_multistream.\n * @param[out] error int *: Returns #OPUS_OK on success, or an error\n * code (see @ref opus_errorcodes) on\n * failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusMSDecoder *opus_multistream_decoder_create(\n opus_int32 Fs,\n int channels,\n int streams,\n int coupled_streams,\n const unsigned char *mapping,\n int *error\n) OPUS_ARG_NONNULL(5);\n\n/** Intialize a previously allocated decoder state object.\n * The memory pointed to by \\a st must be at least the size returned by\n * opus_multistream_encoder_get_size().\n * This is intended for applications which use their own allocator instead of\n * malloc.\n * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.\n * @see opus_multistream_decoder_create\n * @see opus_multistream_deocder_get_size\n * @param st OpusMSEncoder*: Multistream encoder state to initialize.\n * @param Fs opus_int32: Sampling rate to decode at (in Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param channels int: Number of channels to output.\n * This must be at most 255.\n * It may be different from the number of coded\n * channels (streams +\n * coupled_streams).\n * @param streams int: The total number of streams coded in the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number of streams to decode as coupled\n * (2 channel) streams.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * coded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @param[in] mapping const unsigned char[channels]: Mapping from\n * coded channels to output channels, as described in\n * @ref opus_multistream.\n * @returns #OPUS_OK on success, or an error code (see @ref opus_errorcodes)\n * on failure.\n */\nOPUS_EXPORT int opus_multistream_decoder_init(\n OpusMSDecoder *st,\n opus_int32 Fs,\n int channels,\n int streams,\n int coupled_streams,\n const unsigned char *mapping\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(6);\n\n/** Decode a multistream Opus packet.\n * @param st OpusMSDecoder*: Multistream decoder state.\n * @param[in] data const unsigned char*: Input payload.\n * Use a NULL\n * pointer to indicate packet\n * loss.\n * @param len opus_int32: Number of bytes in payload.\n * @param[out] pcm opus_int16*: Output signal, with interleaved\n * samples.\n * This must contain room for\n * frame_size*channels\n * samples.\n * @param frame_size int: The number of samples per channel of\n * available space in \\a pcm.\n * If this is less than the maximum packet duration\n * (120 ms; 5760 for 48kHz), this function will not be capable\n * of decoding some packets. In the case of PLC (data==NULL)\n * or FEC (decode_fec=1), then frame_size needs to be exactly\n * the duration of audio that is missing, otherwise the\n * decoder will not be in the optimal state to decode the\n * next incoming packet. For the PLC and FEC cases, frame_size\n * must be a multiple of 2.5 ms.\n * @param decode_fec int: Flag (0 or 1) to request that any in-band\n * forward error correction data be decoded.\n * If no such data is available, the frame is\n * decoded as if it were lost.\n * @returns Number of samples decoded on success or a negative error code\n * (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_decode(\n OpusMSDecoder *st,\n const unsigned char *data,\n opus_int32 len,\n opus_int16 *pcm,\n int frame_size,\n int decode_fec\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Decode a multistream Opus packet with floating point output.\n * @param st OpusMSDecoder*: Multistream decoder state.\n * @param[in] data const unsigned char*: Input payload.\n * Use a NULL\n * pointer to indicate packet\n * loss.\n * @param len opus_int32: Number of bytes in payload.\n * @param[out] pcm opus_int16*: Output signal, with interleaved\n * samples.\n * This must contain room for\n * frame_size*channels\n * samples.\n * @param frame_size int: The number of samples per channel of\n * available space in \\a pcm.\n * If this is less than the maximum packet duration\n * (120 ms; 5760 for 48kHz), this function will not be capable\n * of decoding some packets. In the case of PLC (data==NULL)\n * or FEC (decode_fec=1), then frame_size needs to be exactly\n * the duration of audio that is missing, otherwise the\n * decoder will not be in the optimal state to decode the\n * next incoming packet. For the PLC and FEC cases, frame_size\n * must be a multiple of 2.5 ms.\n * @param decode_fec int: Flag (0 or 1) to request that any in-band\n * forward error correction data be decoded.\n * If no such data is available, the frame is\n * decoded as if it were lost.\n * @returns Number of samples decoded on success or a negative error code\n * (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_decode_float(\n OpusMSDecoder *st,\n const unsigned char *data,\n opus_int32 len,\n float *pcm,\n int frame_size,\n int decode_fec\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n/** Perform a CTL function on a multistream Opus decoder.\n *\n * Generally the request and subsequent arguments are generated by a\n * convenience macro.\n * @param st OpusMSDecoder*: Multistream decoder state.\n * @param request This and all remaining parameters should be replaced by one\n * of the convenience macros in @ref opus_genericctls,\n * @ref opus_decoderctls, or @ref opus_multistream_ctls.\n * @see opus_genericctls\n * @see opus_decoderctls\n * @see opus_multistream_ctls\n */\nOPUS_EXPORT int opus_multistream_decoder_ctl(OpusMSDecoder *st, int request, ...) OPUS_ARG_NONNULL(1);\n\n/** Frees an OpusMSDecoder allocated by\n * opus_multistream_decoder_create().\n * @param st OpusMSDecoder: Multistream decoder state to be freed.\n */\nOPUS_EXPORT void opus_multistream_decoder_destroy(OpusMSDecoder *st);\n\n/**@}*/\n\n/**@}*/\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* OPUS_MULTISTREAM_H */\n"
},
{
"path": "SGM_android/SmartGlassesManager/src/main/cpp/libopus/opus_projection.h",
"content": "/* Copyright (c) 2017 Google Inc.\n Written by Andrew Allen */\n/*\n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions\n are met:\n\n - Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n - Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER\n OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\n LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n*/\n\n/**\n * @file opus_projection.h\n * @brief Opus projection reference API\n */\n\n#ifndef OPUS_PROJECTION_H\n#define OPUS_PROJECTION_H\n\n#include \"opus_multistream.h\"\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n/** @cond OPUS_INTERNAL_DOC */\n\n/** These are the actual encoder and decoder CTL ID numbers.\n * They should not be used directly by applications.c\n * In general, SETs should be even and GETs should be odd.*/\n/**@{*/\n#define OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN_REQUEST 6001\n#define OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE_REQUEST 6003\n#define OPUS_PROJECTION_GET_DEMIXING_MATRIX_REQUEST 6005\n/**@}*/\n\n\n/** @endcond */\n\n/** @defgroup opus_projection_ctls Projection specific encoder and decoder CTLs\n *\n * These are convenience macros that are specific to the\n * opus_projection_encoder_ctl() and opus_projection_decoder_ctl()\n * interface.\n * The CTLs from @ref opus_genericctls, @ref opus_encoderctls,\n * @ref opus_decoderctls, and @ref opus_multistream_ctls may be applied to a\n * projection encoder or decoder as well.\n */\n/**@{*/\n\n/** Gets the gain (in dB. S7.8-format) of the demixing matrix from the encoder.\n * @param[out] x opus_int32 *: Returns the gain (in dB. S7.8-format)\n * of the demixing matrix.\n * @hideinitializer\n */\n#define OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN(x) OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN_REQUEST, __opus_check_int_ptr(x)\n\n\n/** Gets the size in bytes of the demixing matrix from the encoder.\n * @param[out] x opus_int32 *: Returns the size in bytes of the\n * demixing matrix.\n * @hideinitializer\n */\n#define OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE(x) OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE_REQUEST, __opus_check_int_ptr(x)\n\n\n/** Copies the demixing matrix to the supplied pointer location.\n * @param[out] x unsigned char *: Returns the demixing matrix to the\n * supplied pointer location.\n * @param y opus_int32: The size in bytes of the reserved memory at the\n * pointer location.\n * @hideinitializer\n */\n#define OPUS_PROJECTION_GET_DEMIXING_MATRIX(x,y) OPUS_PROJECTION_GET_DEMIXING_MATRIX_REQUEST, x, __opus_check_int(y)\n\n\n/**@}*/\n\n/** Opus projection encoder state.\n * This contains the complete state of a projection Opus encoder.\n * It is position independent and can be freely copied.\n * @see opus_projection_ambisonics_encoder_create\n */\ntypedef struct OpusProjectionEncoder OpusProjectionEncoder;\n\n\n/** Opus projection decoder state.\n * This contains the complete state of a projection Opus decoder.\n * It is position independent and can be freely copied.\n * @see opus_projection_decoder_create\n * @see opus_projection_decoder_init\n */\ntypedef struct OpusProjectionDecoder OpusProjectionDecoder;\n\n\n/**\\name Projection encoder functions */\n/**@{*/\n\n/** Gets the size of an OpusProjectionEncoder structure.\n * @param channels int: The total number of input channels to encode.\n * This must be no more than 255.\n * @param mapping_family int: The mapping family to use for selecting\n * the appropriate projection.\n * @returns The size in bytes on success, or a negative error code\n * (see @ref opus_errorcodes) on error.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_projection_ambisonics_encoder_get_size(\n int channels,\n int mapping_family\n);\n\n\n/** Allocates and initializes a projection encoder state.\n * Call opus_projection_encoder_destroy() to release\n * this object when finished.\n * @param Fs opus_int32: Sampling rate of the input signal (in Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param channels int: Number of channels in the input signal.\n * This must be at most 255.\n * It may be greater than the number of\n * coded channels (streams +\n * coupled_streams).\n * @param mapping_family int: The mapping family to use for selecting\n * the appropriate projection.\n * @param[out] streams int *: The total number of streams that will\n * be encoded from the input.\n * @param[out] coupled_streams int *: Number of coupled (2 channel)\n * streams that will be encoded from the input.\n * @param application int: The target encoder application.\n * This must be one of the following:\n * streams +\n * coupled_streams).\n * @param streams int: The total number of streams to encode from the\n * input.\n * This must be no more than the number of channels.\n * @param coupled_streams int: Number of coupled (2 channel) streams\n * to encode.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * encoded channels (streams +\n * coupled_streams) must be no\n * more than the number of input channels.\n * @param application int: The target encoder application.\n * This must be one of the following:\n * frame_size*channels\n * samples.\n * @param frame_size int: Number of samples per channel in the input\n * signal.\n * This must be an Opus frame size for the\n * encoder's sampling rate.\n * For example, at 48 kHz the permitted values\n * are 120, 240, 480, 960, 1920, and 2880.\n * Passing in a duration of less than 10 ms\n * (480 samples at 48 kHz) will prevent the\n * encoder from using the LPC or hybrid modes.\n * @param[out] data unsigned char*: Output payload.\n * This must contain storage for at\n * least \\a max_data_bytes.\n * @param [in] max_data_bytes opus_int32: Size of the allocated\n * memory for the output\n * payload. This may be\n * used to impose an upper limit on\n * the instant bitrate, but should\n * not be used as the only bitrate\n * control. Use #OPUS_SET_BITRATE to\n * control the bitrate.\n * @returns The length of the encoded packet (in bytes) on success or a\n * negative error code (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_encode(\n OpusProjectionEncoder *st,\n const opus_int16 *pcm,\n int frame_size,\n unsigned char *data,\n opus_int32 max_data_bytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n\n/** Encodes a projection Opus frame from floating point input.\n * @param st OpusProjectionEncoder*: Projection encoder state.\n * @param[in] pcm const float*: The input signal as interleaved\n * samples with a normal range of\n * +/-1.0.\n * Samples with a range beyond +/-1.0\n * are supported but will be clipped by\n * decoders using the integer API and\n * should only be used if it is known\n * that the far end supports extended\n * dynamic range.\n * This must contain\n * frame_size*channels\n * samples.\n * @param frame_size int: Number of samples per channel in the input\n * signal.\n * This must be an Opus frame size for the\n * encoder's sampling rate.\n * For example, at 48 kHz the permitted values\n * are 120, 240, 480, 960, 1920, and 2880.\n * Passing in a duration of less than 10 ms\n * (480 samples at 48 kHz) will prevent the\n * encoder from using the LPC or hybrid modes.\n * @param[out] data unsigned char*: Output payload.\n * This must contain storage for at\n * least \\a max_data_bytes.\n * @param [in] max_data_bytes opus_int32: Size of the allocated\n * memory for the output\n * payload. This may be\n * used to impose an upper limit on\n * the instant bitrate, but should\n * not be used as the only bitrate\n * control. Use #OPUS_SET_BITRATE to\n * control the bitrate.\n * @returns The length of the encoded packet (in bytes) on success or a\n * negative error code (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_encode_float(\n OpusProjectionEncoder *st,\n const float *pcm,\n int frame_size,\n unsigned char *data,\n opus_int32 max_data_bytes\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);\n\n\n/** Frees an OpusProjectionEncoder allocated by\n * opus_projection_ambisonics_encoder_create().\n * @param st OpusProjectionEncoder*: Projection encoder state to be freed.\n */\nOPUS_EXPORT void opus_projection_encoder_destroy(OpusProjectionEncoder *st);\n\n\n/** Perform a CTL function on a projection Opus encoder.\n *\n * Generally the request and subsequent arguments are generated by a\n * convenience macro.\n * @param st OpusProjectionEncoder*: Projection encoder state.\n * @param request This and all remaining parameters should be replaced by one\n * of the convenience macros in @ref opus_genericctls,\n * @ref opus_encoderctls, @ref opus_multistream_ctls, or\n * @ref opus_projection_ctls\n * @see opus_genericctls\n * @see opus_encoderctls\n * @see opus_multistream_ctls\n * @see opus_projection_ctls\n */\nOPUS_EXPORT int opus_projection_encoder_ctl(OpusProjectionEncoder *st, int request, ...) OPUS_ARG_NONNULL(1);\n\n\n/**@}*/\n\n/**\\name Projection decoder functions */\n/**@{*/\n\n/** Gets the size of an OpusProjectionDecoder structure.\n * @param channels int: The total number of output channels.\n * This must be no more than 255.\n * @param streams int: The total number of streams coded in the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number streams to decode as coupled\n * (2 channel) streams.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * coded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @returns The size in bytes on success, or a negative error code\n * (see @ref opus_errorcodes) on error.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_projection_decoder_get_size(\n int channels,\n int streams,\n int coupled_streams\n);\n\n\n/** Allocates and initializes a projection decoder state.\n * Call opus_projection_decoder_destroy() to release\n * this object when finished.\n * @param Fs opus_int32: Sampling rate to decode at (in Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param channels int: Number of channels to output.\n * This must be at most 255.\n * It may be different from the number of coded\n * channels (streams +\n * coupled_streams).\n * @param streams int: The total number of streams coded in the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number of streams to decode as coupled\n * (2 channel) streams.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * coded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @param[in] demixing_matrix const unsigned char[demixing_matrix_size]: Demixing matrix\n * that mapping from coded channels to output channels,\n * as described in @ref opus_projection and\n * @ref opus_projection_ctls.\n * @param demixing_matrix_size opus_int32: The size in bytes of the\n * demixing matrix, as\n * described in @ref\n * opus_projection_ctls.\n * @param[out] error int *: Returns #OPUS_OK on success, or an error\n * code (see @ref opus_errorcodes) on\n * failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusProjectionDecoder *opus_projection_decoder_create(\n opus_int32 Fs,\n int channels,\n int streams,\n int coupled_streams,\n unsigned char *demixing_matrix,\n opus_int32 demixing_matrix_size,\n int *error\n) OPUS_ARG_NONNULL(5);\n\n\n/** Intialize a previously allocated projection decoder state object.\n * The memory pointed to by \\a st must be at least the size returned by\n * opus_projection_decoder_get_size().\n * This is intended for applications which use their own allocator instead of\n * malloc.\n * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.\n * @see opus_projection_decoder_create\n * @see opus_projection_deocder_get_size\n * @param st OpusProjectionDecoder*: Projection encoder state to initialize.\n * @param Fs opus_int32: Sampling rate to decode at (in Hz).\n * This must be one of 8000, 12000, 16000,\n * 24000, or 48000.\n * @param channels int: Number of channels to output.\n * This must be at most 255.\n * It may be different from the number of coded\n * channels (streams +\n * coupled_streams).\n * @param streams int: The total number of streams coded in the\n * input.\n * This must be no more than 255.\n * @param coupled_streams int: Number of streams to decode as coupled\n * (2 channel) streams.\n * This must be no larger than the total\n * number of streams.\n * Additionally, The total number of\n * coded channels (streams +\n * coupled_streams) must be no\n * more than 255.\n * @param[in] demixing_matrix const unsigned char[demixing_matrix_size]: Demixing matrix\n * that mapping from coded channels to output channels,\n * as described in @ref opus_projection and\n * @ref opus_projection_ctls.\n * @param demixing_matrix_size opus_int32: The size in bytes of the\n * demixing matrix, as\n * described in @ref\n * opus_projection_ctls.\n * @returns #OPUS_OK on success, or an error code (see @ref opus_errorcodes)\n * on failure.\n */\nOPUS_EXPORT int opus_projection_decoder_init(\n OpusProjectionDecoder *st,\n opus_int32 Fs,\n int channels,\n int streams,\n int coupled_streams,\n unsigned char *demixing_matrix,\n opus_int32 demixing_matrix_size\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(6);\n\n\n/** Decode a projection Opus packet.\n * @param st OpusProjectionDecoder*: Projection decoder state.\n * @param[in] data const unsigned char*: Input payload.\n * Use a NULL\n * pointer to indicate packet\n * loss.\n * @param len opus_int32: Number of bytes in payload.\n * @param[out] pcm opus_int16*: Output signal, with interleaved\n * samples.\n * This must contain room for\n * frame_size*channels\n * samples.\n * @param frame_size int: The number of samples per channel of\n * available space in \\a pcm.\n * If this is less than the maximum packet duration\n * (120 ms; 5760 for 48kHz), this function will not be capable\n * of decoding some packets. In the case of PLC (data==NULL)\n * or FEC (decode_fec=1), then frame_size needs to be exactly\n * the duration of audio that is missing, otherwise the\n * decoder will not be in the optimal state to decode the\n * next incoming packet. For the PLC and FEC cases, frame_size\n * must be a multiple of 2.5 ms.\n * @param decode_fec int: Flag (0 or 1) to request that any in-band\n * forward error correction data be decoded.\n * If no such data is available, the frame is\n * decoded as if it were lost.\n * @returns Number of samples decoded on success or a negative error code\n * (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_decode(\n OpusProjectionDecoder *st,\n const unsigned char *data,\n opus_int32 len,\n opus_int16 *pcm,\n int frame_size,\n int decode_fec\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n\n/** Decode a projection Opus packet with floating point output.\n * @param st OpusProjectionDecoder*: Projection decoder state.\n * @param[in] data const unsigned char*: Input payload.\n * Use a NULL\n * pointer to indicate packet\n * loss.\n * @param len opus_int32: Number of bytes in payload.\n * @param[out] pcm opus_int16*: Output signal, with interleaved\n * samples.\n * This must contain room for\n * frame_size*channels\n * samples.\n * @param frame_size int: The number of samples per channel of\n * available space in \\a pcm.\n * If this is less than the maximum packet duration\n * (120 ms; 5760 for 48kHz), this function will not be capable\n * of decoding some packets. In the case of PLC (data==NULL)\n * or FEC (decode_fec=1), then frame_size needs to be exactly\n * the duration of audio that is missing, otherwise the\n * decoder will not be in the optimal state to decode the\n * next incoming packet. For the PLC and FEC cases, frame_size\n * must be a multiple of 2.5 ms.\n * @param decode_fec int: Flag (0 or 1) to request that any in-band\n * forward error correction data be decoded.\n * If no such data is available, the frame is\n * decoded as if it were lost.\n * @returns Number of samples decoded on success or a negative error code\n * (see @ref opus_errorcodes) on failure.\n */\nOPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_decode_float(\n OpusProjectionDecoder *st,\n const unsigned char *data,\n opus_int32 len,\n float *pcm,\n int frame_size,\n int decode_fec\n) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);\n\n\n/** Perform a CTL function on a projection Opus decoder.\n *\n * Generally the request and subsequent arguments are generated by a\n * convenience macro.\n * @param st OpusProjectionDecoder*: Projection decoder state.\n * @param request This and all remaining parameters should be replaced by one\n * of the convenience macros in @ref opus_genericctls,\n * @ref opus_decoderctls, @ref opus_multistream_ctls, or\n * @ref opus_projection_ctls.\n * @see opus_genericctls\n * @see opus_decoderctls\n * @see opus_multistream_ctls\n * @see opus_projection_ctls\n */\nOPUS_EXPORT int opus_projection_decoder_ctl(OpusProjectionDecoder *st, int request, ...) OPUS_ARG_NONNULL(1);\n\n\n/** Frees an OpusProjectionDecoder allocated by\n * opus_projection_decoder_create().\n * @param st OpusProjectionDecoder: Projection decoder state to be freed.\n */\nOPUS_EXPORT void opus_projection_decoder_destroy(OpusProjectionDecoder *st);\n\n\n/**@}*/\n\n/**@}*/\n\n#ifdef __cplusplus\n}\n#endif\n\n#endif /* OPUS_PROJECTION_H */\n"
},
{
"path": "SGM_android/SmartGlassesManager/src/main/cpp/libopus/opus_types.h",
"content": "/* (C) COPYRIGHT 1994-2002 Xiph.Org Foundation */\n/* Modified by Jean-Marc Valin */\n/*\n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions\n are met:\n\n - Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n - Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER\n OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\n LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n*/\n/* opus_types.h based on ogg_types.h from libogg */\n\n/**\n @file opus_types.h\n @brief Opus reference implementation types\n*/\n#ifndef OPUS_TYPES_H\n#define OPUS_TYPES_H\n\n#define opus_int int /* used for counters etc; at least 16 bits */\n#define opus_int64 long long\n#define opus_int8 signed char\n\n#define opus_uint unsigned int /* used for counters etc; at least 16 bits */\n#define opus_uint64 unsigned long long\n#define opus_uint8 unsigned char\n\n/* Use the real stdint.h if it's there (taken from Paul Hsieh's pstdint.h) */\n#if (defined(__STDC__) && __STDC__ && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__GNUC__) && (defined(_STDINT_H) || defined(_STDINT_H_)) || defined (HAVE_STDINT_H))\n#include