]> git.sesse.net Git - vlc/blob - modules/mux/ogg.c
Use var_InheritString for --decklink-video-connection.
[vlc] / modules / mux / ogg.c
1 /*****************************************************************************
2  * ogg.c: ogg muxer module for vlc
3  *****************************************************************************
4  * Copyright (C) 2001, 2002, 2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Gildas Bazin <gbazin@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_sout.h>
36 #include <vlc_block.h>
37 #include <vlc_codecs.h>
38 #include <limits.h>
39 #include <vlc_rand.h>
40 #include "../demux/xiph.h"
41
42 #include <ogg/ogg.h>
43
44 /*****************************************************************************
45  * Module descriptor
46  *****************************************************************************/
47 static int  Open   ( vlc_object_t * );
48 static void Close  ( vlc_object_t * );
49
50 vlc_module_begin ()
51     set_description( N_("Ogg/OGM muxer") )
52     set_capability( "sout mux", 10 )
53     set_category( CAT_SOUT )
54     set_subcategory( SUBCAT_SOUT_MUX )
55     add_shortcut( "ogg", "ogm" )
56     set_callbacks( Open, Close )
57 vlc_module_end ()
58
59
60 /*****************************************************************************
61  * Exported prototypes
62  *****************************************************************************/
63 static int Control  ( sout_mux_t *, int, va_list );
64 static int AddStream( sout_mux_t *, sout_input_t * );
65 static int DelStream( sout_mux_t *, sout_input_t * );
66 static int Mux      ( sout_mux_t * );
67 static int MuxBlock ( sout_mux_t *, sout_input_t * );
68
69 static block_t *OggCreateHeader( sout_mux_t * );
70 static block_t *OggCreateFooter( sout_mux_t * );
71
72 /*****************************************************************************
73  * Misc declarations
74  *****************************************************************************/
75
76 /* Structures used for OggDS headers used in ogm files */
77
78 #define PACKET_TYPE_HEADER   0x01
79 #define PACKET_TYPE_COMMENT  0x03
80 #define PACKET_IS_SYNCPOINT  0x08
81
82 typedef struct
83 #ifdef HAVE_ATTRIBUTE_PACKED
84     __attribute__((__packed__))
85 #endif
86 {
87     int32_t i_width;
88     int32_t i_height;
89 } oggds_header_video_t;
90
91 typedef struct
92 #ifdef HAVE_ATTRIBUTE_PACKED
93     __attribute__((__packed__))
94 #endif
95 {
96     int16_t i_channels;
97     int16_t i_block_align;
98     int32_t i_avgbytespersec;
99 } oggds_header_audio_t;
100
101 typedef struct
102 #ifdef HAVE_ATTRIBUTE_PACKED
103     __attribute__((__packed__))
104 #endif
105 {
106     uint8_t i_packet_type;
107
108     char stream_type[8];
109     char sub_type[4];
110
111     int32_t i_size;
112
113     int64_t i_time_unit;
114     int64_t i_samples_per_unit;
115     int32_t i_default_len;
116
117     int32_t i_buffer_size;
118     int16_t i_bits_per_sample;
119
120     int16_t i_padding_0; /* Because the original is using MSVC packing style */
121
122     union
123     {
124         oggds_header_video_t video;
125         oggds_header_audio_t audio;
126     } header;
127
128     int32_t i_padding_1; /* Because the original is using MSVC packing style */
129
130 } oggds_header_t;
131
132 /*****************************************************************************
133  * Definitions of structures and functions used by this plugins
134  *****************************************************************************/
135 typedef struct
136 {
137     int i_cat;
138     int i_fourcc;
139
140     int b_new;
141
142     mtime_t i_dts;
143     mtime_t i_length;
144     int     i_packet_no;
145     int     i_serial_no;
146     int     i_keyframe_granule_shift; /* Theora only */
147     int     i_last_keyframe; /* dirac and theora */
148     int     i_num_frames; /* Theora only */
149     uint64_t u_last_granulepos; /* Used for correct EOS page */
150     int64_t i_num_keyframes;
151     ogg_stream_state os;
152
153     oggds_header_t *p_oggds_header;
154
155 } ogg_stream_t;
156
157 struct sout_mux_sys_t
158 {
159     int     i_streams;
160
161     mtime_t i_start_dts;
162     int     i_next_serial_no;
163
164     /* number of logical streams pending to be added */
165     int i_add_streams;
166
167     /* logical streams pending to be deleted */
168     int i_del_streams;
169     ogg_stream_t **pp_del_streams;
170 };
171
172 static void OggSetDate( block_t *, mtime_t , mtime_t  );
173 static block_t *OggStreamFlush( sout_mux_t *, ogg_stream_state *, mtime_t );
174
175 /*****************************************************************************
176  * Open: Open muxer
177  *****************************************************************************/
178 static int Open( vlc_object_t *p_this )
179 {
180     sout_mux_t      *p_mux = (sout_mux_t*)p_this;
181     sout_mux_sys_t  *p_sys;
182
183     msg_Info( p_mux, "Open" );
184
185     p_sys                 = malloc( sizeof( sout_mux_sys_t ) );
186     if( !p_sys )
187         return VLC_ENOMEM;
188     p_sys->i_streams      = 0;
189     p_sys->i_add_streams  = 0;
190     p_sys->i_del_streams  = 0;
191     p_sys->pp_del_streams = 0;
192
193     p_mux->p_sys        = p_sys;
194     p_mux->pf_control   = Control;
195     p_mux->pf_addstream = AddStream;
196     p_mux->pf_delstream = DelStream;
197     p_mux->pf_mux       = Mux;
198
199     /* First serial number is random.
200      * (Done like this because on win32 you need to seed the random number
201      *  generator once per thread). */
202     uint32_t r;
203     vlc_rand_bytes(&r, sizeof(r));
204     p_sys->i_next_serial_no = r & INT_MAX;
205
206     return VLC_SUCCESS;
207 }
208
209 /*****************************************************************************
210  * Close: Finalize ogg bitstream and close muxer
211  *****************************************************************************/
212 static void Close( vlc_object_t * p_this )
213 {
214     sout_mux_t     *p_mux = (sout_mux_t*)p_this;
215     sout_mux_sys_t *p_sys = p_mux->p_sys;
216
217     msg_Info( p_mux, "Close" );
218
219     if( p_sys->i_del_streams )
220     {
221         block_t *p_og = NULL;
222         mtime_t i_dts = p_sys->pp_del_streams[p_sys->i_del_streams - 1]->i_dts;
223
224         /* Close the current ogg stream */
225         msg_Dbg( p_mux, "writing footer" );
226         block_ChainAppend( &p_og, OggCreateFooter( p_mux ) );
227
228         /* Remove deleted logical streams */
229         for(int i = 0; i < p_sys->i_del_streams; i++ )
230         {
231             ogg_stream_clear( &p_sys->pp_del_streams[i]->os );
232             FREENULL( p_sys->pp_del_streams[i]->p_oggds_header );
233             FREENULL( p_sys->pp_del_streams[i] );
234         }
235         FREENULL( p_sys->pp_del_streams );
236         p_sys->i_streams -= p_sys->i_del_streams;
237
238         /* Write footer */
239         OggSetDate( p_og, i_dts, 0 );
240         sout_AccessOutWrite( p_mux->p_access, p_og );
241     }
242
243     free( p_sys );
244 }
245
246 /*****************************************************************************
247  * Control:
248  *****************************************************************************/
249 static int Control( sout_mux_t *p_mux, int i_query, va_list args )
250 {
251     VLC_UNUSED(p_mux);
252     bool *pb_bool;
253     char **ppsz;
254
255    switch( i_query )
256    {
257        case MUX_CAN_ADD_STREAM_WHILE_MUXING:
258            pb_bool = (bool*)va_arg( args, bool * );
259            *pb_bool = true;
260            return VLC_SUCCESS;
261
262        case MUX_GET_ADD_STREAM_WAIT:
263            pb_bool = (bool*)va_arg( args, bool * );
264            *pb_bool = true;
265            return VLC_SUCCESS;
266
267        case MUX_GET_MIME:
268            ppsz = (char**)va_arg( args, char ** );
269            *ppsz = strdup( "application/ogg" );
270            return VLC_SUCCESS;
271
272         default:
273             return VLC_EGENERIC;
274    }
275 }
276 /*****************************************************************************
277  * AddStream: Add an elementary stream to the muxed stream
278  *****************************************************************************/
279 static int AddStream( sout_mux_t *p_mux, sout_input_t *p_input )
280 {
281     sout_mux_sys_t *p_sys = p_mux->p_sys;
282     ogg_stream_t   *p_stream;
283     uint16_t i_tag;
284
285     msg_Dbg( p_mux, "adding input" );
286
287     p_input->p_sys = p_stream = calloc( 1, sizeof( ogg_stream_t ) );
288     if( !p_stream )
289         return VLC_ENOMEM;
290
291     p_stream->i_cat       = p_input->p_fmt->i_cat;
292     p_stream->i_fourcc    = p_input->p_fmt->i_codec;
293     p_stream->i_serial_no = p_sys->i_next_serial_no++;
294     p_stream->i_packet_no = 0;
295     p_stream->i_last_keyframe = 0;
296     p_stream->i_num_keyframes = 0;
297     p_stream->i_num_frames = 0;
298
299     p_stream->p_oggds_header = 0;
300
301     switch( p_input->p_fmt->i_cat )
302     {
303     case VIDEO_ES:
304         if( !p_input->p_fmt->video.i_frame_rate ||
305             !p_input->p_fmt->video.i_frame_rate_base )
306         {
307             msg_Warn( p_mux, "Missing frame rate, assuming 25fps" );
308             p_input->p_fmt->video.i_frame_rate = 25;
309             p_input->p_fmt->video.i_frame_rate_base = 1;
310         }
311
312         switch( p_stream->i_fourcc )
313         {
314         case VLC_CODEC_MP4V:
315         case VLC_CODEC_MPGV:
316         case VLC_CODEC_DIV3:
317         case VLC_CODEC_MJPG:
318         case VLC_CODEC_WMV1:
319         case VLC_CODEC_WMV2:
320         case VLC_CODEC_WMV3:
321         case VLC_CODEC_SNOW:
322             p_stream->p_oggds_header = calloc( 1, sizeof(oggds_header_t) );
323             if( !p_stream->p_oggds_header )
324             {
325                 free( p_stream );
326                 return VLC_ENOMEM;
327             }
328             p_stream->p_oggds_header->i_packet_type = PACKET_TYPE_HEADER;
329
330             memcpy( p_stream->p_oggds_header->stream_type, "video", 5 );
331             if( p_stream->i_fourcc == VLC_CODEC_MP4V )
332             {
333                 memcpy( p_stream->p_oggds_header->sub_type, "XVID", 4 );
334             }
335             else if( p_stream->i_fourcc == VLC_CODEC_DIV3 )
336             {
337                 memcpy( p_stream->p_oggds_header->sub_type, "DIV3", 4 );
338             }
339             else
340             {
341                 memcpy( p_stream->p_oggds_header->sub_type,
342                         &p_stream->i_fourcc, 4 );
343             }
344             SetDWLE( &p_stream->p_oggds_header->i_size,
345                      sizeof( oggds_header_t ) - 1 );
346             SetQWLE( &p_stream->p_oggds_header->i_time_unit,
347                      INT64_C(10000000) * p_input->p_fmt->video.i_frame_rate_base /
348                      (int64_t)p_input->p_fmt->video.i_frame_rate );
349             SetQWLE( &p_stream->p_oggds_header->i_samples_per_unit, 1 );
350             SetDWLE( &p_stream->p_oggds_header->i_default_len, 1 ); /* ??? */
351             SetDWLE( &p_stream->p_oggds_header->i_buffer_size, 1024*1024 );
352             SetWLE( &p_stream->p_oggds_header->i_bits_per_sample, 0 );
353             SetDWLE( &p_stream->p_oggds_header->header.video.i_width,
354                      p_input->p_fmt->video.i_width );
355             SetDWLE( &p_stream->p_oggds_header->header.video.i_height,
356                      p_input->p_fmt->video.i_height );
357             msg_Dbg( p_mux, "%4.4s stream", (char *)&p_stream->i_fourcc );
358             break;
359
360         case VLC_CODEC_DIRAC:
361             msg_Dbg( p_mux, "dirac stream" );
362             break;
363
364         case VLC_CODEC_THEORA:
365             msg_Dbg( p_mux, "theora stream" );
366             break;
367
368         default:
369             FREENULL( p_input->p_sys );
370             return VLC_EGENERIC;
371         }
372         break;
373
374     case AUDIO_ES:
375         switch( p_stream->i_fourcc )
376         {
377         case VLC_CODEC_VORBIS:
378             msg_Dbg( p_mux, "vorbis stream" );
379             break;
380
381         case VLC_CODEC_SPEEX:
382             msg_Dbg( p_mux, "speex stream" );
383             break;
384
385         case VLC_CODEC_FLAC:
386             msg_Dbg( p_mux, "flac stream" );
387             break;
388
389         default:
390             fourcc_to_wf_tag( p_stream->i_fourcc, &i_tag );
391             if( i_tag == WAVE_FORMAT_UNKNOWN )
392             {
393                 FREENULL( p_input->p_sys );
394                 return VLC_EGENERIC;
395             }
396
397             p_stream->p_oggds_header =
398                 malloc( sizeof(oggds_header_t) + p_input->p_fmt->i_extra );
399             if( !p_stream->p_oggds_header )
400             {
401                 free( p_stream );
402                 return VLC_ENOMEM;
403             }
404             memset( p_stream->p_oggds_header, 0, sizeof(oggds_header_t) );
405             p_stream->p_oggds_header->i_packet_type = PACKET_TYPE_HEADER;
406
407             SetDWLE( &p_stream->p_oggds_header->i_size,
408                      sizeof( oggds_header_t ) - 1 + p_input->p_fmt->i_extra );
409
410             if( p_input->p_fmt->i_extra )
411             {
412                 memcpy( &p_stream->p_oggds_header[1],
413                         p_input->p_fmt->p_extra, p_input->p_fmt->i_extra );
414             }
415
416             memcpy( p_stream->p_oggds_header->stream_type, "audio", 5 );
417
418             memset( p_stream->p_oggds_header->sub_type, 0, 4 );
419             sprintf( p_stream->p_oggds_header->sub_type, "%-x", i_tag );
420
421             SetQWLE( &p_stream->p_oggds_header->i_time_unit, INT64_C(10000000) );
422             SetDWLE( &p_stream->p_oggds_header->i_default_len, 1 );
423             SetDWLE( &p_stream->p_oggds_header->i_buffer_size, 30*1024 );
424             SetQWLE( &p_stream->p_oggds_header->i_samples_per_unit,
425                      p_input->p_fmt->audio.i_rate );
426             SetWLE( &p_stream->p_oggds_header->i_bits_per_sample,
427                     p_input->p_fmt->audio.i_bitspersample );
428             SetDWLE( &p_stream->p_oggds_header->header.audio.i_channels,
429                      p_input->p_fmt->audio.i_channels );
430             SetDWLE( &p_stream->p_oggds_header->header.audio.i_block_align,
431                      p_input->p_fmt->audio.i_blockalign );
432             SetDWLE( &p_stream->p_oggds_header->header.audio.i_avgbytespersec,
433                      p_input->p_fmt->i_bitrate / 8);
434             msg_Dbg( p_mux, "%4.4s stream", (char *)&p_stream->i_fourcc );
435             break;
436         }
437         break;
438
439     case SPU_ES:
440         switch( p_stream->i_fourcc )
441         {
442         case VLC_CODEC_SUBT:
443             p_stream->p_oggds_header = calloc( 1, sizeof(oggds_header_t) );
444             if( !p_stream->p_oggds_header )
445             {
446                 free( p_stream );
447                 return VLC_ENOMEM;
448             }
449             p_stream->p_oggds_header->i_packet_type = PACKET_TYPE_HEADER;
450
451             memcpy( p_stream->p_oggds_header->stream_type, "text", 4 );
452             msg_Dbg( p_mux, "subtitles stream" );
453             break;
454
455         default:
456             FREENULL( p_input->p_sys );
457             return VLC_EGENERIC;
458         }
459         break;
460     default:
461         FREENULL( p_input->p_sys );
462         return VLC_EGENERIC;
463     }
464
465     p_stream->b_new = true;
466
467     p_sys->i_add_streams++;
468
469     return VLC_SUCCESS;
470 }
471
472 /*****************************************************************************
473  * DelStream: Delete an elementary stream from the muxed stream
474  *****************************************************************************/
475 static int DelStream( sout_mux_t *p_mux, sout_input_t *p_input )
476 {
477     sout_mux_sys_t *p_sys  = p_mux->p_sys;
478     ogg_stream_t   *p_stream = (ogg_stream_t*)p_input->p_sys;
479     block_t *p_og;
480
481     msg_Dbg( p_mux, "removing input" );
482
483     /* flush all remaining data */
484     if( p_input->p_sys )
485     {
486         if( !p_stream->b_new )
487         {
488             while( block_FifoCount( p_input->p_fifo ) )
489                 MuxBlock( p_mux, p_input );
490         }
491
492         if( !p_stream->b_new &&
493             ( p_og = OggStreamFlush( p_mux, &p_stream->os, 0 ) ) )
494         {
495             OggSetDate( p_og, p_stream->i_dts, p_stream->i_length );
496             sout_AccessOutWrite( p_mux->p_access, p_og );
497         }
498
499         /* move input in delete queue */
500         if( !p_stream->b_new )
501         {
502             p_sys->pp_del_streams = xrealloc( p_sys->pp_del_streams,
503                         (p_sys->i_del_streams + 1) * sizeof(ogg_stream_t *) );
504             p_sys->pp_del_streams[p_sys->i_del_streams++] = p_stream;
505         }
506         else
507         {
508             /* wasn't already added so get rid of it */
509             FREENULL( p_stream->p_oggds_header );
510             FREENULL( p_stream );
511             p_sys->i_add_streams--;
512         }
513     }
514
515     p_input->p_sys = NULL;
516
517     return 0;
518 }
519
520 /*****************************************************************************
521  * Ogg bitstream manipulation routines
522  *****************************************************************************/
523 static block_t *OggStreamGetPage( sout_mux_t *p_mux,
524                                   ogg_stream_state *p_os, mtime_t i_pts,
525                                   bool flush )
526 {
527     (void)p_mux;
528     block_t *p_og, *p_og_first = NULL;
529     ogg_page og;
530     int (*pager)( ogg_stream_state*, ogg_page* ) = flush ? ogg_stream_flush : ogg_stream_pageout;
531
532     while( pager( p_os, &og ) )
533     {
534         /* Flush all data */
535         p_og = block_New( p_mux, og.header_len + og.body_len );
536
537         memcpy( p_og->p_buffer, og.header, og.header_len );
538         memcpy( p_og->p_buffer + og.header_len, og.body, og.body_len );
539         p_og->i_dts     = 0;
540         p_og->i_pts     = i_pts;
541         p_og->i_length  = 0;
542
543         i_pts = 0; // write it only once
544
545         block_ChainAppend( &p_og_first, p_og );
546     }
547
548     return p_og_first;
549 }
550
551 static block_t *OggStreamFlush( sout_mux_t *p_mux,
552                                 ogg_stream_state *p_os, mtime_t i_pts )
553 {
554     return OggStreamGetPage( p_mux, p_os, i_pts, true );
555 }
556
557 static block_t *OggStreamPageOut( sout_mux_t *p_mux,
558                                   ogg_stream_state *p_os, mtime_t i_pts )
559 {
560     return OggStreamGetPage( p_mux, p_os, i_pts, false );
561 }
562
563 static block_t *OggCreateHeader( sout_mux_t *p_mux )
564 {
565     block_t *p_hdr = NULL;
566     block_t *p_og = NULL;
567     ogg_packet op;
568     int i;
569
570     /* Write header for each stream. All b_o_s (beginning of stream) packets
571      * must appear first in the ogg stream so we take care of them first. */
572     for( int pass = 0; pass < 2; pass++ )
573     {
574         for( i = 0; i < p_mux->i_nb_inputs; i++ )
575         {
576             sout_input_t *p_input = p_mux->pp_inputs[i];
577             ogg_stream_t *p_stream = (ogg_stream_t*)p_input->p_sys;
578
579             bool video = ( p_stream->i_fourcc == VLC_CODEC_THEORA || p_stream->i_fourcc == VLC_CODEC_DIRAC );
580             if( ( ( pass == 0 && !video ) || ( pass == 1 && video ) ) )
581                 continue;
582
583             msg_Dbg( p_mux, "creating header for %4.4s",
584                      (char *)&p_stream->i_fourcc );
585
586             ogg_stream_init( &p_stream->os, p_stream->i_serial_no );
587             p_stream->b_new = false;
588             p_stream->i_packet_no = 0;
589
590             if( p_stream->i_fourcc == VLC_CODEC_VORBIS ||
591                 p_stream->i_fourcc == VLC_CODEC_SPEEX ||
592                 p_stream->i_fourcc == VLC_CODEC_THEORA )
593             {
594                 /* First packet in order: vorbis/speex/theora info */
595                 unsigned pi_size[XIPH_MAX_HEADER_COUNT];
596                 void     *pp_data[XIPH_MAX_HEADER_COUNT];
597                 unsigned i_count;
598                 if( xiph_SplitHeaders( pi_size, pp_data, &i_count,
599                                        p_input->p_fmt->i_extra, p_input->p_fmt->p_extra ) )
600                 {
601                     i_count = 0;
602                     pi_size[0] = 0;
603                     pp_data[0] = NULL;
604                 }
605
606                 op.bytes  = pi_size[0];
607                 op.packet = pp_data[0];
608                 if( pi_size[0] <= 0 )
609                     msg_Err( p_mux, "header data corrupted");
610
611                 op.b_o_s  = 1;
612                 op.e_o_s  = 0;
613                 op.granulepos = 0;
614                 op.packetno = p_stream->i_packet_no++;
615                 ogg_stream_packetin( &p_stream->os, &op );
616                 p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
617
618                 /* Get keyframe_granule_shift for theora granulepos calculation */
619                 if( p_stream->i_fourcc == VLC_CODEC_THEORA )
620                 {
621                     p_stream->i_keyframe_granule_shift =
622                         ( (op.packet[40] & 0x03) << 3 ) | ( (op.packet[41] & 0xe0) >> 5 );
623                 }
624
625                 for( unsigned i = 0; i < i_count; i++ )
626                     free( pp_data[i] );
627             }
628             else if( p_stream->i_fourcc == VLC_CODEC_DIRAC )
629             {
630                 op.packet = p_input->p_fmt->p_extra;
631                 op.bytes  = p_input->p_fmt->i_extra;
632                 op.b_o_s  = 1;
633                 op.e_o_s  = 0;
634                 op.granulepos = ~0;
635                 op.packetno = p_stream->i_packet_no++;
636                 ogg_stream_packetin( &p_stream->os, &op );
637                 p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
638             }
639             else if( p_stream->i_fourcc == VLC_CODEC_FLAC )
640             {
641                 /* flac stream marker (yeah, only that in the 1st packet) */
642                 op.packet = (unsigned char *)"fLaC";
643                 op.bytes  = 4;
644                 op.b_o_s  = 1;
645                 op.e_o_s  = 0;
646                 op.granulepos = 0;
647                 op.packetno = p_stream->i_packet_no++;
648                 ogg_stream_packetin( &p_stream->os, &op );
649                 p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
650             }
651             else if( p_stream->p_oggds_header )
652             {
653                 /* ds header */
654                 op.packet = (uint8_t*)p_stream->p_oggds_header;
655                 op.bytes  = p_stream->p_oggds_header->i_size + 1;
656                 op.b_o_s  = 1;
657                 op.e_o_s  = 0;
658                 op.granulepos = 0;
659                 op.packetno = p_stream->i_packet_no++;
660                 ogg_stream_packetin( &p_stream->os, &op );
661                 p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
662             }
663
664             block_ChainAppend( &p_hdr, p_og );
665         }
666     }
667
668     /* Take care of the non b_o_s headers */
669     for( i = 0; i < p_mux->i_nb_inputs; i++ )
670     {
671         sout_input_t *p_input = p_mux->pp_inputs[i];
672         ogg_stream_t *p_stream = (ogg_stream_t*)p_input->p_sys;
673
674         if( p_stream->i_fourcc == VLC_CODEC_VORBIS ||
675             p_stream->i_fourcc == VLC_CODEC_SPEEX ||
676             p_stream->i_fourcc == VLC_CODEC_THEORA )
677         {
678             unsigned pi_size[XIPH_MAX_HEADER_COUNT];
679             void     *pp_data[XIPH_MAX_HEADER_COUNT];
680             unsigned i_count;
681             if( xiph_SplitHeaders( pi_size, pp_data, &i_count,
682                                    p_input->p_fmt->i_extra, p_input->p_fmt->p_extra ) )
683                 i_count = 0;
684
685             /* Special case, headers are already there in the incoming stream.
686              * We need to gather them an mark them as headers. */
687             for( unsigned i = 1; i < i_count; i++ )
688             {
689                 op.bytes  = pi_size[i];
690                 op.packet = pp_data[i];
691                 if( pi_size[i] <= 0 )
692                     msg_Err( p_mux, "header data corrupted");
693
694                 op.b_o_s  = 0;
695                 op.e_o_s  = 0;
696                 op.granulepos = 0;
697                 op.packetno = p_stream->i_packet_no++;
698                 ogg_stream_packetin( &p_stream->os, &op );
699
700                 if( i == i_count - 1 )
701                     p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
702                 else
703                     p_og = OggStreamPageOut( p_mux, &p_stream->os, 0 );
704                 if( p_og )
705                     block_ChainAppend( &p_hdr, p_og );
706             }
707             for( unsigned i = 0; i < i_count; i++ )
708                 free( pp_data[i] );
709         }
710         else if( p_stream->i_fourcc != VLC_CODEC_FLAC &&
711                  p_stream->i_fourcc != VLC_CODEC_DIRAC )
712         {
713             uint8_t com[128];
714             int     i_com;
715
716             /* comment */
717             com[0] = PACKET_TYPE_COMMENT;
718             i_com = snprintf( (char *)(com+1), 127,
719                               PACKAGE_VERSION" stream output" )
720                      + 1;
721             op.packet = com;
722             op.bytes  = i_com;
723             op.b_o_s  = 0;
724             op.e_o_s  = 0;
725             op.granulepos = 0;
726             op.packetno = p_stream->i_packet_no++;
727             ogg_stream_packetin( &p_stream->os, &op );
728             p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
729             block_ChainAppend( &p_hdr, p_og );
730         }
731
732         /* Special case for mp4v and flac */
733         if( ( p_stream->i_fourcc == VLC_CODEC_MP4V ||
734               p_stream->i_fourcc == VLC_CODEC_FLAC ) &&
735             p_input->p_fmt->i_extra )
736         {
737             /* Send a packet with the VOL data for mp4v
738              * or STREAMINFO for flac */
739             msg_Dbg( p_mux, "writing extra data" );
740             op.bytes  = p_input->p_fmt->i_extra;
741             op.packet = p_input->p_fmt->p_extra;
742             if( p_stream->i_fourcc == VLC_CODEC_FLAC )
743             {
744                 /* Skip the flac stream marker */
745                 op.bytes -= 4;
746                 op.packet+= 4;
747             }
748             op.b_o_s  = 0;
749             op.e_o_s  = 0;
750             op.granulepos = 0;
751             op.packetno = p_stream->i_packet_no++;
752             ogg_stream_packetin( &p_stream->os, &op );
753             p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
754             block_ChainAppend( &p_hdr, p_og );
755         }
756     }
757
758     /* set HEADER flag */
759     for( p_og = p_hdr; p_og != NULL; p_og = p_og->p_next )
760     {
761         p_og->i_flags |= BLOCK_FLAG_HEADER;
762     }
763     return p_hdr;
764 }
765
766 static block_t *OggCreateFooter( sout_mux_t *p_mux )
767 {
768     sout_mux_sys_t *p_sys = p_mux->p_sys;
769     block_t *p_hdr = NULL;
770     block_t *p_og;
771     ogg_packet    op;
772     int     i;
773
774     /* flush all remaining data */
775     for( i = 0; i < p_mux->i_nb_inputs; i++ )
776     {
777         ogg_stream_t *p_stream = p_mux->pp_inputs[i]->p_sys;
778
779         /* skip newly added streams */
780         if( p_stream->b_new ) continue;
781
782         if( ( p_og = OggStreamFlush( p_mux, &p_stream->os, 0 ) ) )
783         {
784             OggSetDate( p_og, p_stream->i_dts, p_stream->i_length );
785             sout_AccessOutWrite( p_mux->p_access, p_og );
786         }
787     }
788
789     /* Write eos packets for each stream. */
790     for( i = 0; i < p_mux->i_nb_inputs; i++ )
791     {
792         ogg_stream_t *p_stream = p_mux->pp_inputs[i]->p_sys;
793
794         /* skip newly added streams */
795         if( p_stream->b_new ) continue;
796
797         op.packet = NULL;
798         op.bytes  = 0;
799         op.b_o_s  = 0;
800         op.e_o_s  = 1;
801         op.granulepos = p_stream->u_last_granulepos;
802         op.packetno = p_stream->i_packet_no++;
803         ogg_stream_packetin( &p_stream->os, &op );
804
805         p_og = OggStreamFlush( p_mux, &p_stream->os, 0 );
806         block_ChainAppend( &p_hdr, p_og );
807         ogg_stream_clear( &p_stream->os );
808     }
809
810     for( i = 0; i < p_sys->i_del_streams; i++ )
811     {
812         op.packet = NULL;
813         op.bytes  = 0;
814         op.b_o_s  = 0;
815         op.e_o_s  = 1;
816         op.granulepos = p_sys->pp_del_streams[i]->u_last_granulepos;
817         op.packetno = p_sys->pp_del_streams[i]->i_packet_no++;
818         ogg_stream_packetin( &p_sys->pp_del_streams[i]->os, &op );
819
820         p_og = OggStreamFlush( p_mux, &p_sys->pp_del_streams[i]->os, 0 );
821         block_ChainAppend( &p_hdr, p_og );
822         ogg_stream_clear( &p_sys->pp_del_streams[i]->os );
823     }
824
825     return p_hdr;
826 }
827
828 static void OggSetDate( block_t *p_og, mtime_t i_dts, mtime_t i_length )
829 {
830     int i_count;
831     block_t *p_tmp;
832     mtime_t i_delta;
833
834     for( p_tmp = p_og, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->p_next )
835     {
836         i_count++;
837     }
838
839     if( i_count == 0 ) return; /* ignore. */
840
841     i_delta = i_length / i_count;
842
843     for( p_tmp = p_og; p_tmp != NULL; p_tmp = p_tmp->p_next )
844     {
845         p_tmp->i_dts    = i_dts;
846         p_tmp->i_length = i_delta;
847
848         i_dts += i_delta;
849     }
850 }
851
852 /*****************************************************************************
853  * Mux: multiplex available data in input fifos into the Ogg bitstream
854  *****************************************************************************/
855 static int Mux( sout_mux_t *p_mux )
856 {
857     sout_mux_sys_t *p_sys = p_mux->p_sys;
858     block_t        *p_og = NULL;
859     mtime_t        i_dts;
860
861     if( p_sys->i_add_streams || p_sys->i_del_streams )
862     {
863         /* Open new ogg stream */
864         if( sout_MuxGetStream( p_mux, 1, &i_dts) < 0 )
865         {
866             msg_Dbg( p_mux, "waiting for data..." );
867             return VLC_SUCCESS;
868         }
869
870         if( p_sys->i_streams )
871         {
872             /* Close current ogg stream */
873             int i;
874
875             msg_Dbg( p_mux, "writing footer" );
876             block_ChainAppend( &p_og, OggCreateFooter( p_mux ) );
877
878             /* Remove deleted logical streams */
879             for( i = 0; i < p_sys->i_del_streams; i++ )
880             {
881                 FREENULL( p_sys->pp_del_streams[i]->p_oggds_header );
882                 FREENULL( p_sys->pp_del_streams[i] );
883             }
884             FREENULL( p_sys->pp_del_streams );
885             p_sys->i_streams = 0;
886         }
887
888         msg_Dbg( p_mux, "writing header" );
889         p_sys->i_start_dts = i_dts;
890         p_sys->i_streams = p_mux->i_nb_inputs;
891         p_sys->i_del_streams = 0;
892         p_sys->i_add_streams = 0;
893         block_ChainAppend( &p_og, OggCreateHeader( p_mux ) );
894
895         /* Write header and/or footer */
896         OggSetDate( p_og, i_dts, 0 );
897         sout_AccessOutWrite( p_mux->p_access, p_og );
898         p_og = NULL;
899     }
900
901     for( ;; )
902     {
903         int i_stream = sout_MuxGetStream( p_mux, 1, NULL );
904         if( i_stream < 0 )
905             return VLC_SUCCESS;
906         MuxBlock( p_mux, p_mux->pp_inputs[i_stream] );
907     }
908
909     return VLC_SUCCESS;
910 }
911
912 static int MuxBlock( sout_mux_t *p_mux, sout_input_t *p_input )
913 {
914     sout_mux_sys_t *p_sys = p_mux->p_sys;
915     ogg_stream_t *p_stream = (ogg_stream_t*)p_input->p_sys;
916     block_t *p_data = block_FifoGet( p_input->p_fifo );
917     block_t *p_og = NULL;
918     ogg_packet op;
919
920     if( p_stream->i_fourcc != VLC_CODEC_VORBIS &&
921         p_stream->i_fourcc != VLC_CODEC_FLAC &&
922         p_stream->i_fourcc != VLC_CODEC_SPEEX &&
923         p_stream->i_fourcc != VLC_CODEC_THEORA &&
924         p_stream->i_fourcc != VLC_CODEC_DIRAC )
925     {
926         p_data = block_Realloc( p_data, 1, p_data->i_buffer );
927         p_data->p_buffer[0] = PACKET_IS_SYNCPOINT;      // FIXME
928     }
929
930     op.packet   = p_data->p_buffer;
931     op.bytes    = p_data->i_buffer;
932     op.b_o_s    = 0;
933     op.e_o_s    = 0;
934     op.packetno = p_stream->i_packet_no++;
935
936     if( p_stream->i_cat == AUDIO_ES )
937     {
938         if( p_stream->i_fourcc == VLC_CODEC_VORBIS ||
939             p_stream->i_fourcc == VLC_CODEC_FLAC ||
940             p_stream->i_fourcc == VLC_CODEC_SPEEX )
941         {
942             /* number of sample from begining + current packet */
943             op.granulepos =
944                 ( p_data->i_dts - p_sys->i_start_dts + p_data->i_length ) *
945                 (mtime_t)p_input->p_fmt->audio.i_rate / INT64_C(1000000);
946         }
947         else if( p_stream->p_oggds_header )
948         {
949             /* number of sample from begining */
950             op.granulepos = ( p_data->i_dts - p_sys->i_start_dts ) *
951                 p_stream->p_oggds_header->i_samples_per_unit / INT64_C(1000000);
952         }
953     }
954     else if( p_stream->i_cat == VIDEO_ES )
955     {
956         if( p_stream->i_fourcc == VLC_CODEC_THEORA )
957         {
958             p_stream->i_num_frames++;
959             if( p_data->i_flags & BLOCK_FLAG_TYPE_I )
960             {
961                 p_stream->i_num_keyframes++;
962                 p_stream->i_last_keyframe = p_stream->i_num_frames;
963             }
964
965             op.granulepos = (p_stream->i_last_keyframe << p_stream->i_keyframe_granule_shift )
966                           | (p_stream->i_num_frames-p_stream->i_last_keyframe);
967         }
968         else if( p_stream->i_fourcc == VLC_CODEC_DIRAC )
969         {
970             mtime_t dt = (p_data->i_dts - p_sys->i_start_dts + 1)
971                        * p_input->p_fmt->video.i_frame_rate *2
972                        / p_input->p_fmt->video.i_frame_rate_base
973                        / INT64_C(1000000);
974             mtime_t delay = (p_data->i_pts - p_data->i_dts + 1)
975                           * p_input->p_fmt->video.i_frame_rate *2
976                           / p_input->p_fmt->video.i_frame_rate_base
977                           / INT64_C(1000000);
978             if( p_data->i_flags & BLOCK_FLAG_TYPE_I )
979                 p_stream->i_last_keyframe = dt;
980             mtime_t dist = dt - p_stream->i_last_keyframe;
981             op.granulepos = dt << 31 | (dist&0xff00) << 14
982                           | (delay&0x1fff) << 9 | (dist&0xff);
983         }
984         else if( p_stream->p_oggds_header )
985             op.granulepos = ( p_data->i_dts - p_sys->i_start_dts ) * INT64_C(10) /
986                 p_stream->p_oggds_header->i_time_unit;
987     }
988     else if( p_stream->i_cat == SPU_ES )
989     {
990         /* granulepos is in millisec */
991         op.granulepos = ( p_data->i_dts - p_sys->i_start_dts ) / 1000;
992     }
993
994     p_stream->u_last_granulepos = op.granulepos;
995     ogg_stream_packetin( &p_stream->os, &op );
996
997     if( p_stream->i_cat == SPU_ES ||
998         p_stream->i_fourcc == VLC_CODEC_SPEEX ||
999         p_stream->i_fourcc == VLC_CODEC_DIRAC )
1000     {
1001         /* Subtitles or Speex packets are quite small so they
1002          * need to be flushed to be sent on time */
1003         /* The OggDirac mapping suggests ever so strongly that a
1004          * page flush occurs after each OggDirac packet, so to make
1005          * the timestamps unambiguous */
1006         p_og = OggStreamFlush( p_mux, &p_stream->os, p_data->i_dts );
1007     }
1008     else
1009     {
1010         p_og = OggStreamPageOut( p_mux, &p_stream->os, p_data->i_dts );
1011     }
1012
1013     if( p_og )
1014     {
1015         OggSetDate( p_og, p_stream->i_dts, p_stream->i_length );
1016         p_stream->i_dts = -1;
1017         p_stream->i_length = 0;
1018
1019         sout_AccessOutWrite( p_mux->p_access, p_og );
1020     }
1021     else
1022     {
1023         if( p_stream->i_dts < 0 )
1024         {
1025             p_stream->i_dts = p_data->i_dts;
1026         }
1027         p_stream->i_length += p_data->i_length;
1028     }
1029
1030     block_Release( p_data );
1031     return VLC_SUCCESS;
1032 }