src/stream_output/stream_output.c

   1 /*****************************************************************************
   2  * stream_output.c : stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2007 VLC authors and VideoLAN
   5  *
   6  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   7  *          Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Eric Petit <titer@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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 <assert.h>
  34
  35 #include <vlc_common.h>
  36
  37 #include <stdlib.h>                                                /* free() */
  38 #include <stdio.h>                                              /* sprintf() */
  39 #include <string.h>
  40
  41 #include <vlc_sout.h>
  42
  43 #include "stream_output.h"
  44
  45 #include <vlc_meta.h>
  46 #include <vlc_block.h>
  47 #include <vlc_codec.h>
  48 #include <vlc_modules.h>
  49
  50 #include "input/input_interface.h"
  51
  52 #undef DEBUG_BUFFER
  53 /*****************************************************************************
  54  * Local prototypes
  55  *****************************************************************************/
  56 static char *sout_stream_url_to_chain( bool, const char * );
  57
  58 /*
  59  * Generic MRL parser
  60  *
  61  */
  62
  63 typedef struct
  64 {
  65     char *psz_access;
  66     char *psz_way;
  67     char *psz_name;
  68 } mrl_t;
  69
  70 /* mrl_Parse: parse psz_mrl and fill p_mrl */
  71 static int  mrl_Parse( mrl_t *p_mrl, const char *psz_mrl );
  72 /* mrl_Clean: clean p_mrl  after a call to mrl_Parse */
  73 static void mrl_Clean( mrl_t *p_mrl );
  74
  75 #undef sout_NewInstance
  76
  77 /*****************************************************************************
  78  * sout_NewInstance: creates a new stream output instance
  79  *****************************************************************************/
  80 sout_instance_t *sout_NewInstance( vlc_object_t *p_parent, const char *psz_dest )
  81 {
  82     sout_instance_t *p_sout;
  83     char *psz_chain;
  84
  85     assert( psz_dest != NULL );
  86
  87     if( psz_dest[0] == '#' )
  88     {
  89         psz_chain = strdup( &psz_dest[1] );
  90     }
  91     else
  92     {
  93         psz_chain = sout_stream_url_to_chain(
  94             var_InheritBool(p_parent, "sout-display"), psz_dest );
  95     }
  96     if(!psz_chain)
  97         return NULL;
  98
  99     /* *** Allocate descriptor *** */
 100     p_sout = malloc(sizeof (*p_sout));
 101     if( p_sout == NULL )
 102     {
 103         free( psz_chain );
 104         return NULL;
 105     }
 106
 107     msg_Dbg(p_parent, "creating stream output chain `%s'", psz_chain);
 108
 109     /* *** init descriptor *** */
 110     p_sout->psz_sout    = strdup( psz_dest );
 111     p_sout->b_wants_substreams = false;
 112
 113     p_sout->p_stream = NULL;
 114
 115     p_sout->p_stream = sout_StreamChainNew(p_parent, psz_chain, NULL);
 116     if( p_sout->p_stream )
 117     {
 118         free( psz_chain );
 119         sout_StreamControl( p_sout->p_stream,
 120                             SOUT_STREAM_WANTS_SUBSTREAMS,
 121                             &p_sout->b_wants_substreams );
 122         return p_sout;
 123     }
 124
 125     msg_Err(p_parent, "failed to create stream output chain `%s'", psz_chain);
 126     free( psz_chain );
 127
 128     FREENULL( p_sout->psz_sout );
 129
 130     free(p_sout);
 131     return NULL;
 132 }
 133
 134 /*****************************************************************************
 135  * sout_DeleteInstance: delete a previously allocated instance
 136  *****************************************************************************/
 137 void sout_DeleteInstance( sout_instance_t * p_sout )
 138 {
 139     /* remove the stream out chain */
 140     sout_StreamChainDelete( p_sout->p_stream, NULL );
 141
 142     /* *** free all string *** */
 143     FREENULL( p_sout->psz_sout );
 144
 145     /* *** free structure *** */
 146     free(p_sout);
 147 }
 148
 149 bool sout_instance_ControlsPace( sout_instance_t *sout )
 150 {
 151     return !sout_StreamIsSynchronous(sout->p_stream);
 152 }
 153
 154 /*****************************************************************************
 155  * Packetizer/Input
 156  *****************************************************************************/
 157
 158 struct sout_packetizer_input_t
 159 {
 160     void                *id;
 161     bool                 b_flushed;
 162 };
 163
 164 sout_packetizer_input_t *sout_InputNew( sout_instance_t *p_sout,
 165                                         const es_format_t *p_fmt )
 166 {
 167     sout_packetizer_input_t *p_input;
 168
 169     /* *** create a packetizer input *** */
 170     if( !p_fmt->i_codec || !(p_input = malloc(sizeof(sout_packetizer_input_t))) )
 171         return NULL;
 172
 173     p_input->b_flushed = false;
 174
 175     msg_Dbg(p_sout->p_stream, "adding an output ES for `%4.4s` (%p)",
 176             (char *)&p_fmt->i_codec, (void *)p_input);
 177
 178     /* *** add it to the stream chain */
 179     p_input->id = sout_StreamIdAdd( p_sout->p_stream, p_fmt );
 180
 181     if( p_input->id == NULL )
 182     {
 183         msg_Warn(p_sout->p_stream, "failed to add output ES (%p)",
 184                  (void *)p_input);
 185         free( p_input );
 186         p_input = NULL;
 187     }
 188
 189     return( p_input );
 190 }
 191
 192 /*****************************************************************************
 193  *
 194  *****************************************************************************/
 195 int sout_InputDelete( sout_instance_t *p_sout,
 196                       sout_packetizer_input_t *p_input )
 197 {
 198
 199     msg_Dbg(p_sout->p_stream, "removing an output ES (%p)", (void *)p_input);
 200
 201     sout_StreamIdDel( p_sout->p_stream, p_input->id );
 202     free( p_input );
 203
 204     return( VLC_SUCCESS);
 205 }
 206
 207 static int sout_InputControlVa( sout_instance_t *p_sout,
 208                                 sout_packetizer_input_t *p_input,
 209                                 int i_query, va_list args )
 210 {
 211     if( i_query == SOUT_INPUT_SET_SPU_HIGHLIGHT )
 212     {
 213         return sout_StreamControl( p_sout->p_stream,
 214                                         SOUT_STREAM_ID_SPU_HIGHLIGHT,
 215                                         p_input->id, va_arg(args, void *) );
 216     }
 217     return VLC_EGENERIC;
 218 }
 219
 220 int sout_InputControl( sout_instance_t *p_sout,
 221                        sout_packetizer_input_t *p_input, int i_query, ... )
 222 {
 223     va_list args;
 224     int     i_result;
 225
 226     va_start( args, i_query );
 227     i_result = sout_InputControlVa( p_sout, p_input, i_query, args );
 228     va_end( args );
 229     return i_result;
 230 }
 231
 232 void sout_InputFlush( sout_instance_t *p_sout,
 233                       sout_packetizer_input_t *p_input )
 234 {
 235     sout_StreamFlush( p_sout->p_stream, p_input->id );
 236     p_input->b_flushed = true;
 237 }
 238
 239 /*****************************************************************************
 240  *
 241  *****************************************************************************/
 242 int sout_InputSendBuffer( sout_instance_t *p_sout,
 243                           sout_packetizer_input_t *p_input,
 244                           block_t *p_buffer )
 245 {
 246     if( p_input->b_flushed )
 247     {
 248         p_buffer->i_flags |= BLOCK_FLAG_DISCONTINUITY;
 249         p_input->b_flushed = false;
 250     }
 251     return sout_StreamIdSend( p_sout->p_stream, p_input->id, p_buffer );
 252 }
 253
 254 #undef sout_AccessOutNew
 255 /*****************************************************************************
 256  * sout_AccessOutNew: allocate a new access out
 257  *****************************************************************************/
 258 sout_access_out_t *sout_AccessOutNew( vlc_object_t *p_sout,
 259                                       const char *psz_access, const char *psz_name )
 260 {
 261     sout_access_out_t *p_access;
 262     char              *psz_next;
 263
 264     p_access = vlc_custom_create( p_sout, sizeof( *p_access ), "access out" );
 265     if( !p_access )
 266         return NULL;
 267
 268     psz_next = config_ChainCreate( &p_access->psz_access, &p_access->p_cfg,
 269                                    psz_access );
 270     free( psz_next );
 271     p_access->psz_path   = strdup( psz_name ? psz_name : "" );
 272     if( unlikely(p_access->psz_path == NULL) )
 273         goto error;
 274     p_access->p_sys      = NULL;
 275     p_access->pf_seek    = NULL;
 276     p_access->pf_read    = NULL;
 277     p_access->pf_write   = NULL;
 278     p_access->pf_control = NULL;
 279     p_access->p_module   = NULL;
 280
 281     p_access->p_module   =
 282         module_need( p_access, "sout access", p_access->psz_access, true );
 283
 284     if( !p_access->p_module )
 285     {
 286         free( p_access->psz_path );
 287 error:
 288         free( p_access->psz_access );
 289         vlc_object_delete(p_access);
 290         return( NULL );
 291     }
 292
 293     return p_access;
 294 }
 295 /*****************************************************************************
 296  * sout_AccessDelete: delete an access out
 297  *****************************************************************************/
 298 void sout_AccessOutDelete( sout_access_out_t *p_access )
 299 {
 300     if( p_access->p_module )
 301     {
 302         module_unneed( p_access, p_access->p_module );
 303     }
 304     free( p_access->psz_access );
 305
 306     config_ChainDestroy( p_access->p_cfg );
 307
 308     free( p_access->psz_path );
 309
 310     vlc_object_delete(p_access);
 311 }
 312
 313 /*****************************************************************************
 314  * sout_AccessSeek:
 315  *****************************************************************************/
 316 int sout_AccessOutSeek( sout_access_out_t *p_access, off_t i_pos )
 317 {
 318     if (p_access->pf_seek == NULL)
 319         return VLC_EGENERIC;
 320     return p_access->pf_seek( p_access, i_pos );
 321 }
 322
 323 /*****************************************************************************
 324  * sout_AccessRead:
 325  *****************************************************************************/
 326 ssize_t sout_AccessOutRead( sout_access_out_t *p_access, block_t *p_buffer )
 327 {
 328     return( p_access->pf_read ?
 329             p_access->pf_read( p_access, p_buffer ) : VLC_EGENERIC );
 330 }
 331
 332 /*****************************************************************************
 333  * sout_AccessWrite:
 334  *****************************************************************************/
 335 ssize_t sout_AccessOutWrite( sout_access_out_t *p_access, block_t *p_buffer )
 336 {
 337     return p_access->pf_write( p_access, p_buffer );
 338 }
 339
 340 /**
 341  * sout_AccessOutControl
 342  */
 343 int sout_AccessOutControl (sout_access_out_t *access, int query, ...)
 344 {
 345     va_list ap;
 346     int ret;
 347
 348     va_start (ap, query);
 349     if (access->pf_control)
 350         ret = access->pf_control (access, query, ap);
 351     else
 352         ret = VLC_EGENERIC;
 353     va_end (ap);
 354     return ret;
 355 }
 356
 357 /*****************************************************************************
 358  * sout_MuxNew: create a new mux
 359  *****************************************************************************/
 360 sout_mux_t *sout_MuxNew( sout_access_out_t *p_access, const char *psz_mux )
 361 {
 362     sout_mux_t *p_mux;
 363     char       *psz_next;
 364
 365     p_mux = vlc_custom_create( p_access, sizeof( *p_mux ), "mux" );
 366     if( p_mux == NULL )
 367         return NULL;
 368
 369     psz_next = config_ChainCreate( &p_mux->psz_mux, &p_mux->p_cfg, psz_mux );
 370     free( psz_next );
 371
 372     p_mux->p_access     = p_access;
 373     p_mux->pf_control   = NULL;
 374     p_mux->pf_addstream = NULL;
 375     p_mux->pf_delstream = NULL;
 376     p_mux->pf_mux       = NULL;
 377     p_mux->i_nb_inputs  = 0;
 378     p_mux->pp_inputs    = NULL;
 379
 380     p_mux->p_sys        = NULL;
 381     p_mux->p_module     = NULL;
 382
 383     p_mux->b_add_stream_any_time = false;
 384     p_mux->b_waiting_stream = true;
 385     p_mux->i_add_stream_start = VLC_TICK_INVALID;
 386
 387     p_mux->p_module =
 388         module_need( p_mux, "sout mux", p_mux->psz_mux, true );
 389
 390     if( p_mux->p_module == NULL )
 391     {
 392         FREENULL( p_mux->psz_mux );
 393
 394         vlc_object_delete(p_mux);
 395         return NULL;
 396     }
 397
 398     /* *** probe mux capacity *** */
 399     if( p_mux->pf_control )
 400     {
 401         int b_answer = false;
 402
 403         if( sout_MuxControl( p_mux, MUX_CAN_ADD_STREAM_WHILE_MUXING,
 404                              &b_answer ) )
 405         {
 406             b_answer = false;
 407         }
 408
 409         if( b_answer )
 410         {
 411             msg_Dbg( p_access, "muxer support adding stream at any time" );
 412             p_mux->b_add_stream_any_time = true;
 413             p_mux->b_waiting_stream = true;
 414         }
 415     }
 416
 417     return p_mux;
 418 }
 419
 420 /*****************************************************************************
 421  * sout_MuxDelete:
 422  *****************************************************************************/
 423 void sout_MuxDelete( sout_mux_t *p_mux )
 424 {
 425     if( p_mux->p_module )
 426     {
 427         module_unneed( p_mux, p_mux->p_module );
 428     }
 429     free( p_mux->psz_mux );
 430
 431     config_ChainDestroy( p_mux->p_cfg );
 432
 433     vlc_object_delete(p_mux);
 434 }
 435
 436 /*****************************************************************************
 437  * sout_MuxAddStream:
 438  *****************************************************************************/
 439 sout_input_t *sout_MuxAddStream( sout_mux_t *p_mux, const es_format_t *p_fmt )
 440 {
 441     sout_input_t *p_input;
 442
 443     if( !p_mux->b_add_stream_any_time && !p_mux->b_waiting_stream )
 444     {
 445         msg_Err( p_mux, "cannot add a new stream (unsupported while muxing "
 446                         "to this format). You can try increasing sout-mux-caching value" );
 447         return NULL;
 448     }
 449
 450     msg_Dbg( p_mux, "adding a new input" );
 451
 452     /* create a new sout input */
 453     p_input = malloc( sizeof( sout_input_t ) );
 454     if( !p_input )
 455         return NULL;
 456
 457     // FIXME: remove either fmt or p_fmt...
 458     es_format_Copy( &p_input->fmt, p_fmt );
 459     p_input->p_fmt = &p_input->fmt;
 460
 461     p_input->p_fifo = block_FifoNew();
 462     p_input->p_sys  = NULL;
 463
 464     TAB_APPEND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
 465     if( p_mux->pf_addstream( p_mux, p_input ) < 0 )
 466     {
 467         msg_Err( p_mux, "cannot add this stream" );
 468         TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
 469         block_FifoRelease( p_input->p_fifo );
 470         es_format_Clean( &p_input->fmt );
 471         free( p_input );
 472         return NULL;
 473     }
 474
 475     return p_input;
 476 }
 477
 478 /*****************************************************************************
 479  * sout_MuxDeleteStream:
 480  *****************************************************************************/
 481 void sout_MuxDeleteStream( sout_mux_t *p_mux, sout_input_t *p_input )
 482 {
 483     int i_index;
 484
 485     if( p_mux->b_waiting_stream
 486      && block_FifoCount( p_input->p_fifo ) > 0 )
 487     {
 488         /* We stop waiting, and call the muxer for taking care of the data
 489          * before we remove this es */
 490         p_mux->b_waiting_stream = false;
 491         p_mux->pf_mux( p_mux );
 492     }
 493
 494     TAB_FIND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input, i_index );
 495     if( i_index >= 0 )
 496     {
 497         /* remove the entry */
 498         TAB_ERASE( p_mux->i_nb_inputs, p_mux->pp_inputs, i_index );
 499
 500         p_mux->pf_delstream( p_mux, p_input );
 501
 502         if( p_mux->i_nb_inputs == 0 )
 503         {
 504             msg_Warn( p_mux, "no more input streams for this mux" );
 505         }
 506
 507         block_FifoRelease( p_input->p_fifo );
 508         es_format_Clean( &p_input->fmt );
 509         free( p_input );
 510     }
 511 }
 512
 513 /*****************************************************************************
 514  * sout_MuxSendBuffer:
 515  *****************************************************************************/
 516 int sout_MuxSendBuffer( sout_mux_t *p_mux, sout_input_t *p_input,
 517                          block_t *p_buffer )
 518 {
 519     vlc_tick_t i_dts = p_buffer->i_dts;
 520     block_FifoPut( p_input->p_fifo, p_buffer );
 521
 522     if( i_dts == VLC_TICK_INVALID )
 523         i_dts = p_buffer->i_pts;
 524
 525     if( p_mux->b_waiting_stream && i_dts != VLC_TICK_INVALID )
 526     {
 527         const vlc_tick_t i_caching = VLC_TICK_FROM_MS(var_InheritInteger( p_mux, "sout-mux-caching" ));
 528
 529         if( p_mux->i_add_stream_start == VLC_TICK_INVALID )
 530             p_mux->i_add_stream_start = i_dts;
 531
 532         /* Wait until we have enough data before muxing */
 533         if( llabs( i_dts - p_mux->i_add_stream_start ) < i_caching )
 534             return VLC_SUCCESS;
 535         p_mux->b_waiting_stream = false;
 536     }
 537     return p_mux->pf_mux( p_mux );
 538 }
 539
 540 void sout_MuxFlush( sout_mux_t *p_mux, sout_input_t *p_input )
 541 {
 542     VLC_UNUSED(p_mux);
 543     block_FifoEmpty( p_input->p_fifo );
 544 }
 545
 546 /*****************************************************************************
 547  * sout_MuxGetStream: find stream to be muxed
 548  *****************************************************************************/
 549 int sout_MuxGetStream( sout_mux_t *p_mux, unsigned i_blocks, vlc_tick_t *pi_dts )
 550 {
 551     vlc_tick_t i_dts = 0;
 552     int     i_stream = -1;
 553
 554     assert( i_blocks > 0 );
 555
 556     for( int i = 0; i < p_mux->i_nb_inputs; i++ )
 557     {
 558         sout_input_t *p_input = p_mux->pp_inputs[i];
 559         block_t *p_data;
 560
 561         if( block_FifoCount( p_input->p_fifo ) < i_blocks )
 562         {
 563             if( (!p_mux->b_add_stream_any_time) &&
 564                 (p_input->p_fmt->i_cat != SPU_ES ) )
 565             {
 566                 return -1;
 567             }
 568             /* FIXME: SPU muxing */
 569             continue;
 570         }
 571
 572         p_data = block_FifoShow( p_input->p_fifo );
 573         if( i_stream < 0 || p_data->i_dts < i_dts )
 574         {
 575             i_stream = i;
 576             i_dts    = p_data->i_dts;
 577         }
 578     }
 579
 580     if( pi_dts ) *pi_dts = i_dts;
 581
 582     return i_stream;
 583 }
 584
 585
 586 /*****************************************************************************
 587  *
 588  *****************************************************************************/
 589 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl )
 590 {
 591     char * psz_dup = strdup( psz_mrl );
 592     char * psz_parser = psz_dup;
 593     const char * psz_access;
 594     const char * psz_way;
 595     char * psz_name;
 596
 597     /* *** first parse psz_dest */
 598     while( *psz_parser && *psz_parser != ':' )
 599     {
 600         if( *psz_parser == '{' )
 601         {
 602             while( *psz_parser && *psz_parser != '}' )
 603             {
 604                 psz_parser++;
 605             }
 606             if( *psz_parser )
 607             {
 608                 psz_parser++;
 609             }
 610         }
 611         else
 612         {
 613             psz_parser++;
 614         }
 615     }
 616 #if defined( _WIN32 ) || defined( __OS2__ )
 617     if( psz_parser - psz_dup == 1 )
 618     {
 619         /* msg_Warn( p_sout, "drive letter %c: found in source string",
 620                           *psz_dup ) ; */
 621         *psz_parser = '\0';
 622     }
 623 #endif
 624
 625     if( !*psz_parser )
 626     {
 627         psz_access = psz_way = "";
 628         psz_name = psz_dup;
 629     }
 630     else
 631     {
 632         *psz_parser++ = '\0';
 633
 634         /* let's skip '//' */
 635         if( psz_parser[0] == '/' && psz_parser[1] == '/' )
 636         {
 637             psz_parser += 2 ;
 638         }
 639
 640         psz_name = psz_parser ;
 641
 642         /* Come back to parse the access and mux plug-ins */
 643         psz_parser = psz_dup;
 644
 645         if( !*psz_parser )
 646         {
 647             /* No access */
 648             psz_access = "";
 649         }
 650         else if( *psz_parser == '/' )
 651         {
 652             /* No access */
 653             psz_access = "";
 654             psz_parser++;
 655         }
 656         else
 657         {
 658             psz_access = psz_parser;
 659
 660             while( *psz_parser && *psz_parser != '/' )
 661             {
 662                 if( *psz_parser == '{' )
 663                 {
 664                     while( *psz_parser && *psz_parser != '}' )
 665                     {
 666                         psz_parser++;
 667                     }
 668                     if( *psz_parser )
 669                     {
 670                         psz_parser++;
 671                     }
 672                 }
 673                 else
 674                 {
 675                     psz_parser++;
 676                 }
 677             }
 678
 679             if( *psz_parser == '/' )
 680             {
 681                 *psz_parser++ = '\0';
 682             }
 683         }
 684
 685         if( !*psz_parser )
 686         {
 687             /* No mux */
 688             psz_way = "";
 689         }
 690         else
 691         {
 692             psz_way = psz_parser;
 693         }
 694     }
 695
 696     p_mrl->psz_access = strdup( psz_access );
 697     p_mrl->psz_way    = strdup( psz_way );
 698     p_mrl->psz_name   = strdup( psz_name );
 699
 700     free( psz_dup );
 701     return( VLC_SUCCESS );
 702 }
 703
 704
 705 /* mrl_Clean: clean p_mrl  after a call to mrl_Parse */
 706 static void mrl_Clean( mrl_t *p_mrl )
 707 {
 708     FREENULL( p_mrl->psz_access );
 709     FREENULL( p_mrl->psz_way );
 710     FREENULL( p_mrl->psz_name );
 711 }
 712
 713
 714 /****************************************************************************
 715  ****************************************************************************
 716  **
 717  **
 718  **
 719  ****************************************************************************
 720  ****************************************************************************/
 721
 722 struct sout_stream_private {
 723     sout_stream_t stream;
 724     vlc_mutex_t lock;
 725     module_t *module;
 726 };
 727
 728 #define sout_stream_priv(s) \
 729         container_of(s, struct sout_stream_private, stream)
 730
 731 static void sout_StreamLock(sout_stream_t *s)
 732 {
 733     vlc_mutex_lock(&sout_stream_priv(s)->lock);
 734 }
 735
 736 static void sout_StreamUnlock(sout_stream_t *s)
 737 {
 738     vlc_mutex_unlock(&sout_stream_priv(s)->lock);
 739 }
 740
 741 void *sout_StreamIdAdd(sout_stream_t *s, const es_format_t *fmt)
 742 {
 743     void *id;
 744
 745     sout_StreamLock(s);
 746     id = s->ops->add(s, fmt);
 747     sout_StreamUnlock(s);
 748     return id;
 749 }
 750
 751 void sout_StreamIdDel(sout_stream_t *s, void *id)
 752 {
 753     sout_StreamLock(s);
 754     s->ops->del(s, id);
 755     sout_StreamUnlock(s);
 756 }
 757
 758 int sout_StreamIdSend(sout_stream_t *s, void *id, block_t *b)
 759 {
 760     int val;
 761
 762     sout_StreamLock(s);
 763     val = s->ops->send(s, id, b);
 764     sout_StreamUnlock(s);
 765     return val;
 766 }
 767
 768 void sout_StreamFlush(sout_stream_t *s, void *id)
 769 {
 770     if (s->ops->flush != NULL)
 771     {
 772         sout_StreamLock(s);
 773         s->ops->flush(s, id);
 774         sout_StreamUnlock(s);
 775     }
 776 }
 777
 778 int sout_StreamControlVa(sout_stream_t *s, int i_query, va_list args)
 779 {
 780     int val = VLC_EGENERIC;
 781
 782     if (s->ops->control != NULL)
 783     {
 784         sout_StreamLock(s);
 785         val = s->ops->control(s, i_query, args);
 786         sout_StreamUnlock(s);
 787     }
 788     return val;
 789 }
 790
 791 /* Destroy a "stream_out" module */
 792 static void sout_StreamDelete( sout_stream_t *p_stream )
 793 {
 794     struct sout_stream_private *priv = sout_stream_priv(p_stream);
 795
 796     msg_Dbg( p_stream, "destroying chain... (name=%s)", p_stream->psz_name );
 797
 798     if (priv->module != NULL)
 799         module_unneed(p_stream, priv->module);
 800
 801     FREENULL( p_stream->psz_name );
 802
 803     config_ChainDestroy( p_stream->p_cfg );
 804
 805     msg_Dbg( p_stream, "destroying chain done" );
 806     vlc_object_delete(p_stream);
 807 }
 808
 809 /* Destroy a "stream_out" modules chain
 810  *
 811  * p_first is the first module to be destroyed in the chain
 812  * p_last is the last module to be destroyed
 813  *  if NULL, all modules are destroyed
 814  *  if not NULL, modules following it must be destroyed separately
 815  */
 816 void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *end)
 817 {
 818     while (p_first != end)
 819     {
 820         sout_stream_t *p_next = p_first->p_next;
 821
 822         sout_StreamDelete(p_first);
 823         p_first = p_next;
 824     }
 825 }
 826
 827 /* Create a "stream_out" module, which may forward its ES to p_next module */
 828 /*
 829  * XXX name and p_cfg are used (-> do NOT free them)
 830  */
 831 static sout_stream_t *sout_StreamNew( vlc_object_t *parent, char *psz_name,
 832                                config_chain_t *p_cfg, sout_stream_t *p_next)
 833 {
 834     const char *cap = (p_next != NULL) ? "sout filter" : "sout output";
 835     struct sout_stream_private *priv;
 836     sout_stream_t *p_stream;
 837
 838     assert(psz_name);
 839
 840     priv = vlc_custom_create(parent, sizeof (*priv), "stream out");
 841     if (unlikely(priv == NULL))
 842         return NULL;
 843
 844     vlc_mutex_init(&priv->lock);
 845     p_stream = &priv->stream;
 846     p_stream->psz_name = psz_name;
 847     p_stream->p_cfg    = p_cfg;
 848     p_stream->p_next   = p_next;
 849     p_stream->ops = NULL;
 850     p_stream->p_sys = NULL;
 851
 852     msg_Dbg( p_stream, "stream=`%s'", p_stream->psz_name );
 853
 854     priv->module = module_need(p_stream, cap, p_stream->psz_name, true);
 855
 856     if (priv->module == NULL)
 857     {
 858         /* those must be freed by the caller if creation failed */
 859         p_stream->psz_name = NULL;
 860         p_stream->p_cfg = NULL;
 861
 862         sout_StreamDelete( p_stream );
 863         return NULL;
 864     }
 865
 866     return p_stream;
 867 }
 868
 869 /* Creates a complete "stream_out" modules chain
 870  *
 871  *  chain format: module1{option=*:option=*}[:module2{option=*:...}]
 872  *
 873  *  The modules are created starting from the last one and linked together
 874  *
 875  *  Returns a pointer to the first module.
 876  */
 877 sout_stream_t *sout_StreamChainNew(vlc_object_t *parent, const char *psz_chain,
 878                                    sout_stream_t *sink)
 879 {
 880     if(!psz_chain || !*psz_chain)
 881     {
 882         return sink;
 883     }
 884
 885     char *psz_parser = strdup(psz_chain);
 886     if(!psz_parser)
 887         return NULL;
 888
 889     vlc_array_t cfg, name;
 890     vlc_array_init(&cfg);
 891     vlc_array_init(&name);
 892
 893     /* parse chain */
 894     while(psz_parser)
 895     {
 896         config_chain_t *p_cfg;
 897         char *psz_name;
 898         char *psz_rest_chain = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 899         free( psz_parser );
 900         psz_parser = psz_rest_chain;
 901
 902         vlc_array_append_or_abort(&cfg, p_cfg);
 903         vlc_array_append_or_abort(&name, psz_name);
 904     }
 905
 906     /* Instantiate modules from back to front of chain */
 907     sout_stream_t *front = sink;
 908     size_t i = vlc_array_count(&name);
 909
 910     while(i--)
 911     {
 912         sout_stream_t *prev;
 913
 914         prev = sout_StreamNew(parent, vlc_array_item_at_index(&name, i),
 915                               vlc_array_item_at_index(&cfg, i), front);
 916         if (prev == NULL)
 917             goto error;
 918
 919         front = prev;
 920     }
 921
 922     vlc_array_clear(&name);
 923     vlc_array_clear(&cfg);
 924
 925     return front;
 926
 927 error:
 928
 929     i++;    /* last module couldn't be created */
 930
 931     /* Destroy module instances in LIFO order */
 932     while (front != sink)
 933     {
 934         sout_stream_t *next = front->p_next;
 935
 936         sout_StreamDelete(front);
 937         front = next;
 938     }
 939
 940     /* then destroy all names and config which weren't destroyed by
 941      * sout_StreamDelete */
 942     while(i--)
 943     {
 944         free(vlc_array_item_at_index(&name, i));
 945         config_ChainDestroy(vlc_array_item_at_index(&cfg, i));
 946     }
 947     vlc_array_clear(&name);
 948     vlc_array_clear(&cfg);
 949
 950     return NULL;
 951 }
 952
 953 static char *sout_stream_url_to_chain( bool b_sout_display,
 954                                        const char *psz_url )
 955 {
 956     mrl_t       mrl;
 957     char        *psz_chain;
 958
 959     mrl_Parse( &mrl, psz_url );
 960
 961     /* Check if the URLs goes to #rtp - otherwise we'll use #standard */
 962     static const char rtplist[] = "dccp\0sctp\0tcp\0udplite\0";
 963     for (const char *a = rtplist; *a; a += strlen (a) + 1)
 964         if (strcmp (a, mrl.psz_access) == 0)
 965             goto rtp;
 966
 967     if (strcmp (mrl.psz_access, "rtp") == 0)
 968     {
 969         char *port;
 970         /* For historical reasons, rtp:// means RTP over UDP */
 971         strcpy (mrl.psz_access, "udp");
 972 rtp:
 973         if (mrl.psz_name[0] == '[')
 974         {
 975             port = strstr (mrl.psz_name, "]:");
 976             if (port != NULL)
 977                 port++;
 978         }
 979         else
 980             port = strchr (mrl.psz_name, ':');
 981         if (port != NULL)
 982             *port++ = '\0'; /* erase ':' */
 983
 984         if (asprintf (&psz_chain,
 985                       "rtp{mux=\"%s\",proto=\"%s\",dst=\"%s%s%s\"}",
 986                       mrl.psz_way, mrl.psz_access, mrl.psz_name,
 987                       port ? "\",port=\"" : "", port ? port : "") == -1)
 988             psz_chain = NULL;
 989     }
 990     else
 991     {
 992         /* Convert the URL to a basic standard sout chain */
 993         if (asprintf (&psz_chain,
 994                       "standard{mux=\"%s\",access=\"%s\",dst=\"%s\"}",
 995                       mrl.psz_way, mrl.psz_access, mrl.psz_name) == -1)
 996             psz_chain = NULL;
 997     }
 998
 999     /* Duplicate and wrap if sout-display is on */
1000     if (psz_chain && b_sout_display)
1001     {
1002         char *tmp;
1003         if (asprintf (&tmp, "duplicate{dst=display,dst=%s}", psz_chain) == -1)
1004             tmp = NULL;
1005         free (psz_chain);
1006         psz_chain = tmp;
1007     }
1008
1009     mrl_Clean( &mrl );
1010     return psz_chain;
1011 }
1012
1013 #undef sout_EncoderCreate
1014 encoder_t *sout_EncoderCreate( vlc_object_t *p_this, size_t owner_size )
1015 {
1016     assert( owner_size >= sizeof(encoder_t) );
1017     return vlc_custom_create( p_this, owner_size, "encoder" );
1018 }