liboggz: oggz_seek.h Source File

00001 /*
00002    Copyright (C) 2003 Commonwealth Scientific and Industrial Research
00003    Organisation (CSIRO) Australia
00004 
00005    Redistribution and use in source and binary forms, with or without
00006    modification, are permitted provided that the following conditions
00007    are met:
00008 
00009    - Redistributions of source code must retain the above copyright
00010    notice, this list of conditions and the following disclaimer.
00011 
00012    - Redistributions in binary form must reproduce the above copyright
00013    notice, this list of conditions and the following disclaimer in the
00014    documentation and/or other materials provided with the distribution.
00015 
00016    - Neither the name of CSIRO Australia nor the names of its
00017    contributors may be used to endorse or promote products derived from
00018    this software without specific prior written permission.
00019 
00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00023    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 */
00032 
00033 #ifndef __OGGZ_SEEK_H__
00034 #define __OGGZ_SEEK_H__
00035 
00099 ogg_int64_t oggz_tell_units (OGGZ * oggz);
00100 
00109 ogg_int64_t oggz_seek_units (OGGZ * oggz, ogg_int64_t units, int whence);
00110 
00119 ogg_int64_t
00120 oggz_tell_granulepos (OGGZ * oggz);
00121 
00134 oggz_off_t oggz_tell (OGGZ * oggz);
00135 
00143 oggz_off_t oggz_seek (OGGZ * oggz, oggz_off_t offset, int whence);
00144 
00145 #ifdef _UNIMPLEMENTED
00146 long oggz_seek_packets (OGGZ * oggz, long serialno, long packets, int whence);
00147 #endif
00148 
00270 int oggz_get_preroll (OGGZ * oggz, long serialno);
00271 
00283 int oggz_set_preroll (OGGZ * oggz, long serialno, int preroll);
00284 
00294 int oggz_get_granuleshift (OGGZ * oggz, long serialno);
00295 
00308 int oggz_set_granuleshift (OGGZ * oggz, long serialno, int granuleshift);
00309 
00322 int oggz_get_granulerate (OGGZ * oggz, long serialno,
00323                           ogg_int64_t * granulerate_n,
00324                           ogg_int64_t * granulerate_d);
00325 
00339 int oggz_set_granulerate (OGGZ * oggz, long serialno,
00340                           ogg_int64_t granule_rate_numerator,
00341                           ogg_int64_t granule_rate_denominator);
00342 
00360 typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno,
00361                                    ogg_int64_t granulepos, void * user_data);
00362 
00385 int oggz_set_metric (OGGZ * oggz, long serialno, OggzMetric metric,
00386                      void * user_data);
00387 
00388 #ifdef _UNIMPLEMENTED
00389 
00445 typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target,
00446                          void * user_data);
00454 int oggz_set_order (OGGZ * oggz, long serialno, OggzOrder order,
00455                     void * user_data);
00456 
00457 long oggz_seek_byorder (OGGZ * oggz, void * target);
00458 
00459 #endif /* _UNIMPLEMENTED */
00460 
00474 int oggz_set_data_start (OGGZ * oggz, oggz_off_t offset);
00491 ogg_int64_t
00492 oggz_bounded_seek_set (OGGZ * oggz,
00493                        ogg_int64_t unit_target,
00494                        ogg_int64_t offset_begin,
00495                        ogg_int64_t offset_end);
00496 
00497 #endif /* __OGGZ_SEEK_H__ */