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 *****************************************************************************/
34 #include <vlc_common.h>
36 #include <stdlib.h> /* free() */
37 #include <stdio.h> /* sprintf() */
42 #include "stream_output.h"
46 #include "input/input_internal.h"
49 /*****************************************************************************
51 *****************************************************************************/
52 #define sout_stream_url_to_chain( p, s ) \
53 _sout_stream_url_to_chain( VLC_OBJECT(p), s )
54 static char *_sout_stream_url_to_chain( vlc_object_t *, const char * );
68 /* mrl_Parse: parse psz_mrl and fill p_mrl */
69 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl );
70 /* mrl_Clean: clean p_mrl after a call to mrl_Parse */
71 static void mrl_Clean( mrl_t *p_mrl );
73 /*****************************************************************************
74 * sout_NewInstance: creates a new stream output instance
75 *****************************************************************************/
76 sout_instance_t *__sout_NewInstance( vlc_object_t *p_parent, char * psz_dest )
78 static const char typename[] = "stream output";
79 sout_instance_t *p_sout;
81 /* *** Allocate descriptor *** */
82 p_sout = vlc_custom_create( p_parent, sizeof( *p_sout ),
83 VLC_OBJECT_GENERIC, typename );
87 /* *** init descriptor *** */
88 p_sout->psz_sout = strdup( psz_dest );
89 p_sout->p_meta = NULL;
90 p_sout->i_out_pace_nocontrol = 0;
93 vlc_mutex_init( &p_sout->lock );
94 if( psz_dest && psz_dest[0] == '#' )
96 p_sout->psz_chain = strdup( &psz_dest[1] );
100 p_sout->psz_chain = sout_stream_url_to_chain( p_sout, psz_dest );
101 msg_Dbg( p_sout, "using sout chain=`%s'", p_sout->psz_chain );
103 p_sout->p_stream = NULL;
105 /* attach it for inherit */
106 vlc_object_attach( p_sout, p_parent );
109 var_Create( p_sout, "sout-mux-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
112 p_sout->p_stream = sout_StreamNew( p_sout, p_sout->psz_chain );
113 if( p_sout->p_stream == NULL )
115 msg_Err( p_sout, "stream chain failed for `%s'", p_sout->psz_chain );
117 FREENULL( p_sout->psz_sout );
118 FREENULL( p_sout->psz_chain );
120 vlc_object_detach( p_sout );
121 vlc_object_release( p_sout );
128 /*****************************************************************************
129 * sout_DeleteInstance: delete a previously allocated instance
130 *****************************************************************************/
131 void sout_DeleteInstance( sout_instance_t * p_sout )
133 /* remove the stream out chain */
134 sout_StreamDelete( p_sout->p_stream );
136 /* *** free all string *** */
137 FREENULL( p_sout->psz_sout );
138 FREENULL( p_sout->psz_chain );
143 vlc_meta_Delete( p_sout->p_meta );
146 vlc_mutex_destroy( &p_sout->lock );
148 /* *** free structure *** */
149 vlc_object_release( p_sout );
152 /*****************************************************************************
154 *****************************************************************************/
155 void sout_UpdateStatistic( sout_instance_t *p_sout, sout_statistic_t i_type, int i_delta )
157 input_thread_t *p_input;
158 int i_bytes; /* That's pretty stupid to define it as an integer, it will overflow
161 if( !libvlc_stats (p_sout) )
165 * TODO add a private (ie not VLC_EXPORTed) input_UpdateStatistic for that */
166 p_input = vlc_object_find( p_sout, VLC_OBJECT_INPUT, FIND_PARENT );
167 if( !p_input || p_input->i_state == INIT_S || p_input->i_state == ERROR_S )
172 #define I(c) stats_UpdateInteger( p_input, p_input->p->counters.c, i_delta, NULL )
173 case SOUT_STATISTIC_DECODED_VIDEO:
176 case SOUT_STATISTIC_DECODED_AUDIO:
179 case SOUT_STATISTIC_DECODED_SUBTITLE:
183 case SOUT_STATISTIC_ENCODED_VIDEO:
184 case SOUT_STATISTIC_ENCODED_AUDIO:
185 case SOUT_STATISTIC_ENCODED_SUBTITLE:
186 msg_Warn( p_sout, "Not yet supported statistic type %d", i_type );
190 case SOUT_STATISTIC_SENT_PACKET:
191 I(p_sout_sent_packets);
194 case SOUT_STATISTIC_SENT_BYTE:
195 if( !stats_UpdateInteger( p_input, p_input->p->counters.p_sout_sent_bytes, i_delta, &i_bytes ) )
196 stats_UpdateFloat( p_input, p_input->p->counters.p_sout_send_bitrate, i_bytes, NULL );
200 msg_Err( p_sout, "Invalid statistic type %d (internal error)", i_type );
203 vlc_object_release( p_input );
205 /*****************************************************************************
207 *****************************************************************************/
208 sout_packetizer_input_t *sout_InputNew( sout_instance_t *p_sout,
211 sout_packetizer_input_t *p_input;
213 /* *** create a packetizer input *** */
214 p_input = malloc( sizeof( sout_packetizer_input_t ) );
215 if( !p_input ) return NULL;
216 p_input->p_sout = p_sout;
217 p_input->p_fmt = p_fmt;
219 msg_Dbg( p_sout, "adding a new sout input (sout_input:%p)", p_input );
221 if( p_fmt->i_codec == VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
223 vlc_object_release( p_sout );
227 /* *** add it to the stream chain */
228 vlc_mutex_lock( &p_sout->lock );
229 p_input->id = p_sout->p_stream->pf_add( p_sout->p_stream, p_fmt );
230 vlc_mutex_unlock( &p_sout->lock );
232 if( p_input->id == NULL )
241 /*****************************************************************************
243 *****************************************************************************/
244 int sout_InputDelete( sout_packetizer_input_t *p_input )
246 sout_instance_t *p_sout = p_input->p_sout;
248 msg_Dbg( p_sout, "removing a sout input (sout_input:%p)", p_input );
250 if( p_input->p_fmt->i_codec != VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
252 vlc_mutex_lock( &p_sout->lock );
253 p_sout->p_stream->pf_del( p_sout->p_stream, p_input->id );
254 vlc_mutex_unlock( &p_sout->lock );
259 return( VLC_SUCCESS);
262 /*****************************************************************************
264 *****************************************************************************/
265 int sout_InputSendBuffer( sout_packetizer_input_t *p_input,
268 sout_instance_t *p_sout = p_input->p_sout;
271 if( p_input->p_fmt->i_codec == VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
273 block_Release( p_buffer );
276 if( p_buffer->i_dts <= 0 )
278 msg_Warn( p_sout, "trying to send non-dated packet to stream output!");
279 block_Release( p_buffer );
283 vlc_mutex_lock( &p_sout->lock );
284 i_ret = p_sout->p_stream->pf_send( p_sout->p_stream,
285 p_input->id, p_buffer );
286 vlc_mutex_unlock( &p_sout->lock );
291 /*****************************************************************************
292 * sout_AccessOutNew: allocate a new access out
293 *****************************************************************************/
294 sout_access_out_t *sout_AccessOutNew( sout_instance_t *p_sout,
295 const char *psz_access, const char *psz_name )
297 sout_access_out_t *p_access;
300 if( !( p_access = vlc_object_create( p_sout,
301 sizeof( sout_access_out_t ) ) ) )
303 msg_Err( p_sout, "out of memory" );
307 psz_next = config_ChainCreate( &p_access->psz_access, &p_access->p_cfg,
310 p_access->psz_path = strdup( psz_name ? psz_name : "" );
311 p_access->p_sout = p_sout;
312 p_access->p_sys = NULL;
313 p_access->pf_seek = NULL;
314 p_access->pf_read = NULL;
315 p_access->pf_write = NULL;
316 p_access->pf_control = NULL;
317 p_access->p_module = NULL;
319 p_access->i_writes = 0;
320 p_access->i_sent_bytes = 0;
322 vlc_object_attach( p_access, p_sout );
325 module_Need( p_access, "sout access", p_access->psz_access, true );
327 if( !p_access->p_module )
329 free( p_access->psz_access );
330 free( p_access->psz_path );
331 vlc_object_detach( p_access );
332 vlc_object_release( p_access );
338 /*****************************************************************************
339 * sout_AccessDelete: delete an access out
340 *****************************************************************************/
341 void sout_AccessOutDelete( sout_access_out_t *p_access )
343 vlc_object_detach( p_access );
344 if( p_access->p_module )
346 module_Unneed( p_access, p_access->p_module );
348 free( p_access->psz_access );
350 config_ChainDestroy( p_access->p_cfg );
352 free( p_access->psz_path );
354 vlc_object_release( p_access );
357 /*****************************************************************************
359 *****************************************************************************/
360 int sout_AccessOutSeek( sout_access_out_t *p_access, off_t i_pos )
362 return p_access->pf_seek( p_access, i_pos );
365 /*****************************************************************************
367 *****************************************************************************/
368 ssize_t sout_AccessOutRead( sout_access_out_t *p_access, block_t *p_buffer )
370 return( p_access->pf_read ?
371 p_access->pf_read( p_access, p_buffer ) : VLC_EGENERIC );
374 /*****************************************************************************
376 *****************************************************************************/
377 ssize_t sout_AccessOutWrite( sout_access_out_t *p_access, block_t *p_buffer )
379 const unsigned i_packets_gather = 30;
380 p_access->i_writes++;
381 p_access->i_sent_bytes += p_buffer->i_buffer;
382 if( (p_access->i_writes % i_packets_gather) == 0 )
384 sout_UpdateStatistic( p_access->p_sout, SOUT_STATISTIC_SENT_PACKET, i_packets_gather );
385 sout_UpdateStatistic( p_access->p_sout, SOUT_STATISTIC_SENT_BYTE, p_access->i_sent_bytes );
386 p_access->i_sent_bytes = 0;
388 return p_access->pf_write( p_access, p_buffer );
392 * sout_AccessOutControl
394 int sout_AccessOutControl (sout_access_out_t *access, int query, va_list args)
396 return (access->pf_control) ? access->pf_control (access, query, args)
400 /*****************************************************************************
401 * sout_MuxNew: create a new mux
402 *****************************************************************************/
403 sout_mux_t * sout_MuxNew( sout_instance_t *p_sout, char *psz_mux,
404 sout_access_out_t *p_access )
409 p_mux = vlc_object_create( p_sout, sizeof( sout_mux_t ) );
412 msg_Err( p_sout, "out of memory" );
416 p_mux->p_sout = p_sout;
417 psz_next = config_ChainCreate( &p_mux->psz_mux, &p_mux->p_cfg, psz_mux );
420 p_mux->p_access = p_access;
421 p_mux->pf_control = NULL;
422 p_mux->pf_addstream = NULL;
423 p_mux->pf_delstream = NULL;
424 p_mux->pf_mux = NULL;
425 p_mux->i_nb_inputs = 0;
426 p_mux->pp_inputs = NULL;
429 p_mux->p_module = NULL;
431 p_mux->b_add_stream_any_time = false;
432 p_mux->b_waiting_stream = true;
433 p_mux->i_add_stream_start = -1;
435 vlc_object_attach( p_mux, p_sout );
438 module_Need( p_mux, "sout mux", p_mux->psz_mux, true );
440 if( p_mux->p_module == NULL )
442 FREENULL( p_mux->psz_mux );
444 vlc_object_detach( p_mux );
445 vlc_object_release( p_mux );
449 /* *** probe mux capacity *** */
450 if( p_mux->pf_control )
452 int b_answer = false;
454 if( sout_MuxControl( p_mux, MUX_CAN_ADD_STREAM_WHILE_MUXING,
462 msg_Dbg( p_sout, "muxer support adding stream at any time" );
463 p_mux->b_add_stream_any_time = true;
464 p_mux->b_waiting_stream = false;
466 /* If we control the output pace then it's better to wait before
467 * starting muxing (generates better streams/files). */
468 if( !p_sout->i_out_pace_nocontrol )
472 else if( sout_MuxControl( p_mux, MUX_GET_ADD_STREAM_WAIT,
480 msg_Dbg( p_sout, "muxer prefers to wait for all ES before "
482 p_mux->b_waiting_stream = true;
490 /*****************************************************************************
492 *****************************************************************************/
493 void sout_MuxDelete( sout_mux_t *p_mux )
495 vlc_object_detach( p_mux );
496 if( p_mux->p_module )
498 module_Unneed( p_mux, p_mux->p_module );
500 free( p_mux->psz_mux );
502 config_ChainDestroy( p_mux->p_cfg );
504 vlc_object_release( p_mux );
507 /*****************************************************************************
509 *****************************************************************************/
510 sout_input_t *sout_MuxAddStream( sout_mux_t *p_mux, es_format_t *p_fmt )
512 sout_input_t *p_input;
514 if( !p_mux->b_add_stream_any_time && !p_mux->b_waiting_stream )
516 msg_Err( p_mux, "cannot add a new stream (unsupported while muxing "
517 "to this format). You can try increasing sout-mux-caching value" );
521 msg_Dbg( p_mux, "adding a new input" );
523 /* create a new sout input */
524 p_input = malloc( sizeof( sout_input_t ) );
527 msg_Err( p_mux, "out of memory" );
530 p_input->p_sout = p_mux->p_sout;
531 p_input->p_fmt = p_fmt;
532 p_input->p_fifo = block_FifoNew();
533 p_input->p_sys = NULL;
535 TAB_APPEND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
536 if( p_mux->pf_addstream( p_mux, p_input ) < 0 )
538 msg_Err( p_mux, "cannot add this stream" );
539 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
540 block_FifoRelease( p_input->p_fifo );
548 /*****************************************************************************
549 * sout_MuxDeleteStream:
550 *****************************************************************************/
551 void sout_MuxDeleteStream( sout_mux_t *p_mux, sout_input_t *p_input )
555 if( p_mux->b_waiting_stream
556 && block_FifoCount( p_input->p_fifo ) > 0 )
558 /* We stop waiting, and call the muxer for taking care of the data
559 * before we remove this es */
560 p_mux->b_waiting_stream = false;
561 p_mux->pf_mux( p_mux );
564 TAB_FIND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input, i_index );
567 if( p_mux->pf_delstream( p_mux, p_input ) < 0 )
569 msg_Err( p_mux, "cannot delete this stream from mux" );
572 /* remove the entry */
573 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
575 if( p_mux->i_nb_inputs == 0 )
577 msg_Warn( p_mux, "no more input streams for this mux" );
580 block_FifoRelease( p_input->p_fifo );
585 /*****************************************************************************
586 * sout_MuxSendBuffer:
587 *****************************************************************************/
588 void sout_MuxSendBuffer( sout_mux_t *p_mux, sout_input_t *p_input,
591 block_FifoPut( p_input->p_fifo, p_buffer );
593 if( p_mux->p_sout->i_out_pace_nocontrol )
595 mtime_t current_date = mdate();
596 if ( current_date > p_buffer->i_dts )
597 msg_Warn( p_mux, "late buffer for mux input (%"PRId64")",
598 current_date - p_buffer->i_dts );
601 if( p_mux->b_waiting_stream )
603 const int64_t i_caching = var_GetInteger( p_mux->p_sout, "sout-mux-caching" ) * INT64_C(1000);
605 if( p_mux->i_add_stream_start < 0 )
606 p_mux->i_add_stream_start = p_buffer->i_dts;
608 /* Wait until we have enought data before muxing */
609 if( p_mux->i_add_stream_start < 0 ||
610 p_buffer->i_dts < p_mux->i_add_stream_start + i_caching )
612 p_mux->b_waiting_stream = false;
614 p_mux->pf_mux( p_mux );
617 /*****************************************************************************
619 *****************************************************************************/
620 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl )
622 char * psz_dup = strdup( psz_mrl );
623 char * psz_parser = psz_dup;
624 const char * psz_access;
625 const char * psz_way;
628 /* *** first parse psz_dest */
629 while( *psz_parser && *psz_parser != ':' )
631 if( *psz_parser == '{' )
633 while( *psz_parser && *psz_parser != '}' )
647 #if defined( WIN32 ) || defined( UNDER_CE )
648 if( psz_parser - psz_dup == 1 )
650 /* msg_Warn( p_sout, "drive letter %c: found in source string",
658 psz_access = psz_way = "";
663 *psz_parser++ = '\0';
665 /* let's skip '//' */
666 if( psz_parser[0] == '/' && psz_parser[1] == '/' )
671 psz_name = psz_parser ;
673 /* Come back to parse the access and mux plug-ins */
674 psz_parser = psz_dup;
681 else if( *psz_parser == '/' )
689 psz_access = psz_parser;
691 while( *psz_parser && *psz_parser != '/' )
693 if( *psz_parser == '{' )
695 while( *psz_parser && *psz_parser != '}' )
710 if( *psz_parser == '/' )
712 *psz_parser++ = '\0';
723 psz_way = psz_parser;
727 p_mrl->psz_access = strdup( psz_access );
728 p_mrl->psz_way = strdup( psz_way );
729 p_mrl->psz_name = strdup( psz_name );
732 return( VLC_SUCCESS );
736 /* mrl_Clean: clean p_mrl after a call to mrl_Parse */
737 static void mrl_Clean( mrl_t *p_mrl )
739 FREENULL( p_mrl->psz_access );
740 FREENULL( p_mrl->psz_way );
741 FREENULL( p_mrl->psz_name );
745 /****************************************************************************
746 ****************************************************************************
750 ****************************************************************************
751 ****************************************************************************/
753 /* create a complete chain */
755 module{option=*:option=*}[:module{option=*:...}]
759 * parse module{options=str, option="str "}:
760 * return a pointer on the rest
761 * XXX: psz_chain is modified
765 * XXX name and p_cfg are used (-> do NOT free them)
767 sout_stream_t *sout_StreamNew( sout_instance_t *p_sout, char *psz_chain )
769 sout_stream_t *p_stream;
773 msg_Err( p_sout, "invalid chain" );
777 p_stream = vlc_object_create( p_sout, sizeof( sout_stream_t ) );
781 msg_Err( p_sout, "out of memory" );
785 p_stream->p_sout = p_sout;
786 p_stream->p_sys = NULL;
789 config_ChainCreate( &p_stream->psz_name, &p_stream->p_cfg, psz_chain);
791 msg_Dbg( p_sout, "stream=`%s'", p_stream->psz_name );
793 vlc_object_attach( p_stream, p_sout );
796 module_Need( p_stream, "sout stream", p_stream->psz_name, true );
798 if( !p_stream->p_module )
800 sout_StreamDelete( p_stream );
807 void sout_StreamDelete( sout_stream_t *p_stream )
809 msg_Dbg( p_stream, "destroying chain... (name=%s)", p_stream->psz_name );
811 vlc_object_detach( p_stream );
812 if( p_stream->p_module ) module_Unneed( p_stream, p_stream->p_module );
814 FREENULL( p_stream->psz_name );
815 FREENULL( p_stream->psz_next );
817 config_ChainDestroy( p_stream->p_cfg );
819 msg_Dbg( p_stream, "destroying chain done" );
820 vlc_object_release( p_stream );
823 static char *_sout_stream_url_to_chain( vlc_object_t *p_this,
824 const char *psz_url )
828 const char *fmt = "standard{mux=\"%s\",access=\"%s\",dst=\"%s\"}";
829 static const char rtpfmt[] = "rtp{mux=\"%s\",proto=\"%s\",dst=\"%s\"}";
831 mrl_Parse( &mrl, psz_url );
833 /* Check if the URLs goes #rtp - otherwise we'll use #standard */
834 if (strcmp (mrl.psz_access, "rtp") == 0)
836 /* For historical reasons, rtp:// means RTP over UDP */
837 strcpy (mrl.psz_access, "udp");
842 static const char list[] = "dccp\0sctp\0tcp\0udplite\0";
843 for (const char *a = list; *a; a += strlen (a) + 1)
844 if (strcmp (a, mrl.psz_access) == 0)
851 /* Convert the URL to a basic sout chain */
852 if (asprintf (&psz_chain, fmt,
853 mrl.psz_way, mrl.psz_access, mrl.psz_name) == -1)
856 /* Duplicate and wrap if sout-display is on */
857 if (psz_chain && (config_GetInt( p_this, "sout-display" ) > 0))
860 if (asprintf (&tmp, "duplicate{dst=display,dst=%s}", tmp) == -1)