git.sesse.net Git - vlc/blob - modules/stream_out/smem.c

   1 /*****************************************************************************
   2  * smem.c: stream output to memory buffer module
   3  *****************************************************************************
   4  * Copyright (C) 2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Courtaut <christophe.courtaut@gmail.com>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * How to use it
  26  *****************************************************************************
  27  *
  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.
  31  *
  32  * For example, you can use smem as it :
  33  * --sout="#transcode{vcodec=RV24,acodec=s16l}:smem{smem-options}"
  34  *
  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.
  37  *
  38  * the video-data and audio-data pointers will be passed to lock/unlock function
  39  *
  40  ******************************************************************************/
  41
  42 /*****************************************************************************
  43  * Preamble
  44  *****************************************************************************/
  45
  46 #ifdef HAVE_CONFIG_H
  47 # include "config.h"
  48 #endif
  49
  50 #include <vlc_common.h>
  51 #include <vlc_plugin.h>
  52 #include <vlc_sout.h>
  53 #include <vlc_block.h>
  54 #include <vlc_codec.h>
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59
  60 #define T_VIDEO_PRERENDER_CALLBACK N_( "Video prerender callback" )
  61 #define LT_VIDEO_PRERENDER_CALLBACK N_( "Address of the video prerender callback function" \
  62                                 "this function will set the buffer where render will be done" )
  63
  64 #define T_AUDIO_PRERENDER_CALLBACK N_( "Audio prerender callback" )
  65 #define LT_AUDIO_PRERENDER_CALLBACK N_( "Address of the audio prerender callback function." \
  66                                         "this function will set the buffer where render will be done" )
  67
  68 #define T_VIDEO_POSTRENDER_CALLBACK N_( "Video postrender callback" )
  69 #define LT_VIDEO_POSTRENDER_CALLBACK N_( "Address of the video postrender callback function." \
  70                                         "this function will be called when the render is into the buffer" )
  71
  72 #define T_AUDIO_POSTRENDER_CALLBACK N_( "Audio postrender callback" )
  73 #define LT_AUDIO_POSTRENDER_CALLBACK N_( "Address of the audio postrender callback function." \
  74                                         "this function will be called when the render is into the buffer" )
  75
  76 #define T_VIDEO_DATA N_( "Video Callback data" )
  77 #define LT_VIDEO_DATA N_( "Data for the video callback function." )
  78
  79 #define T_AUDIO_DATA N_( "Audio callback data" )
  80 #define LT_AUDIO_DATA N_( "Data for the audio callback function." )
  81
  82 #define T_TIME_SYNC N_( "Time Synchronized output" )
  83 #define LT_TIME_SYNC N_( "Time Synchronisation option for output. " \
  84                         "If true, stream will render as usual, else " \
  85                         "it will be rendered as fast as possible.")
  86
  87 static int  Open ( vlc_object_t * );
  88 static void Close( vlc_object_t * );
  89
  90 #define SOUT_CFG_PREFIX "sout-smem-"
  91 #define SOUT_PREFIX_VIDEO SOUT_CFG_PREFIX"video-"
  92 #define SOUT_PREFIX_AUDIO SOUT_CFG_PREFIX"audio-"
  93
  94 vlc_module_begin ()
  95     set_shortname( N_("Smem"))
  96     set_description( N_("Stream output to memory buffer") )
  97     set_capability( "sout stream", 0 )
  98     add_shortcut( "smem" )
  99     set_category( CAT_SOUT )
 100     set_subcategory( SUBCAT_SOUT_STREAM )
 101     add_string( SOUT_PREFIX_VIDEO "prerender-callback", "0", NULL, T_VIDEO_PRERENDER_CALLBACK, LT_VIDEO_PRERENDER_CALLBACK, true )
 102         change_volatile()
 103     add_string( SOUT_PREFIX_AUDIO "prerender-callback", "0", NULL, T_AUDIO_PRERENDER_CALLBACK, LT_AUDIO_PRERENDER_CALLBACK, true )
 104         change_volatile()
 105     add_string( SOUT_PREFIX_VIDEO "postrender-callback", "0", NULL, T_VIDEO_POSTRENDER_CALLBACK, LT_VIDEO_POSTRENDER_CALLBACK, true )
 106         change_volatile()
 107     add_string( SOUT_PREFIX_AUDIO "postrender-callback", "0", NULL, T_AUDIO_POSTRENDER_CALLBACK, LT_AUDIO_POSTRENDER_CALLBACK, true )
 108         change_volatile()
 109     add_string( SOUT_PREFIX_VIDEO "data", "0", NULL, T_VIDEO_DATA, LT_VIDEO_DATA, true )
 110         change_volatile()
 111     add_string( SOUT_PREFIX_AUDIO "data", "0", NULL, T_AUDIO_DATA, LT_VIDEO_DATA, true )
 112         change_volatile()
 113     add_bool( SOUT_CFG_PREFIX "time-sync", true, NULL, T_TIME_SYNC, LT_TIME_SYNC, true )
 114         change_private()
 115     set_callbacks( Open, Close )
 116 vlc_module_end ()
 117
 118
 119 /*****************************************************************************
 120  * Exported prototypes
 121  *****************************************************************************/
 122 static const char *const ppsz_sout_options[] = {
 123     "video-prerender-callback", "audio-prerender-callback",
 124     "video-postrender-callback", "audio-postrender-callback", "video-data", "audio-data", "time-sync", NULL
 125 };
 126
 127 static sout_stream_id_t *Add ( sout_stream_t *, es_format_t * );
 128 static int               Del ( sout_stream_t *, sout_stream_id_t * );
 129 static int               Send( sout_stream_t *, sout_stream_id_t *, block_t* );
 130
 131 static sout_stream_id_t *AddVideo( sout_stream_t *p_stream, es_format_t *p_fmt );
 132 static sout_stream_id_t *AddAudio( sout_stream_t *p_stream, es_format_t *p_fmt );
 133
 134 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_t *id,
 135                       block_t *p_buffer );
 136 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_t *id,
 137                       block_t *p_buffer );
 138
 139 struct sout_stream_id_t
 140 {
 141     es_format_t* format;
 142     void *p_data;
 143 };
 144
 145 struct sout_stream_sys_t
 146 {
 147     vlc_mutex_t *p_lock;
 148     void ( *pf_video_prerender_callback ) ( void* p_video_data, uint8_t** pp_pixel_buffer , int size );
 149     void ( *pf_audio_prerender_callback ) ( void* p_audio_data, uint8_t** pp_pcm_buffer , unsigned int size );
 150     void ( *pf_video_postrender_callback ) ( void* p_video_data, uint8_t* p_pixel_buffer, int width, int height, int pixel_pitch, int size, mtime_t pts );
 151     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, mtime_t pts );
 152     bool time_sync;
 153 };
 154
 155 /*****************************************************************************
 156  * Open:
 157  *****************************************************************************/
 158 static int Open( vlc_object_t *p_this )
 159 {
 160     char* psz_tmp;
 161     sout_stream_t *p_stream = (sout_stream_t*)p_this;
 162     sout_stream_sys_t *p_sys;
 163
 164     p_sys = calloc( 1, sizeof( sout_stream_sys_t ) );
 165     if( !p_sys )
 166         return VLC_ENOMEM;
 167     p_stream->p_sys = p_sys;
 168
 169     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
 170                        p_stream->p_cfg );
 171
 172     p_sys->time_sync = var_GetBool( p_stream, SOUT_CFG_PREFIX "time-sync" );
 173
 174     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "prerender-callback" );
 175     p_sys->pf_video_prerender_callback = (void (*) (void *, uint8_t**, int))(intptr_t)atoll( psz_tmp );
 176     free( psz_tmp );
 177
 178     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "prerender-callback" );
 179     p_sys->pf_audio_prerender_callback = (void (*) (void* , uint8_t**, unsigned int))(intptr_t)atoll( psz_tmp );
 180     free( psz_tmp );
 181
 182     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "postrender-callback" );
 183     p_sys->pf_video_postrender_callback = (void (*) (void*, uint8_t*, int, int, int, int, mtime_t))(intptr_t)atoll( psz_tmp );
 184     free( psz_tmp );
 185
 186     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "postrender-callback" );
 187     p_sys->pf_audio_postrender_callback = (void (*) (void*, uint8_t*, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, mtime_t))(intptr_t)atoll( psz_tmp );
 188     free( psz_tmp );
 189
 190     /* Setting stream out module callbacks */
 191     p_stream->pf_add    = Add;
 192     p_stream->pf_del    = Del;
 193     p_stream->pf_send   = Send;
 194
 195     /* Does the module need out_pace_control? */
 196     if ( p_sys->time_sync )
 197         p_stream->p_sout->i_out_pace_nocontrol++;
 198
 199     return VLC_SUCCESS;
 200 }
 201
 202 /*****************************************************************************
 203  * Close:
 204  *****************************************************************************/
 205 static void Close( vlc_object_t * p_this )
 206 {
 207     sout_stream_t *p_stream = (sout_stream_t*)p_this;
 208     if ( p_stream->p_sys->time_sync )
 209         p_stream->p_sout->i_out_pace_nocontrol--;
 210     free( p_stream->p_sys );
 211 }
 212
 213 static sout_stream_id_t *Add( sout_stream_t *p_stream, es_format_t *p_fmt )
 214 {
 215     sout_stream_id_t *id = NULL;
 216
 217     if ( p_fmt->i_cat == VIDEO_ES )
 218         id = AddVideo( p_stream, p_fmt );
 219     else if ( p_fmt->i_cat == AUDIO_ES )
 220         id = AddAudio( p_stream, p_fmt );
 221     return id;
 222 }
 223
 224 static sout_stream_id_t *AddVideo( sout_stream_t *p_stream, es_format_t *p_fmt )
 225 {
 226     char* psz_tmp;
 227     sout_stream_id_t    *id;
 228     int i_bits_per_pixel;
 229
 230     switch( p_fmt->i_codec )
 231     {
 232         case VLC_CODEC_RGB32:
 233             i_bits_per_pixel = 32;
 234             break;
 235         case VLC_CODEC_I444:
 236         case VLC_CODEC_RGB24:
 237             i_bits_per_pixel = 24;
 238             break;
 239         case VLC_CODEC_RGB16:
 240         case VLC_CODEC_RGB15:
 241         case VLC_CODEC_RGB8:
 242         case VLC_CODEC_I422:
 243             i_bits_per_pixel = 16;
 244             break;
 245         case VLC_CODEC_YV12:
 246         case VLC_CODEC_I420:
 247             i_bits_per_pixel = 12;
 248             break;
 249         case VLC_CODEC_RGBP:
 250             i_bits_per_pixel = 8;
 251             break;
 252         default:
 253             msg_Err( p_stream, "Smem does only support raw video format" );
 254             return NULL;
 255     }
 256
 257     id = calloc( 1, sizeof( sout_stream_id_t ) );
 258     if( !id )
 259         return NULL;
 260
 261     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_VIDEO "data" );
 262     id->p_data = (void *)( intptr_t )atoll( psz_tmp );
 263     free( psz_tmp );
 264
 265     id->format = p_fmt;
 266     id->format->video.i_bits_per_pixel = i_bits_per_pixel;
 267     return id;
 268 }
 269
 270 static sout_stream_id_t *AddAudio( sout_stream_t *p_stream, es_format_t *p_fmt )
 271 {
 272     char* psz_tmp;
 273     sout_stream_id_t* id;
 274     int i_bits_per_sample;
 275
 276     switch( p_fmt->i_codec )
 277     {
 278     case VLC_CODEC_U8:
 279     case VLC_CODEC_S8:
 280         i_bits_per_sample = 8;
 281         break;
 282     case VLC_CODEC_U16L:
 283     case VLC_CODEC_S16L:
 284     case VLC_CODEC_U16B:
 285     case VLC_CODEC_S16B:
 286         i_bits_per_sample =  16;
 287         break;
 288     case VLC_CODEC_U24L:
 289     case VLC_CODEC_S24L:
 290     case VLC_CODEC_U24B:
 291     case VLC_CODEC_S24B:
 292         i_bits_per_sample = 24;
 293         break;
 294     case VLC_CODEC_S32L:
 295     case VLC_CODEC_S32B:
 296     case VLC_CODEC_FL32:
 297     case VLC_CODEC_FI32:
 298         i_bits_per_sample = 32;
 299         break;
 300     case VLC_CODEC_FL64:
 301         i_bits_per_sample = 64;
 302         break;
 303     default:
 304         msg_Err( p_stream, "Smem does only support raw audio format" );
 305         return NULL;
 306     }
 307
 308     id = calloc( 1, sizeof( sout_stream_id_t ) );
 309     if( !id )
 310         return NULL;
 311
 312     psz_tmp = var_GetString( p_stream, SOUT_PREFIX_AUDIO "data" );
 313     id->p_data = (void *)( intptr_t )atoll( psz_tmp );
 314     free( psz_tmp );
 315
 316     id->format = p_fmt;
 317     id->format->audio.i_bitspersample = i_bits_per_sample;
 318     return id;
 319 }
 320
 321 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
 322 {
 323     VLC_UNUSED( p_stream );
 324     free( id );
 325     return VLC_SUCCESS;
 326 }
 327
 328 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
 329                  block_t *p_buffer )
 330 {
 331     if ( id->format->i_cat == VIDEO_ES )
 332         return SendVideo( p_stream, id, p_buffer );
 333     else if ( id->format->i_cat == AUDIO_ES )
 334         return SendAudio( p_stream, id, p_buffer );
 335     return VLC_SUCCESS;
 336 }
 337
 338 static int SendVideo( sout_stream_t *p_stream, sout_stream_id_t *id,
 339                       block_t *p_buffer )
 340 {
 341     sout_stream_sys_t *p_sys = p_stream->p_sys;
 342     int i_line, i_line_size, i_size, i_pixel_pitch;
 343     uint8_t* p_pixels;
 344
 345     i_line = id->format->video.i_height;
 346     i_pixel_pitch = id->format->video.i_bits_per_pixel / 8;
 347     i_line_size = i_pixel_pitch * id->format->video.i_width;
 348     i_size = i_line * i_line_size;
 349     /* Calling the prerender callback to get user buffer */
 350     p_sys->pf_video_prerender_callback( id->p_data, &p_pixels , i_size );
 351     /* Copying data into user buffer */
 352     for ( int line = 0; line < i_line; line++, p_pixels += i_line_size )
 353         vlc_memcpy( p_pixels, p_buffer->p_buffer + i_line_size * line , i_line_size );
 354     /* Calling the postrender callback to tell the user his buffer is ready */
 355     p_sys->pf_video_postrender_callback( id->p_data, p_pixels,
 356                                          id->format->video.i_width, id->format->video.i_height,
 357                                          id->format->video.i_bits_per_pixel, i_size, p_buffer->i_pts );
 358     block_ChainRelease( p_buffer );
 359     return VLC_SUCCESS;
 360 }
 361
 362 static int SendAudio( sout_stream_t *p_stream, sout_stream_id_t *id,
 363                       block_t *p_buffer )
 364 {
 365     sout_stream_sys_t *p_sys = p_stream->p_sys;
 366     int i_size;
 367     uint8_t* p_pcm_buffer;
 368     int i_samples = 0;
 369
 370     i_size = p_buffer->i_buffer;
 371     i_samples = i_size / ( ( id->format->audio.i_bitspersample / 8 ) * id->format->audio.i_channels );
 372     /* Calling the prerender callback to get user buffer */
 373     p_sys->pf_audio_prerender_callback( id->p_data, &p_pcm_buffer, i_size );
 374     /* Copying data into user buffer */
 375     vlc_memcpy( p_pcm_buffer, p_buffer->p_buffer, i_size );
 376     /* Calling the postrender callback to tell the user his buffer is ready */
 377     p_sys->pf_audio_postrender_callback( id->p_data, p_pcm_buffer,
 378                                          id->format->audio.i_channels, id->format->audio.i_rate, i_samples,
 379                                          id->format->audio.i_bitspersample, i_size, p_buffer->i_pts );
 380     block_ChainRelease( p_buffer );
 381     return VLC_SUCCESS;
 382 }
 383