liboggz: oggz.h Source File

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

# oggz.h

Go to the documentation of this 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_H__
    00034 #define __OGGZ_H__
    00035
    00036 #include <stdio.h>
    00037 #include <sys/types.h>
    00038
    00039 #include <ogg/ogg.h>
    00040 #include <oggz/oggz_constants.h>
    00041 #include <oggz/oggz_table.h>
    00042
    00043 #ifdef __cplusplus
    00044 extern "C" {
    00045 #endif
    00046
    00441 typedef void OGGZ;
    00442
    00449 OGGZ * oggz_new (int flags);
    00450
    00458 OGGZ * oggz_open (const char * filename, int flags);
    00459
    00467 OGGZ * oggz_open_stdio (FILE * file, int flags);
    00468
    00477 int oggz_flush (OGGZ * oggz);
    00478
    00500 long oggz_run (OGGZ * oggz);
    00501
    00510 int oggz_run_set_blocksize (OGGZ * oggz, long blocksize);
    00511
    00519 int oggz_close (OGGZ * oggz);
    00520
    00531 int oggz_get_bos (OGGZ * oggz, long serialno);
    00532
    00543 int oggz_get_eos (OGGZ * oggz, long serialno);
    00544
    00555 int oggz_get_numtracks (OGGZ * oggz);
    00556
    00564 long oggz_serialno_new (OGGZ * oggz);
    00565
    00572 const char *
    00573 oggz_content_type (OggzStreamContent content);
    00574
    00575 #include <oggz/oggz_off_t.h>
    00576 #include <oggz/oggz_read.h>
    00577 #include <oggz/oggz_stream.h>
    00578 #include <oggz/oggz_seek.h>
    00579 #include <oggz/oggz_write.h>
    00580 #include <oggz/oggz_io.h>
    00581 #include <oggz/oggz_comments.h>
    00582 #include <oggz/oggz_deprecated.h>
    00583
    00584 #ifdef __cplusplus
    00585 }
    00586 #endif
    00587
    00588 #endif /* __OGGZ_H__ */