1 /********************************************************************
3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
9 * by the XIPHOPHORUS Company http://www.xiph.org/ *
11 ********************************************************************
13 function: simple example decoder
14 last mod: $Id: decoder_example.c,v 1.27 2002/07/12 15:07:52 giles Exp $
16 ********************************************************************/
18 /* Takes a vorbis bitstream from stdin and writes raw stereo PCM to
19 stdout. Decodes simple and chained OggVorbis files from beginning
20 to end. Vorbisfile.a is somewhat more complex than the code below. */
22 /* Note that this is POSIX, not ANSI code */
27 #include <vorbis/codec.h>
29 #ifdef _WIN32 /* We need the following two to set stdin/stdout to binary */
34 #if defined(__MACOS__) && defined(__MWERKS__)
35 #include <console.h> /* CodeWarrior's Mac "command-line" support */
38 ogg_int16_t convbuffer[4096]; /* take 8k out of the data segment, not the stack */
41 extern void _VDBG_dump(void);
44 ogg_sync_state oy; /* sync and verify incoming physical bitstream */
45 ogg_stream_state os; /* take physical pages, weld into a logical
47 ogg_page og; /* one Ogg bitstream page. Vorbis packets are inside */
48 ogg_packet op; /* one raw packet of data for decode */
50 vorbis_info vi; /* struct that stores all the static vorbis bitstream
52 vorbis_comment vc; /* struct that stores all the bitstream user comments */
53 vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
54 vorbis_block vb; /* local working space for packet->PCM decode */
59 #ifdef _WIN32 /* We need to set stdin/stdout to binary mode. Damn windows. */
60 /* Beware the evil ifdef. We avoid these where we can, but this one we
61 cannot. Don't add any more, you'll probably go to hell if you do. */
62 _setmode( _fileno( stdin ), _O_BINARY );
63 _setmode( _fileno( stdout ), _O_BINARY );
66 #if defined(macintosh) && defined(__MWERKS__)
70 argc=ccommand(&argv); /* get a "command line" from the Mac user */
71 /* this also lets the user set stdin and stdout */
75 /********** Decode setup ************/
77 ogg_sync_init(&oy); /* Now we can read pages */
79 while(1){ /* we repeat if the bitstream is chained */
83 /* grab some data at the head of the stream. We want the first page
84 (which is guaranteed to be small and only contain the Vorbis
85 stream initial header) We need the first page to get the stream
88 /* submit a 4k block to libvorbis' Ogg layer */
89 buffer=ogg_sync_buffer(&oy,4096);
90 bytes=fread(buffer,1,4096,stdin);
91 ogg_sync_wrote(&oy,bytes);
93 /* Get the first page. */
94 if(ogg_sync_pageout(&oy,&og)!=1){
95 /* have we simply run out of data? If so, we're done. */
98 /* error case. Must not be Vorbis data */
99 fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n");
103 /* Get the serial number and set up the rest of decode. */
104 /* serialno first; use it to set up a logical stream */
105 ogg_stream_init(&os,ogg_page_serialno(&og));
107 /* extract the initial header from the first page and verify that the
108 Ogg bitstream is in fact Vorbis data */
110 /* I handle the initial header first instead of just having the code
111 read all three Vorbis headers at once because reading the initial
112 header is an easy way to identify a Vorbis bitstream and it's
113 useful to see that functionality seperated out. */
115 vorbis_info_init(&vi);
116 vorbis_comment_init(&vc);
117 if(ogg_stream_pagein(&os,&og)<0){
118 /* error; stream version mismatch perhaps */
119 fprintf(stderr,"Error reading first page of Ogg bitstream data.\n");
123 if(ogg_stream_packetout(&os,&op)!=1){
124 /* no page? must not be vorbis */
125 fprintf(stderr,"Error reading initial header packet.\n");
129 if(vorbis_synthesis_headerin(&vi,&vc,&op)<0){
130 /* error case; not a vorbis header */
131 fprintf(stderr,"This Ogg bitstream does not contain Vorbis "
136 /* At this point, we're sure we're Vorbis. We've set up the logical
137 (Ogg) bitstream decoder. Get the comment and codebook headers and
138 set up the Vorbis decoder */
140 /* The next two packets in order are the comment and codebook headers.
141 They're likely large and may span multiple pages. Thus we reead
142 and submit data until we get our two pacakets, watching that no
143 pages are missing. If a page is missing, error out; losing a
144 header page is the only place where missing data is fatal. */
149 int result=ogg_sync_pageout(&oy,&og);
150 if(result==0)break; /* Need more data */
151 /* Don't complain about missing or corrupt data yet. We'll
152 catch it at the packet output phase */
154 ogg_stream_pagein(&os,&og); /* we can ignore any errors here
155 as they'll also become apparent
158 result=ogg_stream_packetout(&os,&op);
161 /* Uh oh; data at some point was corrupted or missing!
162 We can't tolerate that in a header. Die. */
163 fprintf(stderr,"Corrupt secondary header. Exiting.\n");
166 vorbis_synthesis_headerin(&vi,&vc,&op);
171 /* no harm in not checking before adding more */
172 buffer=ogg_sync_buffer(&oy,4096);
173 bytes=fread(buffer,1,4096,stdin);
175 fprintf(stderr,"End of file before finding all Vorbis headers!\n");
178 ogg_sync_wrote(&oy,bytes);
181 /* Throw the comments plus a few lines about the bitstream we're
184 char **ptr=vc.user_comments;
186 fprintf(stderr,"%s\n",*ptr);
189 fprintf(stderr,"\nBitstream is %d channel, %ldHz\n",vi.channels,vi.rate);
190 fprintf(stderr,"Encoded by: %s\n\n",vc.vendor);
193 convsize=4096/vi.channels;
195 /* OK, got and parsed all three headers. Initialize the Vorbis
196 packet->PCM decoder. */
197 vorbis_synthesis_init(&vd,&vi); /* central decode state */
198 vorbis_block_init(&vd,&vb); /* local state for most of the decode
199 so multiple block decodes can
200 proceed in parallel. We could init
201 multiple vorbis_block structures
204 /* The rest is just a straight decode loop until end of stream */
207 int result=ogg_sync_pageout(&oy,&og);
208 if(result==0)break; /* need more data */
209 if(result<0){ /* missing or corrupt data at this page position */
210 fprintf(stderr,"Corrupt or missing data in bitstream; "
213 ogg_stream_pagein(&os,&og); /* can safely ignore errors at
216 result=ogg_stream_packetout(&os,&op);
218 if(result==0)break; /* need more data */
219 if(result<0){ /* missing or corrupt data at this page position */
220 /* no reason to complain; already complained above */
222 /* we have a packet. Decode it */
226 if(vorbis_synthesis(&vb,&op)==0) /* test for success! */
227 vorbis_synthesis_blockin(&vd,&vb);
230 **pcm is a multichannel float vector. In stereo, for
231 example, pcm[0] is left, and pcm[1] is right. samples is
232 the size of each channel. Convert the float values
233 (-1.<=range<=1.) to whatever PCM format and write it out */
235 while((samples=vorbis_synthesis_pcmout(&vd,&pcm))>0){
238 int bout=(samples<convsize?samples:convsize);
240 /* convert floats to 16 bit signed ints (host order) and
242 for(i=0;i<vi.channels;i++){
243 ogg_int16_t *ptr=convbuffer+i;
247 int val=mono[j]*32767.f;
248 #else /* optional dither */
249 int val=mono[j]*32767.f+drand48()-0.5f;
251 /* might as well guard against clipping */
266 fprintf(stderr,"Clipping in frame %ld\n",(long)(vd.sequence));
269 fwrite(convbuffer,2*vi.channels,bout,stdout);
271 vorbis_synthesis_read(&vd,bout); /* tell libvorbis how
277 if(ogg_page_eos(&og))eos=1;
281 buffer=ogg_sync_buffer(&oy,4096);
282 bytes=fread(buffer,1,4096,stdin);
283 ogg_sync_wrote(&oy,bytes);
288 /* clean up this logical bitstream; before exit we see if we're
289 followed by another [chained] */
291 ogg_stream_clear(&os);
293 /* ogg_page and ogg_packet structs always point to storage in
294 libvorbis. They're never freed or manipulated directly */
296 vorbis_block_clear(&vb);
297 vorbis_dsp_clear(&vd);
298 vorbis_comment_clear(&vc);
299 vorbis_info_clear(&vi); /* must be called last */
302 /* OK, clean up the framer */
305 fprintf(stderr,"Done.\n");