1 /*****************************************************************************
2 * smem.c: stream output to memory buffer module
3 *****************************************************************************
4 * Copyright (C) 2009 VLC authors and VideoLAN
7 * Authors: Christophe Courtaut <christophe.courtaut@gmail.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * 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 information
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 ******************************************************************************/
42 /*****************************************************************************
44 *****************************************************************************/
50 #include <vlc_common.h>
51 #include <vlc_plugin.h>
53 #include <vlc_block.h>
54 #include <vlc_codec.h>
57 /*****************************************************************************
59 *****************************************************************************/
61 #define T_VIDEO_PRERENDER_CALLBACK N_( "Video prerender callback" )
62 #define LT_VIDEO_PRERENDER_CALLBACK N_( "Address of the video prerender callback function. " \
63 "This function will set the buffer where render will be done." )
65 #define T_AUDIO_PRERENDER_CALLBACK N_( "Audio prerender callback" )
66 #define LT_AUDIO_PRERENDER_CALLBACK N_( "Address of the audio prerender callback function. " \
67 "This function will set the buffer where render will be done." )
69 #define T_VIDEO_POSTRENDER_CALLBACK N_( "Video postrender callback" )
70 #define LT_VIDEO_POSTRENDER_CALLBACK N_( "Address of the video postrender callback function. " \
71 "This function will be called when the render is into the buffer." )
73 #define T_AUDIO_POSTRENDER_CALLBACK N_( "Audio postrender callback" )
74 #define LT_AUDIO_POSTRENDER_CALLBACK N_( "Address of the audio postrender callback function. " \
75 "This function will be called when the render is into the buffer." )
77 #define T_VIDEO_DATA N_( "Video Callback data" )
78 #define LT_VIDEO_DATA N_( "Data for the video callback function." )
80 #define T_AUDIO_DATA N_( "Audio callback data" )
81 #define LT_AUDIO_DATA N_( "Data for the audio callback function." )
83 #define T_TIME_SYNC N_( "Time Synchronized output" )
84 #define LT_TIME_SYNC N_( "Time Synchronisation option for output. " \
85 "If true, stream will render as usual, else " \
86 "it will be rendered as fast as possible.")
88 static int Open ( vlc_object_t * );
89 static void Close( vlc_object_t * );
91 #define SOUT_CFG_PREFIX "sout-smem-"
92 #define SOUT_PREFIX_VIDEO SOUT_CFG_PREFIX"video-"
93 #define SOUT_PREFIX_AUDIO SOUT_CFG_PREFIX"audio-"
96 set_shortname( N_("Smem"))
97 set_description( N_("Stream output to memory buffer") )
98 set_capability( "sout stream", 0 )
99 add_shortcut( "smem" )
100 set_category( CAT_SOUT )
101 set_subcategory( SUBCAT_SOUT_STREAM )
102 add_string( SOUT_PREFIX_VIDEO "prerender-callback", "0", T_VIDEO_PRERENDER_CALLBACK, LT_VIDEO_PRERENDER_CALLBACK, true )
104 add_string( SOUT_PREFIX_AUDIO "prerender-callback", "0", T_AUDIO_PRERENDER_CALLBACK, LT_AUDIO_PRERENDER_CALLBACK, true )
106 add_string( SOUT_PREFIX_VIDEO "postrender-callback", "0", T_VIDEO_POSTRENDER_CALLBACK, LT_VIDEO_POSTRENDER_CALLBACK, true )
108 add_string( SOUT_PREFIX_AUDIO "postrender-callback", "0", T_AUDIO_POSTRENDER_CALLBACK, LT_AUDIO_POSTRENDER_CALLBACK, true )
110 add_string( SOUT_PREFIX_VIDEO "data", "0", T_VIDEO_DATA, LT_VIDEO_DATA, true )
112 add_string( SOUT_PREFIX_AUDIO "data", "0", T_AUDIO_DATA, LT_VIDEO_DATA, true )
114 add_bool( SOUT_CFG_PREFIX "time-sync", true, T_TIME_SYNC, LT_TIME_SYNC, true )
116 set_callbacks( Open, Close )
120 /*****************************************************************************
121 * Exported prototypes
122 *****************************************************************************/
123 static const char *const ppsz_sout_options[] = {
124 "video-prerender-callback", "audio-prerender-callback",
125 "video-postrender-callback", "audio-postrender-callback", "video-data", "audio-data", "time-sync", NULL
128 static sout_stream_id_sys_t *Add( sout_stream_t *, const es_format_t * );
129 static void Del ( sout_stream_t *, sout_stream_id_sys_t * );
130 static int Send( sout_stream_t *, sout_stream_id_sys_t *, block_t* );
132 static sout_stream_id_sys_t *AddVideo( sout_stream_t *p_stream,
133 const es_format_t *p_fmt );
134 static sout_stream_id_sys_t *AddAudio( sout_stream_t *p_stream,
135 const es_format_t *p_fmt );
137 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
139 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
142 struct sout_stream_id_sys_t
148 struct sout_stream_sys_t
151 void ( *pf_video_prerender_callback ) ( void* p_video_data, uint8_t** pp_pixel_buffer, size_t size );
152 void ( *pf_audio_prerender_callback ) ( void* p_audio_data, uint8_t** pp_pcm_buffer, size_t size );
153 void ( *pf_video_postrender_callback ) ( void* p_video_data, uint8_t* p_pixel_buffer, int width, int height, int pixel_pitch, size_t size, mtime_t pts );
154 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, size_t size, mtime_t pts );
158 /*****************************************************************************
160 *****************************************************************************/
161 static int Open( vlc_object_t *p_this )
164 sout_stream_t *p_stream = (sout_stream_t*)p_this;
165 sout_stream_sys_t *p_sys;
167 p_sys = calloc( 1, sizeof( sout_stream_sys_t ) );
170 p_stream->p_sys = p_sys;
172 config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
175 p_sys->time_sync = var_GetBool( p_stream, SOUT_CFG_PREFIX "time-sync" );
177 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "prerender-callback" );
178 p_sys->pf_video_prerender_callback = (void (*) (void *, uint8_t**, size_t))(intptr_t)atoll( psz_tmp );
181 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "prerender-callback" );
182 p_sys->pf_audio_prerender_callback = (void (*) (void* , uint8_t**, size_t))(intptr_t)atoll( psz_tmp );
185 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "postrender-callback" );
186 p_sys->pf_video_postrender_callback = (void (*) (void*, uint8_t*, int, int, int, size_t, mtime_t))(intptr_t)atoll( psz_tmp );
189 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "postrender-callback" );
190 p_sys->pf_audio_postrender_callback = (void (*) (void*, uint8_t*, unsigned int, unsigned int, unsigned int, unsigned int, size_t, mtime_t))(intptr_t)atoll( psz_tmp );
193 /* Setting stream out module callbacks */
194 p_stream->pf_add = Add;
195 p_stream->pf_del = Del;
196 p_stream->pf_send = Send;
197 p_stream->pace_nocontrol = p_sys->time_sync;
202 /*****************************************************************************
204 *****************************************************************************/
205 static void Close( vlc_object_t * p_this )
207 sout_stream_t *p_stream = (sout_stream_t*)p_this;
208 free( p_stream->p_sys );
211 static sout_stream_id_sys_t *Add( sout_stream_t *p_stream,
212 const es_format_t *p_fmt )
214 sout_stream_id_sys_t *id = NULL;
216 if ( p_fmt->i_cat == VIDEO_ES )
217 id = AddVideo( p_stream, p_fmt );
218 else if ( p_fmt->i_cat == AUDIO_ES )
219 id = AddAudio( p_stream, p_fmt );
223 static sout_stream_id_sys_t *AddVideo( sout_stream_t *p_stream,
224 const es_format_t *p_fmt )
227 sout_stream_id_sys_t *id;
228 int i_bits_per_pixel;
230 switch( p_fmt->i_codec )
232 case VLC_CODEC_RGB32:
235 i_bits_per_pixel = 32;
238 case VLC_CODEC_RGB24:
239 i_bits_per_pixel = 24;
241 case VLC_CODEC_RGB16:
242 case VLC_CODEC_RGB15:
245 i_bits_per_pixel = 16;
249 i_bits_per_pixel = 12;
252 i_bits_per_pixel = 8;
255 i_bits_per_pixel = 0;
256 msg_Dbg( p_stream, "non raw video format detected (%4.4s), buffers will contain compressed video", (char *)&p_fmt->i_codec );
260 id = calloc( 1, sizeof( sout_stream_id_sys_t ) );
264 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "data" );
265 id->p_data = (void *)( intptr_t )atoll( psz_tmp );
269 id->format->video.i_bits_per_pixel = i_bits_per_pixel;
273 static sout_stream_id_sys_t *AddAudio( sout_stream_t *p_stream,
274 const es_format_t *p_fmt )
277 sout_stream_id_sys_t* id;
278 int i_bits_per_sample = aout_BitsPerSample( p_fmt->i_codec );
280 if( !i_bits_per_sample )
282 msg_Err( p_stream, "Smem does only support raw audio format" );
286 id = calloc( 1, sizeof( sout_stream_id_sys_t ) );
290 psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "data" );
291 id->p_data = (void *)( intptr_t )atoll( psz_tmp );
295 id->format->audio.i_bitspersample = i_bits_per_sample;
299 static void Del( sout_stream_t *p_stream, sout_stream_id_sys_t *id )
301 VLC_UNUSED( p_stream );
305 static int Send( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
308 if ( id->format->i_cat == VIDEO_ES )
309 return SendVideo( p_stream, id, p_buffer );
310 else if ( id->format->i_cat == AUDIO_ES )
311 return SendAudio( p_stream, id, p_buffer );
315 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
318 sout_stream_sys_t *p_sys = p_stream->p_sys;
319 size_t i_size = p_buffer->i_buffer;
320 uint8_t* p_pixels = NULL;
322 /* Calling the prerender callback to get user buffer */
323 p_sys->pf_video_prerender_callback( id->p_data, &p_pixels, i_size );
327 msg_Err( p_stream, "No buffer given!" );
328 block_ChainRelease( p_buffer );
332 /* Copying data into user buffer */
333 memcpy( p_pixels, p_buffer->p_buffer, i_size );
334 /* Calling the postrender callback to tell the user his buffer is ready */
335 p_sys->pf_video_postrender_callback( id->p_data, p_pixels,
336 id->format->video.i_width, id->format->video.i_height,
337 id->format->video.i_bits_per_pixel, i_size, p_buffer->i_pts );
338 block_ChainRelease( p_buffer );
342 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
345 sout_stream_sys_t *p_sys = p_stream->p_sys;
347 uint8_t* p_pcm_buffer = NULL;
350 i_size = p_buffer->i_buffer;
351 if (id->format->audio.i_channels <= 0)
353 msg_Warn( p_stream, "No buffer given!" );
354 block_ChainRelease( p_buffer );
358 i_samples = i_size / ( ( id->format->audio.i_bitspersample / 8 ) * id->format->audio.i_channels );
359 /* Calling the prerender callback to get user buffer */
360 p_sys->pf_audio_prerender_callback( id->p_data, &p_pcm_buffer, i_size );
363 msg_Err( p_stream, "No buffer given!" );
364 block_ChainRelease( p_buffer );
368 /* Copying data into user buffer */
369 memcpy( p_pcm_buffer, p_buffer->p_buffer, i_size );
370 /* Calling the postrender callback to tell the user his buffer is ready */
371 p_sys->pf_audio_postrender_callback( id->p_data, p_pcm_buffer,
372 id->format->audio.i_channels, id->format->audio.i_rate, i_samples,
373 id->format->audio.i_bitspersample, i_size, p_buffer->i_pts );
374 block_ChainRelease( p_buffer );