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