All sample rates/modes with fresh training now in CVS.
[platform/upstream/libvorbis.git] / examples / encoder_example.c
1 /********************************************************************
2  *                                                                  *
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.       *
7  *                                                                  *
8  * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002             *
9  * by the XIPHOPHORUS Company http://www.xiph.org/                  *
10  *                                                                  *
11  ********************************************************************
12
13  function: simple example encoder
14  last mod: $Id: encoder_example.c,v 1.46 2002/07/11 06:40:47 xiphmont Exp $
15
16  ********************************************************************/
17
18 /* takes a stereo 16bit 44.1kHz WAV file from stdin and encodes it into
19    a Vorbis bitstream */
20
21 /* Note that this is POSIX, not ANSI, code */
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <time.h>
27 #include <math.h>
28 #include <vorbis/vorbisenc.h>
29
30 #ifdef _WIN32 /* We need the following two to set stdin/stdout to binary */
31 #include <io.h>
32 #include <fcntl.h>
33 #endif
34
35 #if defined(macintosh) && defined(__MWERKS__)
36 #include <console.h>      /* CodeWarrior's Mac "command-line" support */
37 #endif
38
39 #define READ 1024
40 signed char readbuffer[READ*4+44]; /* out of the data segment, not the stack */
41
42 int main(){
43   ogg_stream_state os; /* take physical pages, weld into a logical
44                           stream of packets */
45   ogg_page         og; /* one Ogg bitstream page.  Vorbis packets are inside */
46   ogg_packet       op; /* one raw packet of data for decode */
47   
48   vorbis_info      vi; /* struct that stores all the static vorbis bitstream
49                           settings */
50   vorbis_comment   vc; /* struct that stores all the user comments */
51
52   vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
53   vorbis_block     vb; /* local working space for packet->PCM decode */
54
55   int eos=0,ret;
56   int i, founddata;
57
58 #if defined(macintosh) && defined(__MWERKS__)
59   int argc = 0;
60   char **argv = NULL;
61   argc = ccommand(&argv); /* get a "command line" from the Mac user */
62                           /* this also lets the user set stdin and stdout */
63 #endif
64
65   /* we cheat on the WAV header; we just bypass 44 bytes and never
66      verify that it matches 16bit/stereo/44.1kHz.  This is just an
67      example, after all. */
68
69 #ifdef _WIN32 /* We need to set stdin/stdout to binary mode. Damn windows. */
70   /* if we were reading/writing a file, it would also need to in
71      binary mode, eg, 'fopen("file.wav","rb"); */
72   /* Beware the evil ifdef. We avoid these where we can, but this one we 
73      cannot. Don't add any more, you'll probably go to hell if you do. */
74   _setmode( _fileno( stdin ), _O_BINARY );
75   _setmode( _fileno( stdout ), _O_BINARY );
76 #endif
77
78
79   /* we cheat on the WAV header; we just bypass the header and never
80      verify that it matches 16bit/stereo/44.1kHz.  This is just an
81      example, after all. */
82
83   readbuffer[0] = '\0';
84   for (i=0, founddata=0; i<30 && ! feof(stdin) && ! ferror(stdin); i++)
85   {
86     fread(readbuffer,1,2,stdin);
87
88     if ( ! strncmp(readbuffer, "da", 2) )
89     {
90       founddata = 1;
91       fread(readbuffer,1,6,stdin);
92       break;
93     }
94   }
95
96   /********** Encode setup ************/
97
98   vorbis_info_init(&vi);
99
100   /* choose an encoding mode.  A few possibilities commented out, one
101      actually used: */
102
103   /*********************************************************************
104    Encoding using a VBR quality mode.  The usable range is -.1
105    (lowest quality, smallest file) to 1. (highest quality, largest file).
106    Example quality mode .4: 44kHz stereo coupled, roughly 128kbps VBR 
107   
108    ret = vorbis_encode_init_vbr(&vi,2,44100,-.4);
109
110    ---------------------------------------------------------------------
111
112    Encoding using an average bitrate mode (ABR).
113    example: 44kHz stereo coupled, average 128kbps VBR 
114   
115    ret = vorbis_encode_init(&vi,2,44100,-1,128000,-1);
116
117    ---------------------------------------------------------------------
118
119    Encode using a qulity mode, but select that quality mode by asking for
120    an approximate bitrate.  This is not ABR, it is true VBR, but selected
121    using the bitrate interface, and then turning bitrate management off:
122
123    ret = ( vorbis_encode_setup_managed(&vi,2,44100,-1,128000,-1) ||
124            vorbis_encode_ctl(&vi,OV_ECTL_RATEMANAGE_AVG,NULL) ||
125            vorbis_encode_setup_init(&vi));
126
127    *********************************************************************/
128
129   
130   //ret=vorbis_encode_init(&vi,2,44100,-1,64000,-1);
131   ret=vorbis_encode_init_vbr(&vi,2,16000,.5);
132
133   /* do not continue if setup failed; this can happen if we ask for a
134      mode that libVorbis does not support (eg, too low a bitrate, etc,
135      will return 'OV_EIMPL') */
136
137   if(ret)exit(1);
138
139   /* add a comment */
140   vorbis_comment_init(&vc);
141   vorbis_comment_add_tag(&vc,"ENCODER","encoder_example.c");
142
143   /* set up the analysis state and auxiliary encoding storage */
144   vorbis_analysis_init(&vd,&vi);
145   vorbis_block_init(&vd,&vb);
146   
147   /* set up our packet->stream encoder */
148   /* pick a random serial number; that way we can more likely build
149      chained streams just by concatenation */
150   srand(time(NULL));
151   ogg_stream_init(&os,rand());
152
153   /* Vorbis streams begin with three headers; the initial header (with
154      most of the codec setup parameters) which is mandated by the Ogg
155      bitstream spec.  The second header holds any comment fields.  The
156      third header holds the bitstream codebook.  We merely need to
157      make the headers, then pass them to libvorbis one at a time;
158      libvorbis handles the additional Ogg bitstream constraints */
159
160   {
161     ogg_packet header;
162     ogg_packet header_comm;
163     ogg_packet header_code;
164
165     vorbis_analysis_headerout(&vd,&vc,&header,&header_comm,&header_code);
166     ogg_stream_packetin(&os,&header); /* automatically placed in its own
167                                          page */
168     ogg_stream_packetin(&os,&header_comm);
169     ogg_stream_packetin(&os,&header_code);
170
171         /* We don't have to write out here, but doing so makes streaming 
172          * much easier, so we do, flushing ALL pages. This ensures the actual
173          * audio data will start on a new page
174          */
175         while(!eos){
176                 int result=ogg_stream_flush(&os,&og);
177                 if(result==0)break;
178                 fwrite(og.header,1,og.header_len,stdout);
179                 fwrite(og.body,1,og.body_len,stdout);
180         }
181
182   }
183   
184   while(!eos){
185     long i;
186     long bytes=fread(readbuffer,1,READ*4,stdin); /* stereo hardwired here */
187
188     if(bytes==0){
189       /* end of file.  this can be done implicitly in the mainline,
190          but it's easier to see here in non-clever fashion.
191          Tell the library we're at end of stream so that it can handle
192          the last frame and mark end of stream in the output properly */
193       vorbis_analysis_wrote(&vd,0);
194
195     }else{
196       /* data to encode */
197
198       /* expose the buffer to submit data */
199       float **buffer=vorbis_analysis_buffer(&vd,READ);
200       
201       /* uninterleave samples */
202       for(i=0;i<bytes/4;i++){
203         buffer[0][i]=((readbuffer[i*4+1]<<8)|
204                       (0x00ff&(int)readbuffer[i*4]))/32768.f;
205         buffer[1][i]=((readbuffer[i*4+3]<<8)|
206                       (0x00ff&(int)readbuffer[i*4+2]))/32768.f;
207       }
208     
209       /* tell the library how much we actually submitted */
210       vorbis_analysis_wrote(&vd,i);
211     }
212
213     /* vorbis does some data preanalysis, then divvies up blocks for
214        more involved (potentially parallel) processing.  Get a single
215        block for encoding now */
216     while(vorbis_analysis_blockout(&vd,&vb)==1){
217
218       /* analysis, assume we want to use bitrate management */
219       vorbis_analysis(&vb,NULL);
220       vorbis_bitrate_addblock(&vb);
221
222       while(vorbis_bitrate_flushpacket(&vd,&op)){
223         
224         /* weld the packet into the bitstream */
225         ogg_stream_packetin(&os,&op);
226         
227         /* write out pages (if any) */
228         while(!eos){
229           int result=ogg_stream_pageout(&os,&og);
230           if(result==0)break;
231           fwrite(og.header,1,og.header_len,stdout);
232           fwrite(og.body,1,og.body_len,stdout);
233           
234           /* this could be set above, but for illustrative purposes, I do
235              it here (to show that vorbis does know where the stream ends) */
236           
237           if(ogg_page_eos(&og))eos=1;
238         }
239       }
240     }
241   }
242
243   /* clean up and exit.  vorbis_info_clear() must be called last */
244   
245   ogg_stream_clear(&os);
246   vorbis_block_clear(&vb);
247   vorbis_dsp_clear(&vd);
248   vorbis_comment_clear(&vc);
249   vorbis_info_clear(&vi);
250   
251   /* ogg_page and ogg_packet structs always point to storage in
252      libvorbis.  They're never freed or manipulated directly */
253   
254   fprintf(stderr,"Done.\n");
255   return(0);
256 }