diff options
Diffstat (limited to 'thirdparties/iphone/include/speex/speex.h')
-rwxr-xr-x | thirdparties/iphone/include/speex/speex.h | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/thirdparties/iphone/include/speex/speex.h b/thirdparties/iphone/include/speex/speex.h index 82ba016..0eb560e 100755 --- a/thirdparties/iphone/include/speex/speex.h +++ b/thirdparties/iphone/include/speex/speex.h @@ -7,18 +7,18 @@ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - + - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - + - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - + - Neither the name of the Xiph.org Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR @@ -245,70 +245,70 @@ typedef int (*decoder_ctl_func)(void *state, int request, void *ptr); /** Query function for a mode */ typedef int (*mode_query_func)(const void *mode, int request, void *ptr); -/** Struct defining a Speex mode */ +/** Struct defining a Speex mode */ typedef struct SpeexMode { - /** Pointer to the low-level mode data */ - const void *mode; + /** Pointer to the low-level mode data */ + const void *mode; + + /** Pointer to the mode query function */ + mode_query_func query; - /** Pointer to the mode query function */ - mode_query_func query; - - /** The name of the mode (you should not rely on this to identify the mode)*/ - const char *modeName; + /** The name of the mode (you should not rely on this to identify the mode)*/ + const char *modeName; - /**ID of the mode*/ - int modeID; + /**ID of the mode*/ + int modeID; - /**Version number of the bitstream (incremented every time we break - bitstream compatibility*/ - int bitstream_version; + /**Version number of the bitstream (incremented every time we break + bitstream compatibility*/ + int bitstream_version; - /** Pointer to encoder initialization function */ - encoder_init_func enc_init; + /** Pointer to encoder initialization function */ + encoder_init_func enc_init; - /** Pointer to encoder destruction function */ - encoder_destroy_func enc_destroy; + /** Pointer to encoder destruction function */ + encoder_destroy_func enc_destroy; - /** Pointer to frame encoding function */ - encode_func enc; + /** Pointer to frame encoding function */ + encode_func enc; - /** Pointer to decoder initialization function */ - decoder_init_func dec_init; + /** Pointer to decoder initialization function */ + decoder_init_func dec_init; - /** Pointer to decoder destruction function */ - decoder_destroy_func dec_destroy; + /** Pointer to decoder destruction function */ + decoder_destroy_func dec_destroy; - /** Pointer to frame decoding function */ - decode_func dec; + /** Pointer to frame decoding function */ + decode_func dec; - /** ioctl-like requests for encoder */ - encoder_ctl_func enc_ctl; + /** ioctl-like requests for encoder */ + encoder_ctl_func enc_ctl; - /** ioctl-like requests for decoder */ - decoder_ctl_func dec_ctl; + /** ioctl-like requests for decoder */ + decoder_ctl_func dec_ctl; } SpeexMode; /** - * Returns a handle to a newly created Speex encoder state structure. For now, - * the "mode" argument can be &nb_mode or &wb_mode . In the future, more modes - * may be added. Note that for now if you have more than one channels to + * Returns a handle to a newly created Speex encoder state structure. For now, + * the "mode" argument can be &nb_mode or &wb_mode . In the future, more modes + * may be added. Note that for now if you have more than one channels to * encode, you need one state per channel. * - * @param mode The mode to use (either speex_nb_mode or speex_wb.mode) + * @param mode The mode to use (either speex_nb_mode or speex_wb.mode) * @return A newly created encoder state or NULL if state allocation fails */ void *speex_encoder_init(const SpeexMode *mode); -/** Frees all resources associated to an existing Speex encoder state. +/** Frees all resources associated to an existing Speex encoder state. * @param state Encoder state to be destroyed */ void speex_encoder_destroy(void *state); /** Uses an existing encoder state to encode one frame of speech pointed to by "in". The encoded bit-stream is saved in "bits". @param state Encoder state - @param in Frame that will be encoded with a +-2^15 range. This data MAY be - overwritten by the encoder and should be considered uninitialised + @param in Frame that will be encoded with a +-2^15 range. This data MAY be + overwritten by the encoder and should be considered uninitialised after the call. @param bits Bit-stream where the data will be written @return 0 if frame needs not be transmitted (DTX only), 1 otherwise @@ -334,14 +334,14 @@ int speex_encode_int(void *state, spx_int16_t *in, SpeexBits *bits); int speex_encoder_ctl(void *state, int request, void *ptr); -/** Returns a handle to a newly created decoder state structure. For now, +/** Returns a handle to a newly created decoder state structure. For now, * the mode argument can be &nb_mode or &wb_mode . In the future, more modes * may be added. Note that for now if you have more than one channels to * decode, you need one state per channel. * * @param mode Speex mode (one of speex_nb_mode or speex_wb_mode) * @return A newly created decoder state or NULL if state allocation fails - */ + */ void *speex_decoder_init(const SpeexMode *mode); /** Frees all resources associated to an existing decoder state. |