oggz_seek.h

Go to the documentation of this file.

/*
   Copyright (C) 2003 Commonwealth Scientific and Industrial Research
   Organisation (CSIRO) Australia

   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 CSIRO Australia 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 A
   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef __OGGZ_SEEK_H__
#define __OGGZ_SEEK_H__

ogg_int64_t oggz_tell_units (OGGZ * oggz);

ogg_int64_t oggz_seek_units (OGGZ * oggz, ogg_int64_t units, int whence);

ogg_int64_t
oggz_tell_granulepos (OGGZ * oggz);

oggz_off_t oggz_tell (OGGZ * oggz);

oggz_off_t oggz_seek (OGGZ * oggz, oggz_off_t offset, int whence);

#ifdef _UNIMPLEMENTED
long oggz_seek_packets (OGGZ * oggz, long serialno, long packets, int whence);
#endif

int oggz_get_preroll (OGGZ * oggz, long serialno);

int oggz_set_preroll (OGGZ * oggz, long serialno, int preroll);

int oggz_get_granuleshift (OGGZ * oggz, long serialno);

int oggz_set_granuleshift (OGGZ * oggz, long serialno, int granuleshift);

int oggz_get_granulerate (OGGZ * oggz, long serialno,
                          ogg_int64_t * granulerate_n,
                          ogg_int64_t * granulerate_d);

int oggz_set_granulerate (OGGZ * oggz, long serialno,
                          ogg_int64_t granule_rate_numerator,
                          ogg_int64_t granule_rate_denominator);

typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno,
                                   ogg_int64_t granulepos, void * user_data);

int oggz_set_metric (OGGZ * oggz, long serialno, OggzMetric metric,
                     void * user_data);

#ifdef _UNIMPLEMENTED

typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target,
                         void * user_data);
int oggz_set_order (OGGZ * oggz, long serialno, OggzOrder order,
                    void * user_data);

long oggz_seek_byorder (OGGZ * oggz, void * target);

#endif /* _UNIMPLEMENTED */

int oggz_set_data_start (OGGZ * oggz, oggz_off_t offset);
ogg_int64_t
oggz_bounded_seek_set (OGGZ * oggz,
                       ogg_int64_t unit_target,
                       ogg_int64_t offset_begin,
                       ogg_int64_t offset_end);

#endif /* __OGGZ_SEEK_H__ */