1 /*****************************************************************************
2 * smem.c: stream output to memory buffer module
3 *****************************************************************************
4 * Copyright (C) 2009 the VideoLAN team
7 * Authors: Christophe Courtaut <christophe.courtaut@gmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************
28 * You should use this module in combination with the transcode module, to get
29 * raw datas from it. This module does not make any conversion at all, so you
30 * need to use the transcode module for this purpose.
32 * For example, you can use smem as it :
33 * --sout="#transcode{vcodec=RV24,acodec=s16l}:smem{smem-options}"
35 * Into each lock function (audio and video), you will have all the informations
36 * you need to allocate a buffer, so that this module will copy data in it.
38 * the video-data and audio-data pointers will be passed to lock/unlock function
40 * For now, audio is NOT IMPLEMENTED.
42 ******************************************************************************/
44 /*****************************************************************************
46 *****************************************************************************/
52 #include <vlc_common.h>
53 #include <vlc_plugin.h>
55 #include <vlc_block.h>
56 #include <vlc_codec.h>
58 /*****************************************************************************
60 *****************************************************************************/
62 #define T_VIDEO_PRERENDER_CALLBACK N_( "Video prerender callback" )
63 #define LT_VIDEO_PRERENDER_CALLBACK N_( "Address of the video prerender callback function" \
64 "this function will set the buffer where render will be done" )
66 #define T_AUDIO_PRERENDER_CALLBACK N_( "Audio prerender callback" )
67 #define LT_AUDIO_PRERENDER_CALLBACK N_( "Address of the audio prerender callback function." \
68 "this function will set the buffer where render will be done" )
70 #define T_VIDEO_POSTRENDER_CALLBACK N_( "Video postrender callback" )
71 #define LT_VIDEO_POSTRENDER_CALLBACK N_( "Address of the video postrender callback function." \
72 "this function will be called when the render is into the buffer" )
74 #define T_AUDIO_POSTRENDER_CALLBACK N_( "Audio postrender callback" )
75 #define LT_AUDIO_POSTRENDER_CALLBACK N_( "Address of the audio postrender callback function." \
76 "this function will be called when the render is into the buffer" )
78 #define T_VIDEO_DATA N_( "Video Callback data" )
79 #define LT_VIDEO_DATA N_( "Data for the video callback function." )
81 #define T_AUDIO_DATA N_( "Audio callback data" )
82 #define LT_AUDIO_DATA N_( "Data for the audio callback function." )
84 #define T_TIME_SYNC N_( "Time Synchronized output" )
85 #define LT_TIME_SYNC N_( "Time Synchronisation option for output. " \
86 "If true, stream will render as usual, else " \
87 "it will be rendered as fast as possible.")
89 static int Open ( vlc_object_t * );
90 static void Close( vlc_object_t * );
92 #define SOUT_CFG_PREFIX "sout-smem-"
93 #define SOUT_PREFIX_VIDEO SOUT_CFG_PREFIX"video-"
94 #define SOUT_PREFIX_AUDIO SOUT_CFG_PREFIX"audio-"
97 set_shortname( N_("smem"))
98 set_description( N_("Stream output to memory buffer") )
99 set_capability( "sout stream", 50 )
100 add_shortcut( "smem" )
101 set_category( CAT_SOUT )
102 set_subcategory( SUBCAT_SOUT_STREAM )
103 add_string( SOUT_PREFIX_VIDEO "prerender-callback", "0", NULL, T_VIDEO_PRERENDER_CALLBACK, LT_VIDEO_PRERENDER_CALLBACK, true )
104 add_string( SOUT_PREFIX_AUDIO "prerender-callback", "0", NULL, T_AUDIO_PRERENDER_CALLBACK, LT_AUDIO_PRERENDER_CALLBACK, true )
105 add_string( SOUT_PREFIX_VIDEO "postrender-callback", "0", NULL, T_VIDEO_POSTRENDER_CALLBACK, LT_VIDEO_POSTRENDER_CALLBACK, true )
106 add_string( SOUT_PREFIX_AUDIO "postrender-callback", "0", NULL, T_AUDIO_POSTRENDER_CALLBACK, LT_AUDIO_POSTRENDER_CALLBACK, true )
107 add_string( SOUT_PREFIX_VIDEO "data", "0", NULL, T_VIDEO_DATA, LT_VIDEO_DATA, true )
108 add_string( SOUT_PREFIX_AUDIO "data", "0", NULL, T_AUDIO_DATA, LT_VIDEO_DATA, true )
109 add_bool( SOUT_CFG_PREFIX "time-sync", true, NULL, T_TIME_SYNC, LT_TIME_SYNC, true );
110 set_callbacks( Open, Close )
114 /*****************************************************************************
115 * Exported prototypes
116 *****************************************************************************/
117 static const char *const ppsz_sout_options[] = {
118 "video-prerender-callback", "audio-prerender-callback",
119 "video-postrender-callback", "audio-postrender-callback", "video-data", "audio-data", "time-sync", NULL
122 static sout_stream_id_t *Add ( sout_stream_t *, es_format_t * );
123 static int Del ( sout_stream_t *, sout_stream_id_t * );
124 static int Send( sout_stream_t *, sout_stream_id_t *, block_t* );
126 static sout_stream_id_t *AddVideo( sout_stream_t *p_stream, es_format_t *p_fmt );
127 static sout_stream_id_t *AddAudio( sout_stream_t *p_stream, es_format_t *p_fmt );
129 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_t *id,
131 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_t *id,
134 struct sout_stream_id_t
140 struct sout_stream_sys_t
143 void ( *pf_video_prerender_callback ) ( void* p_video_data, uint8_t** pp_pixel_buffer , int size );
144 void ( *pf_audio_prerender_callback ) ( void* p_audio_data, uint8_t** pp_pcm_buffer , unsigned int size );
145 void ( *pf_video_postrender_callback ) ( void* p_video_data, uint8_t* p_pixel_buffer, int width, int height, int pixel_pitch, int size, int pts );
146 void ( *pf_audio_postrender_callback ) ( void* p_audio_data, uint8_t* p_pcm_buffer, unsigned int channels, unsigned int rate, unsigned int nb_samples, unsigned int bits_per_sample, unsigned int size, int pts );
150 /*****************************************************************************
152 *****************************************************************************/
153 static int Open( vlc_object_t *p_this )
156 sout_stream_t *p_stream = (sout_stream_t*)p_this;
157 sout_stream_sys_t *p_sys;
159 p_sys = calloc( 1, sizeof( sout_stream_sys_t ) );
162 p_stream->p_sys = p_sys;
164 p_sys->time_sync = var_CreateGetBool( p_stream, SOUT_CFG_PREFIX "time-sync" );
166 psz_tmp = var_CreateGetString( p_stream, SOUT_PREFIX_VIDEO "prerender-callback" );
167 p_sys->pf_video_prerender_callback = (void (*) (void *, uint8_t**, int))(intptr_t)atoll( psz_tmp );
170 psz_tmp = var_CreateGetString( p_stream, SOUT_PREFIX_AUDIO "prerender-callback" );
171 p_sys->pf_audio_prerender_callback = (void (*) (void* , uint8_t**, unsigned int))(intptr_t)atoll( psz_tmp );
174 psz_tmp = var_CreateGetString( p_stream, SOUT_PREFIX_VIDEO "postrender-callback" );
175 p_sys->pf_video_postrender_callback = (void (*) (void*, uint8_t*, int, int, int, int, int))(intptr_t)atoll( psz_tmp );
178 psz_tmp = var_CreateGetString( p_stream, SOUT_PREFIX_AUDIO "postrender-callback" );
179 p_sys->pf_audio_postrender_callback = (void (*) (void*, uint8_t*, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, int))(intptr_t)atoll( psz_tmp );
182 /* Create the remaining variables for a later use */
183 var_Create( p_stream, SOUT_PREFIX_VIDEO "data", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
184 var_Create( p_stream, SOUT_PREFIX_AUDIO "data", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
186 /* Setting stream out module callbacks */
187 p_stream->pf_add = Add;
188 p_stream->pf_del = Del;
189 p_stream->pf_send = Send;
191 /* Does the module need out_pace_control? */
192 if ( p_sys->time_sync )
193 p_stream->p_sout->i_out_pace_nocontrol++;
198 /*****************************************************************************
200 *****************************************************************************/
201 static void Close( vlc_object_t * p_this )
203 sout_stream_t *p_stream = (sout_stream_t*)p_this;
204 if ( p_stream->p_sys->time_sync )
205 p_stream->p_sout->i_out_pace_nocontrol--;
206 free( p_stream->p_sys );
209 static sout_stream_id_t *Add( sout_stream_t *p_stream, es_format_t *p_fmt )
211 sout_stream_id_t *id = NULL;
213 if ( p_fmt->i_cat == VIDEO_ES )
214 id = AddVideo( p_stream, p_fmt );
215 else if ( p_fmt->i_cat == AUDIO_ES )
216 id = AddAudio( p_stream, p_fmt );
220 static sout_stream_id_t *AddVideo( sout_stream_t *p_stream, es_format_t *p_fmt )
223 sout_stream_id_t *id;
224 int i_bits_per_pixel;
226 switch( p_fmt->i_codec )
228 case VLC_CODEC_RGB32:
229 i_bits_per_pixel = 32;
232 case VLC_CODEC_RGB24:
233 i_bits_per_pixel = 24;
235 case VLC_CODEC_RGB16:
236 case VLC_CODEC_RGB15:
239 i_bits_per_pixel = 16;
243 i_bits_per_pixel = 12;
246 i_bits_per_pixel = 8;
249 msg_Err( p_stream, "Smem does only support raw video format" );
253 id = calloc( 1, sizeof( sout_stream_id_t ) );
257 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "data" );
258 id->p_data = (void *)( intptr_t )atoll( psz_tmp );
262 id->format->video.i_bits_per_pixel = i_bits_per_pixel;
266 static sout_stream_id_t *AddAudio( sout_stream_t *p_stream, es_format_t *p_fmt )
269 sout_stream_id_t* id;
270 int i_bits_per_sample;
272 switch( p_fmt->i_codec )
276 i_bits_per_sample = 8;
282 i_bits_per_sample = 16;
288 i_bits_per_sample = 24;
294 i_bits_per_sample = 32;
297 i_bits_per_sample = 64;
300 msg_Err( p_stream, "Smem does only support raw audio format" );
304 id = calloc( 1, sizeof( sout_stream_id_t ) );
308 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "data" );
309 id->p_data = (void *)( intptr_t )atoll( psz_tmp );
313 id->format->audio.i_bitspersample = i_bits_per_sample;
317 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
319 VLC_UNUSED( p_stream );
325 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
328 if ( id->format->i_cat == VIDEO_ES )
329 return SendVideo( p_stream, id, p_buffer );
330 else if ( id->format->i_cat == AUDIO_ES )
331 return SendAudio( p_stream, id, p_buffer );
335 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_t *id,
338 sout_stream_sys_t *p_sys = p_stream->p_sys;
339 int i_line, i_line_size, i_size, i_pixel_pitch;
342 i_line = id->format->video.i_height;
343 i_pixel_pitch = id->format->video.i_bits_per_pixel / 8;
344 i_line_size = i_pixel_pitch * id->format->video.i_width;
345 i_size = i_line * i_line_size;
346 /* Calling the prerender callback to get user buffer */
347 p_sys->pf_video_prerender_callback( id->p_data, &p_pixels , i_size );
348 /* Copying data into user buffer */
349 for ( int line = 0; line < i_line; line++, p_pixels += i_line_size )
350 vlc_memcpy( p_pixels, p_buffer->p_buffer + i_line_size * line , i_line_size );
351 /* Calling the postrender callback to tell the user his buffer is ready */
352 p_sys->pf_video_postrender_callback( id->p_data, p_pixels,
353 id->format->video.i_width, id->format->video.i_height,
354 id->format->video.i_bits_per_pixel, i_size, p_buffer->i_pts );
355 block_ChainRelease( p_buffer );
359 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_t *id,
362 sout_stream_sys_t *p_sys = p_stream->p_sys;
364 uint8_t* p_pcm_buffer;
367 i_size = p_buffer->i_buffer;
368 i_samples = i_size / ( ( id->format->audio.i_bitspersample / 8 ) * id->format->audio.i_channels );
369 /* Calling the prerender callback to get user buffer */
370 p_sys->pf_audio_prerender_callback( id->p_data, &p_pcm_buffer, i_size );
371 /* Copying data into user buffer */
372 vlc_memcpy( p_pcm_buffer, p_buffer->p_buffer, i_size );
373 /* Calling the postrender callback to tell the user his buffer is ready */
374 p_sys->pf_audio_postrender_callback( id->p_data, p_pcm_buffer,
375 id->format->audio.i_channels, id->format->audio.i_rate, p_buffer->i_nb_samples,
376 id->format->audio.i_bitspersample, i_size, p_buffer->i_pts );
377 block_ChainRelease( p_buffer );