1 /*****************************************************************************
2 * ogg.c : ogg stream demux module for vlc
3 *****************************************************************************
4 * Copyright (C) 2001-2007 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
8 * Andre Pang <Andre.Pang@csiro.au> (Annodex support)
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
36 #include <vlc_input.h>
40 #include <vlc_codecs.h>
44 #include "kate_categories.h"
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Open ( vlc_object_t * );
52 static void Close( vlc_object_t * );
55 set_shortname ( "OGG" )
56 set_description( N_("OGG demuxer" ) )
57 set_category( CAT_INPUT )
58 set_subcategory( SUBCAT_INPUT_DEMUX )
59 set_capability( "demux", 50 )
60 set_callbacks( Open, Close )
65 /*****************************************************************************
66 * Definitions of structures and functions used by this plugins
67 *****************************************************************************/
69 /* OggDS headers for the new header format (used in ogm files) */
74 } stream_header_video_t;
80 ogg_int16_t blockalign;
81 ogg_int32_t avgbytespersec;
82 } stream_header_audio_t;
89 ogg_int32_t size; /* size of the structure */
91 ogg_int64_t time_unit; /* in reference time */
92 ogg_int64_t samples_per_unit;
93 ogg_int32_t default_len; /* in media time */
95 ogg_int32_t buffersize;
96 ogg_int16_t bits_per_sample;
102 stream_header_video_t video;
104 stream_header_audio_t audio;
109 /* Some defines from OggDS */
110 #define PACKET_TYPE_HEADER 0x01
111 #define PACKET_TYPE_BITS 0x07
112 #define PACKET_LEN_BITS01 0xc0
113 #define PACKET_LEN_BITS2 0x02
114 #define PACKET_IS_SYNCPOINT 0x08
116 /*****************************************************************************
118 *****************************************************************************/
119 static int Demux ( demux_t * );
120 static int Control( demux_t *, int, va_list );
122 /* Bitstream manipulation */
123 static int Ogg_ReadPage ( demux_t *, ogg_page * );
124 static void Ogg_UpdatePCR ( logical_stream_t *, ogg_packet * );
125 static void Ogg_DecodePacket ( demux_t *, logical_stream_t *, ogg_packet * );
127 static int Ogg_BeginningOfStream( demux_t *p_demux );
128 static int Ogg_FindLogicalStreams( demux_t *p_demux );
129 static void Ogg_EndOfStream( demux_t *p_demux );
132 static void Ogg_LogicalStreamDelete( demux_t *p_demux, logical_stream_t *p_stream );
133 static bool Ogg_LogicalStreamResetEsFormat( demux_t *p_demux, logical_stream_t *p_stream );
136 static void Ogg_ExtractMeta( demux_t *p_demux, vlc_fourcc_t i_codec, const uint8_t *p_headers, int i_headers );
138 /* Logical bitstream headers */
139 static void Ogg_ReadTheoraHeader( logical_stream_t *, ogg_packet * );
140 static void Ogg_ReadVorbisHeader( logical_stream_t *, ogg_packet * );
141 static void Ogg_ReadSpeexHeader( logical_stream_t *, ogg_packet * );
142 static void Ogg_ReadKateHeader( logical_stream_t *, ogg_packet * );
143 static void Ogg_ReadFlacHeader( demux_t *, logical_stream_t *, ogg_packet * );
144 static void Ogg_ReadAnnodexHeader( vlc_object_t *, logical_stream_t *, ogg_packet * );
145 static bool Ogg_ReadDiracHeader( logical_stream_t *, ogg_packet * );
147 /*****************************************************************************
148 * Open: initializes ogg demux structures
149 *****************************************************************************/
150 static int Open( vlc_object_t * p_this )
152 demux_t *p_demux = (demux_t *)p_this;
154 const uint8_t *p_peek;
157 /* Check if we are dealing with an ogg stream */
158 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
159 if( !p_demux->b_force && memcmp( p_peek, "OggS", 4 ) )
164 /* Set exported functions */
165 p_demux->pf_demux = Demux;
166 p_demux->pf_control = Control;
167 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
171 memset( p_sys, 0, sizeof( demux_sys_t ) );
172 p_sys->i_bitrate = 0;
173 p_sys->pp_stream = NULL;
174 p_sys->p_old_stream = NULL;
176 /* Begnning of stream, tell the demux to look for elementary streams. */
180 /* Initialize the Ogg physical bitstream parser */
181 ogg_sync_init( &p_sys->oy );
182 p_sys->b_page_waiting = false;
185 p_sys->p_meta = NULL;
190 /*****************************************************************************
191 * Close: frees unused data
192 *****************************************************************************/
193 static void Close( vlc_object_t *p_this )
195 demux_t *p_demux = (demux_t *)p_this;
196 demux_sys_t *p_sys = p_demux->p_sys ;
198 /* Cleanup the bitstream parser */
199 ogg_sync_clear( &p_sys->oy );
201 Ogg_EndOfStream( p_demux );
203 if( p_sys->p_old_stream )
204 Ogg_LogicalStreamDelete( p_demux, p_sys->p_old_stream );
209 /*****************************************************************************
210 * Demux: reads and demuxes data packets
211 *****************************************************************************
212 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
213 *****************************************************************************/
214 static int Demux( demux_t * p_demux )
216 demux_sys_t *p_sys = p_demux->p_sys;
217 ogg_packet oggpacket;
219 bool b_skipping = false;
222 if( p_sys->i_eos == p_sys->i_streams )
226 msg_Dbg( p_demux, "end of a group of logical streams" );
227 /* We keep the ES to try reusing it in Ogg_BeginningOfStream
228 * only 1 ES is supported (common case for ogg web radio) */
229 if( p_sys->i_streams == 1 )
231 p_sys->p_old_stream = p_sys->pp_stream[0];
232 TAB_CLEAN( p_sys->i_streams, p_sys->pp_stream );
234 Ogg_EndOfStream( p_demux );
238 if( Ogg_BeginningOfStream( p_demux ) != VLC_SUCCESS )
241 msg_Dbg( p_demux, "beginning of a group of logical streams" );
242 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
246 * The first data page of a physical stream is stored in the relevant logical stream
247 * in Ogg_FindLogicalStreams. Therefore, we must not read a page and only update the
248 * stream it belongs to if we haven't processed this first page yet. If we do, we
249 * will only process that first page whenever we find the second page for this stream.
250 * While this is fine for Vorbis and Theora, which are continuous codecs, which means
251 * the second page will arrive real quick, this is not fine for Kate, whose second
252 * data page will typically arrive much later.
253 * This means it is now possible to seek right at the start of a stream where the last
254 * logical stream is Kate, without having to wait for the second data page to unblock
255 * the first one, which is the one that triggers the 'no more headers to backup' code.
256 * And, as we all know, seeking without having backed up all headers is bad, since the
257 * codec will fail to initialize if it's missing its headers.
259 if( !p_sys->b_page_waiting)
262 * Demux an ogg page from the stream
264 if( Ogg_ReadPage( p_demux, &p_sys->current_page ) != VLC_SUCCESS )
267 /* Test for End of Stream */
268 if( ogg_page_eos( &p_sys->current_page ) )
273 for( i_stream = 0; i_stream < p_sys->i_streams; i_stream++ )
275 logical_stream_t *p_stream = p_sys->pp_stream[i_stream];
277 /* if we've just pulled page, look for the right logical stream */
278 if( !p_sys->b_page_waiting )
280 if( p_sys->i_streams == 1 &&
281 ogg_page_serialno( &p_sys->current_page ) != p_stream->os.serialno )
283 msg_Err( p_demux, "Broken Ogg stream (serialno) mismatch" );
284 ogg_stream_reset_serialno( &p_stream->os, ogg_page_serialno( &p_sys->current_page ) );
286 p_stream->b_reinit = true;
287 p_stream->i_pcr = -1;
288 p_stream->i_interpolated_pcr = -1;
289 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
292 if( ogg_stream_pagein( &p_stream->os, &p_sys->current_page ) != 0 )
299 while( ogg_stream_packetout( &p_stream->os, &oggpacket ) > 0 )
301 /* Read info from any secondary header packets, if there are any */
302 if( p_stream->i_secondary_header_packets > 0 )
304 if( p_stream->fmt.i_codec == VLC_CODEC_THEORA &&
305 oggpacket.bytes >= 7 &&
306 ! memcmp( oggpacket.packet, "\x80theora", 7 ) )
308 Ogg_ReadTheoraHeader( p_stream, &oggpacket );
309 p_stream->i_secondary_header_packets = 0;
311 else if( p_stream->fmt.i_codec == VLC_CODEC_VORBIS &&
312 oggpacket.bytes >= 7 &&
313 ! memcmp( oggpacket.packet, "\x01vorbis", 7 ) )
315 Ogg_ReadVorbisHeader( p_stream, &oggpacket );
316 p_stream->i_secondary_header_packets = 0;
318 else if( p_stream->fmt.i_codec == VLC_CODEC_CMML )
320 p_stream->i_secondary_header_packets = 0;
323 /* update start of data pointer */
324 p_stream->i_data_start = stream_Tell( p_demux->s );
328 /* If any streams have i_skip_frames, only decode (pre-roll)
329 * for those streams */
330 if ( b_skipping && p_stream->i_skip_frames == 0 ) continue;
333 if( p_stream->b_reinit )
335 /* If synchro is re-initialized we need to drop all the packets
336 * until we find a new dated one. */
337 Ogg_UpdatePCR( p_stream, &oggpacket );
339 if( p_stream->i_pcr >= 0 )
341 p_stream->b_reinit = false;
345 p_stream->i_interpolated_pcr = -1;
349 /* An Ogg/vorbis packet contains an end date granulepos */
350 if( p_stream->fmt.i_codec == VLC_CODEC_VORBIS ||
351 p_stream->fmt.i_codec == VLC_CODEC_SPEEX ||
352 p_stream->fmt.i_codec == VLC_CODEC_FLAC )
354 if( ogg_stream_packetout( &p_stream->os, &oggpacket ) > 0 )
356 Ogg_DecodePacket( p_demux, p_stream, &oggpacket );
360 es_out_Control( p_demux->out, ES_OUT_SET_PCR,
361 VLC_TS_0 + p_stream->i_pcr );
367 Ogg_DecodePacket( p_demux, p_stream, &oggpacket );
370 if( !p_sys->b_page_waiting )
374 /* if a page was waiting, it's now processed */
375 p_sys->b_page_waiting = false;
378 for( i_stream = 0; i_stream < p_sys->i_streams; i_stream++ )
380 logical_stream_t *p_stream = p_sys->pp_stream[i_stream];
382 if( p_stream->fmt.i_cat == SPU_ES )
384 if( p_stream->i_interpolated_pcr < 0 )
387 if( p_sys->i_pcr < 0 || p_stream->i_interpolated_pcr < p_sys->i_pcr )
388 p_sys->i_pcr = p_stream->i_interpolated_pcr;
391 if( p_sys->i_pcr >= 0 && ! b_skipping )
392 es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_sys->i_pcr );
397 /*****************************************************************************
399 *****************************************************************************/
400 static int Control( demux_t *p_demux, int i_query, va_list args )
402 demux_sys_t *p_sys = p_demux->p_sys;
411 p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
413 vlc_meta_Merge( p_meta, p_sys->p_meta );
416 case DEMUX_HAS_UNSUPPORTED_META:
417 pb_bool = (bool*)va_arg( args, bool* );
422 pi64 = (int64_t*)va_arg( args, int64_t * );
423 *pi64 = p_sys->i_pcr;
429 case DEMUX_SET_POSITION:
430 /* forbid seeking if we haven't initialized all logical bitstreams yet;
431 if we allowed, some headers would not get backed up and decoder init
432 would fail, making that logical stream unusable */
433 if( p_sys->i_bos > 0 )
438 for( i = 0; i < p_sys->i_streams; i++ )
440 logical_stream_t *p_stream = p_sys->pp_stream[i];
442 /* we'll trash all the data until we find the next pcr */
443 p_stream->b_reinit = true;
444 p_stream->i_pcr = -1;
445 p_stream->i_interpolated_pcr = -1;
446 ogg_stream_reset( &p_stream->os );
448 ogg_sync_reset( &p_sys->oy );
449 /* XXX The break/return is missing on purpose as
450 * demux_vaControlHelper will do the last part of the job */
453 return demux_vaControlHelper( p_demux->s, 0, -1, p_sys->i_bitrate,
458 /****************************************************************************
459 * Ogg_ReadPage: Read a full Ogg page from the physical bitstream.
460 ****************************************************************************
461 * Returns VLC_SUCCESS if a page has been read. An error might happen if we
462 * are at the end of stream.
463 ****************************************************************************/
464 static int Ogg_ReadPage( demux_t *p_demux, ogg_page *p_oggpage )
466 demux_sys_t *p_ogg = p_demux->p_sys ;
470 while( ogg_sync_pageout( &p_ogg->oy, p_oggpage ) != 1 )
472 p_buffer = ogg_sync_buffer( &p_ogg->oy, OGGSEEK_BYTES_TO_READ );
474 i_read = stream_Read( p_demux->s, p_buffer, OGGSEEK_BYTES_TO_READ );
478 ogg_sync_wrote( &p_ogg->oy, i_read );
484 /****************************************************************************
485 * Ogg_UpdatePCR: update the PCR (90kHz program clock reference) for the
487 ****************************************************************************/
488 static void Ogg_UpdatePCR( logical_stream_t *p_stream,
489 ogg_packet *p_oggpacket )
491 /* Convert the granulepos into a pcr */
492 if( p_oggpacket->granulepos >= 0 )
494 if( p_stream->fmt.i_codec == VLC_CODEC_THEORA ||
495 p_stream->fmt.i_codec == VLC_CODEC_KATE )
497 ogg_int64_t iframe = p_oggpacket->granulepos >>
498 p_stream->i_granule_shift;
499 ogg_int64_t pframe = p_oggpacket->granulepos -
500 ( iframe << p_stream->i_granule_shift );
502 p_stream->i_pcr = ( iframe + pframe - p_stream->i_keyframe_offset )
503 * INT64_C(1000000) / p_stream->f_rate;
505 else if( p_stream->fmt.i_codec == VLC_CODEC_DIRAC )
507 ogg_int64_t i_dts = p_oggpacket->granulepos >> 31;
508 /* NB, OggDirac granulepos values are in units of 2*picturerate */
509 p_stream->i_pcr = (i_dts/2) * INT64_C(1000000) / p_stream->f_rate;
513 p_stream->i_pcr = p_oggpacket->granulepos * INT64_C(1000000)
517 p_stream->i_pcr += 1;
518 p_stream->i_interpolated_pcr = p_stream->i_pcr;
522 p_stream->i_pcr = -1;
524 /* no granulepos available, try to interpolate the pcr.
525 * If we can't then don't touch the old value. */
526 if( p_stream->fmt.i_cat == VIDEO_ES )
527 /* 1 frame per packet */
528 p_stream->i_interpolated_pcr += (INT64_C(1000000) / p_stream->f_rate);
529 else if( p_stream->fmt.i_bitrate )
530 p_stream->i_interpolated_pcr +=
531 ( p_oggpacket->bytes * INT64_C(1000000) /
532 p_stream->fmt.i_bitrate / 8 );
536 /****************************************************************************
537 * Ogg_DecodePacket: Decode an Ogg packet.
538 ****************************************************************************/
539 static void Ogg_DecodePacket( demux_t *p_demux,
540 logical_stream_t *p_stream,
541 ogg_packet *p_oggpacket )
545 int i_header_len = 0;
546 mtime_t i_pts = -1, i_interpolated_pts;
547 demux_sys_t *p_ogg = p_demux->p_sys;
550 if( !p_oggpacket->bytes )
552 msg_Dbg( p_demux, "discarding 0 sized packet" );
556 if( p_oggpacket->bytes >= 7 &&
557 ! memcmp ( p_oggpacket->packet, "Annodex", 7 ) )
559 /* it's an Annodex packet -- skip it (do nothing) */
562 else if( p_oggpacket->bytes >= 7 &&
563 ! memcmp ( p_oggpacket->packet, "AnxData", 7 ) )
565 /* it's an AnxData packet -- skip it (do nothing) */
569 if( p_stream->fmt.i_codec == VLC_CODEC_SUBT &&
570 p_oggpacket->packet[0] & PACKET_TYPE_BITS ) return;
572 /* Check the ES is selected */
573 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
574 p_stream->p_es, &b_selected );
576 if( p_stream->b_force_backup )
579 p_stream->i_packets_backup++;
580 switch( p_stream->fmt.i_codec )
582 case VLC_CODEC_VORBIS:
583 case VLC_CODEC_SPEEX:
584 case VLC_CODEC_THEORA:
585 if( p_stream->i_packets_backup == 3 ) p_stream->b_force_backup = 0;
590 if( !p_stream->fmt.audio.i_rate && p_stream->i_packets_backup == 2 )
592 Ogg_ReadFlacHeader( p_demux, p_stream, p_oggpacket );
593 p_stream->b_force_backup = 0;
595 else if( p_stream->fmt.audio.i_rate )
597 p_stream->b_force_backup = 0;
598 if( p_oggpacket->bytes >= 9 )
600 p_oggpacket->packet += 9;
601 p_oggpacket->bytes -= 9;
608 if( p_stream->i_packets_backup == p_stream->i_kate_num_headers ) p_stream->b_force_backup = 0;
613 p_stream->b_force_backup = 0;
618 /* Backup the ogg packet (likely an header packet) */
621 void *p_org = p_stream->p_headers;
622 p_stream->i_headers += p_oggpacket->bytes;
623 p_stream->p_headers = realloc( p_stream->p_headers, p_stream->i_headers );
624 if( p_stream->p_headers )
626 memcpy( (unsigned char *)p_stream->p_headers + p_stream->i_headers - p_oggpacket->bytes,
627 p_oggpacket->packet, p_stream->i_headers );
631 p_stream->i_headers = 0;
632 p_stream->p_headers = NULL;
636 else if( xiph_AppendHeaders( &p_stream->i_headers, &p_stream->p_headers,
637 p_oggpacket->bytes, p_oggpacket->packet ) )
639 p_stream->i_headers = 0;
640 p_stream->p_headers = NULL;
642 if( p_stream->i_headers > 0 )
644 if( !p_stream->b_force_backup )
646 /* Last header received, commit changes */
647 free( p_stream->fmt.p_extra );
649 p_stream->fmt.i_extra = p_stream->i_headers;
650 p_stream->fmt.p_extra = malloc( p_stream->i_headers );
651 if( p_stream->fmt.p_extra )
652 memcpy( p_stream->fmt.p_extra, p_stream->p_headers,
653 p_stream->i_headers );
655 p_stream->fmt.i_extra = 0;
657 if( Ogg_LogicalStreamResetEsFormat( p_demux, p_stream ) )
658 es_out_Control( p_demux->out, ES_OUT_SET_ES_FMT,
659 p_stream->p_es, &p_stream->fmt );
661 if( p_stream->i_headers > 0 )
662 Ogg_ExtractMeta( p_demux, p_stream->fmt.i_codec,
663 p_stream->p_headers, p_stream->i_headers );
665 /* we're not at BOS anymore for this logical stream */
670 b_selected = false; /* Discard the header packet */
673 /* Convert the pcr into a pts */
674 if( p_stream->fmt.i_codec == VLC_CODEC_VORBIS ||
675 p_stream->fmt.i_codec == VLC_CODEC_SPEEX ||
676 p_stream->fmt.i_codec == VLC_CODEC_FLAC )
678 if( p_stream->i_pcr >= 0 )
680 /* This is for streams where the granulepos of the header packets
681 * doesn't match these of the data packets (eg. ogg web radios). */
682 if( p_stream->i_previous_pcr == 0 &&
683 p_stream->i_pcr > 3 * DEFAULT_PTS_DELAY )
685 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
687 /* Call the pace control */
688 es_out_Control( p_demux->out, ES_OUT_SET_PCR,
689 VLC_TS_0 + p_stream->i_pcr );
692 p_stream->i_previous_pcr = p_stream->i_pcr;
694 /* The granulepos is the end date of the sample */
695 i_pts = p_stream->i_pcr;
699 /* Convert the granulepos into the next pcr */
700 i_interpolated_pts = p_stream->i_interpolated_pcr;
701 Ogg_UpdatePCR( p_stream, p_oggpacket );
703 /* SPU streams are typically discontinuous, do not mind large gaps */
704 if( p_stream->fmt.i_cat != SPU_ES )
706 if( p_stream->i_pcr >= 0 )
708 /* This is for streams where the granulepos of the header packets
709 * doesn't match these of the data packets (eg. ogg web radios). */
710 if( p_stream->i_previous_pcr == 0 &&
711 p_stream->i_pcr > 3 * DEFAULT_PTS_DELAY )
713 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
715 /* Call the pace control */
716 es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_stream->i_pcr );
721 if( p_stream->fmt.i_codec != VLC_CODEC_VORBIS &&
722 p_stream->fmt.i_codec != VLC_CODEC_SPEEX &&
723 p_stream->fmt.i_codec != VLC_CODEC_FLAC &&
724 p_stream->i_pcr >= 0 )
726 p_stream->i_previous_pcr = p_stream->i_pcr;
728 /* The granulepos is the start date of the sample */
729 i_pts = p_stream->i_pcr;
734 /* This stream isn't currently selected so we don't need to decode it,
735 * but we did need to store its pcr as it might be selected later on */
739 if( p_oggpacket->bytes <= 0 )
742 if( !( p_block = block_New( p_demux, p_oggpacket->bytes ) ) ) return;
745 /* may need to preroll video frames after a seek */
746 if ( p_stream->i_skip_frames > 0 )
748 p_block->i_flags |= BLOCK_FLAG_PREROLL;
749 p_stream->i_skip_frames--;
754 if( i_pts == 0 ) i_pts = VLC_TS_0;
755 else if( i_pts == -1 && i_interpolated_pts == 0 ) i_pts = VLC_TS_0;
756 else if( i_pts == -1 ) i_pts = VLC_TS_INVALID;
758 if( p_stream->fmt.i_cat == AUDIO_ES )
759 p_block->i_dts = p_block->i_pts = i_pts;
760 else if( p_stream->fmt.i_cat == SPU_ES )
762 p_block->i_dts = p_block->i_pts = i_pts;
763 p_block->i_length = 0;
765 else if( p_stream->fmt.i_codec == VLC_CODEC_THEORA )
767 p_block->i_dts = p_block->i_pts = i_pts;
768 if( (p_oggpacket->granulepos & ((1<<p_stream->i_granule_shift)-1)) == 0 )
770 p_block->i_flags |= BLOCK_FLAG_TYPE_I;
773 else if( p_stream->fmt.i_codec == VLC_CODEC_DIRAC )
775 ogg_int64_t dts = p_oggpacket->granulepos >> 31;
776 ogg_int64_t delay = (p_oggpacket->granulepos >> 9) & 0x1fff;
778 uint64_t u_pnum = dts + delay;
780 p_block->i_dts = p_stream->i_pcr;
781 p_block->i_pts = VLC_TS_INVALID;
782 /* NB, OggDirac granulepos values are in units of 2*picturerate */
784 /* granulepos for dirac is possibly broken, this value should be ignored */
785 if( -1 != p_oggpacket->granulepos )
786 p_block->i_pts = u_pnum * INT64_C(1000000) / p_stream->f_rate / 2;
790 p_block->i_dts = i_pts;
791 p_block->i_pts = VLC_TS_INVALID;
794 if( p_stream->fmt.i_codec != VLC_CODEC_VORBIS &&
795 p_stream->fmt.i_codec != VLC_CODEC_SPEEX &&
796 p_stream->fmt.i_codec != VLC_CODEC_FLAC &&
797 p_stream->fmt.i_codec != VLC_CODEC_TARKIN &&
798 p_stream->fmt.i_codec != VLC_CODEC_THEORA &&
799 p_stream->fmt.i_codec != VLC_CODEC_CMML &&
800 p_stream->fmt.i_codec != VLC_CODEC_DIRAC &&
801 p_stream->fmt.i_codec != VLC_CODEC_KATE )
803 /* We remove the header from the packet */
804 i_header_len = (*p_oggpacket->packet & PACKET_LEN_BITS01) >> 6;
805 i_header_len |= (*p_oggpacket->packet & PACKET_LEN_BITS2) << 1;
807 if( p_stream->fmt.i_codec == VLC_CODEC_SUBT)
809 /* But with subtitles we need to retrieve the duration first */
812 if( i_header_len > 0 && p_oggpacket->bytes >= i_header_len + 1 )
814 for( i = 0, lenbytes = 0; i < i_header_len; i++ )
816 lenbytes = lenbytes << 8;
817 lenbytes += *(p_oggpacket->packet + i_header_len - i);
820 if( p_oggpacket->bytes - 1 - i_header_len > 2 ||
821 ( p_oggpacket->packet[i_header_len + 1] != ' ' &&
822 p_oggpacket->packet[i_header_len + 1] != 0 &&
823 p_oggpacket->packet[i_header_len + 1] != '\n' &&
824 p_oggpacket->packet[i_header_len + 1] != '\r' ) )
826 p_block->i_length = (mtime_t)lenbytes * 1000;
831 if( p_block->i_buffer >= (unsigned int)i_header_len )
832 p_block->i_buffer -= i_header_len;
834 p_block->i_buffer = 0;
837 if( p_stream->fmt.i_codec == VLC_CODEC_TARKIN )
839 /* FIXME: the biggest hack I've ever done */
840 msg_Warn( p_demux, "tarkin pts: %"PRId64", granule: %"PRId64,
841 p_block->i_pts, p_block->i_dts );
845 memcpy( p_block->p_buffer, p_oggpacket->packet + i_header_len,
846 p_oggpacket->bytes - i_header_len );
848 es_out_Send( p_demux->out, p_stream->p_es, p_block );
851 /****************************************************************************
852 * Ogg_FindLogicalStreams: Find the logical streams embedded in the physical
853 * stream and fill p_ogg.
854 *****************************************************************************
855 * The initial page of a logical stream is marked as a 'bos' page.
856 * Furthermore, the Ogg specification mandates that grouped bitstreams begin
857 * together and all of the initial pages must appear before any data pages.
859 * On success this function returns VLC_SUCCESS.
860 ****************************************************************************/
861 static int Ogg_FindLogicalStreams( demux_t *p_demux )
863 demux_sys_t *p_ogg = p_demux->p_sys ;
864 ogg_packet oggpacket;
867 p_ogg->i_total_length = stream_Size ( p_demux->s );
868 msg_Dbg( p_demux, "File length is %"PRId64" bytes", p_ogg->i_total_length );
871 while( Ogg_ReadPage( p_demux, &p_ogg->current_page ) == VLC_SUCCESS )
874 if( ogg_page_bos( &p_ogg->current_page ) )
877 /* All is wonderful in our fine fine little world.
878 * We found the beginning of our first logical stream. */
879 while( ogg_page_bos( &p_ogg->current_page ) )
881 logical_stream_t *p_stream;
883 p_stream = malloc( sizeof(logical_stream_t) );
887 TAB_APPEND( p_ogg->i_streams, p_ogg->pp_stream, p_stream );
889 memset( p_stream, 0, sizeof(logical_stream_t) );
890 p_stream->p_headers = 0;
891 p_stream->i_secondary_header_packets = 0;
893 p_stream->i_keyframe_offset = 0;
894 p_stream->i_skip_frames = 0;
896 p_stream->i_data_start = 0;
898 es_format_Init( &p_stream->fmt, 0, 0 );
899 es_format_Init( &p_stream->fmt_old, 0, 0 );
901 /* Setup the logical stream */
902 p_stream->i_serial_no = ogg_page_serialno( &p_ogg->current_page );
903 ogg_stream_init( &p_stream->os, p_stream->i_serial_no );
905 /* Extract the initial header from the first page and verify
906 * the codec type of this Ogg bitstream */
907 if( ogg_stream_pagein( &p_stream->os, &p_ogg->current_page ) < 0 )
909 /* error. stream version mismatch perhaps */
910 msg_Err( p_demux, "error reading first page of "
911 "Ogg bitstream data" );
915 /* FIXME: check return value */
916 ogg_stream_packetpeek( &p_stream->os, &oggpacket );
918 /* Check for Vorbis header */
919 if( oggpacket.bytes >= 7 &&
920 ! memcmp( oggpacket.packet, "\x01vorbis", 7 ) )
922 Ogg_ReadVorbisHeader( p_stream, &oggpacket );
923 msg_Dbg( p_demux, "found vorbis header" );
925 /* Check for Speex header */
926 else if( oggpacket.bytes >= 5 &&
927 ! memcmp( oggpacket.packet, "Speex", 5 ) )
929 Ogg_ReadSpeexHeader( p_stream, &oggpacket );
930 msg_Dbg( p_demux, "found speex header, channels: %i, "
931 "rate: %i, bitrate: %i",
932 p_stream->fmt.audio.i_channels,
933 (int)p_stream->f_rate, p_stream->fmt.i_bitrate );
935 /* Check for Flac header (< version 1.1.1) */
936 else if( oggpacket.bytes >= 4 &&
937 ! memcmp( oggpacket.packet, "fLaC", 4 ) )
939 msg_Dbg( p_demux, "found FLAC header" );
941 /* Grrrr!!!! Did they really have to put all the
942 * important info in the second header packet!!!
943 * (STREAMINFO metadata is in the following packet) */
944 p_stream->b_force_backup = 1;
946 p_stream->fmt.i_cat = AUDIO_ES;
947 p_stream->fmt.i_codec = VLC_CODEC_FLAC;
949 /* Check for Flac header (>= version 1.1.1) */
950 else if( oggpacket.bytes >= 13 && oggpacket.packet[0] ==0x7F &&
951 ! memcmp( &oggpacket.packet[1], "FLAC", 4 ) &&
952 ! memcmp( &oggpacket.packet[9], "fLaC", 4 ) )
954 int i_packets = ((int)oggpacket.packet[7]) << 8 |
956 msg_Dbg( p_demux, "found FLAC header version %i.%i "
957 "(%i header packets)",
958 oggpacket.packet[5], oggpacket.packet[6],
961 p_stream->b_force_backup = 1;
963 p_stream->fmt.i_cat = AUDIO_ES;
964 p_stream->fmt.i_codec = VLC_CODEC_FLAC;
965 oggpacket.packet += 13; oggpacket.bytes -= 13;
966 Ogg_ReadFlacHeader( p_demux, p_stream, &oggpacket );
968 /* Check for Theora header */
969 else if( oggpacket.bytes >= 7 &&
970 ! memcmp( oggpacket.packet, "\x80theora", 7 ) )
972 Ogg_ReadTheoraHeader( p_stream, &oggpacket );
975 "found theora header, bitrate: %i, rate: %f",
976 p_stream->fmt.i_bitrate, p_stream->f_rate );
978 /* Check for Dirac header */
979 else if( ( oggpacket.bytes >= 5 &&
980 ! memcmp( oggpacket.packet, "BBCD\x00", 5 ) ) ||
981 ( oggpacket.bytes >= 9 &&
982 ! memcmp( oggpacket.packet, "KW-DIRAC\x00", 9 ) ) )
984 if( Ogg_ReadDiracHeader( p_stream, &oggpacket ) )
985 msg_Dbg( p_demux, "found dirac header" );
988 msg_Warn( p_demux, "found dirac header isn't decodable" );
993 /* Check for Tarkin header */
994 else if( oggpacket.bytes >= 7 &&
995 ! memcmp( &oggpacket.packet[1], "tarkin", 6 ) )
999 msg_Dbg( p_demux, "found tarkin header" );
1000 p_stream->fmt.i_cat = VIDEO_ES;
1001 p_stream->fmt.i_codec = VLC_CODEC_TARKIN;
1003 /* Cheat and get additionnal info ;) */
1004 oggpack_readinit( &opb, oggpacket.packet, oggpacket.bytes);
1005 oggpack_adv( &opb, 88 );
1006 oggpack_adv( &opb, 104 );
1007 p_stream->fmt.i_bitrate = oggpack_read( &opb, 32 );
1008 p_stream->f_rate = 2; /* FIXME */
1010 "found tarkin header, bitrate: %i, rate: %f",
1011 p_stream->fmt.i_bitrate, p_stream->f_rate );
1013 /* Check for Annodex header */
1014 else if( oggpacket.bytes >= 7 &&
1015 ! memcmp( oggpacket.packet, "Annodex", 7 ) )
1017 Ogg_ReadAnnodexHeader( VLC_OBJECT(p_demux), p_stream,
1019 /* kill annodex track */
1023 /* Check for Annodex header */
1024 else if( oggpacket.bytes >= 7 &&
1025 ! memcmp( oggpacket.packet, "AnxData", 7 ) )
1027 Ogg_ReadAnnodexHeader( VLC_OBJECT(p_demux), p_stream,
1030 /* Check for Kate header */
1031 else if( oggpacket.bytes >= 8 &&
1032 ! memcmp( &oggpacket.packet[1], "kate\0\0\0", 7 ) )
1034 Ogg_ReadKateHeader( p_stream, &oggpacket );
1035 msg_Dbg( p_demux, "found kate header" );
1037 else if( oggpacket.bytes >= 142 &&
1038 !memcmp( &oggpacket.packet[1],
1039 "Direct Show Samples embedded in Ogg", 35 ))
1041 /* Old header type */
1043 /* Check for video header (old format) */
1044 if( GetDWLE((oggpacket.packet+96)) == 0x05589f80 &&
1045 oggpacket.bytes >= 184 )
1047 p_stream->fmt.i_cat = VIDEO_ES;
1048 p_stream->fmt.i_codec =
1049 VLC_FOURCC( oggpacket.packet[68],
1050 oggpacket.packet[69],
1051 oggpacket.packet[70],
1052 oggpacket.packet[71] );
1053 msg_Dbg( p_demux, "found video header of type: %.4s",
1054 (char *)&p_stream->fmt.i_codec );
1056 p_stream->fmt.video.i_frame_rate = 10000000;
1057 p_stream->fmt.video.i_frame_rate_base =
1058 GetQWLE((oggpacket.packet+164));
1059 p_stream->f_rate = 10000000.0 /
1060 GetQWLE((oggpacket.packet+164));
1061 p_stream->fmt.video.i_bits_per_pixel =
1062 GetWLE((oggpacket.packet+182));
1063 if( !p_stream->fmt.video.i_bits_per_pixel )
1065 p_stream->fmt.video.i_bits_per_pixel = 24;
1066 p_stream->fmt.video.i_width =
1067 GetDWLE((oggpacket.packet+176));
1068 p_stream->fmt.video.i_height =
1069 GetDWLE((oggpacket.packet+180));
1072 "fps: %f, width:%i; height:%i, bitcount:%i",
1074 p_stream->fmt.video.i_width,
1075 p_stream->fmt.video.i_height,
1076 p_stream->fmt.video.i_bits_per_pixel);
1079 /* Check for audio header (old format) */
1080 else if( GetDWLE((oggpacket.packet+96)) == 0x05589F81 )
1083 unsigned int i_format_tag;
1085 p_stream->fmt.i_cat = AUDIO_ES;
1087 i_extra_size = GetWLE((oggpacket.packet+140));
1088 if( i_extra_size > 0 && i_extra_size < oggpacket.bytes - 142 )
1090 p_stream->fmt.i_extra = i_extra_size;
1091 p_stream->fmt.p_extra = malloc( i_extra_size );
1092 if( p_stream->fmt.p_extra )
1093 memcpy( p_stream->fmt.p_extra,
1094 oggpacket.packet + 142, i_extra_size );
1096 p_stream->fmt.i_extra = 0;
1099 i_format_tag = GetWLE((oggpacket.packet+124));
1100 p_stream->fmt.audio.i_channels =
1101 GetWLE((oggpacket.packet+126));
1102 p_stream->f_rate = p_stream->fmt.audio.i_rate =
1103 GetDWLE((oggpacket.packet+128));
1104 p_stream->fmt.i_bitrate =
1105 GetDWLE((oggpacket.packet+132)) * 8;
1106 p_stream->fmt.audio.i_blockalign =
1107 GetWLE((oggpacket.packet+136));
1108 p_stream->fmt.audio.i_bitspersample =
1109 GetWLE((oggpacket.packet+138));
1111 wf_tag_to_fourcc( i_format_tag,
1112 &p_stream->fmt.i_codec, 0 );
1114 if( p_stream->fmt.i_codec ==
1115 VLC_FOURCC('u','n','d','f') )
1117 p_stream->fmt.i_codec = VLC_FOURCC( 'm', 's',
1118 ( i_format_tag >> 8 ) & 0xff,
1119 i_format_tag & 0xff );
1122 msg_Dbg( p_demux, "found audio header of type: %.4s",
1123 (char *)&p_stream->fmt.i_codec );
1124 msg_Dbg( p_demux, "audio:0x%4.4x channels:%d %dHz "
1125 "%dbits/sample %dkb/s",
1127 p_stream->fmt.audio.i_channels,
1128 p_stream->fmt.audio.i_rate,
1129 p_stream->fmt.audio.i_bitspersample,
1130 p_stream->fmt.i_bitrate / 1024 );
1135 msg_Dbg( p_demux, "stream %d has an old header "
1136 "but is of an unknown type", p_ogg->i_streams-1 );
1141 else if( (*oggpacket.packet & PACKET_TYPE_BITS ) == PACKET_TYPE_HEADER &&
1142 oggpacket.bytes >= 56+1 )
1144 stream_header_t tmp;
1145 stream_header_t *st = &tmp;
1147 memcpy( st->streamtype, &oggpacket.packet[1+0], 8 );
1148 memcpy( st->subtype, &oggpacket.packet[1+8], 4 );
1149 st->size = GetDWLE( &oggpacket.packet[1+12] );
1150 st->time_unit = GetQWLE( &oggpacket.packet[1+16] );
1151 st->samples_per_unit = GetQWLE( &oggpacket.packet[1+24] );
1152 st->default_len = GetDWLE( &oggpacket.packet[1+32] );
1153 st->buffersize = GetDWLE( &oggpacket.packet[1+36] );
1154 st->bits_per_sample = GetWLE( &oggpacket.packet[1+40] ); // (padding 2)
1156 /* Check for video header (new format) */
1157 if( !strncmp( st->streamtype, "video", 5 ) )
1159 st->sh.video.width = GetDWLE( &oggpacket.packet[1+44] );
1160 st->sh.video.height = GetDWLE( &oggpacket.packet[1+48] );
1162 p_stream->fmt.i_cat = VIDEO_ES;
1164 /* We need to get rid of the header packet */
1165 ogg_stream_packetout( &p_stream->os, &oggpacket );
1167 p_stream->fmt.i_codec =
1168 VLC_FOURCC( st->subtype[0], st->subtype[1],
1169 st->subtype[2], st->subtype[3] );
1170 msg_Dbg( p_demux, "found video header of type: %.4s",
1171 (char *)&p_stream->fmt.i_codec );
1173 p_stream->fmt.video.i_frame_rate = 10000000;
1174 p_stream->fmt.video.i_frame_rate_base = st->time_unit;
1175 if( st->time_unit <= 0 )
1176 st->time_unit = 400000;
1177 p_stream->f_rate = 10000000.0 / st->time_unit;
1178 p_stream->fmt.video.i_bits_per_pixel = st->bits_per_sample;
1179 p_stream->fmt.video.i_width = st->sh.video.width;
1180 p_stream->fmt.video.i_height = st->sh.video.height;
1183 "fps: %f, width:%i; height:%i, bitcount:%i",
1185 p_stream->fmt.video.i_width,
1186 p_stream->fmt.video.i_height,
1187 p_stream->fmt.video.i_bits_per_pixel );
1189 /* Check for audio header (new format) */
1190 else if( !strncmp( st->streamtype, "audio", 5 ) )
1196 st->sh.audio.channels = GetWLE( &oggpacket.packet[1+44] );
1197 st->sh.audio.blockalign = GetWLE( &oggpacket.packet[1+48] );
1198 st->sh.audio.avgbytespersec = GetDWLE( &oggpacket.packet[1+52] );
1200 p_stream->fmt.i_cat = AUDIO_ES;
1202 /* We need to get rid of the header packet */
1203 ogg_stream_packetout( &p_stream->os, &oggpacket );
1205 i_extra_size = st->size - 56;
1207 if( i_extra_size > 0 &&
1208 i_extra_size < oggpacket.bytes - 1 - 56 )
1210 p_stream->fmt.i_extra = i_extra_size;
1211 p_stream->fmt.p_extra = malloc( p_stream->fmt.i_extra );
1212 if( p_stream->fmt.p_extra )
1213 memcpy( p_stream->fmt.p_extra, st + 1,
1214 p_stream->fmt.i_extra );
1216 p_stream->fmt.i_extra = 0;
1219 memcpy( p_buffer, st->subtype, 4 );
1221 i_format_tag = strtol(p_buffer,NULL,16);
1222 p_stream->fmt.audio.i_channels = st->sh.audio.channels;
1223 if( st->time_unit <= 0 )
1224 st->time_unit = 10000000;
1225 p_stream->f_rate = p_stream->fmt.audio.i_rate = st->samples_per_unit * 10000000 / st->time_unit;
1226 p_stream->fmt.i_bitrate = st->sh.audio.avgbytespersec * 8;
1227 p_stream->fmt.audio.i_blockalign = st->sh.audio.blockalign;
1228 p_stream->fmt.audio.i_bitspersample = st->bits_per_sample;
1230 wf_tag_to_fourcc( i_format_tag,
1231 &p_stream->fmt.i_codec, 0 );
1233 if( p_stream->fmt.i_codec ==
1234 VLC_FOURCC('u','n','d','f') )
1236 p_stream->fmt.i_codec = VLC_FOURCC( 'm', 's',
1237 ( i_format_tag >> 8 ) & 0xff,
1238 i_format_tag & 0xff );
1241 msg_Dbg( p_demux, "found audio header of type: %.4s",
1242 (char *)&p_stream->fmt.i_codec );
1243 msg_Dbg( p_demux, "audio:0x%4.4x channels:%d %dHz "
1244 "%dbits/sample %dkb/s",
1246 p_stream->fmt.audio.i_channels,
1247 p_stream->fmt.audio.i_rate,
1248 p_stream->fmt.audio.i_bitspersample,
1249 p_stream->fmt.i_bitrate / 1024 );
1251 /* Check for text (subtitles) header */
1252 else if( !strncmp(st->streamtype, "text", 4) )
1254 /* We need to get rid of the header packet */
1255 ogg_stream_packetout( &p_stream->os, &oggpacket );
1257 msg_Dbg( p_demux, "found text subtitles header" );
1258 p_stream->fmt.i_cat = SPU_ES;
1259 p_stream->fmt.i_codec = VLC_CODEC_SUBT;
1260 p_stream->f_rate = 1000; /* granulepos is in millisec */
1264 msg_Dbg( p_demux, "stream %d has a header marker "
1265 "but is of an unknown type", p_ogg->i_streams-1 );
1270 else if( oggpacket.bytes >= 7 &&
1271 ! memcmp( oggpacket.packet, "fishead", 7 ) )
1275 msg_Dbg( p_demux, "stream %d is a skeleton",
1276 p_ogg->i_streams-1 );
1277 /* FIXME: https://trac.videolan.org/vlc/ticket/1412 */
1281 msg_Dbg( p_demux, "stream %d is of unknown type",
1282 p_ogg->i_streams-1 );
1287 if( Ogg_ReadPage( p_demux, &p_ogg->current_page ) != VLC_SUCCESS )
1288 return VLC_EGENERIC;
1291 /* we'll need to get all headers for all of those streams
1292 that we have to backup headers for */
1294 for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1296 if( p_ogg->pp_stream[i_stream]->b_force_backup )
1301 /* This is the first data page, which means we are now finished
1302 * with the initial pages. We just need to store it in the relevant
1304 for( i_stream = 0; i_stream < p_ogg->i_streams; i_stream++ )
1306 if( ogg_stream_pagein( &p_ogg->pp_stream[i_stream]->os,
1307 &p_ogg->current_page ) == 0 )
1309 p_ogg->b_page_waiting = true;
1318 return VLC_EGENERIC;
1321 /****************************************************************************
1322 * Ogg_BeginningOfStream: Look for Beginning of Stream ogg pages and add
1323 * Elementary streams.
1324 ****************************************************************************/
1325 static int Ogg_BeginningOfStream( demux_t *p_demux )
1327 demux_sys_t *p_ogg = p_demux->p_sys ;
1328 logical_stream_t *p_old_stream = p_ogg->p_old_stream;
1331 /* Find the logical streams embedded in the physical stream and
1332 * initialize our p_ogg structure. */
1333 if( Ogg_FindLogicalStreams( p_demux ) != VLC_SUCCESS )
1335 msg_Warn( p_demux, "couldn't find any ogg logical stream" );
1336 return VLC_EGENERIC;
1339 p_ogg->i_bitrate = 0;
1341 for( i_stream = 0 ; i_stream < p_ogg->i_streams; i_stream++ )
1343 logical_stream_t *p_stream = p_ogg->pp_stream[i_stream];
1345 p_stream->p_es = NULL;
1347 /* initialise kframe index */
1350 /* Try first to reuse an old ES */
1352 p_old_stream->fmt.i_cat == p_stream->fmt.i_cat &&
1353 p_old_stream->fmt.i_codec == p_stream->fmt.i_codec )
1355 msg_Dbg( p_demux, "will reuse old stream to avoid glitch" );
1357 p_stream->p_es = p_old_stream->p_es;
1358 es_format_Copy( &p_stream->fmt_old, &p_old_stream->fmt );
1360 p_old_stream->p_es = NULL;
1361 p_old_stream = NULL;
1364 if( !p_stream->p_es )
1366 /* Better be safe than sorry when possible with ogm */
1367 if( p_stream->fmt.i_codec == VLC_CODEC_MPGA ||
1368 p_stream->fmt.i_codec == VLC_CODEC_A52 )
1369 p_stream->fmt.b_packetized = false;
1371 p_stream->p_es = es_out_Add( p_demux->out, &p_stream->fmt );
1374 // TODO: something to do here ?
1375 if( p_stream->fmt.i_codec == VLC_CODEC_CMML )
1377 /* Set the CMML stream active */
1378 es_out_Control( p_demux->out, ES_OUT_SET_ES, p_stream->p_es );
1381 p_ogg->i_bitrate += p_stream->fmt.i_bitrate;
1383 p_stream->i_pcr = p_stream->i_previous_pcr =
1384 p_stream->i_interpolated_pcr = -1;
1385 p_stream->b_reinit = false;
1388 if( p_ogg->p_old_stream )
1390 if( p_ogg->p_old_stream->p_es )
1391 msg_Dbg( p_demux, "old stream not reused" );
1392 Ogg_LogicalStreamDelete( p_demux, p_ogg->p_old_stream );
1393 p_ogg->p_old_stream = NULL;
1397 /* get total frame count for video stream; we will need this for seeking */
1398 p_ogg->i_total_frames = 0;
1403 /****************************************************************************
1404 * Ogg_EndOfStream: clean up the ES when an End of Stream is detected.
1405 ****************************************************************************/
1406 static void Ogg_EndOfStream( demux_t *p_demux )
1408 demux_sys_t *p_ogg = p_demux->p_sys ;
1411 for( i_stream = 0 ; i_stream < p_ogg->i_streams; i_stream++ )
1412 Ogg_LogicalStreamDelete( p_demux, p_ogg->pp_stream[i_stream] );
1413 free( p_ogg->pp_stream );
1416 p_ogg->i_bitrate = 0;
1417 p_ogg->i_streams = 0;
1418 p_ogg->pp_stream = NULL;
1422 vlc_meta_Delete( p_ogg->p_meta );
1423 p_ogg->p_meta = NULL;
1427 * This function delete and release all data associated to a logical_stream_t
1429 static void Ogg_LogicalStreamDelete( demux_t *p_demux, logical_stream_t *p_stream )
1431 if( p_stream->p_es )
1432 es_out_Del( p_demux->out, p_stream->p_es );
1434 ogg_stream_clear( &p_stream->os );
1435 free( p_stream->p_headers );
1437 es_format_Clean( &p_stream->fmt_old );
1438 es_format_Clean( &p_stream->fmt );
1440 if ( p_stream->idx != NULL)
1442 oggseek_index_entries_free( p_stream->idx );
1448 * This function check if a we need to reset a decoder in case we are
1451 static bool Ogg_IsVorbisFormatCompatible( const es_format_t *p_new, const es_format_t *p_old )
1453 unsigned pi_new_size[XIPH_MAX_HEADER_COUNT];
1454 void *pp_new_data[XIPH_MAX_HEADER_COUNT];
1455 unsigned i_new_count;
1456 if( xiph_SplitHeaders(pi_new_size, pp_new_data, &i_new_count, p_new->i_extra, p_new->p_extra ) )
1459 unsigned pi_old_size[XIPH_MAX_HEADER_COUNT];
1460 void *pp_old_data[XIPH_MAX_HEADER_COUNT];
1461 unsigned i_old_count;
1462 if( xiph_SplitHeaders(pi_old_size, pp_old_data, &i_old_count, p_old->i_extra, p_old->p_extra ) )
1465 bool b_match = i_new_count == i_old_count;
1466 for( unsigned i = 0; i < i_new_count && b_match; i++ )
1468 /* Ignore vorbis comment */
1471 if( pi_new_size[i] != pi_old_size[i] ||
1472 memcmp( pp_new_data[i], pp_old_data[i], pi_new_size[i] ) )
1476 for( unsigned i = 0; i < i_new_count; i++ )
1477 free( pp_new_data[i] );
1478 for( unsigned i = 0; i < i_old_count; i++ )
1479 free( pp_old_data[i] );
1482 static bool Ogg_LogicalStreamResetEsFormat( demux_t *p_demux, logical_stream_t *p_stream )
1484 bool b_compatible = false;
1485 if( !p_stream->fmt_old.i_cat || !p_stream->fmt_old.i_codec )
1488 /* Only vorbis is supported */
1489 if( p_stream->fmt.i_codec == VLC_CODEC_VORBIS )
1490 b_compatible = Ogg_IsVorbisFormatCompatible( &p_stream->fmt, &p_stream->fmt_old );
1493 msg_Warn( p_demux, "cannot reuse old stream, resetting the decoder" );
1495 return !b_compatible;
1497 static void Ogg_ExtractXiphMeta( demux_t *p_demux, const void *p_headers, unsigned i_headers, unsigned i_skip )
1499 demux_sys_t *p_ogg = p_demux->p_sys;
1501 unsigned pi_size[XIPH_MAX_HEADER_COUNT];
1502 void *pp_data[XIPH_MAX_HEADER_COUNT];
1504 if( xiph_SplitHeaders( pi_size, pp_data, &i_count, i_headers, p_headers ) )
1507 /* TODO how to handle multiple comments properly ? */
1508 if( i_count >= 2 && pi_size[1] > i_skip )
1509 vorbis_ParseComment( &p_ogg->p_meta, (uint8_t*)pp_data[1] + i_skip, pi_size[1] - i_skip );
1511 for( unsigned i = 0; i < i_count; i++ )
1514 static void Ogg_ExtractMeta( demux_t *p_demux, vlc_fourcc_t i_codec, const uint8_t *p_headers, int i_headers )
1516 demux_sys_t *p_ogg = p_demux->p_sys;
1520 /* 3 headers with the 2° one being the comments */
1521 case VLC_CODEC_VORBIS:
1522 Ogg_ExtractXiphMeta( p_demux, p_headers, i_headers, 1+6 );
1524 case VLC_CODEC_THEORA:
1525 Ogg_ExtractXiphMeta( p_demux, p_headers, i_headers, 1+6 );
1527 case VLC_CODEC_SPEEX:
1528 Ogg_ExtractXiphMeta( p_demux, p_headers, i_headers, 0 );
1531 /* N headers with the 2° one being the comments */
1532 case VLC_CODEC_KATE:
1533 /* 1 byte for header type, 7 bytes for magic, 1 reserved zero byte */
1534 Ogg_ExtractXiphMeta( p_demux, p_headers, i_headers, 1+7+1 );
1538 case VLC_CODEC_FLAC:
1539 msg_Warn( p_demux, "Ogg_ExtractMeta does not support %4.4s", (const char*)&i_codec );
1543 case VLC_CODEC_CMML: /* CMML is XML text, doesn't have Vorbis comments */
1544 case VLC_CODEC_DIRAC:
1549 p_demux->info.i_update |= INPUT_UPDATE_META;
1552 static void Ogg_ReadTheoraHeader( logical_stream_t *p_stream,
1553 ogg_packet *p_oggpacket )
1556 int i_fps_numerator;
1557 int i_fps_denominator;
1558 int i_keyframe_frequency_force;
1564 p_stream->fmt.i_cat = VIDEO_ES;
1565 p_stream->fmt.i_codec = VLC_CODEC_THEORA;
1567 /* Signal that we want to keep a backup of the theora
1568 * stream headers. They will be used when switching between
1570 p_stream->b_force_backup = 1;
1572 /* Cheat and get additionnal info ;) */
1573 bs_init( &bitstream, p_oggpacket->packet, p_oggpacket->bytes );
1574 bs_skip( &bitstream, 56 );
1576 i_major = bs_read( &bitstream, 8 ); /* major version num */
1577 i_minor = bs_read( &bitstream, 8 ); /* minor version num */
1578 i_subminor = bs_read( &bitstream, 8 ); /* subminor version num */
1580 bs_read( &bitstream, 16 ) /*<< 4*/; /* width */
1581 bs_read( &bitstream, 16 ) /*<< 4*/; /* height */
1582 bs_read( &bitstream, 24 ); /* frame width */
1583 bs_read( &bitstream, 24 ); /* frame height */
1584 bs_read( &bitstream, 8 ); /* x offset */
1585 bs_read( &bitstream, 8 ); /* y offset */
1587 i_fps_numerator = bs_read( &bitstream, 32 );
1588 i_fps_denominator = bs_read( &bitstream, 32 );
1589 bs_read( &bitstream, 24 ); /* aspect_numerator */
1590 bs_read( &bitstream, 24 ); /* aspect_denominator */
1592 p_stream->fmt.video.i_frame_rate = i_fps_numerator;
1593 p_stream->fmt.video.i_frame_rate_base = i_fps_denominator;
1595 bs_read( &bitstream, 8 ); /* colorspace */
1596 p_stream->fmt.i_bitrate = bs_read( &bitstream, 24 );
1597 bs_read( &bitstream, 6 ); /* quality */
1599 i_keyframe_frequency_force = 1 << bs_read( &bitstream, 5 );
1601 /* granule_shift = i_log( frequency_force -1 ) */
1602 p_stream->i_granule_shift = 0;
1603 i_keyframe_frequency_force--;
1604 while( i_keyframe_frequency_force )
1606 p_stream->i_granule_shift++;
1607 i_keyframe_frequency_force >>= 1;
1610 i_version = i_major * 1000000 + i_minor * 1000 + i_subminor;
1611 p_stream->i_keyframe_offset = 0;
1613 if ( i_version >= 3002001 )
1615 p_stream->i_keyframe_offset = 1;
1618 p_stream->f_rate = ((float)i_fps_numerator) / i_fps_denominator;
1621 static void Ogg_ReadVorbisHeader( logical_stream_t *p_stream,
1622 ogg_packet *p_oggpacket )
1626 p_stream->fmt.i_cat = AUDIO_ES;
1627 p_stream->fmt.i_codec = VLC_CODEC_VORBIS;
1629 /* Signal that we want to keep a backup of the vorbis
1630 * stream headers. They will be used when switching between
1632 p_stream->b_force_backup = 1;
1634 /* Cheat and get additionnal info ;) */
1635 oggpack_readinit( &opb, p_oggpacket->packet, p_oggpacket->bytes);
1636 oggpack_adv( &opb, 88 );
1637 p_stream->fmt.audio.i_channels = oggpack_read( &opb, 8 );
1638 p_stream->f_rate = p_stream->fmt.audio.i_rate =
1639 oggpack_read( &opb, 32 );
1640 oggpack_adv( &opb, 32 );
1641 p_stream->fmt.i_bitrate = oggpack_read( &opb, 32 );
1644 static void Ogg_ReadSpeexHeader( logical_stream_t *p_stream,
1645 ogg_packet *p_oggpacket )
1649 p_stream->fmt.i_cat = AUDIO_ES;
1650 p_stream->fmt.i_codec = VLC_CODEC_SPEEX;
1652 /* Signal that we want to keep a backup of the speex
1653 * stream headers. They will be used when switching between
1655 p_stream->b_force_backup = 1;
1657 /* Cheat and get additionnal info ;) */
1658 oggpack_readinit( &opb, p_oggpacket->packet, p_oggpacket->bytes);
1659 oggpack_adv( &opb, 224 );
1660 oggpack_adv( &opb, 32 ); /* speex_version_id */
1661 oggpack_adv( &opb, 32 ); /* header_size */
1662 p_stream->f_rate = p_stream->fmt.audio.i_rate = oggpack_read( &opb, 32 );
1663 oggpack_adv( &opb, 32 ); /* mode */
1664 oggpack_adv( &opb, 32 ); /* mode_bitstream_version */
1665 p_stream->fmt.audio.i_channels = oggpack_read( &opb, 32 );
1666 p_stream->fmt.i_bitrate = oggpack_read( &opb, 32 );
1669 static void Ogg_ReadFlacHeader( demux_t *p_demux, logical_stream_t *p_stream,
1670 ogg_packet *p_oggpacket )
1672 /* Parse the STREAMINFO metadata */
1675 bs_init( &s, p_oggpacket->packet, p_oggpacket->bytes );
1678 if( bs_read( &s, 7 ) == 0 )
1680 if( bs_read( &s, 24 ) >= 34 /*size STREAMINFO*/ )
1683 p_stream->f_rate = p_stream->fmt.audio.i_rate = bs_read( &s, 20 );
1684 p_stream->fmt.audio.i_channels = bs_read( &s, 3 ) + 1;
1686 msg_Dbg( p_demux, "FLAC header, channels: %i, rate: %i",
1687 p_stream->fmt.audio.i_channels, (int)p_stream->f_rate );
1691 msg_Dbg( p_demux, "FLAC STREAMINFO metadata too short" );
1694 /* Fake this as the last metadata block */
1695 *((uint8_t*)p_oggpacket->packet) |= 0x80;
1699 /* This ain't a STREAMINFO metadata */
1700 msg_Dbg( p_demux, "Invalid FLAC STREAMINFO metadata" );
1704 static void Ogg_ReadKateHeader( logical_stream_t *p_stream,
1705 ogg_packet *p_oggpacket )
1713 p_stream->fmt.i_cat = SPU_ES;
1714 p_stream->fmt.i_codec = VLC_CODEC_KATE;
1716 /* Signal that we want to keep a backup of the kate
1717 * stream headers. They will be used when switching between
1719 p_stream->b_force_backup = 1;
1721 /* Cheat and get additionnal info ;) */
1722 oggpack_readinit( &opb, p_oggpacket->packet, p_oggpacket->bytes);
1723 oggpack_adv( &opb, 11*8 ); /* packet type, kate magic, version */
1724 p_stream->i_kate_num_headers = oggpack_read( &opb, 8 );
1725 oggpack_adv( &opb, 3*8 );
1726 p_stream->i_granule_shift = oggpack_read( &opb, 8 );
1727 oggpack_adv( &opb, 8*8 ); /* reserved */
1728 gnum = oggpack_read( &opb, 32 );
1729 gden = oggpack_read( &opb, 32 );
1730 p_stream->f_rate = (double)gnum/gden;
1732 p_stream->fmt.psz_language = malloc(16);
1733 if( p_stream->fmt.psz_language )
1735 for( n = 0; n < 16; n++ )
1736 p_stream->fmt.psz_language[n] = oggpack_read(&opb,8);
1737 p_stream->fmt.psz_language[15] = 0; /* just in case */
1741 for( n = 0; n < 16; n++ )
1742 oggpack_read(&opb,8);
1744 p_stream->fmt.psz_description = malloc(16);
1745 if( p_stream->fmt.psz_description )
1747 for( n = 0; n < 16; n++ )
1748 p_stream->fmt.psz_description[n] = oggpack_read(&opb,8);
1749 p_stream->fmt.psz_description[15] = 0; /* just in case */
1751 /* Now find a localized user readable description for this category */
1752 psz_desc = strdup(FindKateCategoryName(p_stream->fmt.psz_description));
1755 free( p_stream->fmt.psz_description );
1756 p_stream->fmt.psz_description = psz_desc;
1761 for( n = 0; n < 16; n++ )
1762 oggpack_read(&opb,8);
1766 static void Ogg_ReadAnnodexHeader( vlc_object_t *p_this,
1767 logical_stream_t *p_stream,
1768 ogg_packet *p_oggpacket )
1770 if( p_oggpacket->bytes >= 28 &&
1771 !memcmp( p_oggpacket->packet, "Annodex", 7 ) )
1775 uint16_t major_version;
1776 uint16_t minor_version;
1777 uint64_t timebase_numerator;
1778 uint64_t timebase_denominator;
1780 Ogg_ReadTheoraHeader( p_stream, p_oggpacket );
1782 oggpack_readinit( &opb, p_oggpacket->packet, p_oggpacket->bytes);
1783 oggpack_adv( &opb, 8*8 ); /* "Annodex\0" header */
1784 major_version = oggpack_read( &opb, 2*8 ); /* major version */
1785 minor_version = oggpack_read( &opb, 2*8 ); /* minor version */
1786 timebase_numerator = GetQWLE( &p_oggpacket->packet[16] );
1787 timebase_denominator = GetQWLE( &p_oggpacket->packet[24] );
1789 else if( p_oggpacket->bytes >= 42 &&
1790 !memcmp( p_oggpacket->packet, "AnxData", 7 ) )
1792 uint64_t granule_rate_numerator;
1793 uint64_t granule_rate_denominator;
1794 char content_type_string[1024];
1796 /* Read in Annodex header fields */
1798 granule_rate_numerator = GetQWLE( &p_oggpacket->packet[8] );
1799 granule_rate_denominator = GetQWLE( &p_oggpacket->packet[16] );
1800 p_stream->i_secondary_header_packets =
1801 GetDWLE( &p_oggpacket->packet[24] );
1803 /* we are guaranteed that the first header field will be
1804 * the content-type (by the Annodex standard) */
1805 content_type_string[0] = '\0';
1806 if( !strncasecmp( (char*)(&p_oggpacket->packet[28]), "Content-Type: ", 14 ) )
1808 uint8_t *p = memchr( &p_oggpacket->packet[42], '\r',
1809 p_oggpacket->bytes - 1 );
1810 if( p && p[0] == '\r' && p[1] == '\n' )
1811 sscanf( (char*)(&p_oggpacket->packet[42]), "%1023s\r\n",
1812 content_type_string );
1815 msg_Dbg( p_this, "AnxData packet info: %"PRId64" / %"PRId64", %d, ``%s''",
1816 granule_rate_numerator, granule_rate_denominator,
1817 p_stream->i_secondary_header_packets, content_type_string );
1819 p_stream->f_rate = (float) granule_rate_numerator /
1820 (float) granule_rate_denominator;
1822 /* What type of file do we have?
1823 * strcmp is safe to use here because we've extracted
1824 * content_type_string from the stream manually */
1825 if( !strncmp(content_type_string, "audio/x-wav", 11) )
1827 /* n.b. WAVs are unsupported right now */
1828 p_stream->fmt.i_cat = UNKNOWN_ES;
1830 else if( !strncmp(content_type_string, "audio/x-vorbis", 14) )
1832 p_stream->fmt.i_cat = AUDIO_ES;
1833 p_stream->fmt.i_codec = VLC_CODEC_VORBIS;
1835 p_stream->b_force_backup = 1;
1837 else if( !strncmp(content_type_string, "audio/x-speex", 14) )
1839 p_stream->fmt.i_cat = AUDIO_ES;
1840 p_stream->fmt.i_codec = VLC_CODEC_SPEEX;
1842 p_stream->b_force_backup = 1;
1844 else if( !strncmp(content_type_string, "video/x-theora", 14) )
1846 p_stream->fmt.i_cat = VIDEO_ES;
1847 p_stream->fmt.i_codec = VLC_CODEC_THEORA;
1849 p_stream->b_force_backup = 1;
1851 else if( !strncmp(content_type_string, "video/x-xvid", 14) )
1853 p_stream->fmt.i_cat = VIDEO_ES;
1854 p_stream->fmt.i_codec = VLC_FOURCC( 'x','v','i','d' );
1856 p_stream->b_force_backup = 1;
1858 else if( !strncmp(content_type_string, "video/mpeg", 14) )
1860 /* n.b. MPEG streams are unsupported right now */
1861 p_stream->fmt.i_cat = VIDEO_ES;
1862 p_stream->fmt.i_codec = VLC_CODEC_MPGV;
1864 else if( !strncmp(content_type_string, "text/x-cmml", 11) )
1866 ogg_stream_packetout( &p_stream->os, p_oggpacket );
1867 p_stream->fmt.i_cat = SPU_ES;
1868 p_stream->fmt.i_codec = VLC_CODEC_CMML;
1873 static uint32_t dirac_uint( bs_t *p_bs )
1875 uint32_t u_count = 0, u_value = 0;
1877 while( !bs_eof( p_bs ) && !bs_read( p_bs, 1 ) )
1881 u_value |= bs_read( p_bs, 1 );
1884 return (1<<u_count) - 1 + u_value;
1887 static int dirac_bool( bs_t *p_bs )
1889 return bs_read( p_bs, 1 );
1892 static bool Ogg_ReadDiracHeader( logical_stream_t *p_stream,
1893 ogg_packet *p_oggpacket )
1895 static const struct {
1896 uint32_t u_n /* numerator */, u_d /* denominator */;
1897 } p_dirac_frate_tbl[] = { /* table 10.3 */
1898 {1,1}, /* this first value is never used */
1899 {24000,1001}, {24,1}, {25,1}, {30000,1001}, {30,1},
1900 {50,1}, {60000,1001}, {60,1}, {15000,1001}, {25,2},
1902 static const size_t u_dirac_frate_tbl = sizeof(p_dirac_frate_tbl)/sizeof(*p_dirac_frate_tbl);
1904 static const uint32_t pu_dirac_vidfmt_frate[] = { /* table C.1 */
1905 1, 9, 10, 9, 10, 9, 10, 4, 3, 7, 6, 4, 3, 7, 6, 2, 2, 7, 6, 7, 6,
1907 static const size_t u_dirac_vidfmt_frate = sizeof(pu_dirac_vidfmt_frate)/sizeof(*pu_dirac_vidfmt_frate);
1911 p_stream->i_granule_shift = 22; /* not 32 */
1913 /* Backing up stream headers is not required -- seqhdrs are repeated
1914 * thoughout the stream at suitable decoding start points */
1915 p_stream->b_force_backup = 0;
1917 /* read in useful bits from sequence header */
1918 bs_init( &bs, p_oggpacket->packet, p_oggpacket->bytes );
1919 bs_skip( &bs, 13*8); /* parse_info_header */
1920 dirac_uint( &bs ); /* major_version */
1921 dirac_uint( &bs ); /* minor_version */
1922 dirac_uint( &bs ); /* profile */
1923 dirac_uint( &bs ); /* level */
1925 uint32_t u_video_format = dirac_uint( &bs ); /* index */
1926 if( u_video_format >= u_dirac_vidfmt_frate )
1928 /* don't know how to parse this ogg dirac stream */
1932 if( dirac_bool( &bs ) )
1934 dirac_uint( &bs ); /* frame_width */
1935 dirac_uint( &bs ); /* frame_height */
1938 if( dirac_bool( &bs ) )
1940 dirac_uint( &bs ); /* chroma_format */
1943 if( dirac_bool( &bs ) )
1945 dirac_uint( &bs ); /* scan_format */
1948 uint32_t u_n = p_dirac_frate_tbl[pu_dirac_vidfmt_frate[u_video_format]].u_n;
1949 uint32_t u_d = p_dirac_frate_tbl[pu_dirac_vidfmt_frate[u_video_format]].u_d;
1950 if( dirac_bool( &bs ) )
1952 uint32_t u_frame_rate_index = dirac_uint( &bs );
1953 if( u_frame_rate_index >= u_dirac_frate_tbl )
1955 /* something is wrong with this stream */
1958 u_n = p_dirac_frate_tbl[u_frame_rate_index].u_n;
1959 u_d = p_dirac_frate_tbl[u_frame_rate_index].u_d;
1960 if( u_frame_rate_index == 0 )
1962 u_n = dirac_uint( &bs ); /* frame_rate_numerator */
1963 u_d = dirac_uint( &bs ); /* frame_rate_denominator */
1966 p_stream->f_rate = (float) u_n / u_d;
1968 /* probably is an ogg dirac es */
1969 p_stream->fmt.i_cat = VIDEO_ES;
1970 p_stream->fmt.i_codec = VLC_CODEC_DIRAC;