1 /*****************************************************************************
2 * swscale.c: scaling and chroma conversion using libswscale
3 *****************************************************************************
4 * Copyright (C) 1999-2008 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_filter.h>
38 #include <libswscale/swscale.h>
40 #include "../codec/avcodec/chroma.h" // Chroma Avutil <-> VLC conversion
42 /* Gruikkkkkkkkkk!!!!! */
44 #define AVPALETTE_SIZE (256 * sizeof(uint32_t))
46 /*****************************************************************************
48 *****************************************************************************/
49 static int OpenScaler( vlc_object_t * );
50 static void CloseScaler( vlc_object_t * );
52 #define SCALEMODE_TEXT N_("Scaling mode")
53 #define SCALEMODE_LONGTEXT N_("Scaling mode to use.")
55 static const int pi_mode_values[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
56 const char *const ppsz_mode_descriptions[] =
57 { N_("Fast bilinear"), N_("Bilinear"), N_("Bicubic (good quality)"),
58 N_("Experimental"), N_("Nearest neighbour (bad quality)"),
59 N_("Area"), N_("Luma bicubic / chroma bilinear"), N_("Gauss"),
60 N_("SincR"), N_("Lanczos"), N_("Bicubic spline") };
63 set_description( N_("Video scaling filter") )
64 set_shortname( N_("Swscale" ) )
65 set_capability( "video filter2", 150 )
66 set_category( CAT_VIDEO )
67 set_subcategory( SUBCAT_VIDEO_VFILTER )
68 set_callbacks( OpenScaler, CloseScaler )
69 add_integer( "swscale-mode", 2, SCALEMODE_TEXT, SCALEMODE_LONGTEXT, true )
70 change_integer_list( pi_mode_values, ppsz_mode_descriptions )
73 /* Version checking */
74 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
75 /****************************************************************************
77 ****************************************************************************/
80 * Internal swscale filter structure.
84 SwsFilter *p_src_filter;
85 SwsFilter *p_dst_filter;
86 int i_cpu_mask, i_sws_flags;
88 video_format_t fmt_in;
89 video_format_t fmt_out;
91 struct SwsContext *ctx;
92 struct SwsContext *ctxA;
104 static picture_t *Filter( filter_t *, picture_t * );
105 static int Init( filter_t * );
106 static void Clean( filter_t * );
118 } ScalerConfiguration;
120 static int GetParameters( ScalerConfiguration *,
121 const video_format_t *p_fmti,
122 const video_format_t *p_fmto,
123 int i_sws_flags_default );
125 static int GetSwsCpuMask(void);
127 /* SwScaler point resize quality seems really bad, let our scale module do it
128 * (change it to true to try) */
129 #define ALLOW_YUVP (false)
130 /* SwScaler does not like too small picture */
131 #define MINIMUM_WIDTH (32)
133 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
136 /*****************************************************************************
137 * OpenScaler: probe the filter and return score
138 *****************************************************************************/
139 static int OpenScaler( vlc_object_t *p_this )
141 filter_t *p_filter = (filter_t*)p_this;
146 if( GetParameters( NULL,
147 &p_filter->fmt_in.video,
148 &p_filter->fmt_out.video, 0 ) )
152 p_filter->pf_video_filter = Filter;
153 /* Allocate the memory needed to store the decoder's structure */
154 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
157 /* Set CPU capabilities */
158 p_sys->i_cpu_mask = GetSwsCpuMask();
161 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
164 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
165 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
166 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
167 case 3: p_sys->i_sws_flags = SWS_X; break;
168 case 4: p_sys->i_sws_flags = SWS_POINT; break;
169 case 5: p_sys->i_sws_flags = SWS_AREA; break;
170 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
171 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
172 case 8: p_sys->i_sws_flags = SWS_SINC; break;
173 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
174 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
175 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
178 p_sys->p_src_filter = NULL;
179 p_sys->p_dst_filter = NULL;
184 p_sys->p_src_a = NULL;
185 p_sys->p_dst_a = NULL;
186 p_sys->p_src_e = NULL;
187 p_sys->p_dst_e = NULL;
188 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
189 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
191 if( Init( p_filter ) )
193 if( p_sys->p_src_filter )
194 sws_freeFilter( p_sys->p_src_filter );
199 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
200 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
201 (char *)&p_filter->fmt_in.video.i_chroma,
202 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
203 (char *)&p_filter->fmt_out.video.i_chroma,
204 ppsz_mode_descriptions[i_sws_mode] );
209 /*****************************************************************************
210 * CloseFilter: clean up the filter
211 *****************************************************************************/
212 static void CloseScaler( vlc_object_t *p_this )
214 filter_t *p_filter = (filter_t*)p_this;
215 filter_sys_t *p_sys = p_filter->p_sys;
218 if( p_sys->p_src_filter )
219 sws_freeFilter( p_sys->p_src_filter );
223 /*****************************************************************************
225 *****************************************************************************/
226 static int GetSwsCpuMask(void)
228 const unsigned int i_cpu = vlc_CPU();
231 if( i_cpu & CPU_CAPABILITY_MMX )
232 i_sws_cpu |= SWS_CPU_CAPS_MMX;
233 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
234 if( i_cpu & CPU_CAPABILITY_MMXEXT )
235 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
237 if( i_cpu & CPU_CAPABILITY_3DNOW )
238 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
240 if( i_cpu & CPU_CAPABILITY_ALTIVEC )
241 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
245 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
247 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
248 p_fmt1->i_width == p_fmt2->i_width &&
249 p_fmt1->i_height == p_fmt2->i_height;
252 static void FixParameters( int *pi_fmt, bool *pb_has_a, bool *pb_swap_uv, vlc_fourcc_t fmt )
257 *pi_fmt = PIX_FMT_YUV444P;
261 *pi_fmt = PIX_FMT_BGR32;
265 *pi_fmt = PIX_FMT_YUV420P;
269 *pi_fmt = PIX_FMT_YUV410P;
277 static int GetParameters( ScalerConfiguration *p_cfg,
278 const video_format_t *p_fmti,
279 const video_format_t *p_fmto,
280 int i_sws_flags_default )
285 bool b_has_ai = false;
286 bool b_has_ao = false;
287 int i_sws_flags = i_sws_flags_default;
288 bool b_swap_uvi = false;
289 bool b_swap_uvo = false;
291 GetFfmpegChroma( &i_fmti, *p_fmti );
292 GetFfmpegChroma( &i_fmto, *p_fmto );
294 if( p_fmti->i_chroma == p_fmto->i_chroma )
296 if( p_fmti->i_chroma == VLC_CODEC_YUVP && ALLOW_YUVP )
298 i_fmti = i_fmto = PIX_FMT_GRAY8;
299 i_sws_flags = SWS_POINT;
303 FixParameters( &i_fmti, &b_has_ai, &b_swap_uvi, p_fmti->i_chroma );
304 FixParameters( &i_fmto, &b_has_ao, &b_swap_uvo, p_fmto->i_chroma );
307 /* FIXME TODO removed when ffmpeg is fixed
308 * Without SWS_ACCURATE_RND the quality is really bad for some conversions */
314 i_sws_flags |= SWS_ACCURATE_RND;
321 p_cfg->i_fmti = i_fmti;
322 p_cfg->i_fmto = i_fmto;
323 p_cfg->b_has_a = b_has_ai && b_has_ao;
324 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
325 p_cfg->b_copy = i_fmti == i_fmto &&
326 p_fmti->i_width == p_fmto->i_width &&
327 p_fmti->i_height == p_fmto->i_height;
328 p_cfg->b_swap_uvi = b_swap_uvi;
329 p_cfg->b_swap_uvo = b_swap_uvo;
330 p_cfg->i_sws_flags = i_sws_flags;
333 if( i_fmti < 0 || i_fmto < 0 )
339 static int Init( filter_t *p_filter )
341 filter_sys_t *p_sys = p_filter->p_sys;
342 const video_format_t *p_fmti = &p_filter->fmt_in.video;
343 video_format_t *p_fmto = &p_filter->fmt_out.video;
345 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
346 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
353 /* Init with new parameters */
354 ScalerConfiguration cfg;
355 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
357 msg_Err( p_filter, "format not supported" );
360 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
362 msg_Err( p_filter, "0 width not supported" );
366 /* swscale does not like too small width */
367 p_sys->i_extend_factor = 1;
368 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
369 p_sys->i_extend_factor++;
371 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
372 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
373 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
375 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
376 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
377 struct SwsContext *ctx;
379 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
380 i_fmto_width, p_fmto->i_height, i_fmto,
381 cfg.i_sws_flags | p_sys->i_cpu_mask,
382 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
390 p_sys->p_src_a = picture_New( VLC_CODEC_GREY, i_fmti_width, p_fmti->i_height, 0, 1 );
391 p_sys->p_dst_a = picture_New( VLC_CODEC_GREY, i_fmto_width, p_fmto->i_height, 0, 1 );
393 if( p_sys->i_extend_factor != 1 )
395 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0, 1 );
396 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0, 1 );
399 memset( p_sys->p_src_e->p[0].p_pixels, 0, p_sys->p_src_e->p[0].i_pitch * p_sys->p_src_e->p[0].i_lines );
401 memset( p_sys->p_dst_e->p[0].p_pixels, 0, p_sys->p_dst_e->p[0].i_pitch * p_sys->p_dst_e->p[0].i_lines );
405 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
406 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
408 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
413 p_sys->b_add_a = cfg.b_add_a;
414 p_sys->b_copy = cfg.b_copy;
415 p_sys->fmt_in = *p_fmti;
416 p_sys->fmt_out = *p_fmto;
417 p_sys->b_swap_uvi = cfg.b_swap_uvi;
418 p_sys->b_swap_uvo = cfg.b_swap_uvo;
420 video_format_ScaleCropAr( p_fmto, p_fmti );
422 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
423 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
424 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
425 p_sys->i_extend_factor );
429 static void Clean( filter_t *p_filter )
431 filter_sys_t *p_sys = p_filter->p_sys;
434 picture_Release( p_sys->p_src_e );
436 picture_Release( p_sys->p_dst_e );
439 picture_Release( p_sys->p_src_a );
441 picture_Release( p_sys->p_dst_a );
444 sws_freeContext( p_sys->ctxA );
447 sws_freeContext( p_sys->ctx );
449 /* We have to set it to null has we call be called again :( */
452 p_sys->p_src_a = NULL;
453 p_sys->p_dst_a = NULL;
454 p_sys->p_src_e = NULL;
455 p_sys->p_dst_e = NULL;
458 static void GetPixels( uint8_t *pp_pixel[4], int pi_pitch[4],
459 const picture_t *p_picture,
460 int i_plane_start, int i_plane_count,
463 assert( !b_swap_uv || i_plane_count >= 3 );
465 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
467 const int nd = ( b_swap_uv && n >= 1 && n <= 2 ) ? (3 - n) : n;
468 pp_pixel[nd] = p_picture->p[i_plane_start+n].p_pixels;
469 pi_pitch[nd] = p_picture->p[i_plane_start+n].i_pitch;
478 static void ExtractA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
480 plane_t *d = &p_dst->p[0];
481 const plane_t *s = &p_src->p[0];
483 for( unsigned y = 0; y < i_height; y++ )
484 for( unsigned x = 0; x < i_width; x++ )
485 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
487 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
489 plane_t *d = &p_dst->p[0];
490 const plane_t *s = &p_src->p[0];
492 for( unsigned y = 0; y < i_height; y++ )
493 for( unsigned x = 0; x < i_width; x++ )
494 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
496 static void FillA( plane_t *d, int i_offset )
498 for( int y = 0; y < d->i_visible_lines; y++ )
499 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
500 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
503 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
505 picture_Copy( p_dst, p_src );
506 for( int n = 0; n < p_dst->i_planes; n++ )
508 const plane_t *s = &p_src->p[n];
509 plane_t *d = &p_dst->p[n];
511 for( int y = 0; y < s->i_lines; y++ )
513 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
514 memcpy( &d->p_pixels[y*d->i_pitch + x], &d->p_pixels[y*d->i_pitch + s->i_visible_pitch - s->i_pixel_pitch], s->i_pixel_pitch );
519 static void SwapUV( picture_t *p_dst, const picture_t *p_src )
521 picture_t tmp = *p_src;
522 tmp.p[1] = p_src->p[2];
523 tmp.p[2] = p_src->p[1];
525 picture_CopyPixels( p_dst, &tmp );
527 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
528 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count,
529 bool b_swap_uvi, bool b_swap_uvo )
531 uint8_t palette[AVPALETTE_SIZE];
533 uint8_t *src[4]; int src_stride[4];
534 uint8_t *dst[4]; int dst_stride[4];
536 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count, b_swap_uvi );
537 if( p_filter->fmt_in.video.i_chroma == VLC_CODEC_RGBP )
539 memset( palette, 0, sizeof(palette) );
540 if( p_filter->fmt_in.video.p_palette )
541 memcpy( palette, p_filter->fmt_in.video.p_palette->palette,
542 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
547 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count, b_swap_uvo );
549 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
550 sws_scale( ctx, src, src_stride, 0, i_height,
553 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
558 /****************************************************************************
559 * Filter: the whole thing
560 ****************************************************************************
561 * This function is called just after the thread is launched.
562 ****************************************************************************/
563 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
565 filter_sys_t *p_sys = p_filter->p_sys;
566 const video_format_t *p_fmti = &p_filter->fmt_in.video;
567 const video_format_t *p_fmto = &p_filter->fmt_out.video;
568 picture_t *p_pic_dst;
570 /* Check if format properties changed */
571 if( Init( p_filter ) )
573 picture_Release( p_pic );
577 /* Request output picture */
578 p_pic_dst = filter_NewPicture( p_filter );
581 picture_Release( p_pic );
586 picture_t *p_src = p_pic;
587 picture_t *p_dst = p_pic_dst;
588 if( p_sys->i_extend_factor != 1 )
590 p_src = p_sys->p_src_e;
591 p_dst = p_sys->p_dst_e;
593 CopyPad( p_src, p_pic );
596 if( p_sys->b_copy && p_sys->b_swap_uvi == p_sys->b_swap_uvo )
597 picture_CopyPixels( p_dst, p_src );
598 else if( p_sys->b_copy )
599 SwapUV( p_dst, p_src );
601 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3,
602 p_sys->b_swap_uvi, p_sys->b_swap_uvo );
605 /* We extract the A plane to rescale it, and then we reinject it. */
606 if( p_fmti->i_chroma == VLC_CODEC_RGBA )
607 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
609 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
611 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1, false, false );
612 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
613 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
615 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
617 else if( p_sys->b_add_a )
619 /* We inject a complete opaque alpha plane */
620 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
621 FillA( &p_dst->p[0], OFFSET_A );
623 FillA( &p_dst->p[A_PLANE], 0 );
626 if( p_sys->i_extend_factor != 1 )
628 picture_CopyPixels( p_pic_dst, p_dst );
631 picture_CopyProperties( p_pic_dst, p_pic );
632 picture_Release( p_pic );
636 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
638 int OpenScaler( vlc_object_t *p_this )
643 void CloseScaler( vlc_object_t *p_this )
647 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */