1 /* 2 Copyright (C) 2003 Commonwealth Scientific and Industrial Research 3 Organisation (CSIRO) Australia 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 - Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 12 - Redistributions in binary form must reproduce the above copyright 13 notice, this list of conditions and the following disclaimer in the 14 documentation and/or other materials provided with the distribution. 15 16 - Neither the name of CSIRO Australia nor the names of its 17 contributors may be used to endorse or promote products derived from 18 this software without specific prior written permission. 19 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 23 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR 24 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifndef __FISH_SOUND_ENCODE_H__ 34 #define __FISH_SOUND_ENCODE_H__ 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /** \file 41 * Encode functions and callback prototypes 42 */ 43 44 /** 45 * Signature of a callback for libfishsound to call when it has encoded 46 * data. 47 * \param fsound The FishSound* handle 48 * \param buf The encoded data 49 * \param bytes The count of bytes encoded 50 * \param user_data Arbitrary user data 51 * \retval 0 to continue 52 * \retval non-zero to stop encoding immediately and 53 * return control to the fish_sound_encode() caller 54 */ 55 typedef int (*FishSoundEncoded) (FishSound * fsound, unsigned char * buf, 56 long bytes, void * user_data); 57 58 /** 59 * Set the callback for libfishsound to call when it has a block of 60 * encoded data ready 61 * \param fsound A FishSound* handle (created with mode FISH_SOUND_ENCODE) 62 * \param encoded The callback to call 63 * \param user_data Arbitrary user data to pass to the callback 64 * \returns 0 on success, -1 on failure 65 */ 66 int fish_sound_set_encoded_callback (FishSound * fsound, 67 FishSoundEncoded encoded, 68 void * user_data); 69 70 /** 71 * Encode a block of PCM audio given as non-interleaved floats. 72 * \param fsound A FishSound* handle (created with mode FISH_SOUND_ENCODE) 73 * \param pcm The audio data to encode 74 * \param frames A count of frames to encode 75 * \returns The number of frames encoded 76 * \note For multichannel audio, the audio data is interpreted according 77 * to the current PCM style 78 */ 79 long fish_sound_encode_float (FishSound * fsound, float * pcm[], long frames); 80 81 /** 82 * Encode a block of audio given as interleaved floats. 83 * \param fsound A FishSound* handle (created with mode FISH_SOUND_ENCODE) 84 * \param pcm The audio data to encode 85 * \param frames A count of frames to encode 86 * \returns The number of frames encoded 87 * \note For multichannel audio, the audio data is interpreted according 88 * to the current PCM style 89 */ 90 long fish_sound_encode_float_ilv (FishSound * fsound, float ** pcm, 91 long frames); 92 93 #ifdef __cplusplus 94 } 95 #endif 96 97 #endif /* __FISH_SOUND_ENCODE_H__ */ 98