1 /*****************************************************************************
2 * stream_output.c : stream output module
3 *****************************************************************************
4 * Copyright (C) 2002-2007 the VideoLAN team
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
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.
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.
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 *****************************************************************************/
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 static const char typename[] = "stream output";
86 sout_instance_t *p_sout;
89 if( psz_dest && psz_dest[0] == '#' )
91 psz_chain = strdup( &psz_dest[1] );
95 psz_chain = sout_stream_url_to_chain(
96 var_InheritBool(p_parent, "sout-display"), psz_dest );
101 /* *** Allocate descriptor *** */
102 p_sout = vlc_custom_create( p_parent, sizeof( *p_sout ),
103 VLC_OBJECT_GENERIC, typename );
107 msg_Dbg( p_sout, "using sout chain=`%s'", psz_chain );
109 /* *** init descriptor *** */
110 p_sout->psz_sout = strdup( psz_dest );
111 p_sout->p_meta = NULL;
112 p_sout->i_out_pace_nocontrol = 0;
113 p_sout->p_sys = NULL;
115 vlc_mutex_init( &p_sout->lock );
116 p_sout->p_stream = NULL;
118 var_Create( p_sout, "sout-mux-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
120 p_sout->p_stream = sout_StreamChainNew( p_sout, psz_chain, NULL, NULL );
121 if( p_sout->p_stream )
127 msg_Err( p_sout, "stream chain failed for `%s'", psz_chain );
130 FREENULL( p_sout->psz_sout );
132 vlc_object_release( p_sout );
136 /*****************************************************************************
137 * sout_DeleteInstance: delete a previously allocated instance
138 *****************************************************************************/
139 void sout_DeleteInstance( sout_instance_t * p_sout )
141 /* remove the stream out chain */
142 sout_StreamChainDelete( p_sout->p_stream, NULL );
144 /* *** free all string *** */
145 FREENULL( p_sout->psz_sout );
150 vlc_meta_Delete( p_sout->p_meta );
153 vlc_mutex_destroy( &p_sout->lock );
155 /* *** free structure *** */
156 vlc_object_release( p_sout );
159 /*****************************************************************************
161 *****************************************************************************/
162 sout_packetizer_input_t *sout_InputNew( sout_instance_t *p_sout,
165 sout_packetizer_input_t *p_input;
167 /* *** create a packetizer input *** */
168 p_input = malloc( sizeof( sout_packetizer_input_t ) );
169 if( !p_input ) return NULL;
170 p_input->p_sout = p_sout;
171 p_input->p_fmt = p_fmt;
173 msg_Dbg( p_sout, "adding a new sout input (sout_input:%p)", p_input );
175 if( p_fmt->i_codec == VLC_CODEC_NULL )
177 vlc_object_release( p_sout );
181 /* *** add it to the stream chain */
182 vlc_mutex_lock( &p_sout->lock );
183 p_input->id = p_sout->p_stream->pf_add( p_sout->p_stream, p_fmt );
184 vlc_mutex_unlock( &p_sout->lock );
186 if( p_input->id == NULL )
195 /*****************************************************************************
197 *****************************************************************************/
198 int sout_InputDelete( sout_packetizer_input_t *p_input )
200 sout_instance_t *p_sout = p_input->p_sout;
202 msg_Dbg( p_sout, "removing a sout input (sout_input:%p)", p_input );
204 if( p_input->p_fmt->i_codec != VLC_CODEC_NULL )
206 vlc_mutex_lock( &p_sout->lock );
207 p_sout->p_stream->pf_del( p_sout->p_stream, p_input->id );
208 vlc_mutex_unlock( &p_sout->lock );
213 return( VLC_SUCCESS);
216 /*****************************************************************************
218 *****************************************************************************/
219 int sout_InputSendBuffer( sout_packetizer_input_t *p_input,
222 sout_instance_t *p_sout = p_input->p_sout;
225 if( p_input->p_fmt->i_codec == VLC_CODEC_NULL )
227 block_Release( p_buffer );
231 if( p_buffer->i_dts <= VLC_TS_INVALID )
233 msg_Warn( p_sout, "trying to send non-dated packet to stream output!");
234 block_Release( p_buffer );
238 vlc_mutex_lock( &p_sout->lock );
239 i_ret = p_sout->p_stream->pf_send( p_sout->p_stream,
240 p_input->id, p_buffer );
241 vlc_mutex_unlock( &p_sout->lock );
246 #undef sout_AccessOutNew
247 /*****************************************************************************
248 * sout_AccessOutNew: allocate a new access out
249 *****************************************************************************/
250 sout_access_out_t *sout_AccessOutNew( vlc_object_t *p_sout,
251 const char *psz_access, const char *psz_name )
253 static const char typename[] = "access out";
254 sout_access_out_t *p_access;
257 p_access = vlc_custom_create( p_sout, sizeof( *p_access ),
258 VLC_OBJECT_GENERIC, typename );
262 psz_next = config_ChainCreate( &p_access->psz_access, &p_access->p_cfg,
265 p_access->psz_path = strdup( psz_name ? psz_name : "" );
266 p_access->p_sys = NULL;
267 p_access->pf_seek = NULL;
268 p_access->pf_read = NULL;
269 p_access->pf_write = NULL;
270 p_access->pf_control = NULL;
271 p_access->p_module = NULL;
273 p_access->i_writes = 0;
274 p_access->i_sent_bytes = 0;
277 module_need( p_access, "sout access", p_access->psz_access, true );
279 if( !p_access->p_module )
281 free( p_access->psz_access );
282 free( p_access->psz_path );
283 vlc_object_release( p_access );
289 /*****************************************************************************
290 * sout_AccessDelete: delete an access out
291 *****************************************************************************/
292 void sout_AccessOutDelete( sout_access_out_t *p_access )
294 if( p_access->p_module )
296 module_unneed( p_access, p_access->p_module );
298 free( p_access->psz_access );
300 config_ChainDestroy( p_access->p_cfg );
302 free( p_access->psz_path );
304 vlc_object_release( p_access );
307 /*****************************************************************************
309 *****************************************************************************/
310 int sout_AccessOutSeek( sout_access_out_t *p_access, off_t i_pos )
312 return p_access->pf_seek( p_access, i_pos );
315 /*****************************************************************************
317 *****************************************************************************/
318 ssize_t sout_AccessOutRead( sout_access_out_t *p_access, block_t *p_buffer )
320 return( p_access->pf_read ?
321 p_access->pf_read( p_access, p_buffer ) : VLC_EGENERIC );
324 /*****************************************************************************
326 *****************************************************************************/
327 ssize_t sout_AccessOutWrite( sout_access_out_t *p_access, block_t *p_buffer )
329 return p_access->pf_write( p_access, p_buffer );
333 * sout_AccessOutControl
335 int sout_AccessOutControl (sout_access_out_t *access, int query, ...)
340 va_start (ap, query);
341 if (access->pf_control)
342 ret = access->pf_control (access, query, ap);
349 /*****************************************************************************
350 * sout_MuxNew: create a new mux
351 *****************************************************************************/
352 sout_mux_t * sout_MuxNew( sout_instance_t *p_sout, const char *psz_mux,
353 sout_access_out_t *p_access )
355 static const char typename[] = "mux";
359 p_mux = vlc_custom_create( p_sout, sizeof( *p_mux ), VLC_OBJECT_GENERIC,
364 p_mux->p_sout = p_sout;
365 psz_next = config_ChainCreate( &p_mux->psz_mux, &p_mux->p_cfg, psz_mux );
368 p_mux->p_access = p_access;
369 p_mux->pf_control = NULL;
370 p_mux->pf_addstream = NULL;
371 p_mux->pf_delstream = NULL;
372 p_mux->pf_mux = NULL;
373 p_mux->i_nb_inputs = 0;
374 p_mux->pp_inputs = NULL;
377 p_mux->p_module = NULL;
379 p_mux->b_add_stream_any_time = false;
380 p_mux->b_waiting_stream = true;
381 p_mux->i_add_stream_start = -1;
384 module_need( p_mux, "sout mux", p_mux->psz_mux, true );
386 if( p_mux->p_module == NULL )
388 FREENULL( p_mux->psz_mux );
390 vlc_object_release( p_mux );
394 /* *** probe mux capacity *** */
395 if( p_mux->pf_control )
397 int b_answer = false;
399 if( sout_MuxControl( p_mux, MUX_CAN_ADD_STREAM_WHILE_MUXING,
407 msg_Dbg( p_sout, "muxer support adding stream at any time" );
408 p_mux->b_add_stream_any_time = true;
409 p_mux->b_waiting_stream = false;
411 /* If we control the output pace then it's better to wait before
412 * starting muxing (generates better streams/files). */
413 if( !p_sout->i_out_pace_nocontrol )
417 else if( sout_MuxControl( p_mux, MUX_GET_ADD_STREAM_WAIT,
425 msg_Dbg( p_sout, "muxer prefers to wait for all ES before "
427 p_mux->b_waiting_stream = true;
435 /*****************************************************************************
437 *****************************************************************************/
438 void sout_MuxDelete( sout_mux_t *p_mux )
440 if( p_mux->p_module )
442 module_unneed( p_mux, p_mux->p_module );
444 free( p_mux->psz_mux );
446 config_ChainDestroy( p_mux->p_cfg );
448 vlc_object_release( p_mux );
451 /*****************************************************************************
453 *****************************************************************************/
454 sout_input_t *sout_MuxAddStream( sout_mux_t *p_mux, es_format_t *p_fmt )
456 sout_input_t *p_input;
458 if( !p_mux->b_add_stream_any_time && !p_mux->b_waiting_stream )
460 msg_Err( p_mux, "cannot add a new stream (unsupported while muxing "
461 "to this format). You can try increasing sout-mux-caching value" );
465 msg_Dbg( p_mux, "adding a new input" );
467 /* create a new sout input */
468 p_input = malloc( sizeof( sout_input_t ) );
471 p_input->p_sout = p_mux->p_sout;
472 p_input->p_fmt = p_fmt;
473 p_input->p_fifo = block_FifoNew();
474 p_input->p_sys = NULL;
476 TAB_APPEND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
477 if( p_mux->pf_addstream( p_mux, p_input ) < 0 )
479 msg_Err( p_mux, "cannot add this stream" );
480 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
481 block_FifoRelease( p_input->p_fifo );
489 /*****************************************************************************
490 * sout_MuxDeleteStream:
491 *****************************************************************************/
492 void sout_MuxDeleteStream( sout_mux_t *p_mux, sout_input_t *p_input )
496 if( p_mux->b_waiting_stream
497 && block_FifoCount( p_input->p_fifo ) > 0 )
499 /* We stop waiting, and call the muxer for taking care of the data
500 * before we remove this es */
501 p_mux->b_waiting_stream = false;
502 p_mux->pf_mux( p_mux );
505 TAB_FIND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input, i_index );
508 if( p_mux->pf_delstream( p_mux, p_input ) < 0 )
510 msg_Err( p_mux, "cannot delete this stream from mux" );
513 /* remove the entry */
514 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
516 if( p_mux->i_nb_inputs == 0 )
518 msg_Warn( p_mux, "no more input streams for this mux" );
521 block_FifoRelease( p_input->p_fifo );
526 /*****************************************************************************
527 * sout_MuxSendBuffer:
528 *****************************************************************************/
529 void sout_MuxSendBuffer( sout_mux_t *p_mux, sout_input_t *p_input,
532 block_FifoPut( p_input->p_fifo, p_buffer );
534 if( p_mux->p_sout->i_out_pace_nocontrol )
536 mtime_t current_date = mdate();
537 if ( current_date > p_buffer->i_dts )
538 msg_Warn( p_mux, "late buffer for mux input (%"PRId64")",
539 current_date - p_buffer->i_dts );
542 if( p_mux->b_waiting_stream )
544 const int64_t i_caching = var_GetInteger( p_mux->p_sout, "sout-mux-caching" ) * INT64_C(1000);
546 if( p_mux->i_add_stream_start < 0 )
547 p_mux->i_add_stream_start = p_buffer->i_dts;
549 /* Wait until we have enought data before muxing */
550 if( p_mux->i_add_stream_start < 0 ||
551 p_buffer->i_dts < p_mux->i_add_stream_start + i_caching )
553 p_mux->b_waiting_stream = false;
555 p_mux->pf_mux( p_mux );
559 /*****************************************************************************
560 * sout_MuxGetStream: find stream to be muxed
561 *****************************************************************************/
562 int sout_MuxGetStream( sout_mux_t *p_mux, int i_blocks, mtime_t *pi_dts )
567 for( int i = 0; i < p_mux->i_nb_inputs; i++ )
569 sout_input_t *p_input = p_mux->pp_inputs[i];
572 if( block_FifoCount( p_input->p_fifo ) < i_blocks )
574 if( p_input->p_fmt->i_cat != SPU_ES )
578 /* FIXME: SPU muxing */
582 p_data = block_FifoShow( p_input->p_fifo );
583 if( i_stream < 0 || p_data->i_dts < i_dts )
586 i_dts = p_data->i_dts;
590 if( pi_dts ) *pi_dts = i_dts;
596 /*****************************************************************************
598 *****************************************************************************/
599 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl )
601 char * psz_dup = strdup( psz_mrl );
602 char * psz_parser = psz_dup;
603 const char * psz_access;
604 const char * psz_way;
607 /* *** first parse psz_dest */
608 while( *psz_parser && *psz_parser != ':' )
610 if( *psz_parser == '{' )
612 while( *psz_parser && *psz_parser != '}' )
626 #if defined( WIN32 ) || defined( UNDER_CE ) || defined( __OS2__ )
627 if( psz_parser - psz_dup == 1 )
629 /* msg_Warn( p_sout, "drive letter %c: found in source string",
637 psz_access = psz_way = "";
642 *psz_parser++ = '\0';
644 /* let's skip '//' */
645 if( psz_parser[0] == '/' && psz_parser[1] == '/' )
650 psz_name = psz_parser ;
652 /* Come back to parse the access and mux plug-ins */
653 psz_parser = psz_dup;
660 else if( *psz_parser == '/' )
668 psz_access = psz_parser;
670 while( *psz_parser && *psz_parser != '/' )
672 if( *psz_parser == '{' )
674 while( *psz_parser && *psz_parser != '}' )
689 if( *psz_parser == '/' )
691 *psz_parser++ = '\0';
702 psz_way = psz_parser;
706 p_mrl->psz_access = strdup( psz_access );
707 p_mrl->psz_way = strdup( psz_way );
708 p_mrl->psz_name = strdup( psz_name );
711 return( VLC_SUCCESS );
715 /* mrl_Clean: clean p_mrl after a call to mrl_Parse */
716 static void mrl_Clean( mrl_t *p_mrl )
718 FREENULL( p_mrl->psz_access );
719 FREENULL( p_mrl->psz_way );
720 FREENULL( p_mrl->psz_name );
724 /****************************************************************************
725 ****************************************************************************
729 ****************************************************************************
730 ****************************************************************************/
732 /* Destroy a "stream_out" module */
733 static void sout_StreamDelete( sout_stream_t *p_stream )
735 msg_Dbg( p_stream, "destroying chain... (name=%s)", p_stream->psz_name );
737 if( p_stream->p_module ) module_unneed( p_stream, p_stream->p_module );
739 FREENULL( p_stream->psz_name );
741 config_ChainDestroy( p_stream->p_cfg );
743 msg_Dbg( p_stream, "destroying chain done" );
744 vlc_object_release( p_stream );
747 /* Destroy a "stream_out" modules chain
749 * p_first is the first module to be destroyed in the chain
750 * p_last is the last module to be destroyed
751 * if NULL, all modules are destroyed
752 * if not NULL, modules following it must be destroyed separately
754 void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *p_last)
756 while(p_first != NULL)
758 sout_stream_t *p_next = p_first->p_next;
760 sout_StreamDelete(p_first);
761 if(p_first == p_last)
767 /* Create a "stream_out" module, which may forward its ES to p_next module */
769 * XXX name and p_cfg are used (-> do NOT free them)
771 static sout_stream_t *sout_StreamNew( sout_instance_t *p_sout, char *psz_name,
772 config_chain_t *p_cfg, sout_stream_t *p_next)
774 static const char typename[] = "stream out";
775 sout_stream_t *p_stream;
779 p_stream = vlc_custom_create( p_sout, sizeof( *p_stream ),
780 VLC_OBJECT_GENERIC, typename );
784 p_stream->p_sout = p_sout;
785 p_stream->p_sys = NULL;
786 p_stream->psz_name = psz_name;
787 p_stream->p_cfg = p_cfg;
788 p_stream->p_next = p_next;
790 msg_Dbg( p_sout, "stream=`%s'", p_stream->psz_name );
793 module_need( p_stream, "sout stream", p_stream->psz_name, true );
795 if( !p_stream->p_module )
797 /* those must be freed by the caller if creation failed */
798 p_stream->psz_name = NULL;
799 p_stream->p_cfg = NULL;
801 sout_StreamDelete( p_stream );
808 /* Creates a complete "stream_out" modules chain
810 * chain format: module1{option=*:option=*}[:module2{option=*:...}]
812 * The modules are created starting from the last one and linked together
813 * A pointer to the last module created is stored if pp_last isn't NULL, to
814 * make sure sout_StreamChainDelete doesn't delete modules created in another
817 * Returns a pointer to the first module.
819 sout_stream_t *sout_StreamChainNew(sout_instance_t *p_sout, char *psz_chain,
820 sout_stream_t *p_next, sout_stream_t **pp_last)
822 if(!psz_chain || !*psz_chain)
824 if(pp_last) *pp_last = NULL;
828 char *psz_parser = strdup(psz_chain);
832 vlc_array_t cfg, name;
833 vlc_array_init(&cfg);
834 vlc_array_init(&name);
839 config_chain_t *p_cfg;
841 psz_chain = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
843 psz_parser = psz_chain;
845 vlc_array_append(&cfg, p_cfg);
846 vlc_array_append(&name, psz_name);
849 int i = vlc_array_count(&name);
851 vlc_array_init(&module);
854 p_next = sout_StreamNew( p_sout, vlc_array_item_at_index(&name, i),
855 vlc_array_item_at_index(&cfg, i), p_next);
860 if(i == vlc_array_count(&name) - 1 && pp_last)
861 *pp_last = p_next; /* last module created in the chain */
863 vlc_array_append(&module, p_next);
866 vlc_array_clear(&name);
867 vlc_array_clear(&cfg);
868 vlc_array_clear(&module);
874 i++; /* last module couldn't be created */
876 /* destroy all modules created, starting with the last one */
877 int modules = vlc_array_count(&module);
879 sout_StreamDelete(vlc_array_item_at_index(&module, modules));
880 vlc_array_clear(&module);
882 /* then destroy all names and config which weren't destroyed by
883 * sout_StreamDelete */
886 free(vlc_array_item_at_index(&name, i));
887 config_ChainDestroy(vlc_array_item_at_index(&cfg, i));
889 vlc_array_clear(&name);
890 vlc_array_clear(&cfg);
895 static char *sout_stream_url_to_chain( bool b_sout_display,
896 const char *psz_url )
901 mrl_Parse( &mrl, psz_url );
903 /* Check if the URLs goes to #rtp - otherwise we'll use #standard */
904 static const char rtplist[] = "dccp\0sctp\0tcp\0udplite\0";
905 for (const char *a = rtplist; *a; a += strlen (a) + 1)
906 if (strcmp (a, mrl.psz_access) == 0)
909 if (strcmp (mrl.psz_access, "rtp") == 0)
912 /* For historical reasons, rtp:// means RTP over UDP */
913 strcpy (mrl.psz_access, "udp");
915 if (mrl.psz_name[0] == '[')
917 port = strstr (mrl.psz_name, "]:");
922 port = strchr (mrl.psz_name, ':');
924 *port++ = '\0'; /* erase ':' */
926 if (asprintf (&psz_chain,
927 "rtp{mux=\"%s\",proto=\"%s\",dst=\"%s%s%s\"}",
928 mrl.psz_way, mrl.psz_access, mrl.psz_name,
929 port ? "\",port=\"" : "", port ? port : "") == -1)
934 /* Convert the URL to a basic standard sout chain */
935 if (asprintf (&psz_chain,
936 "standard{mux=\"%s\",access=\"%s\",dst=\"%s\"}",
937 mrl.psz_way, mrl.psz_access, mrl.psz_name) == -1)
941 /* Duplicate and wrap if sout-display is on */
942 if (psz_chain && b_sout_display)
945 if (asprintf (&tmp, "duplicate{dst=display,dst=%s}", psz_chain) == -1)
955 #undef sout_EncoderCreate
956 encoder_t *sout_EncoderCreate( vlc_object_t *p_this )
958 static const char type[] = "encoder";
959 return vlc_custom_create( p_this, sizeof( encoder_t ), VLC_OBJECT_GENERIC,