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