* modules/demux/ogg.c: small bug-fix for my previous commit.
[vlc.git] / modules / demux / ogg.c
1 /*****************************************************************************
2  * ogg.c : ogg stream input module for vlc
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id: ogg.c,v 1.12 2002/11/21 10:12:34 gbazin Exp $
6  *
7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
8  * 
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  * 
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc/input.h>
32
33 #include <sys/types.h>
34
35 #include <ogg/ogg.h>
36
37 #include <codecs.h>                        /* BITMAPINFOHEADER, WAVEFORMATEX */
38
39 #define OGG_BLOCK_SIZE 4096
40 #define PAGES_READ_ONCE 1
41
42 /*****************************************************************************
43  * Definitions of structures and functions used by this plugins 
44  *****************************************************************************/
45 typedef struct logical_stream_s
46 {
47     ogg_stream_state os;                        /* logical stream of packets */
48
49     int              i_serial_no;
50     int              i_cat;                            /* AUDIO_ES, VIDEO_ES */
51     int              i_activated;
52     vlc_fourcc_t     i_fourcc;
53     vlc_fourcc_t     i_codec;
54
55     es_descriptor_t  *p_es;
56     int              b_selected;                           /* newly selected */
57
58     /* the header of some logical streams (eg vorbis) contain essential
59      * data for the decoder. We back them up here in case we need to re-feed
60      * them to the decoder. */
61     int              b_force_backup;
62     int              i_packets_backup;
63     ogg_packet       *p_packets_backup;
64
65     /* program clock reference (in units of 90kHz) derived from the previous
66      * granulepos */
67     mtime_t          i_pcr;
68     mtime_t          i_interpolated_pcr;
69
70     /* info from logical streams */
71     double f_rate;
72     int i_bitrate;
73     int b_reinit;
74
75     /* codec specific stuff */
76     BITMAPINFOHEADER *p_bih;
77     WAVEFORMATEX *p_wf;
78     int i_theora_keyframe_granule_shift;
79
80 } logical_stream_t;
81
82 struct demux_sys_t
83 {
84     ogg_sync_state oy;        /* sync and verify incoming physical bitstream */
85
86     int i_streams;                           /* number of logical bitstreams */
87     logical_stream_t **pp_stream;  /* pointer to an array of logical streams */
88
89     /* current audio and video es */
90     logical_stream_t *p_stream_video;
91     logical_stream_t *p_stream_audio;
92     logical_stream_t *p_stream_spu;
93
94     /* program clock reference (in units of 90kHz) derived from the pcr of
95      * the sub-streams */
96     mtime_t i_pcr;
97
98     mtime_t i_length;
99     int     b_seekable;
100     int     b_reinit;
101 };
102
103 /* OggDS headers for the new header format (used in ogm files) */
104 typedef struct stream_header_video
105 {
106     ogg_int32_t width;
107     ogg_int32_t height;
108 } stream_header_video;
109         
110 typedef struct stream_header_audio
111 {
112     ogg_int16_t channels;
113     ogg_int16_t blockalign;
114     ogg_int32_t avgbytespersec;
115 } stream_header_audio;
116
117 typedef struct stream_header
118 {
119     char        streamtype[8];
120     char        subtype[4];
121
122     ogg_int32_t size;                               /* size of the structure */
123
124     ogg_int64_t time_unit;                              /* in reference time */
125     ogg_int64_t samples_per_unit;
126     ogg_int32_t default_len;                                /* in media time */
127
128     ogg_int32_t buffersize;
129     ogg_int16_t bits_per_sample;
130
131     union
132     {
133         /* Video specific */
134         stream_header_video video;
135         /* Audio specific */
136         stream_header_audio audio;
137     } sh;
138 } stream_header;
139
140 /* Some defines from OggDS */
141 #define PACKET_TYPE_HEADER   0x01
142 #define PACKET_TYPE_BITS     0x07
143 #define PACKET_LEN_BITS01    0xc0
144 #define PACKET_LEN_BITS2     0x02
145 #define PACKET_IS_SYNCPOINT  0x08
146
147 /* Some functions to manipulate memory */
148 static uint16_t GetWLE( uint8_t *p_buff )
149 {
150     return( (p_buff[0]) + ( p_buff[1] <<8 ) );
151 }
152
153 static uint32_t GetDWLE( uint8_t *p_buff )
154 {
155     return( p_buff[0] + ( p_buff[1] <<8 ) +
156             ( p_buff[2] <<16 ) + ( p_buff[3] <<24 ) );
157 }
158
159 static uint64_t GetQWLE( uint8_t *p_buff )
160 {
161     return( GetDWLE( p_buff ) + ( ((uint64_t)GetDWLE( p_buff + 4 )) << 32 ) );
162 }
163 /*****************************************************************************
164  * Local prototypes
165  *****************************************************************************/
166 static int  Activate  ( vlc_object_t * );
167 static void Deactivate( vlc_object_t * );
168 static int  Demux     ( input_thread_t * );
169
170 /* Stream managment */
171 static int  Ogg_StreamStart  ( input_thread_t *, demux_sys_t *, int );
172 static void Ogg_StreamStop   ( input_thread_t *, demux_sys_t *, int );
173
174 /* Bitstream manipulation */
175 static int  Ogg_Check        ( input_thread_t *p_input );
176 static int  Ogg_ReadPage     ( input_thread_t *, demux_sys_t *, ogg_page * );
177 static void Ogg_UpdatePCR    ( logical_stream_t *, ogg_packet * );
178 static void Ogg_DecodePacket ( input_thread_t *p_input,
179                                logical_stream_t *p_stream, ogg_packet * );
180 static int  Ogg_FindLogicalStreams( input_thread_t *p_input,
181                                     demux_sys_t *p_ogg );
182
183 /*****************************************************************************
184  * Module descriptor
185  *****************************************************************************/
186 vlc_module_begin();
187     set_description( _("ogg stream demux" ) );
188     set_capability( "demux", 50 );
189     set_callbacks( Activate, Deactivate );
190     add_shortcut( "ogg" );
191 vlc_module_end();
192
193 /*****************************************************************************
194  * Stream managment
195  *****************************************************************************/
196 static int Ogg_StreamStart( input_thread_t *p_input,
197                             demux_sys_t *p_ogg, int i_stream )
198 {
199 #define p_stream p_ogg->pp_stream[i_stream]
200     if( !p_stream->p_es )
201     {
202         msg_Warn( p_input, "stream[%d] unselectable", i_stream );
203         return( 0 );
204     }
205     if( p_stream->i_activated )
206     {
207         msg_Warn( p_input, "stream[%d] already selected", i_stream );
208         return( 1 );
209     }
210
211     if( !p_stream->p_es->p_decoder_fifo )
212     {
213         vlc_mutex_lock( &p_input->stream.stream_lock );
214         input_SelectES( p_input, p_stream->p_es );
215         vlc_mutex_unlock( &p_input->stream.stream_lock );
216     }
217     p_stream->i_activated = p_stream->p_es->p_decoder_fifo ? 1 : 0;
218
219     /* Feed the backup header to the decoder */
220     if( !p_stream->b_force_backup )
221     {
222         int i;
223         for( i = 0; i < p_stream->i_packets_backup; i++ )
224         {
225             Ogg_DecodePacket( p_input, p_stream,
226                               &p_stream->p_packets_backup[i] );
227         }
228     }
229
230     return( p_stream->i_activated );
231 #undef  p_stream
232 }
233
234 static void Ogg_StreamStop( input_thread_t *p_input,
235                             demux_sys_t *p_ogg, int i_stream )
236 {
237 #define p_stream    p_ogg->pp_stream[i_stream]
238
239     if( !p_stream->i_activated )
240     {
241         msg_Warn( p_input, "stream[%d] already unselected", i_stream );
242         return;
243     }
244
245     if( p_stream->p_es->p_decoder_fifo )
246     {
247         vlc_mutex_lock( &p_input->stream.stream_lock );
248         input_UnselectES( p_input, p_stream->p_es );
249         vlc_mutex_unlock( &p_input->stream.stream_lock );
250     }
251
252     p_stream->i_activated = 0;
253
254 #undef  p_stream
255 }
256
257 /****************************************************************************
258  * Ogg_Check: Check we are dealing with an ogg stream.
259  ****************************************************************************/
260 static int Ogg_Check( input_thread_t *p_input )
261 {
262     u8 *p_peek;
263     int i_size = input_Peek( p_input, &p_peek, 4 );
264
265     /* Check for the Ogg capture pattern */
266     if( !(i_size>3) || !(p_peek[0] == 'O') || !(p_peek[1] == 'g') ||
267         !(p_peek[2] == 'g') || !(p_peek[3] == 'S') )
268         return VLC_EGENERIC;
269
270     /* FIXME: Capture pattern might not be enough so we can also check for the
271      * the first complete page */
272
273     return VLC_SUCCESS;
274 }
275
276 /****************************************************************************
277  * Ogg_ReadPage: Read a full Ogg page from the physical bitstream.
278  ****************************************************************************
279  * Returns VLC_SUCCESS if a page has been read. An error might happen if we
280  * are at the end of stream.
281  ****************************************************************************/
282 static int Ogg_ReadPage( input_thread_t *p_input, demux_sys_t *p_ogg,
283                          ogg_page *p_oggpage )
284 {
285     int i_read = 0;
286     data_packet_t *p_data;
287     byte_t *p_buffer;
288
289     while( ogg_sync_pageout( &p_ogg->oy, p_oggpage ) != 1 )
290     {
291         i_read = input_SplitBuffer( p_input, &p_data, OGG_BLOCK_SIZE );
292         if( i_read <= 0 )
293             return VLC_EGENERIC;
294
295         p_buffer = ogg_sync_buffer( &p_ogg->oy, i_read );
296         p_input->p_vlc->pf_memcpy( p_buffer, p_data->p_payload_start, i_read );
297         ogg_sync_wrote( &p_ogg->oy, i_read );
298         input_DeletePacket( p_input->p_method_data, p_data );
299     }
300
301     return VLC_SUCCESS;
302 }
303
304 /****************************************************************************
305  * Ogg_UpdatePCR: update the PCR (90kHz program clock reference) for the
306  *                current stream.
307  ****************************************************************************/
308 static void Ogg_UpdatePCR( logical_stream_t *p_stream,
309                            ogg_packet *p_oggpacket )
310 {
311
312     /* Convert the next granulepos into a pcr */
313     if( p_oggpacket->granulepos >= 0 )
314     {
315         if( p_stream->i_fourcc != VLC_FOURCC( 't','h','e','o' ) )
316         {
317             p_stream->i_pcr = p_oggpacket->granulepos * 90000
318                               / p_stream->f_rate;
319         }
320         else
321         {
322             ogg_int64_t iframe = p_oggpacket->granulepos >>
323               p_stream->i_theora_keyframe_granule_shift;
324             ogg_int64_t pframe = p_oggpacket->granulepos -
325               ( iframe << p_stream->i_theora_keyframe_granule_shift );
326
327             p_stream->i_pcr = ( iframe + pframe ) * 90000
328                               / p_stream->f_rate;
329         }
330
331         p_stream->i_interpolated_pcr = p_stream->i_pcr;
332     }
333     else
334     {
335         /* FIXME: ffmpeg doesn't like null pts */
336         if( p_stream->i_cat == VIDEO_ES )
337             /* 1 frame per packet */
338             p_stream->i_pcr += (90000 / p_stream->f_rate);
339         else
340             p_stream->i_pcr = -1;
341
342         /* no granulepos available, try to interpolate the pcr.
343          * If we can't then don't touch the old value. */
344         if( p_stream->i_bitrate )
345             p_stream->i_interpolated_pcr += ( p_oggpacket->bytes * 90000
346                                               / p_stream->i_bitrate / 8 );
347     }
348 }
349
350 /****************************************************************************
351  * Ogg_DecodePacket: Decode an Ogg packet.
352  ****************************************************************************/
353 static void Ogg_DecodePacket( input_thread_t *p_input,
354                               logical_stream_t *p_stream,
355                               ogg_packet *p_oggpacket )
356 {
357     pes_packet_t  *p_pes;
358     data_packet_t *p_data;
359     //demux_sys_t *p_ogg = p_input->p_demux_data;
360     int i_header_len = 0;
361
362     if( p_stream->b_force_backup )
363     {
364         /* Backup the ogg packet (likely an header packet) */
365         ogg_packet *p_packet_backup;
366         p_stream->i_packets_backup++;
367         p_stream->p_packets_backup =
368             realloc( p_stream->p_packets_backup, p_stream->i_packets_backup *
369                      sizeof(ogg_packet) );
370
371         p_packet_backup =
372             &p_stream->p_packets_backup[p_stream->i_packets_backup - 1];
373
374         p_packet_backup->bytes = p_oggpacket->bytes;
375         p_packet_backup->granulepos = p_oggpacket->granulepos;
376         p_packet_backup->packet = malloc( p_oggpacket->bytes );
377         if( !p_packet_backup->packet ) return;
378         memcpy( p_packet_backup->packet, p_oggpacket->packet,
379                 p_oggpacket->bytes );
380
381         switch( p_stream->i_fourcc )
382         {
383         case VLC_FOURCC( 'v','o','r','b' ):
384           if( p_stream->i_packets_backup == 3 ) p_stream->b_force_backup = 0;
385           break;
386
387         default:
388           p_stream->b_force_backup = 0;
389           break;
390         }
391     }
392
393     if( !p_stream->p_es->p_decoder_fifo )
394     {
395         /* This stream isn't currently selected so we don't need to decode it,
396          * but we do need to store its pcr as it might be selected later on. */
397         Ogg_UpdatePCR( p_stream, p_oggpacket );
398
399         return;
400     }
401
402     if( !( p_pes = input_NewPES( p_input->p_method_data ) ) )
403     {
404         return;
405     }
406     if( !( p_data = input_NewPacket( p_input->p_method_data,
407                                      p_oggpacket->bytes ) ) )
408     {
409         input_DeletePES( p_input->p_method_data, p_pes );
410         return;
411     }
412
413     /* Convert the pcr into a pts */
414     if( p_stream->i_cat != SPU_ES )
415     {
416         p_pes->i_pts = ( p_stream->i_pcr < 0 ) ? 0 :
417             input_ClockGetTS( p_input, p_input->stream.p_selected_program,
418                               p_stream->i_pcr );
419     }
420     else
421     {
422         /* Of course subtitles had to be different! */
423         p_pes->i_pts = ( p_oggpacket->granulepos < 0 ) ? 0 :
424             input_ClockGetTS( p_input, p_input->stream.p_selected_program,
425                               p_oggpacket->granulepos * 90000 /
426                               p_stream->f_rate );
427     }
428
429     /* Convert the next granulepos into a pcr */
430     Ogg_UpdatePCR( p_stream, p_oggpacket );
431
432     p_pes->i_nb_data = 1;
433     p_pes->i_dts = p_oggpacket->granulepos;
434     p_pes->p_first = p_pes->p_last = p_data;
435     p_pes->i_pes_size = p_oggpacket->bytes;
436
437     if( p_stream->i_fourcc != VLC_FOURCC( 'v','o','r','b' ) &&
438         p_stream->i_fourcc != VLC_FOURCC( 't','a','r','k' ) &&
439         p_stream->i_fourcc != VLC_FOURCC( 't','h','e','o' ) )
440     {
441         /* Remove the header from the packet */
442         i_header_len = (*p_oggpacket->packet & PACKET_LEN_BITS01) >> 6;
443         i_header_len |= (*p_oggpacket->packet & PACKET_LEN_BITS2) << 1;
444         i_header_len++;
445
446         p_pes->i_pes_size -= i_header_len;
447         p_pes->i_dts = 0;
448     }
449
450     if( p_stream->i_fourcc == VLC_FOURCC( 't','a','r','k' ) )
451     {
452         /* FIXME: the biggest hack I've ever done */
453         msg_Warn( p_input, "tark pts: %lli, granule: %i",
454                   p_pes->i_pts, p_pes->i_dts );
455         msleep(10000);
456     }
457
458     memcpy( p_data->p_payload_start,
459             p_oggpacket->packet + i_header_len,
460             p_oggpacket->bytes - i_header_len );
461
462     p_data->p_payload_end = p_data->p_payload_start + p_pes->i_pes_size;
463     p_data->b_discard_payload = 0;
464
465     input_DecodePES( p_stream->p_es->p_decoder_fifo, p_pes );
466 }
467
468 /****************************************************************************
469  * Ogg_FindLogicalStreams: Find the logical streams embedded in the physical
470  *                         stream and fill p_ogg.
471  *****************************************************************************
472  * The initial page of a logical stream is marked as a 'bos' page.
473  * Furthermore, the Ogg specification mandates that grouped bitstreams begin
474  * together and all of the initial pages must appear before any data pages.
475  *
476  * On success this function returns VLC_SUCCESS.
477  ****************************************************************************/
478 static int Ogg_FindLogicalStreams( input_thread_t *p_input, demux_sys_t *p_ogg)
479 {
480     ogg_packet oggpacket;
481     ogg_page oggpage;
482     int i_stream;
483
484     while( Ogg_ReadPage( p_input, p_ogg, &oggpage ) == VLC_SUCCESS )
485     {
486         if( ogg_page_bos( &oggpage ) )
487         {
488
489             /* All is wonderful in our fine fine little world.
490              * We found the beginning of our first logical stream. */
491             while( ogg_page_bos( &oggpage ) )
492             {
493                 p_ogg->i_streams++;
494                 p_ogg->pp_stream =
495                     realloc( p_ogg->pp_stream, p_ogg->i_streams *
496                              sizeof(logical_stream_t *) );
497
498 #define p_stream p_ogg->pp_stream[p_ogg->i_streams - 1]
499
500                 p_stream = malloc( sizeof(logical_stream_t) );
501                 memset( p_stream, 0, sizeof(logical_stream_t) );
502
503                 /* Setup the logical stream */
504                 p_stream->i_serial_no = ogg_page_serialno( &oggpage );
505                 ogg_stream_init( &p_stream->os, p_stream->i_serial_no );
506
507                 /* Extract the initial header from the first page and verify
508                  * the codec type of tis Ogg bitstream */
509                 if( ogg_stream_pagein( &p_stream->os, &oggpage ) < 0 )
510                 {
511                     /* error. stream version mismatch perhaps */
512                     msg_Err( p_input, "Error reading first page of "
513                              "Ogg bitstream data" );
514                     return VLC_EGENERIC;
515                 }
516
517                 /* FIXME: check return value */
518                 ogg_stream_packetpeek( &p_stream->os, &oggpacket );
519
520                 /* Check for Vorbis header */
521                 if( oggpacket.bytes >= 7 &&
522                     ! strncmp( &oggpacket.packet[1], "vorbis", 6 ) )
523                 {
524                     oggpack_buffer opb;
525
526                     msg_Dbg( p_input, "found vorbis header" );
527                     p_stream->i_cat = AUDIO_ES;
528                     p_stream->i_fourcc = VLC_FOURCC( 'v','o','r','b' );
529
530                     /* Signal that we want to keep a backup of the vorbis
531                      * stream headers. They will be used when switching between
532                      * audio streams. */
533                     p_stream->b_force_backup = 1;
534
535                     /* Cheat and get additionnal info ;) */
536                     oggpack_readinit( &opb, oggpacket.packet, oggpacket.bytes);
537                     oggpack_adv( &opb, 96 );
538                     p_stream->f_rate = oggpack_read( &opb, 32 );
539                     oggpack_adv( &opb, 32 );
540                     p_stream->i_bitrate = oggpack_read( &opb, 32 );
541                 }
542                 /* Check for Theora header */
543                 else if( oggpacket.bytes >= 7 &&
544                          ! strncmp( &oggpacket.packet[1], "theora", 6 ) )
545                 {
546 #ifdef HAVE_OGGPACKB
547                     oggpack_buffer opb;
548                     int i_fps_numerator;
549                     int i_fps_denominator;
550                     int i_keyframe_frequency_force;
551 #endif
552
553                     msg_Dbg( p_input, "found theora header" );
554 #ifdef HAVE_OGGPACKB
555                     p_stream->i_cat = VIDEO_ES;
556                     p_stream->i_fourcc = VLC_FOURCC( 't','h','e','o' );
557
558                     /* Cheat and get additionnal info ;) */
559                     oggpackB_readinit(&opb, oggpacket.packet, oggpacket.bytes);
560                     oggpackB_adv( &opb, 56 );
561                     oggpackB_read( &opb, 8 ); /* major version num */
562                     oggpackB_read( &opb, 8 ); /* minor version num */
563                     oggpackB_read( &opb, 8 ); /* subminor version num */
564                     oggpackB_read( &opb, 16 ) /*<< 4*/; /* width */
565                     oggpackB_read( &opb, 16 ) /*<< 4*/; /* height */
566                     i_fps_numerator = oggpackB_read( &opb, 32 );
567                     i_fps_denominator = oggpackB_read( &opb, 32 );
568                     oggpackB_read( &opb, 24 ); /* aspect_numerator */
569                     oggpackB_read( &opb, 24 ); /* aspect_denominator */
570                     i_keyframe_frequency_force = 1 << oggpackB_read( &opb, 5 );
571                     p_stream->i_bitrate = oggpackB_read( &opb, 24 );
572                     oggpackB_read(&opb,6); /* quality */
573
574                     /* granule_shift = i_log( frequency_force -1 ) */
575                     p_stream->i_theora_keyframe_granule_shift = 0;
576                     i_keyframe_frequency_force--;
577                     while( i_keyframe_frequency_force )
578                     {
579                         p_stream->i_theora_keyframe_granule_shift++;
580                         i_keyframe_frequency_force >>= 1;
581                     }
582
583                     p_stream->f_rate = (float)i_fps_numerator /
584                                                 i_fps_denominator;
585                     msg_Dbg( p_input,
586                              "found theora header, bitrate: %i, rate: %f",
587                              p_stream->i_bitrate, p_stream->f_rate );
588 #else /* HAVE_OGGPACKB */
589                     msg_Dbg( p_input, "the ogg demuxer has been compiled "
590                              "without support for the oggpackB extension."
591                              "The theora stream won't be decoded." );
592                     free( p_stream );
593                     p_ogg->i_streams--;
594                     continue;
595 #endif /* HAVE_OGGPACKB */
596                 }
597                 /* Check for Tarkin header */
598                 else if( oggpacket.bytes >= 7 &&
599                          ! strncmp( &oggpacket.packet[1], "tarkin", 6 ) )
600                 {
601                     oggpack_buffer opb;
602
603                     msg_Dbg( p_input, "found tarkin header" );
604                     p_stream->i_cat = VIDEO_ES;
605                     p_stream->i_fourcc = VLC_FOURCC( 't','a','r','k' );
606
607                     /* Cheat and get additionnal info ;) */
608                     oggpack_readinit( &opb, oggpacket.packet, oggpacket.bytes);
609                     oggpack_adv( &opb, 88 );
610                     oggpack_adv( &opb, 104 );
611                     p_stream->i_bitrate = oggpack_read( &opb, 32 );
612                     p_stream->f_rate = 2; /* FIXME */
613                     msg_Dbg( p_input,
614                              "found tarkin header, bitrate: %i, rate: %f",
615                              p_stream->i_bitrate, p_stream->f_rate );
616                 }
617                 else if( (*oggpacket.packet & PACKET_TYPE_BITS )
618                          == PACKET_TYPE_HEADER && 
619                          oggpacket.bytes >= (int)sizeof(stream_header)+1 )
620                 {
621                     stream_header *st = (stream_header *)(oggpacket.packet+1);
622
623                     /* Check for video header (new format) */
624                     if( !strncmp( st->streamtype, "video", 5 ) )
625                     {
626                         p_stream->i_cat = VIDEO_ES;
627
628                         /* We need to get rid of the header packet */
629                         ogg_stream_packetout( &p_stream->os, &oggpacket );
630
631                         p_stream->p_bih = (BITMAPINFOHEADER *)
632                             malloc( sizeof(BITMAPINFOHEADER) );
633                         if( !p_stream->p_bih )
634                         {
635                             /* Mem allocation error, just ignore the stream */
636                             free( p_stream );
637                             p_ogg->i_streams--;
638                             continue;
639                         }
640                         p_stream->p_bih->biSize = sizeof(BITMAPINFOHEADER);
641                         p_stream->p_bih->biCompression=
642                             p_stream->i_fourcc = VLC_FOURCC( st->subtype[0],
643                                                              st->subtype[1],
644                                                              st->subtype[2],
645                                                              st->subtype[3] );
646                         msg_Dbg( p_input, "found video header of type: %.4s",
647                                  (char *)&p_stream->i_fourcc );
648
649                         p_stream->f_rate = 10000000.0 /
650                             GetQWLE((uint8_t *)&st->time_unit);
651                         p_stream->p_bih->biBitCount =
652                             GetWLE((uint8_t *)&st->bits_per_sample);
653                         p_stream->p_bih->biWidth =
654                             GetDWLE((uint8_t *)&st->sh.video.width);
655                         p_stream->p_bih->biHeight =
656                             GetDWLE((uint8_t *)&st->sh.video.height);
657                         p_stream->p_bih->biPlanes= 1 ;
658                         p_stream->p_bih->biSizeImage =
659                             (p_stream->p_bih->biBitCount >> 3) *
660                             p_stream->p_bih->biWidth *
661                             p_stream->p_bih->biHeight;
662
663                         msg_Dbg( p_input,
664                              "fps: %f, width:%i; height:%i, bitcount:%i",
665                             p_stream->f_rate, p_stream->p_bih->biWidth,
666                             p_stream->p_bih->biHeight,
667                             p_stream->p_bih->biBitCount);
668
669                         p_stream->i_bitrate = 0;
670                     }
671                     /* Check for audio header (new format) */
672                     else if( !strncmp( st->streamtype, "audio", 5 ) )
673                     {
674                         char p_buffer[5];
675
676                         p_stream->i_cat = AUDIO_ES;
677
678                         /* We need to get rid of the header packet */
679                         ogg_stream_packetout( &p_stream->os, &oggpacket );
680
681                         p_stream->p_wf = (WAVEFORMATEX *)
682                             malloc( sizeof(WAVEFORMATEX) );
683                         if( !p_stream->p_wf )
684                         {
685                             /* Mem allocation error, just ignore the stream */
686                             free( p_stream );
687                             p_ogg->i_streams--;
688                             continue;
689                         }
690
691                         memcpy( p_buffer, st->subtype, 4 );
692                         p_buffer[4] = '\0';
693                         p_stream->p_wf->wFormatTag = strtol(p_buffer,NULL,16);
694                         p_stream->p_wf->nChannels =
695                             GetWLE((uint8_t *)&st->sh.audio.channels);
696                         p_stream->f_rate = p_stream->p_wf->nSamplesPerSec =
697                             GetQWLE((uint8_t *)&st->samples_per_unit);
698                         p_stream->i_bitrate = p_stream->p_wf->nAvgBytesPerSec =
699                             GetDWLE((uint8_t *)&st->sh.audio.avgbytespersec);
700                         p_stream->i_bitrate *= 8;
701                         p_stream->p_wf->nBlockAlign =
702                             GetWLE((uint8_t *)&st->sh.audio.blockalign);
703                         p_stream->p_wf->wBitsPerSample =
704                             GetWLE((uint8_t *)&st->bits_per_sample);
705                         p_stream->p_wf->cbSize = 0;
706
707                         switch( p_stream->p_wf->wFormatTag )
708                         {
709                         case WAVE_FORMAT_PCM:
710                             p_stream->i_fourcc =
711                                 VLC_FOURCC( 'a', 'r', 'a', 'w' );
712                             break;
713                         case WAVE_FORMAT_MPEG:
714                         case WAVE_FORMAT_MPEGLAYER3:
715                             p_stream->i_fourcc =
716                                 VLC_FOURCC( 'm', 'p', 'g', 'a' );
717                             break;
718                         case WAVE_FORMAT_A52:
719                             p_stream->i_fourcc =
720                                 VLC_FOURCC( 'a', '5', '2', ' ' );
721                             break;
722                         case WAVE_FORMAT_WMA1:
723                             p_stream->i_fourcc =
724                                 VLC_FOURCC( 'w', 'm', 'a', '1' );
725                             break;
726                         case WAVE_FORMAT_WMA2:
727                             p_stream->i_fourcc =
728                                 VLC_FOURCC( 'w', 'm', 'a', '2' );
729                             break;
730                         default:
731                             p_stream->i_fourcc = VLC_FOURCC( 'm', 's',
732                                 ( p_stream->p_wf->wFormatTag >> 8 ) & 0xff,
733                                 p_stream->p_wf->wFormatTag & 0xff );
734                         }
735
736                         msg_Dbg( p_input, "found audio header of type: %.4s",
737                                  (char *)&p_stream->i_fourcc );
738                         msg_Dbg( p_input, "audio:0x%4.4x channels:%d %dHz "
739                                  "%dbits/sample %dkb/s",
740                                  p_stream->p_wf->wFormatTag,
741                                  p_stream->p_wf->nChannels,
742                                  p_stream->p_wf->nSamplesPerSec,
743                                  p_stream->p_wf->wBitsPerSample,
744                                  p_stream->p_wf->nAvgBytesPerSec * 8 / 1024 );
745                     }
746                     /* Check for text (subtitles) header */
747                     else if( !strncmp(st->streamtype, "text", 4) )
748                     {
749                         /* We need to get rid of the header packet */
750                         ogg_stream_packetout( &p_stream->os, &oggpacket );
751
752                         msg_Dbg( p_input, "found text subtitles header" );
753                         p_stream->i_cat = SPU_ES;
754                         p_stream->i_fourcc =
755                             VLC_FOURCC( 's', 'u', 'b', 't' );
756                         p_stream->f_rate = 1000; /* granulepos is in milisec */
757                     }
758                     else
759                     {
760                         msg_Dbg( p_input, "stream %d has a header marker "
761                             "but is of an unknown type", p_ogg->i_streams-1 );
762                         free( p_stream );
763                         p_ogg->i_streams--;
764                     }
765                 }
766                 else
767                 {
768                     msg_Dbg( p_input, "stream %d is of unknown type",
769                              p_ogg->i_streams-1 );
770                     free( p_stream );
771                     p_ogg->i_streams--;
772                 }
773
774 #undef p_stream
775
776                 if( Ogg_ReadPage( p_input, p_ogg, &oggpage ) != VLC_SUCCESS )
777                     return VLC_EGENERIC;
778             }
779
780             /* This is the first data page, which means we are now finished
781              * with the initial pages. We just need to store it in the relevant
782              * bitstream. */
783             for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
784             {
785                 if( ogg_stream_pagein( &p_ogg->pp_stream[i_stream]->os,
786                                        &oggpage ) == 0 )
787                 {
788                     break;
789                 }
790             }
791             return VLC_SUCCESS;
792         }
793     }
794     return VLC_EGENERIC;
795 }
796
797 /*****************************************************************************
798  * Activate: initializes ogg demux structures
799  *****************************************************************************/
800 static int Activate( vlc_object_t * p_this )
801 {
802     int i_stream, b_forced;
803     demux_sys_t    *p_ogg;
804     input_thread_t *p_input = (input_thread_t *)p_this;
805
806     p_input->p_demux_data = NULL;
807     b_forced = ( ( *p_input->psz_demux )&&
808                  ( !strncmp( p_input->psz_demux, "ogg", 10 ) ) ) ? 1 : 0;
809
810     /* Check if we are dealing with an ogg stream */
811     if( !b_forced && ( Ogg_Check( p_input ) != VLC_SUCCESS ) )
812         return -1;
813
814     /* Allocate p_ogg */
815     if( !( p_ogg = malloc( sizeof( demux_sys_t ) ) ) )
816     {
817         msg_Err( p_input, "out of memory" );
818         goto error;
819     }
820     memset( p_ogg, 0, sizeof( demux_sys_t ) );
821     p_input->p_demux_data = p_ogg;
822
823     p_ogg->i_pcr  = 0;
824     p_ogg->b_seekable = ( ( p_input->stream.b_seekable )
825                         &&( p_input->stream.i_method == INPUT_METHOD_FILE ) );
826
827     /* Initialize the Ogg physical bitstream parser */
828     ogg_sync_init( &p_ogg->oy );
829
830     /* Find the logical streams embedded in the physical stream and
831      * initialize our p_ogg structure. */
832     if( Ogg_FindLogicalStreams( p_input, p_ogg ) != VLC_SUCCESS )
833     {
834         msg_Err( p_input, "couldn't find an ogg logical stream" );
835         goto error;
836     }
837
838     /* Set the demux function */
839     p_input->pf_demux = Demux;
840
841     /* Initialize access plug-in structures. */
842     if( p_input->i_mtu == 0 )
843     {
844         /* Improve speed. */
845         p_input->i_bufsize = INPUT_DEFAULT_BUFSIZE;
846     }
847
848     /* Create one program */
849     vlc_mutex_lock( &p_input->stream.stream_lock );
850     if( input_InitStream( p_input, 0 ) == -1)
851     {
852         vlc_mutex_unlock( &p_input->stream.stream_lock );
853         msg_Err( p_input, "cannot init stream" );
854         goto error;
855     }
856     if( input_AddProgram( p_input, 0, 0) == NULL )
857     {
858         vlc_mutex_unlock( &p_input->stream.stream_lock );
859         msg_Err( p_input, "cannot add program" );
860         goto error;
861     }
862     p_input->stream.p_selected_program = p_input->stream.pp_programs[0];
863     p_input->stream.i_mux_rate = 0;
864     vlc_mutex_unlock( &p_input->stream.stream_lock );
865
866     for( i_stream = 0 ; i_stream < p_ogg->i_streams; i_stream++ )
867     {
868 #define p_stream p_ogg->pp_stream[i_stream]
869         vlc_mutex_lock( &p_input->stream.stream_lock );
870         p_stream->p_es = input_AddES( p_input,
871                                       p_input->stream.p_selected_program,
872                                       p_ogg->i_streams + 1, 0 );
873         p_input->stream.i_mux_rate += (p_stream->i_bitrate / ( 8 * 50 ));
874         vlc_mutex_unlock( &p_input->stream.stream_lock );
875         p_stream->p_es->i_stream_id = p_stream->p_es->i_id = i_stream;
876         p_stream->p_es->i_fourcc = p_stream->i_fourcc;
877         p_stream->p_es->i_cat = p_stream->i_cat;
878         p_stream->p_es->p_demux_data = p_stream->p_bih ?
879             (void *)p_stream->p_bih : (void *)p_stream->p_wf;
880 #undef p_stream
881     }
882
883     for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
884     {
885 #define p_stream  p_ogg->pp_stream[i_stream]
886         switch( p_stream->p_es->i_cat )
887         {
888             case( VIDEO_ES ):
889                 if( (p_ogg->p_stream_video == NULL) )
890                 {
891                     p_ogg->p_stream_video = p_stream;
892                     /* TODO add test to see if a decoder has been found */
893                     Ogg_StreamStart( p_input, p_ogg, i_stream );
894                 }
895                 break;
896
897             case( AUDIO_ES ):
898                 if( (p_ogg->p_stream_audio == NULL) )
899                 {
900                     int i_audio = config_GetInt( p_input, "audio-channel" );
901                     if( i_audio == i_stream || i_audio <= 0 ||
902                         i_audio >= p_ogg->i_streams ||
903                         p_ogg->pp_stream[i_audio]->p_es->i_cat != AUDIO_ES )
904                     {
905                         p_ogg->p_stream_audio = p_stream;
906                         Ogg_StreamStart( p_input, p_ogg, i_stream );
907                     }
908                 }
909                 break;
910
911             case( SPU_ES ):
912                 if( (p_ogg->p_stream_spu == NULL) )
913                 {
914                     /* for spu, default is none */
915                     int i_spu = config_GetInt( p_input, "spu-channel" );
916                     if( i_spu < 0 || i_spu >= p_ogg->i_streams ||
917                         p_ogg->pp_stream[i_spu]->p_es->i_cat != SPU_ES )
918                     {
919                         break;
920                     }
921                     else if( i_spu == i_stream )
922                     {
923                         p_ogg->p_stream_spu = p_stream;
924                         Ogg_StreamStart( p_input, p_ogg, i_stream );
925                     }
926                 }
927                 break;
928
929             default:
930                 break;
931         }
932 #undef p_stream
933     }
934
935     /* we select the first audio and video ES */
936     vlc_mutex_lock( &p_input->stream.stream_lock );
937     if( !p_ogg->p_stream_video )
938     {
939         msg_Warn( p_input, "no video stream found" );
940     }
941     if( !p_ogg->p_stream_audio )
942     {
943         msg_Warn( p_input, "no audio stream found!" );
944     }
945     p_input->stream.p_selected_program->b_is_ok = 1;
946     vlc_mutex_unlock( &p_input->stream.stream_lock );
947
948     /* Call the pace control */
949     input_ClockManageRef( p_input,
950                           p_input->stream.p_selected_program,
951                           p_ogg->i_pcr );
952
953     return 0;
954
955  error:
956     Deactivate( (vlc_object_t *)p_input );
957     return -1;
958
959 }
960
961 /*****************************************************************************
962  * Deactivate: frees unused data
963  *****************************************************************************/
964 static void Deactivate( vlc_object_t *p_this )
965 {
966     input_thread_t *p_input = (input_thread_t *)p_this;
967     demux_sys_t *p_ogg = (demux_sys_t *)p_input->p_demux_data  ; 
968     int i, j;
969
970     if( p_ogg )
971     {
972         /* Cleanup the bitstream parser */
973         ogg_sync_clear( &p_ogg->oy );
974
975         for( i = 0; i < p_ogg->i_streams; i++ )
976         {
977             ogg_stream_clear( &p_ogg->pp_stream[i]->os );
978             for( j = 0; j < p_ogg->pp_stream[i]->i_packets_backup; j++ )
979             {
980                 free( p_ogg->pp_stream[i]->p_packets_backup[j].packet );
981             }
982             if( p_ogg->pp_stream[i]->p_packets_backup)
983                 free( p_ogg->pp_stream[i]->p_packets_backup );
984 #if 0 /* hmmm, it's already freed in input_DelES() */
985             if( p_ogg->pp_stream[i]->p_bih )
986                 free( p_ogg->pp_stream[i]->p_bih );
987             if( p_ogg->pp_stream[i]->p_wf )
988                 free( p_ogg->pp_stream[i]->p_wf );
989 #endif
990             free( p_ogg->pp_stream[i] );
991         }
992         if( p_ogg->pp_stream ) free( p_ogg->pp_stream );
993
994         free( p_ogg );
995     }
996 }
997
998 /*****************************************************************************
999  * Demux: reads and demuxes data packets
1000  *****************************************************************************
1001  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
1002  *****************************************************************************/
1003 static int Demux( input_thread_t * p_input )
1004 {
1005     int i, i_stream, b_eos = 0;
1006     ogg_page    oggpage;
1007     ogg_packet  oggpacket;
1008     demux_sys_t *p_ogg  = (demux_sys_t *)p_input->p_demux_data;
1009
1010 #define p_stream p_ogg->pp_stream[i_stream]
1011     /* detect new selected/unselected streams */
1012     for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1013     {
1014         if( p_stream->p_es )
1015         {
1016             if( p_stream->p_es->p_decoder_fifo &&
1017                 !p_stream->i_activated )
1018             {
1019                 Ogg_StreamStart( p_input, p_ogg, i_stream );
1020             }
1021             else
1022             if( !p_stream->p_es->p_decoder_fifo &&
1023                 p_stream->i_activated )
1024             {
1025                 Ogg_StreamStop( p_input, p_ogg, i_stream );
1026             }
1027         }
1028     }
1029
1030     /* search for new video and audio stream to select
1031      * if current have been unselected */
1032     if( ( !p_ogg->p_stream_video )
1033             || ( !p_ogg->p_stream_video->p_es->p_decoder_fifo ) )
1034     {
1035         p_ogg->p_stream_video = NULL;
1036         for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1037         {
1038             if( ( p_stream->i_cat == VIDEO_ES )
1039                   &&( p_stream->p_es->p_decoder_fifo ) )
1040             {
1041                 p_ogg->p_stream_video = p_stream;
1042                 break;
1043             }
1044         }
1045     }
1046     if( ( !p_ogg->p_stream_audio )
1047             ||( !p_ogg->p_stream_audio->p_es->p_decoder_fifo ) )
1048     {
1049         p_ogg->p_stream_audio = NULL;
1050         for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1051         {
1052             if( ( p_stream->i_cat == AUDIO_ES )
1053                   &&( p_stream->p_es->p_decoder_fifo ) )
1054             {
1055                 p_ogg->p_stream_audio = p_stream;
1056                 break;
1057             }
1058         }
1059     }
1060
1061     if( p_input->stream.p_selected_program->i_synchro_state == SYNCHRO_REINIT )
1062     {
1063         msg_Warn( p_input, "synchro reinit" );
1064
1065         /* An ogg packet does only contain the starting date of the next
1066          * packet, not its own starting date.
1067          * As a quick work around, we just skip an oggpage */
1068
1069         for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1070         {
1071             /* we'll trash all the data until we find the next pcr */
1072             p_stream->b_reinit = 1;
1073             p_stream->i_pcr = -1;
1074             p_stream->i_interpolated_pcr = -1;
1075         }
1076         p_ogg->b_reinit = 1;
1077     }
1078
1079
1080     /*
1081      * Demux ogg pages from the stream
1082      */
1083     for( i = 0; i < PAGES_READ_ONCE || p_ogg->b_reinit;  i++ )
1084     {
1085         if( Ogg_ReadPage( p_input, p_ogg, &oggpage ) != VLC_SUCCESS )
1086         {
1087             b_eos = 1;
1088             break;
1089         }
1090
1091         for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1092         {
1093             if( ogg_stream_pagein( &p_stream->os, &oggpage ) != 0 )
1094                 continue;
1095
1096             while( ogg_stream_packetout( &p_stream->os, &oggpacket ) > 0 )
1097             {
1098                 if( !p_stream->p_es )
1099                 {
1100                     break;
1101                 }
1102
1103                 if( p_stream->b_reinit )
1104                 {
1105                     if( oggpacket.granulepos >= 0 )
1106                     {
1107                         p_stream->b_reinit = 0;
1108
1109                         /* Convert the next granulepos into a pcr */
1110                         Ogg_UpdatePCR( p_stream, &oggpacket );
1111
1112                         /* Call the pace control to reinitialize
1113                          * the system clock */
1114                          input_ClockManageRef( p_input,
1115                              p_input->stream.p_selected_program,
1116                              p_stream->i_pcr );
1117
1118                          if( (!p_ogg->p_stream_video ||
1119                               !p_ogg->p_stream_video->b_reinit) &&
1120                              (!p_ogg->p_stream_audio ||
1121                               !p_ogg->p_stream_audio->b_reinit) )
1122                          {
1123                              p_ogg->b_reinit = 0;
1124                          }
1125                     }
1126                     continue;
1127                 }
1128
1129                 Ogg_DecodePacket( p_input, p_stream, &oggpacket );
1130
1131             }
1132         }
1133     }
1134
1135     i_stream = 0;
1136     p_ogg->i_pcr = p_stream->i_interpolated_pcr;
1137     for( ; i_stream < p_ogg->i_streams; i_stream++ )
1138     {
1139         if( p_stream->i_cat == SPU_ES )
1140             continue;
1141
1142         if( p_stream->i_interpolated_pcr < p_ogg->i_pcr )
1143             p_ogg->i_pcr = p_stream->i_interpolated_pcr;
1144     }
1145 #undef p_stream
1146
1147
1148     /* Call the pace control */
1149     input_ClockManageRef( p_input, p_input->stream.p_selected_program,
1150                           p_ogg->i_pcr );
1151
1152     /* Did we reach the end of stream ? */
1153     return( b_eos ? 0 : 1 );
1154 }