]> git.sesse.net Git - vlc/blob - src/stream_output/stream_output.c
AccessOutWrite is called very often, especially for TS. Don't store stats on each...
[vlc] / src / stream_output / stream_output.c
1 /*****************************************************************************
2  * stream_output.c : stream output module
3  *****************************************************************************
4  * Copyright (C) 2002-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *          Laurent Aimar <fenrir@via.ecp.fr>
9  *          Eric Petit <titer@videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #include <stdlib.h>                                                /* free() */
30 #include <stdio.h>                                              /* sprintf() */
31 #include <string.h>                                            /* strerror() */
32
33 #include <vlc/vlc.h>
34 #include <vlc/sout.h>
35 #include <vlc/input.h>
36
37 #include "vlc_meta.h"
38
39 #undef DEBUG_BUFFER
40 /*****************************************************************************
41  * Local prototypes
42  *****************************************************************************/
43 static void sout_CfgDestroy( sout_cfg_t * );
44
45 #define sout_stream_url_to_chain( p, s ) \
46     _sout_stream_url_to_chain( VLC_OBJECT(p), s )
47 static char *_sout_stream_url_to_chain( vlc_object_t *, char * );
48
49 /*
50  * Generic MRL parser
51  *
52  */
53
54 typedef struct
55 {
56     char *psz_access;
57     char *psz_way;
58     char *psz_name;
59 } mrl_t;
60
61 /* mrl_Parse: parse psz_mrl and fill p_mrl */
62 static int  mrl_Parse( mrl_t *p_mrl, char *psz_mrl );
63 /* mrl_Clean: clean p_mrl  after a call to mrl_Parse */
64 static void mrl_Clean( mrl_t *p_mrl );
65
66 #define FREE( p ) if( p ) { free( p ); (p) = NULL; }
67
68 /*****************************************************************************
69  * sout_NewInstance: creates a new stream output instance
70  *****************************************************************************/
71 sout_instance_t *__sout_NewInstance( vlc_object_t *p_parent, char * psz_dest )
72 {
73     sout_instance_t *p_sout;
74     vlc_value_t keep;
75     counter_t *p_counter;
76
77     if( var_Get( p_parent, "sout-keep", &keep ) < 0 )
78     {
79         msg_Warn( p_parent, "cannot get sout-keep value" );
80         keep.b_bool = VLC_FALSE;
81     }
82     if( keep.b_bool )
83     {
84         if( ( p_sout = vlc_object_find( p_parent, VLC_OBJECT_SOUT,
85                                         FIND_ANYWHERE ) ) != NULL )
86         {
87             if( !strcmp( p_sout->psz_sout, psz_dest ) )
88             {
89                 msg_Dbg( p_parent, "sout keep : reusing sout" );
90                 msg_Dbg( p_parent, "sout keep : you probably want to use "
91                           "gather stream_out" );
92                 vlc_object_detach( p_sout );
93                 vlc_object_attach( p_sout, p_parent );
94                 vlc_object_release( p_sout );
95                 return p_sout;
96             }
97             else
98             {
99                 msg_Dbg( p_parent, "sout keep : destroying unusable sout" );
100                 vlc_object_release( p_sout );
101                 sout_DeleteInstance( p_sout );
102             }
103         }
104     }
105     else if( !keep.b_bool )
106     {
107         while( ( p_sout = vlc_object_find( p_parent, VLC_OBJECT_SOUT,
108                                            FIND_PARENT ) ) != NULL )
109         {
110             msg_Dbg( p_parent, "sout keep : destroying old sout" );
111             vlc_object_release( p_sout );
112             sout_DeleteInstance( p_sout );
113         }
114     }
115
116     /* *** Allocate descriptor *** */
117     p_sout = vlc_object_create( p_parent, VLC_OBJECT_SOUT );
118     if( p_sout == NULL )
119     {
120         msg_Err( p_parent, "out of memory" );
121         return NULL;
122     }
123
124     /* *** init descriptor *** */
125     p_sout->psz_sout    = strdup( psz_dest );
126     p_sout->p_meta      = NULL;
127     p_sout->i_out_pace_nocontrol = 0;
128     p_sout->p_sys       = NULL;
129
130     vlc_mutex_init( p_sout, &p_sout->lock );
131     if( psz_dest && psz_dest[0] == '#' )
132     {
133         p_sout->psz_chain = strdup( &psz_dest[1] );
134     }
135     else
136     {
137         p_sout->psz_chain = sout_stream_url_to_chain( p_sout, psz_dest );
138         msg_Dbg( p_sout, "using sout chain=`%s'", p_sout->psz_chain );
139     }
140     p_sout->p_stream = NULL;
141
142     /* attach it for inherit */
143     vlc_object_attach( p_sout, p_parent );
144
145     /* Create statistics */
146     stats_Create( p_parent, "sout_sent_packets",
147                   VLC_VAR_INTEGER, STATS_COUNTER );
148     stats_Create( p_parent, "sout_sent_bytes", VLC_VAR_INTEGER, STATS_COUNTER );
149     stats_Create( p_parent, "sout_send_bitrate",
150                   VLC_VAR_FLOAT, STATS_DERIVATIVE );
151     p_counter = stats_CounterGet( p_parent, p_parent->i_object_id,
152                     "sout_send_bitrate" );
153     if( p_counter) p_counter->update_interval = 1000000;
154
155     p_sout->p_stream = sout_StreamNew( p_sout, p_sout->psz_chain );
156
157     if( p_sout->p_stream == NULL )
158     {
159         msg_Err( p_sout, "stream chained failed for `%s'", p_sout->psz_chain );
160
161         FREE( p_sout->psz_sout );
162         FREE( p_sout->psz_chain );
163
164         vlc_object_detach( p_sout );
165         vlc_object_destroy( p_sout );
166         return NULL;
167     }
168
169     return p_sout;
170 }
171 /*****************************************************************************
172  * sout_DeleteInstance: delete a previously allocated instance
173  *****************************************************************************/
174 void sout_DeleteInstance( sout_instance_t * p_sout )
175 {
176     /* Unlink object */
177     vlc_object_detach( p_sout );
178
179     /* remove the stream out chain */
180     sout_StreamDelete( p_sout->p_stream );
181
182     /* *** free all string *** */
183     FREE( p_sout->psz_sout );
184     FREE( p_sout->psz_chain );
185
186     /* delete meta */
187     if( p_sout->p_meta )
188     {
189         vlc_meta_Delete( p_sout->p_meta );
190     }
191
192     vlc_mutex_destroy( &p_sout->lock );
193
194     /* *** free structure *** */
195     vlc_object_destroy( p_sout );
196 }
197
198 /*****************************************************************************
199  * Packetizer/Input
200  *****************************************************************************/
201 sout_packetizer_input_t *sout_InputNew( sout_instance_t *p_sout,
202                                         es_format_t *p_fmt )
203 {
204     sout_packetizer_input_t *p_input;
205
206     msg_Dbg( p_sout, "adding a new input" );
207
208     /* *** create a packetizer input *** */
209     p_input         = malloc( sizeof( sout_packetizer_input_t ) );
210     p_input->p_sout = p_sout;
211     p_input->p_fmt  = p_fmt;
212
213     if( p_fmt->i_codec == VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
214     {
215         vlc_object_release( p_sout );
216         return p_input;
217     }
218
219     /* *** add it to the stream chain */
220     vlc_mutex_lock( &p_sout->lock );
221     p_input->id = p_sout->p_stream->pf_add( p_sout->p_stream, p_fmt );
222     vlc_mutex_unlock( &p_sout->lock );
223
224     if( p_input->id == NULL )
225     {
226         free( p_input );
227         return NULL;
228     }
229
230     return( p_input );
231 }
232
233 /*****************************************************************************
234  *
235  *****************************************************************************/
236 int sout_InputDelete( sout_packetizer_input_t *p_input )
237 {
238     sout_instance_t     *p_sout = p_input->p_sout;
239
240     msg_Dbg( p_sout, "removing an input" );
241
242     if( p_input->p_fmt->i_codec != VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
243     {
244         vlc_mutex_lock( &p_sout->lock );
245         p_sout->p_stream->pf_del( p_sout->p_stream, p_input->id );
246         vlc_mutex_unlock( &p_sout->lock );
247     }
248
249     free( p_input );
250
251     return( VLC_SUCCESS);
252 }
253
254 /*****************************************************************************
255  *
256  *****************************************************************************/
257 int sout_InputSendBuffer( sout_packetizer_input_t *p_input,
258                           block_t *p_buffer )
259 {
260     sout_instance_t     *p_sout = p_input->p_sout;
261     int                 i_ret;
262
263     if( p_input->p_fmt->i_codec == VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
264     {
265         block_Release( p_buffer );
266         return VLC_SUCCESS;
267     }
268     if( p_buffer->i_dts <= 0 )
269     {
270         msg_Warn( p_sout, "trying to send non-dated packet to stream output!");
271         block_Release( p_buffer );
272         return VLC_SUCCESS;
273     }
274
275     vlc_mutex_lock( &p_sout->lock );
276     i_ret = p_sout->p_stream->pf_send( p_sout->p_stream,
277                                        p_input->id, p_buffer );
278     vlc_mutex_unlock( &p_sout->lock );
279
280     return i_ret;
281 }
282
283 /*****************************************************************************
284  * sout_AccessOutNew: allocate a new access out
285  *****************************************************************************/
286 sout_access_out_t *sout_AccessOutNew( sout_instance_t *p_sout,
287                                       char *psz_access, char *psz_name )
288 {
289     sout_access_out_t *p_access;
290     char              *psz_next;
291
292     if( !( p_access = vlc_object_create( p_sout,
293                                          sizeof( sout_access_out_t ) ) ) )
294     {
295         msg_Err( p_sout, "out of memory" );
296         return NULL;
297     }
298
299     psz_next = sout_CfgCreate( &p_access->psz_access, &p_access->p_cfg,
300                                 psz_access );
301     if( psz_next )
302     {
303         free( psz_next );
304     }
305     p_access->psz_name   = strdup( psz_name ? psz_name : "" );
306     p_access->p_sout     = p_sout;
307     p_access->p_sys = NULL;
308     p_access->pf_seek    = NULL;
309     p_access->pf_read    = NULL;
310     p_access->pf_write   = NULL;
311     p_access->p_module   = NULL;
312
313     p_access->i_writes = 0;
314     p_access->i_sent_bytes = 0;
315
316     vlc_object_attach( p_access, p_sout );
317
318     p_access->p_module   =
319         module_Need( p_access, "sout access", p_access->psz_access, VLC_TRUE );
320
321     if( !p_access->p_module )
322     {
323         free( p_access->psz_access );
324         free( p_access->psz_name );
325         vlc_object_detach( p_access );
326         vlc_object_destroy( p_access );
327         return( NULL );
328     }
329
330     return p_access;
331 }
332 /*****************************************************************************
333  * sout_AccessDelete: delete an access out
334  *****************************************************************************/
335 void sout_AccessOutDelete( sout_access_out_t *p_access )
336 {
337     vlc_object_detach( p_access );
338     if( p_access->p_module )
339     {
340         module_Unneed( p_access, p_access->p_module );
341     }
342     free( p_access->psz_access );
343
344     sout_CfgDestroy( p_access->p_cfg );
345
346     free( p_access->psz_name );
347
348     vlc_object_destroy( p_access );
349 }
350
351 /*****************************************************************************
352  * sout_AccessSeek:
353  *****************************************************************************/
354 int sout_AccessOutSeek( sout_access_out_t *p_access, off_t i_pos )
355 {
356     return p_access->pf_seek( p_access, i_pos );
357 }
358
359 /*****************************************************************************
360  * sout_AccessRead:
361  *****************************************************************************/
362 int sout_AccessOutRead( sout_access_out_t *p_access, block_t *p_buffer )
363 {
364     return( p_access->pf_read ?
365             p_access->pf_read( p_access, p_buffer ) : VLC_EGENERIC );
366 }
367
368 /*****************************************************************************
369  * sout_AccessWrite:
370  *****************************************************************************/
371 int sout_AccessOutWrite( sout_access_out_t *p_access, block_t *p_buffer )
372 {
373     int i_total;
374     p_access->i_writes++;
375     p_access->i_sent_bytes += p_buffer->i_buffer;
376     if( p_access->p_libvlc->b_stats && p_access->i_writes % 10 == 0 )
377     {
378         /* Access_out -> sout_instance -> input_thread_t */
379         input_thread_t *p_input =
380             (input_thread_t *)vlc_object_find( p_access, VLC_OBJECT_INPUT,
381                                                FIND_PARENT );
382         if( p_input )
383         {
384             stats_UpdateInteger( p_input, "sout_sent_packets", 10 );
385             stats_UpdateInteger( p_input, "sout_sent_bytes",
386                                  p_access->i_sent_bytes );
387             stats_GetInteger( p_input,
388                               p_access->p_parent->p_parent->i_object_id,
389                               "sout_sent_bytes", &i_total );
390             stats_UpdateFloat( p_input, "sout_send_bitrate", (float)i_total );
391
392             p_access->i_sent_bytes = 0;
393             vlc_object_release( p_input );
394         }
395     }
396     return p_access->pf_write( p_access, p_buffer );
397 }
398
399 /*****************************************************************************
400  * sout_MuxNew: create a new mux
401  *****************************************************************************/
402 sout_mux_t * sout_MuxNew( sout_instance_t *p_sout, char *psz_mux,
403                           sout_access_out_t *p_access )
404 {
405     sout_mux_t *p_mux;
406     char       *psz_next;
407
408     p_mux = vlc_object_create( p_sout, sizeof( sout_mux_t ) );
409     if( p_mux == NULL )
410     {
411         msg_Err( p_sout, "out of memory" );
412         return NULL;
413     }
414
415     p_mux->p_sout = p_sout;
416     psz_next = sout_CfgCreate( &p_mux->psz_mux, &p_mux->p_cfg, psz_mux );
417     if( psz_next ) free( psz_next );
418
419     p_mux->p_access     = p_access;
420     p_mux->pf_control   = NULL;
421     p_mux->pf_addstream = NULL;
422     p_mux->pf_delstream = NULL;
423     p_mux->pf_mux       = NULL;
424     p_mux->i_nb_inputs  = 0;
425     p_mux->pp_inputs    = NULL;
426
427     p_mux->p_sys        = NULL;
428     p_mux->p_module     = NULL;
429
430     p_mux->b_add_stream_any_time = VLC_FALSE;
431     p_mux->b_waiting_stream = VLC_TRUE;
432     p_mux->i_add_stream_start = -1;
433
434     vlc_object_attach( p_mux, p_sout );
435
436     p_mux->p_module =
437         module_Need( p_mux, "sout mux", p_mux->psz_mux, VLC_TRUE );
438
439     if( p_mux->p_module == NULL )
440     {
441         FREE( p_mux->psz_mux );
442
443         vlc_object_detach( p_mux );
444         vlc_object_destroy( p_mux );
445         return NULL;
446     }
447
448     /* *** probe mux capacity *** */
449     if( p_mux->pf_control )
450     {
451         int b_answer = VLC_FALSE;
452
453         if( sout_MuxControl( p_mux, MUX_CAN_ADD_STREAM_WHILE_MUXING,
454                              &b_answer ) )
455         {
456             b_answer = VLC_FALSE;
457         }
458
459         if( b_answer )
460         {
461             msg_Dbg( p_sout, "muxer support adding stream at any time" );
462             p_mux->b_add_stream_any_time = VLC_TRUE;
463             p_mux->b_waiting_stream = VLC_FALSE;
464
465             /* If we control the output pace then it's better to wait before
466              * starting muxing (generates better streams/files). */
467             if( !p_sout->i_out_pace_nocontrol )
468             {
469                 b_answer = VLC_TRUE;
470             }
471             else if( sout_MuxControl( p_mux, MUX_GET_ADD_STREAM_WAIT,
472                                       &b_answer ) )
473             {
474                 b_answer = VLC_FALSE;
475             }
476
477             if( b_answer )
478             {
479                 msg_Dbg( p_sout, "muxer prefers waiting for all ES before "
480                          "starting muxing" );
481                 p_mux->b_waiting_stream = VLC_TRUE;
482             }
483         }
484     }
485
486     return p_mux;
487 }
488
489 /*****************************************************************************
490  * sout_MuxDelete:
491  *****************************************************************************/
492 void sout_MuxDelete( sout_mux_t *p_mux )
493 {
494     vlc_object_detach( p_mux );
495     if( p_mux->p_module )
496     {
497         module_Unneed( p_mux, p_mux->p_module );
498     }
499     free( p_mux->psz_mux );
500
501     sout_CfgDestroy( p_mux->p_cfg );
502
503     vlc_object_destroy( p_mux );
504 }
505
506 /*****************************************************************************
507  * sout_MuxAddStream:
508  *****************************************************************************/
509 sout_input_t *sout_MuxAddStream( sout_mux_t *p_mux, es_format_t *p_fmt )
510 {
511     sout_input_t *p_input;
512
513     if( !p_mux->b_add_stream_any_time && !p_mux->b_waiting_stream )
514     {
515         msg_Err( p_mux, "cannot add a new stream (unsupported while muxing "
516                         "for this format)" );
517         return NULL;
518     }
519
520     msg_Dbg( p_mux, "adding a new input" );
521
522     /* create a new sout input */
523     p_input = malloc( sizeof( sout_input_t ) );
524     p_input->p_sout = p_mux->p_sout;
525     p_input->p_fmt  = p_fmt;
526     p_input->p_fifo = block_FifoNew( p_mux->p_sout );
527     p_input->p_sys  = NULL;
528
529     TAB_APPEND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
530     if( p_mux->pf_addstream( p_mux, p_input ) < 0 )
531     {
532             msg_Err( p_mux, "cannot add this stream" );
533             TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
534             block_FifoRelease( p_input->p_fifo );
535             free( p_input );
536             return NULL;
537     }
538
539     return p_input;
540 }
541
542 /*****************************************************************************
543  * sout_MuxDeleteStream:
544  *****************************************************************************/
545 void sout_MuxDeleteStream( sout_mux_t *p_mux, sout_input_t *p_input )
546 {
547     int i_index;
548
549     if( p_mux->b_waiting_stream && p_input->p_fifo->i_depth > 0 )
550     {
551         /* We stop waiting, and call the muxer for taking care of the data
552          * before we remove this es */
553         p_mux->b_waiting_stream = VLC_FALSE;
554         p_mux->pf_mux( p_mux );
555     }
556
557     TAB_FIND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input, i_index );
558     if( i_index >= 0 )
559     {
560         if( p_mux->pf_delstream( p_mux, p_input ) < 0 )
561         {
562             msg_Err( p_mux, "cannot del this stream from mux" );
563         }
564
565         /* remove the entry */
566         TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
567
568         if( p_mux->i_nb_inputs == 0 )
569         {
570             msg_Warn( p_mux, "no more input stream for this mux" );
571         }
572
573         block_FifoRelease( p_input->p_fifo );
574         free( p_input );
575     }
576 }
577
578 /*****************************************************************************
579  * sout_MuxSendBuffer:
580  *****************************************************************************/
581 void sout_MuxSendBuffer( sout_mux_t *p_mux, sout_input_t *p_input,
582                          block_t *p_buffer )
583 {
584     block_FifoPut( p_input->p_fifo, p_buffer );
585
586     if( p_mux->p_sout->i_out_pace_nocontrol )
587     {
588         mtime_t current_date = mdate();
589         if ( current_date > p_buffer->i_dts )
590             msg_Warn( p_mux, "late buffer for mux input ("I64Fd")",
591                       current_date - p_buffer->i_dts );
592     }
593
594     if( p_mux->b_waiting_stream )
595     {
596         if( p_mux->i_add_stream_start < 0 )
597         {
598             p_mux->i_add_stream_start = p_buffer->i_dts;
599         }
600
601         if( p_mux->i_add_stream_start >= 0 &&
602             p_mux->i_add_stream_start + I64C(1500000) < p_buffer->i_dts )
603         {
604             /* Wait until we have more than 1.5 seconds worth of data
605              * before start muxing */
606             p_mux->b_waiting_stream = VLC_FALSE;
607         }
608         else
609         {
610             return;
611         }
612     }
613     p_mux->pf_mux( p_mux );
614 }
615
616 /*****************************************************************************
617  *
618  *****************************************************************************/
619 static int mrl_Parse( mrl_t *p_mrl, char *psz_mrl )
620 {
621     char * psz_dup = strdup( psz_mrl );
622     char * psz_parser = psz_dup;
623     char * psz_access = "";
624     char * psz_way = "";
625     char * psz_name = "";
626
627     /* *** first parse psz_dest */
628     while( *psz_parser && *psz_parser != ':' )
629     {
630         if( *psz_parser == '{' )
631         {
632             while( *psz_parser && *psz_parser != '}' )
633             {
634                 psz_parser++;
635             }
636             if( *psz_parser )
637             {
638                 psz_parser++;
639             }
640         }
641         else
642         {
643             psz_parser++;
644         }
645     }
646 #if defined( WIN32 ) || defined( UNDER_CE )
647     if( psz_parser - psz_dup == 1 )
648     {
649         /* msg_Warn( p_sout, "drive letter %c: found in source string",
650                           *psz_dup ) ; */
651         psz_parser = "";
652     }
653 #endif
654
655     if( !*psz_parser )
656     {
657         psz_access = psz_way = "";
658         psz_name = psz_dup;
659     }
660     else
661     {
662         *psz_parser++ = '\0';
663
664         /* let's skip '//' */
665         if( psz_parser[0] == '/' && psz_parser[1] == '/' )
666         {
667             psz_parser += 2 ;
668         }
669
670         psz_name = psz_parser ;
671
672         /* Come back to parse the access and mux plug-ins */
673         psz_parser = psz_dup;
674
675         if( !*psz_parser )
676         {
677             /* No access */
678             psz_access = "";
679         }
680         else if( *psz_parser == '/' )
681         {
682             /* No access */
683             psz_access = "";
684             psz_parser++;
685         }
686         else
687         {
688             psz_access = psz_parser;
689
690             while( *psz_parser && *psz_parser != '/' )
691             {
692                 if( *psz_parser == '{' )
693                 {
694                     while( *psz_parser && *psz_parser != '}' )
695                     {
696                         psz_parser++;
697                     }
698                     if( *psz_parser )
699                     {
700                         psz_parser++;
701                     }
702                 }
703                 else
704                 {
705                     psz_parser++;
706                 }
707             }
708
709             if( *psz_parser == '/' )
710             {
711                 *psz_parser++ = '\0';
712             }
713         }
714
715         if( !*psz_parser )
716         {
717             /* No mux */
718             psz_way = "";
719         }
720         else
721         {
722             psz_way = psz_parser;
723         }
724     }
725
726     p_mrl->psz_access = strdup( psz_access );
727     p_mrl->psz_way    = strdup( psz_way );
728     p_mrl->psz_name   = strdup( psz_name );
729
730     free( psz_dup );
731     return( VLC_SUCCESS );
732 }
733
734
735 /* mrl_Clean: clean p_mrl  after a call to mrl_Parse */
736 static void mrl_Clean( mrl_t *p_mrl )
737 {
738     FREE( p_mrl->psz_access );
739     FREE( p_mrl->psz_way );
740     FREE( p_mrl->psz_name );
741 }
742
743
744 /****************************************************************************
745  ****************************************************************************
746  **
747  **
748  **
749  ****************************************************************************
750  ****************************************************************************/
751
752 /* create a complete chain */
753 /* chain format:
754     module{option=*:option=*}[:module{option=*:...}]
755  */
756
757 /*
758  * parse module{options=str, option="str "}:
759  *  return a pointer on the rest
760  *  XXX: psz_chain is modified
761  */
762 #define SKIPSPACE( p ) { while( *p && ( *p == ' ' || *p == '\t' ) ) p++; }
763 #define SKIPTRAILINGSPACE( p, e ) \
764     { while( e > p && ( *(e-1) == ' ' || *(e-1) == '\t' ) ) e--; }
765
766 /* go accross " " and { } */
767 static char *_get_chain_end( char *str )
768 {
769     char c, *p = str;
770
771     SKIPSPACE( p );
772
773     for( ;; )
774     {
775         if( !*p || *p == ',' || *p == '}' ) return p;
776
777         if( *p != '{' && *p != '"' && *p != '\'' )
778         {
779             p++;
780             continue;
781         }
782
783         if( *p == '{' ) c = '}';
784         else c = *p;
785         p++;
786
787         for( ;; )
788         {
789             if( !*p ) return p;
790
791             if( *p == c ) return ++p;
792             else if( *p == '{' && c == '}' ) p = _get_chain_end( p );
793             else p++;
794         }
795     }
796 }
797
798 char *sout_CfgCreate( char **ppsz_name, sout_cfg_t **pp_cfg, char *psz_chain )
799 {
800     sout_cfg_t *p_cfg = NULL;
801     char       *p = psz_chain;
802
803     *ppsz_name = NULL;
804     *pp_cfg    = NULL;
805
806     if( !p ) return NULL;
807
808     SKIPSPACE( p );
809
810     while( *p && *p != '{' && *p != ':' && *p != ' ' && *p != '\t' ) p++;
811
812     if( p == psz_chain ) return NULL;
813
814     *ppsz_name = strndup( psz_chain, p - psz_chain );
815
816     SKIPSPACE( p );
817
818     if( *p == '{' )
819     {
820         char *psz_name;
821
822         p++;
823
824         for( ;; )
825         {
826             sout_cfg_t cfg;
827
828             SKIPSPACE( p );
829
830             psz_name = p;
831
832             while( *p && *p != '=' && *p != ',' && *p != '{' && *p != '}' &&
833                    *p != ' ' && *p != '\t' ) p++;
834
835             /* fprintf( stderr, "name=%s - rest=%s\n", psz_name, p ); */
836             if( p == psz_name )
837             {
838                 fprintf( stderr, "invalid options (empty)" );
839                 break;
840             }
841
842             cfg.psz_name = strndup( psz_name, p - psz_name );
843
844             SKIPSPACE( p );
845
846             if( *p == '=' || *p == '{' )
847             {
848                 char *end;
849                 vlc_bool_t b_keep_brackets = (*p == '{');
850
851                 if( *p == '=' ) p++;
852
853                 end = _get_chain_end( p );
854                 if( end <= p )
855                 {
856                     cfg.psz_value = NULL;
857                 }
858                 else
859                 {
860                     /* Skip heading and trailing spaces.
861                      * This ain't necessary but will avoid simple
862                      * user mistakes. */
863                     SKIPSPACE( p );
864                 }
865
866                 if( end <= p )
867                 {
868                     cfg.psz_value = NULL;
869                 }
870                 else
871                 {
872                     if( *p == '\'' || *p == '"' ||
873                         ( !b_keep_brackets && *p == '{' ) )
874                     {
875                         p++;
876
877                         if( *(end-1) != '\'' && *(end-1) == '"' )
878                             SKIPTRAILINGSPACE( p, end );
879
880                         if( end - 1 <= p ) cfg.psz_value = NULL;
881                         else cfg.psz_value = strndup( p, end -1 - p );
882                     }
883                     else
884                     {
885                         SKIPTRAILINGSPACE( p, end );
886                         if( end <= p ) cfg.psz_value = NULL;
887                         else cfg.psz_value = strndup( p, end - p );
888                     }
889                 }
890
891                 p = end;
892                 SKIPSPACE( p );
893             }
894             else
895             {
896                 cfg.psz_value = NULL;
897             }
898
899             cfg.p_next = NULL;
900             if( p_cfg )
901             {
902                 p_cfg->p_next = malloc( sizeof( sout_cfg_t ) );
903                 memcpy( p_cfg->p_next, &cfg, sizeof( sout_cfg_t ) );
904
905                 p_cfg = p_cfg->p_next;
906             }
907             else
908             {
909                 p_cfg = malloc( sizeof( sout_cfg_t ) );
910                 memcpy( p_cfg, &cfg, sizeof( sout_cfg_t ) );
911
912                 *pp_cfg = p_cfg;
913             }
914
915             if( *p == ',' ) p++;
916
917             if( *p == '}' )
918             {
919                 p++;
920                 break;
921             }
922         }
923     }
924
925     if( *p == ':' ) return( strdup( p + 1 ) );
926
927     return NULL;
928 }
929
930 static void sout_CfgDestroy( sout_cfg_t *p_cfg )
931 {
932     while( p_cfg != NULL )
933     {
934         sout_cfg_t *p_next;
935
936         p_next = p_cfg->p_next;
937
938         FREE( p_cfg->psz_name );
939         FREE( p_cfg->psz_value );
940         free( p_cfg );
941
942         p_cfg = p_next;
943     }
944 }
945
946 void __sout_CfgParse( vlc_object_t *p_this, char *psz_prefix,
947                       const char **ppsz_options, sout_cfg_t *cfg )
948 {
949     char *psz_name;
950     int  i_type;
951     int  i;
952
953     /* First, var_Create all variables */
954     for( i = 0; ppsz_options[i] != NULL; i++ )
955     {
956         asprintf( &psz_name, "%s%s", psz_prefix,
957                   *ppsz_options[i] == '*' ? &ppsz_options[i][1] : ppsz_options[i] );
958
959         i_type = config_GetType( p_this, psz_name );
960
961         var_Create( p_this, psz_name, i_type | VLC_VAR_DOINHERIT );
962         free( psz_name );
963     }
964
965     /* Now parse options and set value */
966     if( psz_prefix == NULL ) psz_prefix = "";
967
968     while( cfg )
969     {
970         vlc_value_t val;
971         vlc_bool_t b_yes = VLC_TRUE;
972         vlc_bool_t b_once = VLC_FALSE;
973
974         if( cfg->psz_name == NULL || *cfg->psz_name == '\0' )
975         {
976             cfg = cfg->p_next;
977             continue;
978         }
979         for( i = 0; ppsz_options[i] != NULL; i++ )
980         {
981             if( !strcmp( ppsz_options[i], cfg->psz_name ) )
982             {
983                 break;
984             }
985             if( ( !strncmp( cfg->psz_name, "no-", 3 ) &&
986                   !strcmp( ppsz_options[i], cfg->psz_name + 3 ) ) ||
987                 ( !strncmp( cfg->psz_name, "no", 2 ) &&
988                   !strcmp( ppsz_options[i], cfg->psz_name + 2 ) ) )
989             {
990                 b_yes = VLC_FALSE;
991                 break;
992             }
993
994             if( *ppsz_options[i] == '*' &&
995                 !strcmp( &ppsz_options[i][1], cfg->psz_name ) )
996             {
997                 b_once = VLC_TRUE;
998                 break;
999             }
1000
1001         }
1002         if( ppsz_options[i] == NULL )
1003         {
1004             msg_Warn( p_this, "option %s is unknown", cfg->psz_name );
1005             cfg = cfg->p_next;
1006             continue;
1007         }
1008
1009         /* create name */
1010         asprintf( &psz_name, "%s%s", psz_prefix, b_once ? &ppsz_options[i][1] : ppsz_options[i] );
1011
1012         /* get the type of the variable */
1013         i_type = config_GetType( p_this, psz_name );
1014         if( !i_type )
1015         {
1016             msg_Warn( p_this, "unknown option %s (value=%s)",
1017                       cfg->psz_name, cfg->psz_value );
1018             goto next;
1019         }
1020         if( i_type != VLC_VAR_BOOL && cfg->psz_value == NULL )
1021         {
1022             msg_Warn( p_this, "missing value for option %s", cfg->psz_name );
1023             goto next;
1024         }
1025         if( i_type != VLC_VAR_STRING && b_once )
1026         {
1027             msg_Warn( p_this, "*option_name need to be a string option" );
1028             goto next;
1029         }
1030
1031         switch( i_type )
1032         {
1033             case VLC_VAR_BOOL:
1034                 val.b_bool = b_yes;
1035                 break;
1036             case VLC_VAR_INTEGER:
1037                 val.i_int = strtol( cfg->psz_value ? cfg->psz_value : "0",
1038                                     NULL, 0 );
1039                 break;
1040             case VLC_VAR_FLOAT:
1041                 val.f_float = atof( cfg->psz_value ? cfg->psz_value : "0" );
1042                 break;
1043             case VLC_VAR_STRING:
1044             case VLC_VAR_MODULE:
1045                 val.psz_string = cfg->psz_value;
1046                 break;
1047             default:
1048                 msg_Warn( p_this, "unhandled config var type" );
1049                 memset( &val, 0, sizeof( vlc_value_t ) );
1050                 break;
1051         }
1052         if( b_once )
1053         {
1054             vlc_value_t val2;
1055
1056             var_Get( p_this, psz_name, &val2 );
1057             if( *val2.psz_string )
1058             {
1059                 free( val2.psz_string );
1060                 msg_Dbg( p_this, "ignoring option %s (not first occurrence)", psz_name );
1061                 goto next;
1062             }
1063             free( val2.psz_string );
1064         }
1065         var_Set( p_this, psz_name, val );
1066         msg_Dbg( p_this, "set sout option: %s to %s", psz_name, cfg->psz_value );
1067
1068     next:
1069         free( psz_name );
1070         cfg = cfg->p_next;
1071     }
1072 }
1073
1074
1075 /*
1076  * XXX name and p_cfg are used (-> do NOT free them)
1077  */
1078 sout_stream_t *sout_StreamNew( sout_instance_t *p_sout, char *psz_chain )
1079 {
1080     sout_stream_t *p_stream;
1081
1082     if( !psz_chain )
1083     {
1084         msg_Err( p_sout, "invalid chain" );
1085         return NULL;
1086     }
1087
1088     p_stream = vlc_object_create( p_sout, sizeof( sout_stream_t ) );
1089
1090     if( !p_stream )
1091     {
1092         msg_Err( p_sout, "out of memory" );
1093         return NULL;
1094     }
1095
1096     p_stream->p_sout   = p_sout;
1097     p_stream->p_sys    = NULL;
1098
1099     p_stream->psz_next =
1100         sout_CfgCreate( &p_stream->psz_name, &p_stream->p_cfg, psz_chain);
1101
1102     msg_Dbg( p_sout, "stream=`%s'", p_stream->psz_name );
1103
1104     vlc_object_attach( p_stream, p_sout );
1105
1106     p_stream->p_module =
1107         module_Need( p_stream, "sout stream", p_stream->psz_name, VLC_TRUE );
1108
1109     if( !p_stream->p_module )
1110     {
1111         sout_StreamDelete( p_stream );
1112         return NULL;
1113     }
1114
1115     return p_stream;
1116 }
1117
1118 void sout_StreamDelete( sout_stream_t *p_stream )
1119 {
1120     msg_Dbg( p_stream, "destroying chain... (name=%s)", p_stream->psz_name );
1121
1122     vlc_object_detach( p_stream );
1123     if( p_stream->p_module ) module_Unneed( p_stream, p_stream->p_module );
1124
1125     FREE( p_stream->psz_name );
1126     FREE( p_stream->psz_next );
1127
1128     sout_CfgDestroy( p_stream->p_cfg );
1129
1130     msg_Dbg( p_stream, "destroying chain done" );
1131     vlc_object_destroy( p_stream );
1132 }
1133
1134 static char *_sout_stream_url_to_chain( vlc_object_t *p_this, char *psz_url )
1135 {
1136     mrl_t       mrl;
1137     char        *psz_chain, *p;
1138
1139     mrl_Parse( &mrl, psz_url );
1140     p = psz_chain = malloc( 500 + strlen( mrl.psz_way ) +
1141                                   strlen( mrl.psz_access ) +
1142                                   strlen( mrl.psz_name ) );
1143
1144
1145     if( config_GetInt( p_this, "sout-display" ) )
1146     {
1147         p += sprintf( p, "duplicate{dst=display,dst=std{mux=\"%s\","
1148                       "access=\"%s\",url=\"%s\"}}",
1149                       mrl.psz_way, mrl.psz_access, mrl.psz_name );
1150     }
1151     else
1152     {
1153         p += sprintf( p, "std{mux=\"%s\",access=\"%s\",url=\"%s\"}",
1154                       mrl.psz_way, mrl.psz_access, mrl.psz_name );
1155     }
1156
1157     mrl_Clean( &mrl );
1158     return( psz_chain );
1159 }