* ALL: separation of the SPU engine from the VOUT.
[vlc.git] / src / video_output / vout_pictures.c
1 /*****************************************************************************
2  * vout_pictures.c : picture management functions
3  *****************************************************************************
4  * Copyright (C) 2000-2004 VideoLAN
5  * $Id$
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@zoy.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #include <stdlib.h>                                                /* free() */
29 #include <stdio.h>                                              /* sprintf() */
30 #include <string.h>                                            /* strerror() */
31
32 #include <vlc/vlc.h>
33
34 #include "vlc_video.h"
35 #include "video_output.h"
36 #include "vlc_spu.h"
37
38 #include "vout_pictures.h"
39
40 /**
41  * Display a picture
42  *
43  * Remove the reservation flag of a picture, which will cause it to be ready
44  * for display. The picture won't be displayed until vout_DatePicture has been
45  * called.
46  */
47 void vout_DisplayPicture( vout_thread_t *p_vout, picture_t *p_pic )
48 {
49     vlc_mutex_lock( &p_vout->picture_lock );
50     switch( p_pic->i_status )
51     {
52     case RESERVED_PICTURE:
53         p_pic->i_status = RESERVED_DISP_PICTURE;
54         break;
55     case RESERVED_DATED_PICTURE:
56         p_pic->i_status = READY_PICTURE;
57         break;
58     default:
59         msg_Err( p_vout, "picture to display %p has invalid status %d",
60                          p_pic, p_pic->i_status );
61         break;
62     }
63
64     vlc_mutex_unlock( &p_vout->picture_lock );
65 }
66
67 /**
68  * Date a picture
69  *
70  * Remove the reservation flag of a picture, which will cause it to be ready
71  * for display. The picture won't be displayed until vout_DisplayPicture has
72  * been called.
73  * \param p_vout The vout in question
74  * \param p_pic The picture to date
75  * \param date The date to display the picture
76  */
77 void vout_DatePicture( vout_thread_t *p_vout,
78                        picture_t *p_pic, mtime_t date )
79 {
80     vlc_mutex_lock( &p_vout->picture_lock );
81     p_pic->date = date;
82     switch( p_pic->i_status )
83     {
84     case RESERVED_PICTURE:
85         p_pic->i_status = RESERVED_DATED_PICTURE;
86         break;
87     case RESERVED_DISP_PICTURE:
88         p_pic->i_status = READY_PICTURE;
89         break;
90     default:
91         msg_Err( p_vout, "picture to date %p has invalid status %d",
92                          p_pic, p_pic->i_status );
93         break;
94     }
95
96     vlc_mutex_unlock( &p_vout->picture_lock );
97 }
98
99 /**
100  * Allocate a picture in the video output heap.
101  *
102  * This function creates a reserved image in the video output heap.
103  * A null pointer is returned if the function fails. This method provides an
104  * already allocated zone of memory in the picture data fields.
105  * It needs locking since several pictures can be created by several producers
106  * threads.
107  */
108 picture_t *vout_CreatePicture( vout_thread_t *p_vout,
109                                vlc_bool_t b_progressive,
110                                vlc_bool_t b_top_field_first,
111                                unsigned int i_nb_fields )
112 {
113     int         i_pic;                                      /* picture index */
114     picture_t * p_pic;
115     picture_t * p_freepic = NULL;                      /* first free picture */
116
117     /* Get lock */
118     vlc_mutex_lock( &p_vout->picture_lock );
119
120     /*
121      * Look for an empty place in the picture heap.
122      */
123     for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
124     {
125         p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1)
126                                  % I_RENDERPICTURES];
127
128         switch( p_pic->i_status )
129         {
130             case DESTROYED_PICTURE:
131                 /* Memory will not be reallocated, and function can end
132                  * immediately - this is the best possible case, since no
133                  * memory allocation needs to be done */
134                 p_pic->i_status   = RESERVED_PICTURE;
135                 p_pic->i_refcount = 0;
136                 p_pic->b_force    = 0;
137
138                 p_pic->b_progressive        = b_progressive;
139                 p_pic->i_nb_fields          = i_nb_fields;
140                 p_pic->b_top_field_first    = b_top_field_first;
141
142                 p_vout->i_heap_size++;
143                 p_vout->render.i_last_used_pic =
144                     ( p_vout->render.i_last_used_pic + i_pic + 1 )
145                     % I_RENDERPICTURES;
146                 vlc_mutex_unlock( &p_vout->picture_lock );
147                 return( p_pic );
148
149             case FREE_PICTURE:
150                 /* Picture is empty and ready for allocation */
151                 p_vout->render.i_last_used_pic =
152                     ( p_vout->render.i_last_used_pic + i_pic + 1 )
153                     % I_RENDERPICTURES;
154                 p_freepic = p_pic;
155                 break;
156
157             default:
158                 break;
159         }
160     }
161
162     /*
163      * Prepare picture
164      */
165     if( p_freepic != NULL )
166     {
167         vout_AllocatePicture( VLC_OBJECT(p_vout),
168                               p_freepic, p_vout->render.i_chroma,
169                               p_vout->render.i_width, p_vout->render.i_height,
170                               p_vout->render.i_aspect );
171
172         if( p_freepic->i_planes )
173         {
174             /* Copy picture information, set some default values */
175             p_freepic->i_status   = RESERVED_PICTURE;
176             p_freepic->i_type     = MEMORY_PICTURE;
177             p_freepic->b_slow     = 0;
178
179             p_freepic->i_refcount = 0;
180             p_freepic->b_force = 0;
181
182             p_freepic->b_progressive        = b_progressive;
183             p_freepic->i_nb_fields          = i_nb_fields;
184             p_freepic->b_top_field_first    = b_top_field_first;
185
186             p_freepic->i_matrix_coefficients = 1;
187
188             p_vout->i_heap_size++;
189         }
190         else
191         {
192             /* Memory allocation failed : set picture as empty */
193             p_freepic->i_status = FREE_PICTURE;
194             p_freepic = NULL;
195
196             msg_Err( p_vout, "picture allocation failed" );
197         }
198
199         vlc_mutex_unlock( &p_vout->picture_lock );
200
201         return( p_freepic );
202     }
203
204     /* No free or destroyed picture could be found, but the decoder
205      * will try again in a while. */
206     vlc_mutex_unlock( &p_vout->picture_lock );
207
208     return( NULL );
209 }
210
211 /**
212  * Remove a permanent or reserved picture from the heap
213  *
214  * This function frees a previously reserved picture or a permanent
215  * picture. It is meant to be used when the construction of a picture aborted.
216  * Note that the picture will be destroyed even if it is linked !
217  */
218 void vout_DestroyPicture( vout_thread_t *p_vout, picture_t *p_pic )
219 {
220     vlc_mutex_lock( &p_vout->picture_lock );
221
222 #ifdef DEBUG
223     /* Check if picture status is valid */
224     if( (p_pic->i_status != RESERVED_PICTURE) &&
225         (p_pic->i_status != RESERVED_DATED_PICTURE) &&
226         (p_pic->i_status != RESERVED_DISP_PICTURE) )
227     {
228         msg_Err( p_vout, "picture to destroy %p has invalid status %d",
229                          p_pic, p_pic->i_status );
230     }
231 #endif
232
233     p_pic->i_status = DESTROYED_PICTURE;
234     p_vout->i_heap_size--;
235
236     vlc_mutex_unlock( &p_vout->picture_lock );
237 }
238
239 /**
240  * Increment reference counter of a picture
241  *
242  * This function increments the reference counter of a picture in the video
243  * heap. It needs a lock since several producer threads can access the picture.
244  */
245 void vout_LinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
246 {
247     vlc_mutex_lock( &p_vout->picture_lock );
248     p_pic->i_refcount++;
249     vlc_mutex_unlock( &p_vout->picture_lock );
250 }
251
252 /**
253  * Decrement reference counter of a picture
254  *
255  * This function decrement the reference counter of a picture in the video heap
256  */
257 void vout_UnlinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
258 {
259     vlc_mutex_lock( &p_vout->picture_lock );
260     p_pic->i_refcount--;
261
262     if( p_pic->i_refcount < 0 )
263     {
264         msg_Err( p_vout, "picture %p refcount is %i",
265                  p_pic, p_pic->i_refcount );
266         p_pic->i_refcount = 0;
267     }
268
269     if( ( p_pic->i_refcount == 0 ) &&
270         ( p_pic->i_status == DISPLAYED_PICTURE ) )
271     {
272         p_pic->i_status = DESTROYED_PICTURE;
273         p_vout->i_heap_size--;
274     }
275
276     vlc_mutex_unlock( &p_vout->picture_lock );
277 }
278
279 /**
280  * Render a picture
281  *
282  * This function chooses whether the current picture needs to be copied
283  * before rendering, does the subpicture magic, and tells the video output
284  * thread which direct buffer needs to be displayed.
285  */
286 picture_t * vout_RenderPicture( vout_thread_t *p_vout, picture_t *p_pic,
287                                                        subpicture_t *p_subpic )
288 {
289     video_format_t fmt;
290     int i_scale_width, i_scale_height;
291
292     if( p_pic == NULL )
293     {
294         /* XXX: subtitles */
295
296         return NULL;
297     }
298
299     fmt.i_aspect = p_vout->output.i_aspect;
300     fmt.i_chroma = p_vout->output.i_chroma;
301     fmt.i_width = p_vout->output.i_width;
302     fmt.i_height = p_vout->output.i_height;
303     i_scale_width = p_vout->output.i_width * 1000 / p_vout->render.i_width;
304     i_scale_height = p_vout->output.i_height * 1000 / p_vout->render.i_height;
305
306     if( p_pic->i_type == DIRECT_PICTURE )
307     {
308         if( !p_vout->render.b_allow_modify_pics || p_pic->i_refcount ||
309             p_pic->b_force )
310         {
311             /* Picture is in a direct buffer and is still in use,
312              * we need to copy it to another direct buffer before
313              * displaying it if there are subtitles. */
314             if( p_subpic != NULL )
315             {
316                 /* We have subtitles. First copy the picture to
317                  * the spare direct buffer, then render the
318                  * subtitles. */
319                 vout_CopyPicture( p_vout, PP_OUTPUTPICTURE[0], p_pic );
320
321                 spu_RenderSubpictures( p_vout->p_spu, &fmt,
322                                        PP_OUTPUTPICTURE[0], p_pic, p_subpic,
323                                        i_scale_width, i_scale_height );
324
325                 return PP_OUTPUTPICTURE[0];
326             }
327
328             /* No subtitles, picture is in a directbuffer so
329              * we can display it directly even if it is still
330              * in use. */
331             return p_pic;
332         }
333
334         /* Picture is in a direct buffer but isn't used by the
335          * decoder. We can safely render subtitles on it and
336          * display it. */
337         spu_RenderSubpictures( p_vout->p_spu, &fmt, p_pic, p_pic, p_subpic,
338                                i_scale_width, i_scale_height );
339
340         return p_pic;
341     }
342
343     /* Not a direct buffer. We either need to copy it to a direct buffer,
344      * or render it if the chroma isn't the same. */
345     if( p_vout->b_direct )
346     {
347         /* Picture is not in a direct buffer, but is exactly the
348          * same size as the direct buffers. A memcpy() is enough,
349          * then render the subtitles. */
350
351         if( PP_OUTPUTPICTURE[0]->pf_lock )
352             if( PP_OUTPUTPICTURE[0]->pf_lock( p_vout, PP_OUTPUTPICTURE[0] ) )
353                 return NULL;
354
355         vout_CopyPicture( p_vout, PP_OUTPUTPICTURE[0], p_pic );
356         spu_RenderSubpictures( p_vout->p_spu, &fmt, PP_OUTPUTPICTURE[0],
357                                p_pic, p_subpic, i_scale_width, i_scale_height);
358
359         if( PP_OUTPUTPICTURE[0]->pf_unlock )
360             PP_OUTPUTPICTURE[0]->pf_unlock( p_vout, PP_OUTPUTPICTURE[0] );
361
362         return PP_OUTPUTPICTURE[0];
363     }
364
365     /* Picture is not in a direct buffer, and needs to be converted to
366      * another size/chroma. Then the subtitles need to be rendered as
367      * well. This usually means software YUV, or hardware YUV with a
368      * different chroma. */
369
370     if( p_subpic != NULL && p_vout->p_picture[0].b_slow )
371     {
372         /* The picture buffer is in slow memory. We'll use
373          * the "2 * VOUT_MAX_PICTURES + 1" picture as a temporary
374          * one for subpictures rendering. */
375         picture_t *p_tmp_pic = &p_vout->p_picture[2 * VOUT_MAX_PICTURES];
376         if( p_tmp_pic->i_status == FREE_PICTURE )
377         {
378             vout_AllocatePicture( VLC_OBJECT(p_vout),
379                                   p_tmp_pic, p_vout->output.i_chroma,
380                                   p_vout->output.i_width,
381                                   p_vout->output.i_height,
382                                   p_vout->output.i_aspect );
383             p_tmp_pic->i_type = MEMORY_PICTURE;
384             p_tmp_pic->i_status = RESERVED_PICTURE;
385         }
386
387         /* Convert image to the first direct buffer */
388         p_vout->chroma.pf_convert( p_vout, p_pic, p_tmp_pic );
389
390         /* Render subpictures on the first direct buffer */
391         spu_RenderSubpictures( p_vout->p_spu, &fmt, p_tmp_pic,
392                                p_tmp_pic, p_subpic,
393                                i_scale_width, i_scale_height );
394
395         if( p_vout->p_picture[0].pf_lock )
396             if( p_vout->p_picture[0].pf_lock( p_vout, &p_vout->p_picture[0] ) )
397                 return NULL;
398
399         vout_CopyPicture( p_vout, &p_vout->p_picture[0], p_tmp_pic );
400     }
401     else
402     {
403         if( p_vout->p_picture[0].pf_lock )
404             if( p_vout->p_picture[0].pf_lock( p_vout, &p_vout->p_picture[0] ) )
405                 return NULL;
406
407         /* Convert image to the first direct buffer */
408         p_vout->chroma.pf_convert( p_vout, p_pic, &p_vout->p_picture[0] );
409
410         /* Render subpictures on the first direct buffer */
411         spu_RenderSubpictures( p_vout->p_spu, &fmt, &p_vout->p_picture[0],
412                                &p_vout->p_picture[0], p_subpic,
413                                i_scale_width, i_scale_height );
414     }
415
416     if( p_vout->p_picture[0].pf_unlock )
417         p_vout->p_picture[0].pf_unlock( p_vout, &p_vout->p_picture[0] );
418
419     return &p_vout->p_picture[0];
420 }
421
422 /**
423  * Calculate image window coordinates
424  *
425  * This function will be accessed by plugins. It calculates the relative
426  * position of the output window and the image window.
427  */
428 void vout_PlacePicture( vout_thread_t *p_vout,
429                         unsigned int i_width, unsigned int i_height,
430                         unsigned int *pi_x, unsigned int *pi_y,
431                         unsigned int *pi_width, unsigned int *pi_height )
432 {
433     if( (i_width <= 0) || (i_height <=0) )
434     {
435         *pi_width = *pi_height = *pi_x = *pi_y = 0;
436
437         return;
438     }
439
440     if( p_vout->b_scale )
441     {
442         *pi_width = i_width;
443         *pi_height = i_height;
444     }
445     else
446     {
447         *pi_width = __MIN( i_width, p_vout->render.i_width );
448         *pi_height = __MIN( i_height, p_vout->render.i_height );
449     }
450
451     if( VOUT_ASPECT_FACTOR * *pi_width / *pi_height < p_vout->render.i_aspect )
452     {
453         *pi_width = *pi_height * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR;
454     }
455     else
456     {
457         *pi_height = *pi_width * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect;
458     }
459
460     if( *pi_width > i_width )
461     {
462         *pi_width = i_width;
463         *pi_height = VOUT_ASPECT_FACTOR * *pi_width / p_vout->render.i_aspect;
464     }
465
466     if( *pi_height > i_height )
467     {
468         *pi_height = i_height;
469         *pi_width = *pi_height * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR;
470     }
471
472     switch( p_vout->i_alignment & VOUT_ALIGN_HMASK )
473     {
474     case VOUT_ALIGN_LEFT:
475         *pi_x = 0;
476         break;
477     case VOUT_ALIGN_RIGHT:
478         *pi_x = i_width - *pi_width;
479         break;
480     default:
481         *pi_x = ( i_width - *pi_width ) / 2;
482     }
483
484     switch( p_vout->i_alignment & VOUT_ALIGN_VMASK )
485     {
486     case VOUT_ALIGN_TOP:
487         *pi_y = 0;
488         break;
489     case VOUT_ALIGN_BOTTOM:
490         *pi_y = i_height - *pi_height;
491         break;
492     default:
493         *pi_y = ( i_height - *pi_height ) / 2;
494     }
495 }
496
497 /**
498  * Allocate a new picture in the heap.
499  *
500  * This function allocates a fake direct buffer in memory, which can be
501  * used exactly like a video buffer. The video output thread then manages
502  * how it gets displayed.
503  */
504 int __vout_AllocatePicture( vlc_object_t *p_this, picture_t *p_pic,
505                             vlc_fourcc_t i_chroma,
506                             int i_width, int i_height, int i_aspect )
507 {
508     int i_bytes, i_index, i_width_aligned, i_height_aligned;
509
510     /* Make sure the real dimensions are a multiple of 16 */
511     i_width_aligned = (i_width + 15) >> 4 << 4;
512     i_height_aligned = (i_height + 15) >> 4 << 4;
513
514     if( vout_InitPicture( p_this, p_pic, i_chroma,
515                           i_width, i_height, i_aspect ) != VLC_SUCCESS )
516     {
517         p_pic->i_planes = 0;
518         return VLC_EGENERIC;
519     }
520
521     /* Calculate how big the new image should be */
522     i_bytes = p_pic->format.i_bits_per_pixel *
523         i_width_aligned * i_height_aligned / 8;
524
525     p_pic->p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
526
527     if( p_pic->p_data == NULL )
528     {
529         p_pic->i_planes = 0;
530         return VLC_EGENERIC;
531     }
532
533     /* Fill the p_pixels field for each plane */
534     p_pic->p[ 0 ].p_pixels = p_pic->p_data;
535
536     for( i_index = 1; i_index < p_pic->i_planes; i_index++ )
537     {
538         p_pic->p[i_index].p_pixels = p_pic->p[i_index-1].p_pixels +
539             p_pic->p[i_index-1].i_lines * p_pic->p[i_index-1].i_pitch;
540     }
541
542     return VLC_SUCCESS;
543 }
544
545 /**
546  * Initialise the video format fields given chroma/size.
547  *
548  * This function initializes all the video_frame_format_t fields given the
549  * static properties of a picture (chroma and size).
550  * \param p_format Pointer to the format structure to initialize
551  * \param i_chroma Chroma to set
552  * \param i_width Width to set
553  * \param i_height Height to set
554  * \param i_aspect Aspect ratio
555  */
556 void vout_InitFormat( video_frame_format_t *p_format, vlc_fourcc_t i_chroma,
557                       int i_width, int i_height, int i_aspect )
558 {
559     p_format->i_chroma   = i_chroma;
560     p_format->i_width    = p_format->i_visible_width  = i_width;
561     p_format->i_height   = p_format->i_visible_height = i_height;
562     p_format->i_x_offset = p_format->i_y_offset = 0;
563     p_format->i_aspect   = i_aspect;
564
565 #if 0
566     /* Assume we have square pixels */
567     if( i_width && i_height )
568         p_format->i_aspect = i_width * VOUT_ASPECT_FACTOR / i_height;
569     else
570         p_format->i_aspect = 0;
571 #endif
572
573     switch( i_chroma )
574     {
575         case FOURCC_YUVA:
576             p_format->i_bits_per_pixel = 32;
577             break;
578         case FOURCC_I444:
579             p_format->i_bits_per_pixel = 24;
580             break;
581         case FOURCC_I422:
582         case FOURCC_YUY2:
583         case FOURCC_UYVY:
584             p_format->i_bits_per_pixel = 16;
585             p_format->i_bits_per_pixel = 16;
586             break;
587         case FOURCC_I411:
588         case FOURCC_YV12:
589         case FOURCC_I420:
590         case FOURCC_IYUV:
591             p_format->i_bits_per_pixel = 12;
592             break;
593         case FOURCC_I410:
594         case FOURCC_YVU9:
595             p_format->i_bits_per_pixel = 9;
596             break;
597         case FOURCC_Y211:
598             p_format->i_bits_per_pixel = 8;
599             break;
600         case FOURCC_YUVP:
601             p_format->i_bits_per_pixel = 8;
602             break;
603
604         case FOURCC_RV32:
605             p_format->i_bits_per_pixel = 32;
606             break;
607         case FOURCC_RV24:
608             p_format->i_bits_per_pixel = 24;
609             break;
610         case FOURCC_RV15:
611         case FOURCC_RV16:
612             p_format->i_bits_per_pixel = 16;
613             break;
614         case FOURCC_RGB2:
615             p_format->i_bits_per_pixel = 8;
616             break;
617         default:
618             p_format->i_bits_per_pixel = 0;
619             break;
620     }
621 }
622
623 /**
624  * Initialise the picture_t fields given chroma/size.
625  *
626  * This function initializes most of the picture_t fields given a chroma and
627  * size. It makes the assumption that stride == width.
628  * \param p_this The calling object
629  * \param p_pic Pointer to the picture to initialize
630  * \param i_chroma The chroma fourcc to set
631  * \param i_width The width of the picture
632  * \param i_height The height of the picture
633  * \param i_aspect The aspect ratio of the picture
634  */
635 int __vout_InitPicture( vlc_object_t *p_this, picture_t *p_pic,
636                         vlc_fourcc_t i_chroma,
637                         int i_width, int i_height, int i_aspect )
638 {
639     int i_index, i_width_aligned, i_height_aligned;
640
641     /* Store default values */
642     for( i_index = 0; i_index < VOUT_MAX_PLANES; i_index++ )
643     {
644         p_pic->p[i_index].p_pixels = NULL;
645         p_pic->p[i_index].i_pixel_pitch = 1;
646     }
647
648     p_pic->pf_release = 0;
649     p_pic->pf_lock = 0;
650     p_pic->pf_unlock = 0;
651     p_pic->i_refcount = 0;
652
653     vout_InitFormat( &p_pic->format, i_chroma, i_width, i_height, i_aspect );
654
655     /* Make sure the real dimensions are a multiple of 16 */
656     i_width_aligned = (i_width + 15) >> 4 << 4;
657     i_height_aligned = (i_height + 15) >> 4 << 4;
658
659     /* Calculate coordinates */
660     switch( i_chroma )
661     {
662         case FOURCC_I411:
663             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
664             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
665             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
666             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
667             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
668             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
669             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 4;
670             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 4;
671             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
672             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
673             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 4;
674             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 4;
675             p_pic->i_planes = 3;
676             break;
677
678         case FOURCC_I410:
679         case FOURCC_YVU9:
680             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
681             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
682             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
683             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
684             p_pic->p[ U_PLANE ].i_lines = i_height_aligned / 4;
685             p_pic->p[ U_PLANE ].i_visible_lines = i_height / 4;
686             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 4;
687             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 4;
688             p_pic->p[ V_PLANE ].i_lines = i_height_aligned / 4;
689             p_pic->p[ V_PLANE ].i_visible_lines = i_height / 4;
690             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 4;
691             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 4;
692             p_pic->i_planes = 3;
693             break;
694
695         case FOURCC_YV12:
696         case FOURCC_I420:
697         case FOURCC_IYUV:
698             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
699             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
700             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
701             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
702             p_pic->p[ U_PLANE ].i_lines = i_height_aligned / 2;
703             p_pic->p[ U_PLANE ].i_visible_lines = i_height / 2;
704             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 2;
705             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 2;
706             p_pic->p[ V_PLANE ].i_lines = i_height_aligned / 2;
707             p_pic->p[ V_PLANE ].i_visible_lines = i_height / 2;
708             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 2;
709             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 2;
710             p_pic->i_planes = 3;
711             break;
712
713         case FOURCC_I422:
714             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
715             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
716             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
717             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
718             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
719             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
720             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 2;
721             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 2;
722             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
723             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
724             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 2;
725             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 2;
726             p_pic->i_planes = 3;
727             break;
728
729         case FOURCC_I444:
730             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
731             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
732             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
733             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
734             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
735             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
736             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned;
737             p_pic->p[ U_PLANE ].i_visible_pitch = i_width;
738             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
739             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
740             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned;
741             p_pic->p[ V_PLANE ].i_visible_pitch = i_width;
742             p_pic->i_planes = 3;
743             break;
744
745         case FOURCC_YUVA:
746             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
747             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
748             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
749             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
750             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
751             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
752             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned;
753             p_pic->p[ U_PLANE ].i_visible_pitch = i_width;
754             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
755             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
756             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned;
757             p_pic->p[ V_PLANE ].i_visible_pitch = i_width;
758             p_pic->p[ A_PLANE ].i_lines = i_height_aligned;
759             p_pic->p[ A_PLANE ].i_visible_lines = i_height;
760             p_pic->p[ A_PLANE ].i_pitch = i_width_aligned;
761             p_pic->p[ A_PLANE ].i_visible_pitch = i_width;
762             p_pic->i_planes = 4;
763             break;
764
765         case FOURCC_YUVP:
766             p_pic->p->i_lines = i_height_aligned;
767             p_pic->p->i_visible_lines = i_height;
768             p_pic->p->i_pitch = i_width_aligned;
769             p_pic->p->i_visible_pitch = i_width;
770             p_pic->p->i_pixel_pitch = 8;
771             p_pic->i_planes = 1;
772             break;
773
774         case FOURCC_Y211:
775             p_pic->p->i_lines = i_height_aligned;
776             p_pic->p->i_visible_lines = i_height;
777             p_pic->p->i_pitch = i_width_aligned;
778             p_pic->p->i_visible_pitch = i_width;
779             p_pic->p->i_pixel_pitch = 4;
780             p_pic->i_planes = 1;
781             break;
782
783         case FOURCC_UYVY:
784         case FOURCC_YUY2:
785             p_pic->p->i_lines = i_height_aligned;
786             p_pic->p->i_visible_lines = i_height;
787             p_pic->p->i_pitch = i_width_aligned * 2;
788             p_pic->p->i_visible_pitch = i_width * 2;
789             p_pic->p->i_pixel_pitch = 4;
790             p_pic->i_planes = 1;
791             break;
792
793         case FOURCC_RGB2:
794             p_pic->p->i_lines = i_height_aligned;
795             p_pic->p->i_visible_lines = i_height;
796             p_pic->p->i_pitch = i_width_aligned;
797             p_pic->p->i_visible_pitch = i_width;
798             p_pic->p->i_pixel_pitch = 1;
799             p_pic->i_planes = 1;
800             break;
801
802         case FOURCC_RV15:
803             p_pic->p->i_lines = i_height_aligned;
804             p_pic->p->i_visible_lines = i_height;
805             p_pic->p->i_pitch = i_width_aligned * 2;
806             p_pic->p->i_visible_pitch = i_width * 2;
807             p_pic->p->i_pixel_pitch = 2;
808             p_pic->i_planes = 1;
809             break;
810
811         case FOURCC_RV16:
812             p_pic->p->i_lines = i_height_aligned;
813             p_pic->p->i_visible_lines = i_height;
814             p_pic->p->i_pitch = i_width_aligned * 2;
815             p_pic->p->i_visible_pitch = i_width * 2;
816             p_pic->p->i_pixel_pitch = 2;
817             p_pic->i_planes = 1;
818             break;
819
820         case FOURCC_RV24:
821             p_pic->p->i_lines = i_height_aligned;
822             p_pic->p->i_visible_lines = i_height;
823             p_pic->p->i_pitch = i_width_aligned * 3;
824             p_pic->p->i_visible_pitch = i_width * 3;
825             p_pic->p->i_pixel_pitch = 3;
826             p_pic->i_planes = 1;
827             break;
828
829         case FOURCC_RV32:
830             p_pic->p->i_lines = i_height_aligned;
831             p_pic->p->i_visible_lines = i_height;
832             p_pic->p->i_pitch = i_width_aligned * 4;
833             p_pic->p->i_visible_pitch = i_width * 4;
834             p_pic->p->i_pixel_pitch = 4;
835             p_pic->i_planes = 1;
836             break;
837
838         default:
839             msg_Err( p_this, "unknown chroma type 0x%.8x (%4.4s)",
840                              i_chroma, (char*)&i_chroma );
841             p_pic->i_planes = 0;
842             return VLC_EGENERIC;
843     }
844
845     return VLC_SUCCESS;
846 }
847
848 /**
849  * Compare two chroma values
850  *
851  * This function returns 1 if the two fourcc values given as argument are
852  * the same format (eg. UYVY/UYNV) or almost the same format (eg. I420/YV12)
853  */
854 int vout_ChromaCmp( vlc_fourcc_t i_chroma, vlc_fourcc_t i_amorhc )
855 {
856     /* If they are the same, they are the same ! */
857     if( i_chroma == i_amorhc )
858     {
859         return 1;
860     }
861
862     /* Check for equivalence classes */
863     switch( i_chroma )
864     {
865         case FOURCC_I420:
866         case FOURCC_IYUV:
867         case FOURCC_YV12:
868             switch( i_amorhc )
869             {
870                 case FOURCC_I420:
871                 case FOURCC_IYUV:
872                 case FOURCC_YV12:
873                     return 1;
874
875                 default:
876                     return 0;
877             }
878
879         case FOURCC_UYVY:
880         case FOURCC_UYNV:
881         case FOURCC_Y422:
882             switch( i_amorhc )
883             {
884                 case FOURCC_UYVY:
885                 case FOURCC_UYNV:
886                 case FOURCC_Y422:
887                     return 1;
888
889                 default:
890                     return 0;
891             }
892
893         case FOURCC_YUY2:
894         case FOURCC_YUNV:
895             switch( i_amorhc )
896             {
897                 case FOURCC_YUY2:
898                 case FOURCC_YUNV:
899                     return 1;
900
901                 default:
902                     return 0;
903             }
904
905         default:
906             return 0;
907     }
908 }
909
910 /*****************************************************************************
911  * vout_CopyPicture: copy a picture to another one
912  *****************************************************************************
913  * This function takes advantage of the image format, and reduces the
914  * number of calls to memcpy() to the minimum. Source and destination
915  * images must have same width (hence i_visible_pitch), height, and chroma.
916  *****************************************************************************/
917 void __vout_CopyPicture( vlc_object_t *p_this,
918                          picture_t *p_dest, picture_t *p_src )
919 {
920     int i;
921
922     for( i = 0; i < p_src->i_planes ; i++ )
923     {
924         if( p_src->p[i].i_pitch == p_dest->p[i].i_pitch )
925         {
926             /* There are margins, but with the same width : perfect ! */
927             p_this->p_vlc->pf_memcpy(
928                          p_dest->p[i].p_pixels, p_src->p[i].p_pixels,
929                          p_src->p[i].i_pitch * p_src->p[i].i_visible_lines );
930         }
931         else
932         {
933             /* We need to proceed line by line */
934             uint8_t *p_in = p_src->p[i].p_pixels;
935             uint8_t *p_out = p_dest->p[i].p_pixels;
936             int i_line;
937
938             for( i_line = p_src->p[i].i_visible_lines; i_line--; )
939             {
940                 p_this->p_vlc->pf_memcpy( p_out, p_in,
941                                           p_src->p[i].i_visible_pitch );
942                 p_in += p_src->p[i].i_pitch;
943                 p_out += p_dest->p[i].i_pitch;
944             }
945         }
946     }
947
948     p_dest->date = p_src->date;
949     p_dest->b_force = p_src->b_force;
950     p_dest->i_nb_fields = p_src->i_nb_fields;
951     p_dest->b_progressive = p_src->b_progressive;
952     p_dest->b_top_field_first = p_src->b_top_field_first;
953 }