doc/vorbisfile/seekingexample.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - Example Code</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>Example Code</h1>
  17
  18 <p>
  19 The following is a run-through of the decoding example program supplied
  20 with vorbisfile - <a href="vorbisfile_example_c.html">vorbisfile_example.c</a>.
  21 This program takes a vorbis bitstream from stdin and writes raw pcm to stdout.
  22
  23 <p>
  24 First, relevant headers, including vorbis-specific "codec.h" and "vorbisfile.h" have to be included.
  25
  26 <br><br>
  27 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  28 <tr bgcolor=#cccccc>
  29         <td>
  30 <pre><b>
  31 #include &lt;stdio.h&gt;
  32 #include &lt;stdlib.h&gt;
  33 #include &lt;math.h&gt;
  34 #include "vorbis/codec.h"
  35 #include "vorbis/vorbisfile.h"
  36 </b></pre>
  37         </td>
  38 </tr>
  39 </table>
  40 <p>
  41 We also have to make a concession to Windows users here.  If we are using windows for decoding, we must declare these libraries so that we can set stdin/stdout to binary.
  42 <br><br>
  43 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  44 <tr bgcolor=#cccccc>
  45         <td>
  46 <pre><b>
  47 #ifdef _WIN32
  48 #include &lt;io.h&gt;
  49 #include &lt;fcntl.h&gt;
  50 #endif
  51 </b></pre>
  52         </td>
  53 </tr>
  54 </table>
  55 <p>
  56 Next, a buffer for the pcm audio output is declared.
  57
  58 <br><br>
  59 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  60 <tr bgcolor=#cccccc>
  61         <td>
  62 <pre><b>
  63 char pcmout[4096];
  64 </b></pre>
  65         </td>
  66 </tr>
  67 </table>
  68
  69 <p>Inside main(), we declare our primary OggVorbis_File structure.  We also declare a few other helpful variables to track out progress within the file.
  70 Also, we make our final concession to Windows users by setting the stdin and stdout to binary mode.
  71 <br><br>
  72 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  73 <tr bgcolor=#cccccc>
  74         <td>
  75 <pre><b>
  76 int main(int argc, char **argv){
  77   OggVorbis_File vf;
  78   int eof=0;
  79   int current_section;
  80
  81 #ifdef _WIN32
  82   _setmode( _fileno( stdin ), _O_BINARY );
  83   _setmode( _fileno( stdout ), _O_BINARY );
  84 #endif
  85 </b></pre>
  86         </td>
  87 </tr>
  88 </table>
  89
  90 <p><a href="ov_open.html">ov_open()</a> must be
  91 called to initialize the <b>OggVorbis_File</b> structure with default values.
  92 <a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else.
  93
  94 <br><br>
  95 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  96 <tr bgcolor=#cccccc>
  97         <td>
  98 <pre><b>
  99   if(ov_open(stdin, &vf, NULL, 0) < 0) {
 100       fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n");
 101       exit(1);
 102   }
 103
 104 </b></pre>
 105         </td>
 106 </tr>
 107 </table>
 108
 109 <p>
 110 We're going to pull the channel and bitrate info from the file using <a href="ov_info.html">ov_info()</a> and show them to the user.
 111 We also want to pull out and show the user a comment attached to the file using <a href="ov_comment.html">ov_comment()</a>.
 112
 113 <br><br>
 114 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
 115 <tr bgcolor=#cccccc>
 116         <td>
 117 <pre><b>
 118   {
 119     char **ptr=ov_comment(&vf,-1)->user_comments;
 120     vorbis_info *vi=ov_info(&vf,-1);
 121     while(*ptr){
 122       fprintf(stderr,"%s\n",*ptr);
 123       ++ptr;
 124     }
 125     fprintf(stderr,"\nBitstream is %d channel, %ldHz\n",vi->channels,vi->rate);
 126     fprintf(stderr,"Encoded by: %s\n\n",ov_comment(&vf,-1)->vendor);
 127   }
 128
 129 </b></pre>
 130         </td>
 131 </tr>
 132 </table>
 133
 134 <p>
 135 Here's the read loop:
 136
 137 <br><br>
 138 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
 139 <tr bgcolor=#cccccc>
 140         <td>
 141 <pre><b>
 142
 143   while(!eof){
 144     long ret=ov_read(&vf,pcmout,sizeof(pcmout),0,2,1,&current_section);
 145     switch(ret){
 146     case 0:
 147       /* EOF */
 148       eof=1;
 149       break;
 150     case -1:
 151       break;
 152     default:
 153       fwrite(pcmout,1,ret,stdout);
 154       break;
 155     }
 156   }
 157
 158 </b></pre>
 159         </td>
 160 </tr>
 161 </table>
 162
 163 <p>
 164 The code is reading blocks of data using <a href="ov_read.html">ov_read()</a>.
 165 Based on the value returned, we know if we're at the end of the file or have invalid data.  If we have valid data, we write it to the pcm output.
 166
 167 <p>
 168 Now that we've finished playing, we can pack up and go home.  It's important to call <a href="ov_clear.html">ov_clear()</a> when we're finished.
 169
 170 <br><br>
 171 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
 172 <tr bgcolor=#cccccc>
 173         <td>
 174 <pre><b>
 175
 176   ov_clear(&vf);
 177
 178   fprintf(stderr,"Done.\n");
 179   return(0);
 180 }
 181 </b></pre>
 182         </td>
 183 </tr>
 184 </table>
 185
 186 <p>
 187 The full source for vorbisfile_example.c can be found with the vorbis
 188 distribution in <a href="vorbisfile_example_c.html">vorbisfile_example.c</a>.
 189
 190 <br><br>
 191 <hr noshade>
 192 <table border=0 width=100%>
 193 <tr valign=top>
 194 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
 195 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
 196 </tr><tr>
 197 <td><p class=tiny>vorbisfile documentation</p></td>
 198 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
 199 </tr>
 200 </table>
 201
 202 </body>
 203
 204 </html>