1 /*****************************************************************************
2 * vmem.c: memory video driver for vlc
3 *****************************************************************************
4 * Copyright (C) 2008 the VideoLAN team
7 * Authors: Sam Hocevar <sam@zoy.org>
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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
36 /*****************************************************************************
38 *****************************************************************************/
39 static int Create ( vlc_object_t * );
40 static void Destroy ( vlc_object_t * );
42 static int Init ( vout_thread_t * );
43 static void End ( vout_thread_t * );
44 static int LockPicture ( vout_thread_t *, picture_t * );
45 static int UnlockPicture ( vout_thread_t *, picture_t * );
47 /*****************************************************************************
49 *****************************************************************************/
50 #define T_WIDTH N_( "Width" )
51 #define LT_WIDTH N_( "Video memory buffer width." )
53 #define T_HEIGHT N_( "Height" )
54 #define LT_HEIGHT N_( "Video memory buffer height." )
56 #define T_PITCH N_( "Pitch" )
57 #define LT_PITCH N_( "Video memory buffer pitch in bytes." )
59 #define T_CHROMA N_( "Chroma" )
60 #define LT_CHROMA N_( "Output chroma for the memory image as a 4-character " \
61 "string, eg. \"RV32\"." )
63 #define T_LOCK N_( "Lock function" )
64 #define LT_LOCK N_( "Address of the locking callback function. This " \
65 "function must return a valid memory address for use " \
66 "by the video renderer." )
68 #define T_UNLOCK N_( "Unlock function" )
69 #define LT_UNLOCK N_( "Address of the unlocking callback function" )
71 #define T_DATA N_( "Callback data" )
72 #define LT_DATA N_( "Data for the locking and unlocking functions" )
75 set_description( N_( "Video memory module" ) );
76 set_shortname( N_("Video memory") );
78 set_category( CAT_VIDEO );
79 set_subcategory( SUBCAT_VIDEO_VOUT );
80 set_capability( "video output", 0 );
82 add_integer( "vmem-width", 320, NULL, T_WIDTH, LT_WIDTH, false );
83 add_integer( "vmem-height", 200, NULL, T_HEIGHT, LT_HEIGHT, false );
84 add_integer( "vmem-pitch", 640, NULL, T_PITCH, LT_PITCH, false );
85 add_string( "vmem-chroma", "RV16", NULL, T_CHROMA, LT_CHROMA, true );
86 add_string( "vmem-lock", "0", NULL, T_LOCK, LT_LOCK, true );
87 add_string( "vmem-unlock", "0", NULL, T_UNLOCK, LT_UNLOCK, true );
88 add_string( "vmem-data", "0", NULL, T_DATA, LT_DATA, true );
90 set_callbacks( Create, Destroy );
93 /*****************************************************************************
94 * vout_sys_t: video output descriptor
95 *****************************************************************************/
98 int i_width, i_height, i_pitch;
100 void * (*pf_lock) (void *);
101 void (*pf_unlock) (void *);
105 /*****************************************************************************
106 * Create: allocates video thread
107 *****************************************************************************
108 * This function allocates and initializes a vout method.
109 *****************************************************************************/
110 static int Create( vlc_object_t *p_this )
112 vout_thread_t *p_vout = ( vout_thread_t * )p_this;
114 /* Allocate instance and initialize some members */
115 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
116 if( ! p_vout->p_sys )
119 p_vout->pf_init = Init;
120 p_vout->pf_end = End;
121 p_vout->pf_manage = NULL;
122 p_vout->pf_render = NULL;
123 p_vout->pf_display = NULL;
128 /*****************************************************************************
129 * Init: initialize video thread
130 *****************************************************************************/
131 static int Init( vout_thread_t *p_vout )
135 char *psz_chroma, *psz_tmp;
136 int i_width, i_height, i_pitch, i_chroma;
138 i_width = config_GetInt( p_vout, "vmem-width" );
139 i_height = config_GetInt( p_vout, "vmem-height" );
140 i_pitch = config_GetInt( p_vout, "vmem-pitch" );
142 psz_chroma = config_GetPsz( p_vout, "vmem-chroma" );
145 if( strlen( psz_chroma ) < 4 )
147 msg_Err( p_vout, "vmem-chroma should be 4 characters long" );
151 i_chroma = VLC_FOURCC( psz_chroma[0], psz_chroma[1],
152 psz_chroma[2], psz_chroma[3] );
157 msg_Err( p_vout, "Cannot find chroma information." );
161 psz_tmp = config_GetPsz( p_vout, "vmem-lock" );
162 p_vout->p_sys->pf_lock = (void * (*) (void *))(intptr_t)atoll( psz_tmp );
165 psz_tmp = config_GetPsz( p_vout, "vmem-unlock" );
166 p_vout->p_sys->pf_unlock = (void (*) (void *))(intptr_t)atoll( psz_tmp );
169 psz_tmp = config_GetPsz( p_vout, "vmem-data" );
170 p_vout->p_sys->p_data = (void *)(intptr_t)atoll( psz_tmp );
173 if( !p_vout->p_sys->pf_lock || !p_vout->p_sys->pf_unlock )
175 msg_Err( p_vout, "Invalid lock or unlock callbacks" );
179 I_OUTPUTPICTURES = 0;
181 /* Initialize the output structure */
182 p_vout->output.i_chroma = i_chroma;
183 p_vout->output.pf_setpalette = NULL;
184 p_vout->output.i_width = i_width;
185 p_vout->output.i_height = i_height;
186 p_vout->output.i_aspect = p_vout->output.i_width
187 * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
189 /* Define the bitmasks */
192 case VLC_FOURCC( 'R','V','1','5' ):
193 p_vout->output.i_rmask = 0x001f;
194 p_vout->output.i_gmask = 0x03e0;
195 p_vout->output.i_bmask = 0x7c00;
198 case VLC_FOURCC( 'R','V','1','6' ):
199 p_vout->output.i_rmask = 0x001f;
200 p_vout->output.i_gmask = 0x07e0;
201 p_vout->output.i_bmask = 0xf800;
204 case VLC_FOURCC( 'R','V','2','4' ):
205 p_vout->output.i_rmask = 0xff0000;
206 p_vout->output.i_gmask = 0x00ff00;
207 p_vout->output.i_bmask = 0x0000ff;
210 case VLC_FOURCC( 'R','V','3','2' ):
211 p_vout->output.i_rmask = 0xff0000;
212 p_vout->output.i_gmask = 0x00ff00;
213 p_vout->output.i_bmask = 0x0000ff;
217 /* Try to initialize 1 direct buffer */
220 /* Find an empty picture slot */
221 for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
223 if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
225 p_pic = p_vout->p_picture + i_index;
230 /* Allocate the picture */
236 vout_InitPicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
237 p_vout->output.i_width, p_vout->output.i_height,
238 p_vout->output.i_aspect );
240 p_pic->p->i_pitch = i_pitch;
242 p_pic->pf_lock = LockPicture;
243 p_pic->pf_unlock = UnlockPicture;
245 p_pic->i_status = DESTROYED_PICTURE;
246 p_pic->i_type = DIRECT_PICTURE;
248 PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
255 /*****************************************************************************
256 * End: terminate video thread output method
257 *****************************************************************************/
258 static void End( vout_thread_t *p_vout )
263 /*****************************************************************************
264 * Destroy: destroy video thread
265 *****************************************************************************
266 * Terminate an output method created by Create
267 *****************************************************************************/
268 static void Destroy( vlc_object_t *p_this )
270 vout_thread_t *p_vout = ( vout_thread_t * )p_this;
272 /* Destroy structure */
273 free( p_vout->p_sys );
276 /*****************************************************************************
277 * LockPicture: lock a picture
278 *****************************************************************************
279 * This function locks the picture and prepares it for direct pixel access.
280 *****************************************************************************/
281 static int LockPicture( vout_thread_t *p_vout, picture_t *p_pic )
283 p_pic->p->p_pixels = p_vout->p_sys->pf_lock( p_vout->p_sys->p_data );
288 /*****************************************************************************
289 * UnlockPicture: unlock a picture
290 *****************************************************************************
291 * This function unlocks a previously locked picture.
292 *****************************************************************************/
293 static int UnlockPicture( vout_thread_t *p_vout, picture_t *p_pic )
295 p_vout->p_sys->pf_unlock( p_vout->p_sys->p_data );