| fishsound.h | fishsound.h | |||
|---|---|---|---|---|
| skipping to change at line 612 | skipping to change at line 612 | |||
| * fish_sound_get_frameno() will simply continue to increment. See also | * fish_sound_get_frameno() will simply continue to increment. See also | |||
| * fish_sound_reset(). | * fish_sound_reset(). | |||
| * | * | |||
| * \param fsound A FishSound* handle | * \param fsound A FishSound* handle | |||
| * \param frameno The current frame number. | * \param frameno The current frame number. | |||
| * \retval 0 Success | * \retval 0 Success | |||
| * \retval -1 Invalid \a fsound | * \retval -1 Invalid \a fsound | |||
| */ | */ | |||
| int fish_sound_set_frameno (FishSound * fsound, long frameno); | int fish_sound_set_frameno (FishSound * fsound, long frameno); | |||
| /** | ||||
| * Prepare truncation details for the next block of data. | ||||
| * The semantics of these parameters derives directly from Ogg encapsulatio | ||||
| n | ||||
| * of Vorbis, described | ||||
| * <a href="http://www.xiph.org/ogg/vorbis/doc/Vorbis_I_spec.html#vorbis-ov | ||||
| er-ogg">here</a>. | ||||
| * | ||||
| * When decoding from Ogg, you should call this function with the \a granul | ||||
| epos | ||||
| * and \a eos of the \a ogg_packet structure. This call should be made befo | ||||
| re | ||||
| * passing the packet's data to fish_sound_decode(). Failure to do so may | ||||
| * result in minor decode errors on the first and/or last packet of the str | ||||
| eam. | ||||
| * | ||||
| * When encoding into Ogg, you should call this function with the \a granul | ||||
| epos | ||||
| * and \a eos that will be used for the \a ogg_packet structure. This call | ||||
| * should be made before passing the block of audio data to | ||||
| * fish_sound_encode(). Failure to do so may result in minor encoding error | ||||
| s | ||||
| * on the first and/or last packet of the stream. | ||||
| * | ||||
| * \param fsound A FishSound* handle | ||||
| * \param next_granulepos The "granulepos" for the next block to decode. | ||||
| * If unknown, set \a next_granulepos to -1. Otherwise, | ||||
| * \a next_granulepos specifies the frameno of the final frame in th | ||||
| e | ||||
| * block. This is authoritative, hence can be used to indicate | ||||
| * various forms of truncation at the beginning or end of a stream. | ||||
| * Mid-stream, a later-than-expected "granulepos" indicates that som | ||||
| e | ||||
| * data was missing. | ||||
| * \param next_eos A boolean indicating whether the next data block will be | ||||
| * the last in the stream. | ||||
| * \retval 0 Success | ||||
| * \retval -1 Invalid \a fsound | ||||
| */ | ||||
| int fish_sound_prepare_truncation (FishSound * fsound, long next_granulepos | ||||
| , | ||||
| int next_eos); | ||||
| #ifdef __cplusplus | #ifdef __cplusplus | |||
| } | } | |||
| #endif | #endif | |||
| #include <fishsound/comments.h> | #include <fishsound/comments.h> | |||
| #endif /* __FISH_SOUND_H__ */ | #endif /* __FISH_SOUND_H__ */ | |||
| End of changes. 1 change blocks. | ||||
| 0 lines changed or deleted | 43 lines changed or added | |||