oggz_private.h 6.58 KB
Newer Older
andre's avatar
andre committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
/*
   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_PRIVATE_H__
#define __OGGZ_PRIVATE_H__

conrad's avatar
conrad committed
36
#include <stdio.h>
silvia's avatar
silvia committed
37
#include <sys/types.h>
conrad's avatar
conrad committed
38

andre's avatar
andre committed
39 40 41
#include <ogg/ogg.h>
#include <oggz/oggz_constants.h>

conrad's avatar
conrad committed
42
#include "oggz_macros.h"
andre's avatar
andre committed
43 44 45
#include "oggz_vector.h"

typedef struct _OGGZ OGGZ;
46
typedef struct _OggzIO OggzIO;
andre's avatar
andre committed
47 48 49
typedef struct _OggzReader OggzReader;
typedef struct _OggzWriter OggzWriter;

50

andre's avatar
andre committed
51 52
typedef int (*OggzReadPacket) (OGGZ * oggz, ogg_packet * op, long serialno,
			       void * user_data);
53
typedef int (*OggzReadPage) (OGGZ * oggz, const ogg_page * og, long serialno,
54
			     void * user_data);
andre's avatar
andre committed
55

56 57 58
/* oggz_stream */
#include "oggz_stream.h"

andre's avatar
andre committed
59 60 61 62 63 64 65 66 67
typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno,
				   ogg_int64_t granulepos,
				   void * user_data);

typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target,
			  void * user_data);

typedef int (*OggzWriteHungry) (OGGZ * oggz, int empty, void * user_data);

68 69 70 71 72 73 74
/* oggz_io */
typedef size_t (*OggzIORead) (void * user_handle, void * buf, size_t n);
typedef size_t (*OggzIOWrite) (void * user_handle, void * buf, size_t n);
typedef int (*OggzIOSeek) (void * user_handle, long offset, int whence);
typedef long (*OggzIOTell) (void * user_handle);
typedef int (*OggzIOFlush) (void * user_handle);

75
struct _oggz_stream_t {
andre's avatar
andre committed
76 77
  ogg_stream_state ogg_stream;

78
  /** STATIC INFO */
79
  int content;
80 81 82 83 84 85 86 87
  int nr_headers;
  int preroll;
  ogg_int64_t granulerate_n;
  ogg_int64_t granulerate_d;
  ogg_int64_t basegranule;
  int granuleshift;

  /** CURRENT STATE **/
andre's avatar
andre committed
88 89 90 91 92 93 94 95
  /* non b_o_s packet has been written (not just queued) */
  int delivered_non_b_o_s;

  int b_o_s; /* beginning of stream */
  int e_o_s; /* end of stream */
  ogg_int64_t granulepos;
  ogg_int64_t packetno;

96
  /** CALLBACKS **/
andre's avatar
andre committed
97 98 99 100 101 102 103 104 105
  OggzMetric metric;
  void * metric_user_data;
  int metric_internal;

  OggzOrder order;
  void * order_user_data;

  OggzReadPacket read_packet;
  void * read_user_data;
106 107 108

  OggzReadPage read_page;
  void * read_page_user_data;
109
};
andre's avatar
andre committed
110 111 112 113 114 115 116 117 118 119 120

struct _OggzReader {
  ogg_sync_state ogg_sync;

  /* XXX: these two can prolly be removed again :) */
  ogg_stream_state ogg_stream;
  long current_serialno;

  OggzReadPacket read_packet;
  void * read_user_data;

121 122 123
  OggzReadPage read_page;
  void * read_page_user_data;

andre's avatar
andre committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
  ogg_int64_t current_unit;

#if 0
  off_t offset_page_end; /* offset of end of current page */
#endif
};

/**
 * Bundle a packet with the stream it is being queued for; used in
 * the packet_queue vector
 */
typedef struct {
  ogg_packet op;
  oggz_stream_t * stream;
  int flush;
  int * guard;
} oggz_writer_packet_t;

enum oggz_writer_state {
  OGGZ_MAKING_PACKETS = 0,
  OGGZ_WRITING_PAGES = 1
};

struct _OggzWriter {
  oggz_writer_packet_t * next_zpacket; /* stashed in case of FLUSH_BEFORE */
conrad's avatar
conrad committed
149
  OggzVector * packet_queue;
andre's avatar
andre committed
150 151 152 153 154 155 156 157 158 159 160

  OggzWriteHungry hungry;
  void * hungry_user_data;
  int hungry_only_when_empty;

  int writing; /* already mid-write; check for recursive writes */
  int state; /* OGGZ_MAKING_PACKETS or OGGZ_WRITING_PAGES */

  int flushing; /* whether current packet is being flushed or just paged out */

#if 0
161
  int eog; /* end of page */
andre's avatar
andre committed
162 163 164 165 166 167 168 169 170 171 172 173
  int eop; /* end of packet */
#endif
  int eos; /* end of stream */

  oggz_writer_packet_t * current_zpacket;

  int packet_offset; /* n bytes already copied out of current packet */
  int page_offset; /* n bytes already copied out of current page */

  ogg_stream_state * current_stream;
};

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
struct _OggzIO {
  OggzIORead read;
  void * read_user_handle;

  OggzIOWrite write;
  void * write_user_handle;

  OggzIOSeek seek;
  void * seek_user_handle;

  OggzIOTell tell;
  void * tell_user_handle;

  OggzIOFlush flush;
  void * flush_user_handle;
};

andre's avatar
andre committed
191 192
struct _OGGZ {
  int flags;
conrad's avatar
conrad committed
193
  FILE * file;
194
  OggzIO * io;
andre's avatar
andre committed
195 196 197 198 199 200 201

  ogg_packet current_packet;
  ogg_page current_page;

  off_t offset; /* offset of current page start */
  off_t offset_data_begin; /* offset of unit 0 page start */

conrad's avatar
conrad committed
202
  long run_blocksize; /* blocksize to use for oggz_run() */
203 204
  int cb_next;

conrad's avatar
conrad committed
205
  OggzVector * streams;
andre's avatar
andre committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  int all_at_eos; /* all streams are at eos */

  OggzMetric metric;
  void * metric_user_data;
  int metric_internal;

  OggzOrder order;
  void * order_user_data;

  union {
    OggzReader reader;
    OggzWriter writer;
  } x;
};

OGGZ * oggz_read_init (OGGZ * oggz);
OGGZ * oggz_read_close (OGGZ * oggz);

OGGZ * oggz_write_init (OGGZ * oggz);
225
int oggz_write_flush (OGGZ * oggz);
andre's avatar
andre committed
226 227
OGGZ * oggz_write_close (OGGZ * oggz);

228 229
int oggz_map_return_value_to_error (int cb_ret);

andre's avatar
andre committed
230 231 232
int oggz_get_bos (OGGZ * oggz, long serialno);
ogg_int64_t oggz_get_unit (OGGZ * oggz, long serialno, ogg_int64_t granulepos);

conrad's avatar
conrad committed
233 234
int oggz_set_metric_internal (OGGZ * oggz, long serialno, OggzMetric metric,
			      void * user_data, int internal);
235
int oggz_has_metrics (OGGZ * oggz);
conrad's avatar
conrad committed
236

237 238
int oggz_purge (OGGZ * oggz);

239 240
int oggz_auto_get_granulerate (OGGZ * oggz, ogg_packet * op, long serialno, 
                void * user_data);
conrad's avatar
conrad committed
241

242 243 244 245 246 247 248
/* oggz_io */
size_t oggz_io_read (OGGZ * oggz, void * buf, size_t n);
size_t oggz_io_write (OGGZ * oggz, void * buf, size_t n);
int oggz_io_seek (OGGZ * oggz, long offset, int whence);
long oggz_io_tell (OGGZ * oggz);
int oggz_io_flush (OGGZ * oggz);

andre's avatar
andre committed
249
#endif /* __OGGZ_PRIVATE_H__ */