1 /*****************************************************************************
2 * stream_output.c : stream output module
3 *****************************************************************************
4 * Copyright (C) 2002-2007 VLC authors and VideoLAN
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * Eric Petit <titer@videolan.org>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 of the License, or
14 * (at your option) any later version.
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 Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
36 #include <vlc_common.h>
38 #include <stdlib.h> /* free() */
39 #include <stdio.h> /* sprintf() */
44 #include "stream_output.h"
47 #include <vlc_block.h>
48 #include <vlc_codec.h>
49 #include <vlc_modules.h>
51 #include "input/input_interface.h"
53 #define VLC_CODEC_NULL VLC_FOURCC( 'n', 'u', 'l', 'l' )
56 /*****************************************************************************
58 *****************************************************************************/
59 static char *sout_stream_url_to_chain( bool, const char * );
73 /* mrl_Parse: parse psz_mrl and fill p_mrl */
74 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl );
75 /* mrl_Clean: clean p_mrl after a call to mrl_Parse */
76 static void mrl_Clean( mrl_t *p_mrl );
78 #undef sout_NewInstance
80 /*****************************************************************************
81 * sout_NewInstance: creates a new stream output instance
82 *****************************************************************************/
83 sout_instance_t *sout_NewInstance( vlc_object_t *p_parent, const char *psz_dest )
85 sout_instance_t *p_sout;
88 if( psz_dest && psz_dest[0] == '#' )
90 psz_chain = strdup( &psz_dest[1] );
94 psz_chain = sout_stream_url_to_chain(
95 var_InheritBool(p_parent, "sout-display"), psz_dest );
100 /* *** Allocate descriptor *** */
101 p_sout = vlc_custom_create( p_parent, sizeof( *p_sout ), "stream output" );
108 msg_Dbg( p_sout, "using sout chain=`%s'", psz_chain );
110 /* *** init descriptor *** */
111 p_sout->psz_sout = strdup( psz_dest );
112 p_sout->i_out_pace_nocontrol = 0;
114 vlc_mutex_init( &p_sout->lock );
115 p_sout->p_stream = NULL;
117 var_Create( p_sout, "sout-mux-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
119 p_sout->p_stream = sout_StreamChainNew( p_sout, psz_chain, NULL, NULL );
120 if( p_sout->p_stream )
126 msg_Err( p_sout, "stream chain failed for `%s'", psz_chain );
129 FREENULL( p_sout->psz_sout );
131 vlc_object_release( p_sout );
135 /*****************************************************************************
136 * sout_DeleteInstance: delete a previously allocated instance
137 *****************************************************************************/
138 void sout_DeleteInstance( sout_instance_t * p_sout )
140 /* remove the stream out chain */
141 sout_StreamChainDelete( p_sout->p_stream, NULL );
143 /* *** free all string *** */
144 FREENULL( p_sout->psz_sout );
146 vlc_mutex_destroy( &p_sout->lock );
148 /* *** free structure *** */
149 vlc_object_release( p_sout );
152 /*****************************************************************************
154 *****************************************************************************/
155 sout_packetizer_input_t *sout_InputNew( sout_instance_t *p_sout,
158 sout_packetizer_input_t *p_input;
160 /* *** create a packetizer input *** */
161 p_input = malloc( sizeof( sout_packetizer_input_t ) );
162 if( !p_input ) return NULL;
163 p_input->p_sout = p_sout;
164 p_input->p_fmt = p_fmt;
166 msg_Dbg( p_sout, "adding a new sout input (sout_input:%p)", p_input );
168 if( p_fmt->i_codec == VLC_CODEC_NULL )
170 vlc_object_release( p_sout );
174 /* *** add it to the stream chain */
175 vlc_mutex_lock( &p_sout->lock );
176 p_input->id = p_sout->p_stream->pf_add( p_sout->p_stream, p_fmt );
177 vlc_mutex_unlock( &p_sout->lock );
179 if( p_input->id == NULL )
188 /*****************************************************************************
190 *****************************************************************************/
191 int sout_InputDelete( sout_packetizer_input_t *p_input )
193 sout_instance_t *p_sout = p_input->p_sout;
195 msg_Dbg( p_sout, "removing a sout input (sout_input:%p)", p_input );
197 if( p_input->p_fmt->i_codec != VLC_CODEC_NULL )
199 vlc_mutex_lock( &p_sout->lock );
200 p_sout->p_stream->pf_del( p_sout->p_stream, p_input->id );
201 vlc_mutex_unlock( &p_sout->lock );
206 return( VLC_SUCCESS);
209 /*****************************************************************************
211 *****************************************************************************/
212 int sout_InputSendBuffer( sout_packetizer_input_t *p_input,
215 sout_instance_t *p_sout = p_input->p_sout;
218 if( p_input->p_fmt->i_codec == VLC_CODEC_NULL )
220 block_Release( p_buffer );
224 if( p_buffer->i_dts <= VLC_TS_INVALID )
226 msg_Warn( p_sout, "trying to send non-dated packet to stream output!");
227 block_Release( p_buffer );
231 vlc_mutex_lock( &p_sout->lock );
232 i_ret = p_sout->p_stream->pf_send( p_sout->p_stream,
233 p_input->id, p_buffer );
234 vlc_mutex_unlock( &p_sout->lock );
239 #undef sout_AccessOutNew
240 /*****************************************************************************
241 * sout_AccessOutNew: allocate a new access out
242 *****************************************************************************/
243 sout_access_out_t *sout_AccessOutNew( vlc_object_t *p_sout,
244 const char *psz_access, const char *psz_name )
246 sout_access_out_t *p_access;
249 p_access = vlc_custom_create( p_sout, sizeof( *p_access ), "access out" );
253 psz_next = config_ChainCreate( &p_access->psz_access, &p_access->p_cfg,
256 p_access->psz_path = strdup( psz_name ? psz_name : "" );
257 p_access->p_sys = NULL;
258 p_access->pf_seek = NULL;
259 p_access->pf_read = NULL;
260 p_access->pf_write = NULL;
261 p_access->pf_control = NULL;
262 p_access->p_module = NULL;
265 module_need( p_access, "sout access", p_access->psz_access, true );
267 if( !p_access->p_module )
269 free( p_access->psz_access );
270 free( p_access->psz_path );
271 vlc_object_release( p_access );
277 /*****************************************************************************
278 * sout_AccessDelete: delete an access out
279 *****************************************************************************/
280 void sout_AccessOutDelete( sout_access_out_t *p_access )
282 if( p_access->p_module )
284 module_unneed( p_access, p_access->p_module );
286 free( p_access->psz_access );
288 config_ChainDestroy( p_access->p_cfg );
290 free( p_access->psz_path );
292 vlc_object_release( p_access );
295 /*****************************************************************************
297 *****************************************************************************/
298 int sout_AccessOutSeek( sout_access_out_t *p_access, off_t i_pos )
300 return p_access->pf_seek( p_access, i_pos );
303 /*****************************************************************************
305 *****************************************************************************/
306 ssize_t sout_AccessOutRead( sout_access_out_t *p_access, block_t *p_buffer )
308 return( p_access->pf_read ?
309 p_access->pf_read( p_access, p_buffer ) : VLC_EGENERIC );
312 /*****************************************************************************
314 *****************************************************************************/
315 ssize_t sout_AccessOutWrite( sout_access_out_t *p_access, block_t *p_buffer )
317 return p_access->pf_write( p_access, p_buffer );
321 * sout_AccessOutControl
323 int sout_AccessOutControl (sout_access_out_t *access, int query, ...)
328 va_start (ap, query);
329 if (access->pf_control)
330 ret = access->pf_control (access, query, ap);
337 /*****************************************************************************
338 * sout_MuxNew: create a new mux
339 *****************************************************************************/
340 sout_mux_t * sout_MuxNew( sout_instance_t *p_sout, const char *psz_mux,
341 sout_access_out_t *p_access )
346 p_mux = vlc_custom_create( p_sout, sizeof( *p_mux ), "mux" );
350 p_mux->p_sout = p_sout;
351 psz_next = config_ChainCreate( &p_mux->psz_mux, &p_mux->p_cfg, psz_mux );
354 p_mux->p_access = p_access;
355 p_mux->pf_control = NULL;
356 p_mux->pf_addstream = NULL;
357 p_mux->pf_delstream = NULL;
358 p_mux->pf_mux = NULL;
359 p_mux->i_nb_inputs = 0;
360 p_mux->pp_inputs = NULL;
363 p_mux->p_module = NULL;
365 p_mux->b_add_stream_any_time = false;
366 p_mux->b_waiting_stream = true;
367 p_mux->i_add_stream_start = -1;
370 module_need( p_mux, "sout mux", p_mux->psz_mux, true );
372 if( p_mux->p_module == NULL )
374 FREENULL( p_mux->psz_mux );
376 vlc_object_release( p_mux );
380 /* *** probe mux capacity *** */
381 if( p_mux->pf_control )
383 int b_answer = false;
385 if( sout_MuxControl( p_mux, MUX_CAN_ADD_STREAM_WHILE_MUXING,
393 msg_Dbg( p_sout, "muxer support adding stream at any time" );
394 p_mux->b_add_stream_any_time = true;
395 p_mux->b_waiting_stream = false;
397 /* If we control the output pace then it's better to wait before
398 * starting muxing (generates better streams/files). */
399 if( !p_sout->i_out_pace_nocontrol )
403 else if( sout_MuxControl( p_mux, MUX_GET_ADD_STREAM_WAIT,
411 msg_Dbg( p_sout, "muxer prefers to wait for all ES before "
413 p_mux->b_waiting_stream = true;
421 /*****************************************************************************
423 *****************************************************************************/
424 void sout_MuxDelete( sout_mux_t *p_mux )
426 if( p_mux->p_module )
428 module_unneed( p_mux, p_mux->p_module );
430 free( p_mux->psz_mux );
432 config_ChainDestroy( p_mux->p_cfg );
434 vlc_object_release( p_mux );
437 /*****************************************************************************
439 *****************************************************************************/
440 sout_input_t *sout_MuxAddStream( sout_mux_t *p_mux, es_format_t *p_fmt )
442 sout_input_t *p_input;
444 if( !p_mux->b_add_stream_any_time && !p_mux->b_waiting_stream )
446 msg_Err( p_mux, "cannot add a new stream (unsupported while muxing "
447 "to this format). You can try increasing sout-mux-caching value" );
451 msg_Dbg( p_mux, "adding a new input" );
453 /* create a new sout input */
454 p_input = malloc( sizeof( sout_input_t ) );
457 p_input->p_fmt = p_fmt;
458 p_input->p_fifo = block_FifoNew();
459 p_input->p_sys = NULL;
461 TAB_APPEND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
462 if( p_mux->pf_addstream( p_mux, p_input ) < 0 )
464 msg_Err( p_mux, "cannot add this stream" );
465 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
466 block_FifoRelease( p_input->p_fifo );
474 /*****************************************************************************
475 * sout_MuxDeleteStream:
476 *****************************************************************************/
477 void sout_MuxDeleteStream( sout_mux_t *p_mux, sout_input_t *p_input )
481 if( p_mux->b_waiting_stream
482 && block_FifoCount( p_input->p_fifo ) > 0 )
484 /* We stop waiting, and call the muxer for taking care of the data
485 * before we remove this es */
486 p_mux->b_waiting_stream = false;
487 p_mux->pf_mux( p_mux );
490 TAB_FIND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input, i_index );
493 if( p_mux->pf_delstream( p_mux, p_input ) < 0 )
495 msg_Err( p_mux, "cannot delete this stream from mux" );
498 /* remove the entry */
499 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
501 if( p_mux->i_nb_inputs == 0 )
503 msg_Warn( p_mux, "no more input streams for this mux" );
506 block_FifoRelease( p_input->p_fifo );
511 /*****************************************************************************
512 * sout_MuxSendBuffer:
513 *****************************************************************************/
514 void sout_MuxSendBuffer( sout_mux_t *p_mux, sout_input_t *p_input,
517 block_FifoPut( p_input->p_fifo, p_buffer );
519 if( p_mux->p_sout->i_out_pace_nocontrol )
521 mtime_t current_date = mdate();
522 if ( current_date > p_buffer->i_dts )
523 msg_Warn( p_mux, "late buffer for mux input (%"PRId64")",
524 current_date - p_buffer->i_dts );
527 if( p_mux->b_waiting_stream )
529 const int64_t i_caching = var_GetInteger( p_mux->p_sout, "sout-mux-caching" ) * INT64_C(1000);
531 if( p_mux->i_add_stream_start < 0 )
532 p_mux->i_add_stream_start = p_buffer->i_dts;
534 /* Wait until we have enought data before muxing */
535 if( p_mux->i_add_stream_start < 0 ||
536 p_buffer->i_dts < p_mux->i_add_stream_start + i_caching )
538 p_mux->b_waiting_stream = false;
540 p_mux->pf_mux( p_mux );
544 /*****************************************************************************
545 * sout_MuxGetStream: find stream to be muxed
546 *****************************************************************************/
547 int sout_MuxGetStream( sout_mux_t *p_mux, int i_blocks, mtime_t *pi_dts )
552 for( int i = 0; i < p_mux->i_nb_inputs; i++ )
554 sout_input_t *p_input = p_mux->pp_inputs[i];
557 if( block_FifoCount( p_input->p_fifo ) < i_blocks )
559 if( p_input->p_fmt->i_cat != SPU_ES )
563 /* FIXME: SPU muxing */
567 p_data = block_FifoShow( p_input->p_fifo );
568 if( i_stream < 0 || p_data->i_dts < i_dts )
571 i_dts = p_data->i_dts;
575 if( pi_dts ) *pi_dts = i_dts;
581 /*****************************************************************************
583 *****************************************************************************/
584 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl )
586 char * psz_dup = strdup( psz_mrl );
587 char * psz_parser = psz_dup;
588 const char * psz_access;
589 const char * psz_way;
592 /* *** first parse psz_dest */
593 while( *psz_parser && *psz_parser != ':' )
595 if( *psz_parser == '{' )
597 while( *psz_parser && *psz_parser != '}' )
611 #if defined( WIN32 ) || defined( __OS2__ )
612 if( psz_parser - psz_dup == 1 )
614 /* msg_Warn( p_sout, "drive letter %c: found in source string",
622 psz_access = psz_way = "";
627 *psz_parser++ = '\0';
629 /* let's skip '//' */
630 if( psz_parser[0] == '/' && psz_parser[1] == '/' )
635 psz_name = psz_parser ;
637 /* Come back to parse the access and mux plug-ins */
638 psz_parser = psz_dup;
645 else if( *psz_parser == '/' )
653 psz_access = psz_parser;
655 while( *psz_parser && *psz_parser != '/' )
657 if( *psz_parser == '{' )
659 while( *psz_parser && *psz_parser != '}' )
674 if( *psz_parser == '/' )
676 *psz_parser++ = '\0';
687 psz_way = psz_parser;
691 p_mrl->psz_access = strdup( psz_access );
692 p_mrl->psz_way = strdup( psz_way );
693 p_mrl->psz_name = strdup( psz_name );
696 return( VLC_SUCCESS );
700 /* mrl_Clean: clean p_mrl after a call to mrl_Parse */
701 static void mrl_Clean( mrl_t *p_mrl )
703 FREENULL( p_mrl->psz_access );
704 FREENULL( p_mrl->psz_way );
705 FREENULL( p_mrl->psz_name );
709 /****************************************************************************
710 ****************************************************************************
714 ****************************************************************************
715 ****************************************************************************/
717 /* Destroy a "stream_out" module */
718 static void sout_StreamDelete( sout_stream_t *p_stream )
720 sout_instance_t *p_sout = (sout_instance_t *)(p_stream->p_parent);
722 msg_Dbg( p_stream, "destroying chain... (name=%s)", p_stream->psz_name );
724 p_sout->i_out_pace_nocontrol -= p_stream->pace_nocontrol;
726 if( p_stream->p_module != NULL )
727 module_unneed( p_stream, p_stream->p_module );
729 FREENULL( p_stream->psz_name );
731 config_ChainDestroy( p_stream->p_cfg );
733 msg_Dbg( p_stream, "destroying chain done" );
734 vlc_object_release( p_stream );
737 /* Destroy a "stream_out" modules chain
739 * p_first is the first module to be destroyed in the chain
740 * p_last is the last module to be destroyed
741 * if NULL, all modules are destroyed
742 * if not NULL, modules following it must be destroyed separately
744 void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *p_last)
746 while(p_first != NULL)
748 sout_stream_t *p_next = p_first->p_next;
750 sout_StreamDelete(p_first);
751 if(p_first == p_last)
757 /* Create a "stream_out" module, which may forward its ES to p_next module */
759 * XXX name and p_cfg are used (-> do NOT free them)
761 static sout_stream_t *sout_StreamNew( sout_instance_t *p_sout, char *psz_name,
762 config_chain_t *p_cfg, sout_stream_t *p_next)
764 sout_stream_t *p_stream;
768 p_stream = vlc_custom_create( p_sout, sizeof( *p_stream ), "stream out" );
772 p_stream->p_sout = p_sout;
773 p_stream->psz_name = psz_name;
774 p_stream->p_cfg = p_cfg;
775 p_stream->p_next = p_next;
776 p_stream->pace_nocontrol = false;
777 p_stream->p_sys = NULL;
779 msg_Dbg( p_sout, "stream=`%s'", p_stream->psz_name );
782 module_need( p_stream, "sout stream", p_stream->psz_name, true );
784 if( !p_stream->p_module )
786 /* those must be freed by the caller if creation failed */
787 p_stream->psz_name = NULL;
788 p_stream->p_cfg = NULL;
790 sout_StreamDelete( p_stream );
794 p_sout->i_out_pace_nocontrol += p_stream->pace_nocontrol;
798 /* Creates a complete "stream_out" modules chain
800 * chain format: module1{option=*:option=*}[:module2{option=*:...}]
802 * The modules are created starting from the last one and linked together
803 * A pointer to the last module created is stored if pp_last isn't NULL, to
804 * make sure sout_StreamChainDelete doesn't delete modules created in another
807 * Returns a pointer to the first module.
809 sout_stream_t *sout_StreamChainNew(sout_instance_t *p_sout, char *psz_chain,
810 sout_stream_t *p_next, sout_stream_t **pp_last)
812 if(!psz_chain || !*psz_chain)
814 if(pp_last) *pp_last = NULL;
818 char *psz_parser = strdup(psz_chain);
822 vlc_array_t cfg, name;
823 vlc_array_init(&cfg);
824 vlc_array_init(&name);
829 config_chain_t *p_cfg;
831 psz_chain = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
833 psz_parser = psz_chain;
835 vlc_array_append(&cfg, p_cfg);
836 vlc_array_append(&name, psz_name);
839 int i = vlc_array_count(&name);
841 vlc_array_init(&module);
844 p_next = sout_StreamNew( p_sout, vlc_array_item_at_index(&name, i),
845 vlc_array_item_at_index(&cfg, i), p_next);
850 if(i == vlc_array_count(&name) - 1 && pp_last)
851 *pp_last = p_next; /* last module created in the chain */
853 vlc_array_append(&module, p_next);
856 vlc_array_clear(&name);
857 vlc_array_clear(&cfg);
858 vlc_array_clear(&module);
864 i++; /* last module couldn't be created */
866 /* destroy all modules created, starting with the last one */
867 int modules = vlc_array_count(&module);
869 sout_StreamDelete(vlc_array_item_at_index(&module, modules));
870 vlc_array_clear(&module);
872 /* then destroy all names and config which weren't destroyed by
873 * sout_StreamDelete */
876 free(vlc_array_item_at_index(&name, i));
877 config_ChainDestroy(vlc_array_item_at_index(&cfg, i));
879 vlc_array_clear(&name);
880 vlc_array_clear(&cfg);
885 static char *sout_stream_url_to_chain( bool b_sout_display,
886 const char *psz_url )
891 mrl_Parse( &mrl, psz_url );
893 /* Check if the URLs goes to #rtp - otherwise we'll use #standard */
894 static const char rtplist[] = "dccp\0sctp\0tcp\0udplite\0";
895 for (const char *a = rtplist; *a; a += strlen (a) + 1)
896 if (strcmp (a, mrl.psz_access) == 0)
899 if (strcmp (mrl.psz_access, "rtp") == 0)
902 /* For historical reasons, rtp:// means RTP over UDP */
903 strcpy (mrl.psz_access, "udp");
905 if (mrl.psz_name[0] == '[')
907 port = strstr (mrl.psz_name, "]:");
912 port = strchr (mrl.psz_name, ':');
914 *port++ = '\0'; /* erase ':' */
916 if (asprintf (&psz_chain,
917 "rtp{mux=\"%s\",proto=\"%s\",dst=\"%s%s%s\"}",
918 mrl.psz_way, mrl.psz_access, mrl.psz_name,
919 port ? "\",port=\"" : "", port ? port : "") == -1)
924 /* Convert the URL to a basic standard sout chain */
925 if (asprintf (&psz_chain,
926 "standard{mux=\"%s\",access=\"%s\",dst=\"%s\"}",
927 mrl.psz_way, mrl.psz_access, mrl.psz_name) == -1)
931 /* Duplicate and wrap if sout-display is on */
932 if (psz_chain && b_sout_display)
935 if (asprintf (&tmp, "duplicate{dst=display,dst=%s}", psz_chain) == -1)
945 #undef sout_EncoderCreate
946 encoder_t *sout_EncoderCreate( vlc_object_t *p_this )
948 return vlc_custom_create( p_this, sizeof( encoder_t ), "encoder" );