cannam@154: /* Copyright (c) 2017 Google Inc.
cannam@154:    Written by Andrew Allen */
cannam@154: /*
cannam@154:    Redistribution and use in source and binary forms, with or without
cannam@154:    modification, are permitted provided that the following conditions
cannam@154:    are met:
cannam@154: 
cannam@154:    - Redistributions of source code must retain the above copyright
cannam@154:    notice, this list of conditions and the following disclaimer.
cannam@154: 
cannam@154:    - Redistributions in binary form must reproduce the above copyright
cannam@154:    notice, this list of conditions and the following disclaimer in the
cannam@154:    documentation and/or other materials provided with the distribution.
cannam@154: 
cannam@154:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
cannam@154:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
cannam@154:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
cannam@154:    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
cannam@154:    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
cannam@154:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
cannam@154:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
cannam@154:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
cannam@154:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
cannam@154:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
cannam@154:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cannam@154: */
cannam@154: 
cannam@154: /**
cannam@154:  * @file opus_projection.h
cannam@154:  * @brief Opus projection reference API
cannam@154:  */
cannam@154: 
cannam@154: #ifndef OPUS_PROJECTION_H
cannam@154: #define OPUS_PROJECTION_H
cannam@154: 
cannam@154: #include "opus_multistream.h"
cannam@154: 
cannam@154: #ifdef __cplusplus
cannam@154: extern "C" {
cannam@154: #endif
cannam@154: 
cannam@154: /** @cond OPUS_INTERNAL_DOC */
cannam@154: 
cannam@154: /** These are the actual encoder and decoder CTL ID numbers.
cannam@154:   * They should not be used directly by applications.c
cannam@154:   * In general, SETs should be even and GETs should be odd.*/
cannam@154: /**@{*/
cannam@154: #define OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN_REQUEST    6001
cannam@154: #define OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE_REQUEST    6003
cannam@154: #define OPUS_PROJECTION_GET_DEMIXING_MATRIX_REQUEST         6005
cannam@154: /**@}*/
cannam@154: 
cannam@154: 
cannam@154: /** @endcond */
cannam@154: 
cannam@154: /** @defgroup opus_projection_ctls Projection specific encoder and decoder CTLs
cannam@154:   *
cannam@154:   * These are convenience macros that are specific to the
cannam@154:   * opus_projection_encoder_ctl() and opus_projection_decoder_ctl()
cannam@154:   * interface.
cannam@154:   * The CTLs from @ref opus_genericctls, @ref opus_encoderctls,
cannam@154:   * @ref opus_decoderctls, and @ref opus_multistream_ctls may be applied to a
cannam@154:   * projection encoder or decoder as well.
cannam@154:   */
cannam@154: /**@{*/
cannam@154: 
cannam@154: /** Gets the gain (in dB. S7.8-format) of the demixing matrix from the encoder.
cannam@154:   * @param[out] x <tt>opus_int32 *</tt>: Returns the gain (in dB. S7.8-format)
cannam@154:   *                                      of the demixing matrix.
cannam@154:   * @hideinitializer
cannam@154:   */
cannam@154: #define OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN(x) OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN_REQUEST, __opus_check_int_ptr(x)
cannam@154: 
cannam@154: 
cannam@154: /** Gets the size in bytes of the demixing matrix from the encoder.
cannam@154:   * @param[out] x <tt>opus_int32 *</tt>: Returns the size in bytes of the
cannam@154:   *                                      demixing matrix.
cannam@154:   * @hideinitializer
cannam@154:   */
cannam@154: #define OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE(x) OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE_REQUEST, __opus_check_int_ptr(x)
cannam@154: 
cannam@154: 
cannam@154: /** Copies the demixing matrix to the supplied pointer location.
cannam@154:   * @param[out] x <tt>unsigned char *</tt>: Returns the demixing matrix to the
cannam@154:   *                                         supplied pointer location.
cannam@154:   * @param y <tt>opus_int32</tt>: The size in bytes of the reserved memory at the
cannam@154:   *                              pointer location.
cannam@154:   * @hideinitializer
cannam@154:   */
cannam@154: #define OPUS_PROJECTION_GET_DEMIXING_MATRIX(x,y) OPUS_PROJECTION_GET_DEMIXING_MATRIX_REQUEST, x, __opus_check_int(y)
cannam@154: 
cannam@154: 
cannam@154: /**@}*/
cannam@154: 
cannam@154: /** Opus projection encoder state.
cannam@154:  * This contains the complete state of a projection Opus encoder.
cannam@154:  * It is position independent and can be freely copied.
cannam@154:  * @see opus_projection_ambisonics_encoder_create
cannam@154:  */
cannam@154: typedef struct OpusProjectionEncoder OpusProjectionEncoder;
cannam@154: 
cannam@154: 
cannam@154: /** Opus projection decoder state.
cannam@154:   * This contains the complete state of a projection Opus decoder.
cannam@154:   * It is position independent and can be freely copied.
cannam@154:   * @see opus_projection_decoder_create
cannam@154:   * @see opus_projection_decoder_init
cannam@154:   */
cannam@154: typedef struct OpusProjectionDecoder OpusProjectionDecoder;
cannam@154: 
cannam@154: 
cannam@154: /**\name Projection encoder functions */
cannam@154: /**@{*/
cannam@154: 
cannam@154: /** Gets the size of an OpusProjectionEncoder structure.
cannam@154:   * @param channels <tt>int</tt>: The total number of input channels to encode.
cannam@154:   *                               This must be no more than 255.
cannam@154:   * @param mapping_family <tt>int</tt>: The mapping family to use for selecting
cannam@154:   *                                     the appropriate projection.
cannam@154:   * @returns The size in bytes on success, or a negative error code
cannam@154:   *          (see @ref opus_errorcodes) on error.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_projection_ambisonics_encoder_get_size(
cannam@154:     int channels,
cannam@154:     int mapping_family
cannam@154: );
cannam@154: 
cannam@154: 
cannam@154: /** Allocates and initializes a projection encoder state.
cannam@154:   * Call opus_projection_encoder_destroy() to release
cannam@154:   * this object when finished.
cannam@154:   * @param Fs <tt>opus_int32</tt>: Sampling rate of the input signal (in Hz).
cannam@154:   *                                This must be one of 8000, 12000, 16000,
cannam@154:   *                                24000, or 48000.
cannam@154:   * @param channels <tt>int</tt>: Number of channels in the input signal.
cannam@154:   *                               This must be at most 255.
cannam@154:   *                               It may be greater than the number of
cannam@154:   *                               coded channels (<code>streams +
cannam@154:   *                               coupled_streams</code>).
cannam@154:   * @param mapping_family <tt>int</tt>: The mapping family to use for selecting
cannam@154:   *                                     the appropriate projection.
cannam@154:   * @param[out] streams <tt>int *</tt>: The total number of streams that will
cannam@154:   *                                     be encoded from the input.
cannam@154:   * @param[out] coupled_streams <tt>int *</tt>: Number of coupled (2 channel)
cannam@154:   *                                 streams that will be encoded from the input.
cannam@154:   * @param application <tt>int</tt>: The target encoder application.
cannam@154:   *                                  This must be one of the following:
cannam@154:   * <dl>
cannam@154:   * <dt>#OPUS_APPLICATION_VOIP</dt>
cannam@154:   * <dd>Process signal for improved speech intelligibility.</dd>
cannam@154:   * <dt>#OPUS_APPLICATION_AUDIO</dt>
cannam@154:   * <dd>Favor faithfulness to the original input.</dd>
cannam@154:   * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
cannam@154:   * <dd>Configure the minimum possible coding delay by disabling certain modes
cannam@154:   * of operation.</dd>
cannam@154:   * </dl>
cannam@154:   * @param[out] error <tt>int *</tt>: Returns #OPUS_OK on success, or an error
cannam@154:   *                                   code (see @ref opus_errorcodes) on
cannam@154:   *                                   failure.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusProjectionEncoder *opus_projection_ambisonics_encoder_create(
cannam@154:     opus_int32 Fs,
cannam@154:     int channels,
cannam@154:     int mapping_family,
cannam@154:     int *streams,
cannam@154:     int *coupled_streams,
cannam@154:     int application,
cannam@154:     int *error
cannam@154: ) OPUS_ARG_NONNULL(4) OPUS_ARG_NONNULL(5);
cannam@154: 
cannam@154: 
cannam@154: /** Initialize a previously allocated projection encoder state.
cannam@154:   * The memory pointed to by \a st must be at least the size returned by
cannam@154:   * opus_projection_ambisonics_encoder_get_size().
cannam@154:   * This is intended for applications which use their own allocator instead of
cannam@154:   * malloc.
cannam@154:   * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.
cannam@154:   * @see opus_projection_ambisonics_encoder_create
cannam@154:   * @see opus_projection_ambisonics_encoder_get_size
cannam@154:   * @param st <tt>OpusProjectionEncoder*</tt>: Projection encoder state to initialize.
cannam@154:   * @param Fs <tt>opus_int32</tt>: Sampling rate of the input signal (in Hz).
cannam@154:   *                                This must be one of 8000, 12000, 16000,
cannam@154:   *                                24000, or 48000.
cannam@154:   * @param channels <tt>int</tt>: Number of channels in the input signal.
cannam@154:   *                               This must be at most 255.
cannam@154:   *                               It may be greater than the number of
cannam@154:   *                               coded channels (<code>streams +
cannam@154:   *                               coupled_streams</code>).
cannam@154:   * @param streams <tt>int</tt>: The total number of streams to encode from the
cannam@154:   *                              input.
cannam@154:   *                              This must be no more than the number of channels.
cannam@154:   * @param coupled_streams <tt>int</tt>: Number of coupled (2 channel) streams
cannam@154:   *                                      to encode.
cannam@154:   *                                      This must be no larger than the total
cannam@154:   *                                      number of streams.
cannam@154:   *                                      Additionally, The total number of
cannam@154:   *                                      encoded channels (<code>streams +
cannam@154:   *                                      coupled_streams</code>) must be no
cannam@154:   *                                      more than the number of input channels.
cannam@154:   * @param application <tt>int</tt>: The target encoder application.
cannam@154:   *                                  This must be one of the following:
cannam@154:   * <dl>
cannam@154:   * <dt>#OPUS_APPLICATION_VOIP</dt>
cannam@154:   * <dd>Process signal for improved speech intelligibility.</dd>
cannam@154:   * <dt>#OPUS_APPLICATION_AUDIO</dt>
cannam@154:   * <dd>Favor faithfulness to the original input.</dd>
cannam@154:   * <dt>#OPUS_APPLICATION_RESTRICTED_LOWDELAY</dt>
cannam@154:   * <dd>Configure the minimum possible coding delay by disabling certain modes
cannam@154:   * of operation.</dd>
cannam@154:   * </dl>
cannam@154:   * @returns #OPUS_OK on success, or an error code (see @ref opus_errorcodes)
cannam@154:   *          on failure.
cannam@154:   */
cannam@154: OPUS_EXPORT int opus_projection_ambisonics_encoder_init(
cannam@154:     OpusProjectionEncoder *st,
cannam@154:     opus_int32 Fs,
cannam@154:     int channels,
cannam@154:     int mapping_family,
cannam@154:     int *streams,
cannam@154:     int *coupled_streams,
cannam@154:     int application
cannam@154: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(5) OPUS_ARG_NONNULL(6);
cannam@154: 
cannam@154: 
cannam@154: /** Encodes a projection Opus frame.
cannam@154:   * @param st <tt>OpusProjectionEncoder*</tt>: Projection encoder state.
cannam@154:   * @param[in] pcm <tt>const opus_int16*</tt>: The input signal as interleaved
cannam@154:   *                                            samples.
cannam@154:   *                                            This must contain
cannam@154:   *                                            <code>frame_size*channels</code>
cannam@154:   *                                            samples.
cannam@154:   * @param frame_size <tt>int</tt>: Number of samples per channel in the input
cannam@154:   *                                 signal.
cannam@154:   *                                 This must be an Opus frame size for the
cannam@154:   *                                 encoder's sampling rate.
cannam@154:   *                                 For example, at 48 kHz the permitted values
cannam@154:   *                                 are 120, 240, 480, 960, 1920, and 2880.
cannam@154:   *                                 Passing in a duration of less than 10 ms
cannam@154:   *                                 (480 samples at 48 kHz) will prevent the
cannam@154:   *                                 encoder from using the LPC or hybrid modes.
cannam@154:   * @param[out] data <tt>unsigned char*</tt>: Output payload.
cannam@154:   *                                           This must contain storage for at
cannam@154:   *                                           least \a max_data_bytes.
cannam@154:   * @param [in] max_data_bytes <tt>opus_int32</tt>: Size of the allocated
cannam@154:   *                                                 memory for the output
cannam@154:   *                                                 payload. This may be
cannam@154:   *                                                 used to impose an upper limit on
cannam@154:   *                                                 the instant bitrate, but should
cannam@154:   *                                                 not be used as the only bitrate
cannam@154:   *                                                 control. Use #OPUS_SET_BITRATE to
cannam@154:   *                                                 control the bitrate.
cannam@154:   * @returns The length of the encoded packet (in bytes) on success or a
cannam@154:   *          negative error code (see @ref opus_errorcodes) on failure.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_encode(
cannam@154:     OpusProjectionEncoder *st,
cannam@154:     const opus_int16 *pcm,
cannam@154:     int frame_size,
cannam@154:     unsigned char *data,
cannam@154:     opus_int32 max_data_bytes
cannam@154: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
cannam@154: 
cannam@154: 
cannam@154: /** Encodes a projection Opus frame from floating point input.
cannam@154:   * @param st <tt>OpusProjectionEncoder*</tt>: Projection encoder state.
cannam@154:   * @param[in] pcm <tt>const float*</tt>: The input signal as interleaved
cannam@154:   *                                       samples with a normal range of
cannam@154:   *                                       +/-1.0.
cannam@154:   *                                       Samples with a range beyond +/-1.0
cannam@154:   *                                       are supported but will be clipped by
cannam@154:   *                                       decoders using the integer API and
cannam@154:   *                                       should only be used if it is known
cannam@154:   *                                       that the far end supports extended
cannam@154:   *                                       dynamic range.
cannam@154:   *                                       This must contain
cannam@154:   *                                       <code>frame_size*channels</code>
cannam@154:   *                                       samples.
cannam@154:   * @param frame_size <tt>int</tt>: Number of samples per channel in the input
cannam@154:   *                                 signal.
cannam@154:   *                                 This must be an Opus frame size for the
cannam@154:   *                                 encoder's sampling rate.
cannam@154:   *                                 For example, at 48 kHz the permitted values
cannam@154:   *                                 are 120, 240, 480, 960, 1920, and 2880.
cannam@154:   *                                 Passing in a duration of less than 10 ms
cannam@154:   *                                 (480 samples at 48 kHz) will prevent the
cannam@154:   *                                 encoder from using the LPC or hybrid modes.
cannam@154:   * @param[out] data <tt>unsigned char*</tt>: Output payload.
cannam@154:   *                                           This must contain storage for at
cannam@154:   *                                           least \a max_data_bytes.
cannam@154:   * @param [in] max_data_bytes <tt>opus_int32</tt>: Size of the allocated
cannam@154:   *                                                 memory for the output
cannam@154:   *                                                 payload. This may be
cannam@154:   *                                                 used to impose an upper limit on
cannam@154:   *                                                 the instant bitrate, but should
cannam@154:   *                                                 not be used as the only bitrate
cannam@154:   *                                                 control. Use #OPUS_SET_BITRATE to
cannam@154:   *                                                 control the bitrate.
cannam@154:   * @returns The length of the encoded packet (in bytes) on success or a
cannam@154:   *          negative error code (see @ref opus_errorcodes) on failure.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_encode_float(
cannam@154:     OpusProjectionEncoder *st,
cannam@154:     const float *pcm,
cannam@154:     int frame_size,
cannam@154:     unsigned char *data,
cannam@154:     opus_int32 max_data_bytes
cannam@154: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
cannam@154: 
cannam@154: 
cannam@154: /** Frees an <code>OpusProjectionEncoder</code> allocated by
cannam@154:   * opus_projection_ambisonics_encoder_create().
cannam@154:   * @param st <tt>OpusProjectionEncoder*</tt>: Projection encoder state to be freed.
cannam@154:   */
cannam@154: OPUS_EXPORT void opus_projection_encoder_destroy(OpusProjectionEncoder *st);
cannam@154: 
cannam@154: 
cannam@154: /** Perform a CTL function on a projection Opus encoder.
cannam@154:   *
cannam@154:   * Generally the request and subsequent arguments are generated by a
cannam@154:   * convenience macro.
cannam@154:   * @param st <tt>OpusProjectionEncoder*</tt>: Projection encoder state.
cannam@154:   * @param request This and all remaining parameters should be replaced by one
cannam@154:   *                of the convenience macros in @ref opus_genericctls,
cannam@154:   *                @ref opus_encoderctls, @ref opus_multistream_ctls, or
cannam@154:   *                @ref opus_projection_ctls
cannam@154:   * @see opus_genericctls
cannam@154:   * @see opus_encoderctls
cannam@154:   * @see opus_multistream_ctls
cannam@154:   * @see opus_projection_ctls
cannam@154:   */
cannam@154: OPUS_EXPORT int opus_projection_encoder_ctl(OpusProjectionEncoder *st, int request, ...) OPUS_ARG_NONNULL(1);
cannam@154: 
cannam@154: 
cannam@154: /**@}*/
cannam@154: 
cannam@154: /**\name Projection decoder functions */
cannam@154: /**@{*/
cannam@154: 
cannam@154: /** Gets the size of an <code>OpusProjectionDecoder</code> structure.
cannam@154:   * @param channels <tt>int</tt>: The total number of output channels.
cannam@154:   *                               This must be no more than 255.
cannam@154:   * @param streams <tt>int</tt>: The total number of streams coded in the
cannam@154:   *                              input.
cannam@154:   *                              This must be no more than 255.
cannam@154:   * @param coupled_streams <tt>int</tt>: Number streams to decode as coupled
cannam@154:   *                                      (2 channel) streams.
cannam@154:   *                                      This must be no larger than the total
cannam@154:   *                                      number of streams.
cannam@154:   *                                      Additionally, The total number of
cannam@154:   *                                      coded channels (<code>streams +
cannam@154:   *                                      coupled_streams</code>) must be no
cannam@154:   *                                      more than 255.
cannam@154:   * @returns The size in bytes on success, or a negative error code
cannam@154:   *          (see @ref opus_errorcodes) on error.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_projection_decoder_get_size(
cannam@154:     int channels,
cannam@154:     int streams,
cannam@154:     int coupled_streams
cannam@154: );
cannam@154: 
cannam@154: 
cannam@154: /** Allocates and initializes a projection decoder state.
cannam@154:   * Call opus_projection_decoder_destroy() to release
cannam@154:   * this object when finished.
cannam@154:   * @param Fs <tt>opus_int32</tt>: Sampling rate to decode at (in Hz).
cannam@154:   *                                This must be one of 8000, 12000, 16000,
cannam@154:   *                                24000, or 48000.
cannam@154:   * @param channels <tt>int</tt>: Number of channels to output.
cannam@154:   *                               This must be at most 255.
cannam@154:   *                               It may be different from the number of coded
cannam@154:   *                               channels (<code>streams +
cannam@154:   *                               coupled_streams</code>).
cannam@154:   * @param streams <tt>int</tt>: The total number of streams coded in the
cannam@154:   *                              input.
cannam@154:   *                              This must be no more than 255.
cannam@154:   * @param coupled_streams <tt>int</tt>: Number of streams to decode as coupled
cannam@154:   *                                      (2 channel) streams.
cannam@154:   *                                      This must be no larger than the total
cannam@154:   *                                      number of streams.
cannam@154:   *                                      Additionally, The total number of
cannam@154:   *                                      coded channels (<code>streams +
cannam@154:   *                                      coupled_streams</code>) must be no
cannam@154:   *                                      more than 255.
cannam@154:   * @param[in] demixing_matrix <tt>const unsigned char[demixing_matrix_size]</tt>: Demixing matrix
cannam@154:   *                         that mapping from coded channels to output channels,
cannam@154:   *                         as described in @ref opus_projection and
cannam@154:   *                         @ref opus_projection_ctls.
cannam@154:   * @param demixing_matrix_size <tt>opus_int32</tt>: The size in bytes of the
cannam@154:   *                                                  demixing matrix, as
cannam@154:   *                                                  described in @ref
cannam@154:   *                                                  opus_projection_ctls.
cannam@154:   * @param[out] error <tt>int *</tt>: Returns #OPUS_OK on success, or an error
cannam@154:   *                                   code (see @ref opus_errorcodes) on
cannam@154:   *                                   failure.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusProjectionDecoder *opus_projection_decoder_create(
cannam@154:     opus_int32 Fs,
cannam@154:     int channels,
cannam@154:     int streams,
cannam@154:     int coupled_streams,
cannam@154:     unsigned char *demixing_matrix,
cannam@154:     opus_int32 demixing_matrix_size,
cannam@154:     int *error
cannam@154: ) OPUS_ARG_NONNULL(5);
cannam@154: 
cannam@154: 
cannam@154: /** Intialize a previously allocated projection decoder state object.
cannam@154:   * The memory pointed to by \a st must be at least the size returned by
cannam@154:   * opus_projection_decoder_get_size().
cannam@154:   * This is intended for applications which use their own allocator instead of
cannam@154:   * malloc.
cannam@154:   * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.
cannam@154:   * @see opus_projection_decoder_create
cannam@154:   * @see opus_projection_deocder_get_size
cannam@154:   * @param st <tt>OpusProjectionDecoder*</tt>: Projection encoder state to initialize.
cannam@154:   * @param Fs <tt>opus_int32</tt>: Sampling rate to decode at (in Hz).
cannam@154:   *                                This must be one of 8000, 12000, 16000,
cannam@154:   *                                24000, or 48000.
cannam@154:   * @param channels <tt>int</tt>: Number of channels to output.
cannam@154:   *                               This must be at most 255.
cannam@154:   *                               It may be different from the number of coded
cannam@154:   *                               channels (<code>streams +
cannam@154:   *                               coupled_streams</code>).
cannam@154:   * @param streams <tt>int</tt>: The total number of streams coded in the
cannam@154:   *                              input.
cannam@154:   *                              This must be no more than 255.
cannam@154:   * @param coupled_streams <tt>int</tt>: Number of streams to decode as coupled
cannam@154:   *                                      (2 channel) streams.
cannam@154:   *                                      This must be no larger than the total
cannam@154:   *                                      number of streams.
cannam@154:   *                                      Additionally, The total number of
cannam@154:   *                                      coded channels (<code>streams +
cannam@154:   *                                      coupled_streams</code>) must be no
cannam@154:   *                                      more than 255.
cannam@154:   * @param[in] demixing_matrix <tt>const unsigned char[demixing_matrix_size]</tt>: Demixing matrix
cannam@154:   *                         that mapping from coded channels to output channels,
cannam@154:   *                         as described in @ref opus_projection and
cannam@154:   *                         @ref opus_projection_ctls.
cannam@154:   * @param demixing_matrix_size <tt>opus_int32</tt>: The size in bytes of the
cannam@154:   *                                                  demixing matrix, as
cannam@154:   *                                                  described in @ref
cannam@154:   *                                                  opus_projection_ctls.
cannam@154:   * @returns #OPUS_OK on success, or an error code (see @ref opus_errorcodes)
cannam@154:   *          on failure.
cannam@154:   */
cannam@154: OPUS_EXPORT int opus_projection_decoder_init(
cannam@154:     OpusProjectionDecoder *st,
cannam@154:     opus_int32 Fs,
cannam@154:     int channels,
cannam@154:     int streams,
cannam@154:     int coupled_streams,
cannam@154:     unsigned char *demixing_matrix,
cannam@154:     opus_int32 demixing_matrix_size
cannam@154: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(6);
cannam@154: 
cannam@154: 
cannam@154: /** Decode a projection Opus packet.
cannam@154:   * @param st <tt>OpusProjectionDecoder*</tt>: Projection decoder state.
cannam@154:   * @param[in] data <tt>const unsigned char*</tt>: Input payload.
cannam@154:   *                                                Use a <code>NULL</code>
cannam@154:   *                                                pointer to indicate packet
cannam@154:   *                                                loss.
cannam@154:   * @param len <tt>opus_int32</tt>: Number of bytes in payload.
cannam@154:   * @param[out] pcm <tt>opus_int16*</tt>: Output signal, with interleaved
cannam@154:   *                                       samples.
cannam@154:   *                                       This must contain room for
cannam@154:   *                                       <code>frame_size*channels</code>
cannam@154:   *                                       samples.
cannam@154:   * @param frame_size <tt>int</tt>: The number of samples per channel of
cannam@154:   *                                 available space in \a pcm.
cannam@154:   *                                 If this is less than the maximum packet duration
cannam@154:   *                                 (120 ms; 5760 for 48kHz), this function will not be capable
cannam@154:   *                                 of decoding some packets. In the case of PLC (data==NULL)
cannam@154:   *                                 or FEC (decode_fec=1), then frame_size needs to be exactly
cannam@154:   *                                 the duration of audio that is missing, otherwise the
cannam@154:   *                                 decoder will not be in the optimal state to decode the
cannam@154:   *                                 next incoming packet. For the PLC and FEC cases, frame_size
cannam@154:   *                                 <b>must</b> be a multiple of 2.5 ms.
cannam@154:   * @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band
cannam@154:   *                                 forward error correction data be decoded.
cannam@154:   *                                 If no such data is available, the frame is
cannam@154:   *                                 decoded as if it were lost.
cannam@154:   * @returns Number of samples decoded on success or a negative error code
cannam@154:   *          (see @ref opus_errorcodes) on failure.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_decode(
cannam@154:     OpusProjectionDecoder *st,
cannam@154:     const unsigned char *data,
cannam@154:     opus_int32 len,
cannam@154:     opus_int16 *pcm,
cannam@154:     int frame_size,
cannam@154:     int decode_fec
cannam@154: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
cannam@154: 
cannam@154: 
cannam@154: /** Decode a projection Opus packet with floating point output.
cannam@154:   * @param st <tt>OpusProjectionDecoder*</tt>: Projection decoder state.
cannam@154:   * @param[in] data <tt>const unsigned char*</tt>: Input payload.
cannam@154:   *                                                Use a <code>NULL</code>
cannam@154:   *                                                pointer to indicate packet
cannam@154:   *                                                loss.
cannam@154:   * @param len <tt>opus_int32</tt>: Number of bytes in payload.
cannam@154:   * @param[out] pcm <tt>opus_int16*</tt>: Output signal, with interleaved
cannam@154:   *                                       samples.
cannam@154:   *                                       This must contain room for
cannam@154:   *                                       <code>frame_size*channels</code>
cannam@154:   *                                       samples.
cannam@154:   * @param frame_size <tt>int</tt>: The number of samples per channel of
cannam@154:   *                                 available space in \a pcm.
cannam@154:   *                                 If this is less than the maximum packet duration
cannam@154:   *                                 (120 ms; 5760 for 48kHz), this function will not be capable
cannam@154:   *                                 of decoding some packets. In the case of PLC (data==NULL)
cannam@154:   *                                 or FEC (decode_fec=1), then frame_size needs to be exactly
cannam@154:   *                                 the duration of audio that is missing, otherwise the
cannam@154:   *                                 decoder will not be in the optimal state to decode the
cannam@154:   *                                 next incoming packet. For the PLC and FEC cases, frame_size
cannam@154:   *                                 <b>must</b> be a multiple of 2.5 ms.
cannam@154:   * @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band
cannam@154:   *                                 forward error correction data be decoded.
cannam@154:   *                                 If no such data is available, the frame is
cannam@154:   *                                 decoded as if it were lost.
cannam@154:   * @returns Number of samples decoded on success or a negative error code
cannam@154:   *          (see @ref opus_errorcodes) on failure.
cannam@154:   */
cannam@154: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_projection_decode_float(
cannam@154:     OpusProjectionDecoder *st,
cannam@154:     const unsigned char *data,
cannam@154:     opus_int32 len,
cannam@154:     float *pcm,
cannam@154:     int frame_size,
cannam@154:     int decode_fec
cannam@154: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
cannam@154: 
cannam@154: 
cannam@154: /** Perform a CTL function on a projection Opus decoder.
cannam@154:   *
cannam@154:   * Generally the request and subsequent arguments are generated by a
cannam@154:   * convenience macro.
cannam@154:   * @param st <tt>OpusProjectionDecoder*</tt>: Projection decoder state.
cannam@154:   * @param request This and all remaining parameters should be replaced by one
cannam@154:   *                of the convenience macros in @ref opus_genericctls,
cannam@154:   *                @ref opus_decoderctls, @ref opus_multistream_ctls, or
cannam@154:   *                @ref opus_projection_ctls.
cannam@154:   * @see opus_genericctls
cannam@154:   * @see opus_decoderctls
cannam@154:   * @see opus_multistream_ctls
cannam@154:   * @see opus_projection_ctls
cannam@154:   */
cannam@154: OPUS_EXPORT int opus_projection_decoder_ctl(OpusProjectionDecoder *st, int request, ...) OPUS_ARG_NONNULL(1);
cannam@154: 
cannam@154: 
cannam@154: /** Frees an <code>OpusProjectionDecoder</code> allocated by
cannam@154:   * opus_projection_decoder_create().
cannam@154:   * @param st <tt>OpusProjectionDecoder</tt>: Projection decoder state to be freed.
cannam@154:   */
cannam@154: OPUS_EXPORT void opus_projection_decoder_destroy(OpusProjectionDecoder *st);
cannam@154: 
cannam@154: 
cannam@154: /**@}*/
cannam@154: 
cannam@154: /**@}*/
cannam@154: 
cannam@154: #ifdef __cplusplus
cannam@154: }
cannam@154: #endif
cannam@154: 
cannam@154: #endif /* OPUS_PROJECTION_H */