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