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"
45 #include <vlc_block.h>
46 #include <vlc_codec.h>
48 #include "input/input_interface.h"
51 /*****************************************************************************
53 *****************************************************************************/
54 #define sout_stream_url_to_chain( p, s ) \
55 _sout_stream_url_to_chain( VLC_OBJECT(p), s )
56 static char *_sout_stream_url_to_chain( vlc_object_t *, const char * );
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 );
75 /*****************************************************************************
76 * sout_NewInstance: creates a new stream output instance
77 *****************************************************************************/
78 sout_instance_t *__sout_NewInstance( vlc_object_t *p_parent, const char *psz_dest )
80 static const char typename[] = "stream output";
81 sout_instance_t *p_sout;
83 /* *** Allocate descriptor *** */
84 p_sout = vlc_custom_create( p_parent, sizeof( *p_sout ),
85 VLC_OBJECT_GENERIC, typename );
89 /* *** init descriptor *** */
90 p_sout->psz_sout = strdup( psz_dest );
91 p_sout->p_meta = NULL;
92 p_sout->i_out_pace_nocontrol = 0;
95 vlc_mutex_init( &p_sout->lock );
96 if( psz_dest && psz_dest[0] == '#' )
98 p_sout->psz_chain = strdup( &psz_dest[1] );
102 p_sout->psz_chain = sout_stream_url_to_chain( p_sout, psz_dest );
103 msg_Dbg( p_sout, "using sout chain=`%s'", p_sout->psz_chain );
105 p_sout->p_stream = NULL;
107 /* attach it for inherit */
108 vlc_object_attach( p_sout, p_parent );
111 var_Create( p_sout, "sout-mux-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
114 p_sout->p_stream = sout_StreamNew( p_sout, p_sout->psz_chain );
115 if( p_sout->p_stream == NULL )
117 msg_Err( p_sout, "stream chain failed for `%s'", p_sout->psz_chain );
119 FREENULL( p_sout->psz_sout );
120 FREENULL( p_sout->psz_chain );
122 vlc_object_detach( p_sout );
123 vlc_object_release( p_sout );
130 /*****************************************************************************
131 * sout_DeleteInstance: delete a previously allocated instance
132 *****************************************************************************/
133 void sout_DeleteInstance( sout_instance_t * p_sout )
135 /* remove the stream out chain */
136 sout_StreamDelete( p_sout->p_stream );
138 /* *** free all string *** */
139 FREENULL( p_sout->psz_sout );
140 FREENULL( p_sout->psz_chain );
145 vlc_meta_Delete( p_sout->p_meta );
148 vlc_mutex_destroy( &p_sout->lock );
150 /* *** free structure *** */
151 vlc_object_release( p_sout );
154 /*****************************************************************************
156 *****************************************************************************/
157 void sout_UpdateStatistic( sout_instance_t *p_sout, sout_statistic_t i_type, int i_delta )
159 if( !libvlc_stats( p_sout ) )
163 input_thread_t *p_input = vlc_object_find( p_sout, VLC_OBJECT_INPUT, FIND_PARENT );
170 case SOUT_STATISTIC_DECODED_VIDEO:
171 i_input_type = SOUT_STATISTIC_DECODED_VIDEO;
173 case SOUT_STATISTIC_DECODED_AUDIO:
174 i_input_type = SOUT_STATISTIC_DECODED_AUDIO;
176 case SOUT_STATISTIC_DECODED_SUBTITLE:
177 i_input_type = SOUT_STATISTIC_DECODED_SUBTITLE;
180 case SOUT_STATISTIC_SENT_PACKET:
181 i_input_type = SOUT_STATISTIC_SENT_PACKET;
184 case SOUT_STATISTIC_SENT_BYTE:
185 i_input_type = SOUT_STATISTIC_SENT_BYTE;
189 msg_Err( p_sout, "Not yet supported statistic type %d", i_type );
190 vlc_object_release( p_input );
194 input_UpdateStatistic( p_input, i_input_type, i_delta );
196 vlc_object_release( p_input );
198 /*****************************************************************************
200 *****************************************************************************/
201 sout_packetizer_input_t *sout_InputNew( sout_instance_t *p_sout,
204 sout_packetizer_input_t *p_input;
206 /* *** create a packetizer input *** */
207 p_input = malloc( sizeof( sout_packetizer_input_t ) );
208 if( !p_input ) return NULL;
209 p_input->p_sout = p_sout;
210 p_input->p_fmt = p_fmt;
212 msg_Dbg( p_sout, "adding a new sout input (sout_input:%p)", p_input );
214 if( p_fmt->i_codec == VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
216 vlc_object_release( p_sout );
220 /* *** add it to the stream chain */
221 vlc_mutex_lock( &p_sout->lock );
222 p_input->id = p_sout->p_stream->pf_add( p_sout->p_stream, p_fmt );
223 vlc_mutex_unlock( &p_sout->lock );
225 if( p_input->id == NULL )
234 /*****************************************************************************
236 *****************************************************************************/
237 int sout_InputDelete( sout_packetizer_input_t *p_input )
239 sout_instance_t *p_sout = p_input->p_sout;
241 msg_Dbg( p_sout, "removing a sout input (sout_input:%p)", p_input );
243 if( p_input->p_fmt->i_codec != VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
245 vlc_mutex_lock( &p_sout->lock );
246 p_sout->p_stream->pf_del( p_sout->p_stream, p_input->id );
247 vlc_mutex_unlock( &p_sout->lock );
252 return( VLC_SUCCESS);
255 /*****************************************************************************
257 *****************************************************************************/
258 int sout_InputSendBuffer( sout_packetizer_input_t *p_input,
261 sout_instance_t *p_sout = p_input->p_sout;
264 if( p_input->p_fmt->i_codec == VLC_FOURCC( 'n', 'u', 'l', 'l' ) )
266 block_Release( p_buffer );
269 if( p_buffer->i_dts <= 0 )
271 msg_Warn( p_sout, "trying to send non-dated packet to stream output!");
272 block_Release( p_buffer );
276 vlc_mutex_lock( &p_sout->lock );
277 i_ret = p_sout->p_stream->pf_send( p_sout->p_stream,
278 p_input->id, p_buffer );
279 vlc_mutex_unlock( &p_sout->lock );
284 #undef sout_AccessOutNew
285 /*****************************************************************************
286 * sout_AccessOutNew: allocate a new access out
287 *****************************************************************************/
288 sout_access_out_t *sout_AccessOutNew( vlc_object_t *p_sout,
289 const char *psz_access, const char *psz_name )
291 static const char typename[] = "access out";
292 sout_access_out_t *p_access;
295 p_access = vlc_custom_create( p_sout, sizeof( *p_access ),
296 VLC_OBJECT_GENERIC, typename );
300 psz_next = config_ChainCreate( &p_access->psz_access, &p_access->p_cfg,
303 p_access->psz_path = strdup( psz_name ? psz_name : "" );
304 p_access->p_sys = NULL;
305 p_access->pf_seek = NULL;
306 p_access->pf_read = NULL;
307 p_access->pf_write = NULL;
308 p_access->pf_control = NULL;
309 p_access->p_module = NULL;
311 p_access->i_writes = 0;
312 p_access->i_sent_bytes = 0;
314 vlc_object_attach( p_access, p_sout );
317 module_need( p_access, "sout access", p_access->psz_access, true );
319 if( !p_access->p_module )
321 free( p_access->psz_access );
322 free( p_access->psz_path );
323 vlc_object_detach( p_access );
324 vlc_object_release( p_access );
330 /*****************************************************************************
331 * sout_AccessDelete: delete an access out
332 *****************************************************************************/
333 void sout_AccessOutDelete( sout_access_out_t *p_access )
335 vlc_object_detach( p_access );
336 if( p_access->p_module )
338 module_unneed( p_access, p_access->p_module );
340 free( p_access->psz_access );
342 config_ChainDestroy( p_access->p_cfg );
344 free( p_access->psz_path );
346 vlc_object_release( p_access );
349 /*****************************************************************************
351 *****************************************************************************/
352 int sout_AccessOutSeek( sout_access_out_t *p_access, off_t i_pos )
354 return p_access->pf_seek( p_access, i_pos );
357 /*****************************************************************************
359 *****************************************************************************/
360 ssize_t sout_AccessOutRead( sout_access_out_t *p_access, block_t *p_buffer )
362 return( p_access->pf_read ?
363 p_access->pf_read( p_access, p_buffer ) : VLC_EGENERIC );
366 /*****************************************************************************
368 *****************************************************************************/
369 ssize_t sout_AccessOutWrite( sout_access_out_t *p_access, block_t *p_buffer )
372 const unsigned i_packets_gather = 30;
373 p_access->i_writes++;
374 p_access->i_sent_bytes += p_buffer->i_buffer;
375 if( (p_access->i_writes % i_packets_gather) == 0 )
377 sout_UpdateStatistic( p_access->p_sout, SOUT_STATISTIC_SENT_PACKET, i_packets_gather );
378 sout_UpdateStatistic( p_access->p_sout, SOUT_STATISTIC_SENT_BYTE, p_access->i_sent_bytes );
379 p_access->i_sent_bytes = 0;
382 return p_access->pf_write( p_access, p_buffer );
386 * sout_AccessOutControl
388 int sout_AccessOutControl (sout_access_out_t *access, int query, ...)
393 va_start (ap, query);
394 if (access->pf_control)
395 ret = access->pf_control (access, query, ap);
402 /*****************************************************************************
403 * sout_MuxNew: create a new mux
404 *****************************************************************************/
405 sout_mux_t * sout_MuxNew( sout_instance_t *p_sout, char *psz_mux,
406 sout_access_out_t *p_access )
408 static const char typename[] = "mux";
412 p_mux = vlc_custom_create( p_sout, sizeof( *p_mux ), VLC_OBJECT_GENERIC,
417 p_mux->p_sout = p_sout;
418 psz_next = config_ChainCreate( &p_mux->psz_mux, &p_mux->p_cfg, psz_mux );
421 p_mux->p_access = p_access;
422 p_mux->pf_control = NULL;
423 p_mux->pf_addstream = NULL;
424 p_mux->pf_delstream = NULL;
425 p_mux->pf_mux = NULL;
426 p_mux->i_nb_inputs = 0;
427 p_mux->pp_inputs = NULL;
430 p_mux->p_module = NULL;
432 p_mux->b_add_stream_any_time = false;
433 p_mux->b_waiting_stream = true;
434 p_mux->i_add_stream_start = -1;
436 vlc_object_attach( p_mux, p_sout );
439 module_need( p_mux, "sout mux", p_mux->psz_mux, true );
441 if( p_mux->p_module == NULL )
443 FREENULL( p_mux->psz_mux );
445 vlc_object_detach( p_mux );
446 vlc_object_release( p_mux );
450 /* *** probe mux capacity *** */
451 if( p_mux->pf_control )
453 int b_answer = false;
455 if( sout_MuxControl( p_mux, MUX_CAN_ADD_STREAM_WHILE_MUXING,
463 msg_Dbg( p_sout, "muxer support adding stream at any time" );
464 p_mux->b_add_stream_any_time = true;
465 p_mux->b_waiting_stream = false;
467 /* If we control the output pace then it's better to wait before
468 * starting muxing (generates better streams/files). */
469 if( !p_sout->i_out_pace_nocontrol )
473 else if( sout_MuxControl( p_mux, MUX_GET_ADD_STREAM_WAIT,
481 msg_Dbg( p_sout, "muxer prefers to wait for all ES before "
483 p_mux->b_waiting_stream = true;
491 /*****************************************************************************
493 *****************************************************************************/
494 void sout_MuxDelete( sout_mux_t *p_mux )
496 vlc_object_detach( p_mux );
497 if( p_mux->p_module )
499 module_unneed( p_mux, p_mux->p_module );
501 free( p_mux->psz_mux );
503 config_ChainDestroy( p_mux->p_cfg );
505 vlc_object_release( p_mux );
508 /*****************************************************************************
510 *****************************************************************************/
511 sout_input_t *sout_MuxAddStream( sout_mux_t *p_mux, es_format_t *p_fmt )
513 sout_input_t *p_input;
515 if( !p_mux->b_add_stream_any_time && !p_mux->b_waiting_stream )
517 msg_Err( p_mux, "cannot add a new stream (unsupported while muxing "
518 "to this format). You can try increasing sout-mux-caching value" );
522 msg_Dbg( p_mux, "adding a new input" );
524 /* create a new sout input */
525 p_input = malloc( sizeof( sout_input_t ) );
528 p_input->p_sout = p_mux->p_sout;
529 p_input->p_fmt = p_fmt;
530 p_input->p_fifo = block_FifoNew();
531 p_input->p_sys = NULL;
533 TAB_APPEND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
534 if( p_mux->pf_addstream( p_mux, p_input ) < 0 )
536 msg_Err( p_mux, "cannot add this stream" );
537 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
538 block_FifoRelease( p_input->p_fifo );
546 /*****************************************************************************
547 * sout_MuxDeleteStream:
548 *****************************************************************************/
549 void sout_MuxDeleteStream( sout_mux_t *p_mux, sout_input_t *p_input )
553 if( p_mux->b_waiting_stream
554 && block_FifoCount( p_input->p_fifo ) > 0 )
556 /* We stop waiting, and call the muxer for taking care of the data
557 * before we remove this es */
558 p_mux->b_waiting_stream = false;
559 p_mux->pf_mux( p_mux );
562 TAB_FIND( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input, i_index );
565 if( p_mux->pf_delstream( p_mux, p_input ) < 0 )
567 msg_Err( p_mux, "cannot delete this stream from mux" );
570 /* remove the entry */
571 TAB_REMOVE( p_mux->i_nb_inputs, p_mux->pp_inputs, p_input );
573 if( p_mux->i_nb_inputs == 0 )
575 msg_Warn( p_mux, "no more input streams for this mux" );
578 block_FifoRelease( p_input->p_fifo );
583 /*****************************************************************************
584 * sout_MuxSendBuffer:
585 *****************************************************************************/
586 void sout_MuxSendBuffer( sout_mux_t *p_mux, sout_input_t *p_input,
589 block_FifoPut( p_input->p_fifo, p_buffer );
591 if( p_mux->p_sout->i_out_pace_nocontrol )
593 mtime_t current_date = mdate();
594 if ( current_date > p_buffer->i_dts )
595 msg_Warn( p_mux, "late buffer for mux input (%"PRId64")",
596 current_date - p_buffer->i_dts );
599 if( p_mux->b_waiting_stream )
601 const int64_t i_caching = var_GetInteger( p_mux->p_sout, "sout-mux-caching" ) * INT64_C(1000);
603 if( p_mux->i_add_stream_start < 0 )
604 p_mux->i_add_stream_start = p_buffer->i_dts;
606 /* Wait until we have enought data before muxing */
607 if( p_mux->i_add_stream_start < 0 ||
608 p_buffer->i_dts < p_mux->i_add_stream_start + i_caching )
610 p_mux->b_waiting_stream = false;
612 p_mux->pf_mux( p_mux );
615 /*****************************************************************************
617 *****************************************************************************/
618 static int mrl_Parse( mrl_t *p_mrl, const char *psz_mrl )
620 char * psz_dup = strdup( psz_mrl );
621 char * psz_parser = psz_dup;
622 const char * psz_access;
623 const char * psz_way;
626 /* *** first parse psz_dest */
627 while( *psz_parser && *psz_parser != ':' )
629 if( *psz_parser == '{' )
631 while( *psz_parser && *psz_parser != '}' )
645 #if defined( WIN32 ) || defined( UNDER_CE )
646 if( psz_parser - psz_dup == 1 )
648 /* msg_Warn( p_sout, "drive letter %c: found in source string",
656 psz_access = psz_way = "";
661 *psz_parser++ = '\0';
663 /* let's skip '//' */
664 if( psz_parser[0] == '/' && psz_parser[1] == '/' )
669 psz_name = psz_parser ;
671 /* Come back to parse the access and mux plug-ins */
672 psz_parser = psz_dup;
679 else if( *psz_parser == '/' )
687 psz_access = psz_parser;
689 while( *psz_parser && *psz_parser != '/' )
691 if( *psz_parser == '{' )
693 while( *psz_parser && *psz_parser != '}' )
708 if( *psz_parser == '/' )
710 *psz_parser++ = '\0';
721 psz_way = psz_parser;
725 p_mrl->psz_access = strdup( psz_access );
726 p_mrl->psz_way = strdup( psz_way );
727 p_mrl->psz_name = strdup( psz_name );
730 return( VLC_SUCCESS );
734 /* mrl_Clean: clean p_mrl after a call to mrl_Parse */
735 static void mrl_Clean( mrl_t *p_mrl )
737 FREENULL( p_mrl->psz_access );
738 FREENULL( p_mrl->psz_way );
739 FREENULL( p_mrl->psz_name );
743 /****************************************************************************
744 ****************************************************************************
748 ****************************************************************************
749 ****************************************************************************/
751 /* create a complete chain */
753 module{option=*:option=*}[:module{option=*:...}]
757 * parse module{options=str, option="str "}:
758 * return a pointer on the rest
759 * XXX: psz_chain is modified
763 * XXX name and p_cfg are used (-> do NOT free them)
765 sout_stream_t *sout_StreamNew( sout_instance_t *p_sout, char *psz_chain )
767 static const char typename[] = "stream out";
768 sout_stream_t *p_stream;
772 msg_Err( p_sout, "invalid chain" );
776 p_stream = vlc_custom_create( p_sout, sizeof( *p_stream ),
777 VLC_OBJECT_GENERIC, typename );
781 p_stream->p_sout = p_sout;
782 p_stream->p_sys = NULL;
785 config_ChainCreate( &p_stream->psz_name, &p_stream->p_cfg, psz_chain);
787 msg_Dbg( p_sout, "stream=`%s'", p_stream->psz_name );
789 vlc_object_attach( p_stream, p_sout );
792 module_need( p_stream, "sout stream", p_stream->psz_name, true );
794 if( !p_stream->p_module )
796 sout_StreamDelete( p_stream );
803 void sout_StreamDelete( sout_stream_t *p_stream )
805 msg_Dbg( p_stream, "destroying chain... (name=%s)", p_stream->psz_name );
807 vlc_object_detach( p_stream );
808 if( p_stream->p_module ) module_unneed( p_stream, p_stream->p_module );
810 FREENULL( p_stream->psz_name );
811 FREENULL( p_stream->psz_next );
813 config_ChainDestroy( p_stream->p_cfg );
815 msg_Dbg( p_stream, "destroying chain done" );
816 vlc_object_release( p_stream );
819 static char *_sout_stream_url_to_chain( vlc_object_t *p_this,
820 const char *psz_url )
825 mrl_Parse( &mrl, psz_url );
827 /* Check if the URLs goes to #rtp - otherwise we'll use #standard */
828 static const char rtplist[] = "dccp\0sctp\0tcp\0udplite\0";
829 for (const char *a = rtplist; *a; a += strlen (a) + 1)
830 if (strcmp (a, mrl.psz_access) == 0)
833 if (strcmp (mrl.psz_access, "rtp") == 0)
836 /* For historical reasons, rtp:// means RTP over UDP */
837 strcpy (mrl.psz_access, "udp");
839 if (mrl.psz_name[0] == '[')
841 port = strstr (mrl.psz_name, "]:");
846 port = strchr (mrl.psz_name, ':');
848 *port++ = '\0'; /* erase ':' */
850 if (asprintf (&psz_chain,
851 "rtp{mux=\"%s\",proto=\"%s\",dst=\"%s%s%s\"}",
852 mrl.psz_way, mrl.psz_access, mrl.psz_name,
853 port ? "\",port=\"" : "", port ? port : "") == -1)
858 /* Convert the URL to a basic standard sout chain */
859 if (asprintf (&psz_chain,
860 "standard{mux=\"%s\",access=\"%s\",dst=\"%s\"}",
861 mrl.psz_way, mrl.psz_access, mrl.psz_name) == -1)
865 /* Duplicate and wrap if sout-display is on */
866 if (psz_chain && (config_GetInt( p_this, "sout-display" ) > 0))
869 if (asprintf (&tmp, "duplicate{dst=display,dst=%s}", tmp) == -1)
879 #undef sout_EncoderCreate
880 encoder_t *sout_EncoderCreate( vlc_object_t *p_this )
882 static const char type[] = "encoder";
883 return vlc_custom_create( p_this, sizeof( encoder_t ), VLC_OBJECT_GENERIC,