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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include <vlc_filter.h>
37 #ifdef HAVE_LIBSWSCALE_SWSCALE_H
38 # include <libswscale/swscale.h>
39 #elif defined(HAVE_FFMPEG_SWSCALE_H)
40 # include <ffmpeg/swscale.h>
43 /* Gruikkkkkkkkkk!!!!! */
44 #include "../codec/avcodec/chroma.h"
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_capability( "video filter2", 1000 );
65 set_category( CAT_VIDEO );
66 set_subcategory( SUBCAT_VIDEO_VFILTER );
67 set_callbacks( OpenScaler, CloseScaler );
68 add_integer( "swscale-mode", 2, NULL, SCALEMODE_TEXT, SCALEMODE_LONGTEXT, true );
69 change_integer_list( pi_mode_values, ppsz_mode_descriptions, 0 );
72 /* Version checking */
73 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
74 /****************************************************************************
76 ****************************************************************************/
78 void *( *swscale_fast_memcpy )( void *, const void *, size_t );
81 * Internal swscale filter structure.
85 SwsFilter *p_src_filter;
86 SwsFilter *p_dst_filter;
87 int i_cpu_mask, i_sws_flags;
89 video_format_t fmt_in;
90 video_format_t fmt_out;
92 struct SwsContext *ctx;
93 struct SwsContext *ctxA;
102 static picture_t *Filter( filter_t *, picture_t * );
103 static int Init( filter_t * );
104 static void Clean( filter_t * );
106 static int GetParameters( int *pi_fmti, int *pi_fmto, bool *pb_has_a, bool *pb_add_a, int *pi_sws_flags,
107 const video_format_t *p_fmti,
108 const video_format_t *p_fmto,
109 int i_sws_flags_default );
111 static int GetSwsCpuMask(void);
113 /* SwScaler point resize quality seems really bad, let our scale module do it
114 * (change it to true to try) */
115 #define ALLOW_YUVP (false)
116 /* SwScaler does not like too small picture */
117 #define MINIMUM_WIDTH (16)
119 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
122 /*****************************************************************************
123 * OpenScaler: probe the filter and return score
124 *****************************************************************************/
125 static int OpenScaler( vlc_object_t *p_this )
127 filter_t *p_filter = (filter_t*)p_this;
132 float sws_lum_gblur = 0.0, sws_chr_gblur = 0.0;
133 int sws_chr_vshift = 0, sws_chr_hshift = 0;
134 float sws_chr_sharpen = 0.0, sws_lum_sharpen = 0.0;
136 if( GetParameters( NULL, NULL, NULL, NULL, NULL,
137 &p_filter->fmt_in.video,
138 &p_filter->fmt_out.video, 0 ) )
144 p_filter->pf_video_filter = Filter;
145 /* Allocate the memory needed to store the decoder's structure */
146 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
149 /* FIXME pointer assignment may not be atomic */
150 swscale_fast_memcpy = vlc_memcpy;
152 /* Set CPU capabilities */
153 p_sys->i_cpu_mask = GetSwsCpuMask();
156 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
159 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
160 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
161 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
162 case 3: p_sys->i_sws_flags = SWS_X; break;
163 case 4: p_sys->i_sws_flags = SWS_POINT; break;
164 case 5: p_sys->i_sws_flags = SWS_AREA; break;
165 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
166 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
167 case 8: p_sys->i_sws_flags = SWS_SINC; break;
168 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
169 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
170 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
173 p_sys->p_src_filter =
174 sws_getDefaultFilter( sws_lum_gblur, sws_chr_gblur,
175 sws_lum_sharpen, sws_chr_sharpen,
176 sws_chr_hshift, sws_chr_vshift, 0 );
177 p_sys->p_dst_filter = NULL;
182 p_sys->p_src_a = NULL;
183 p_sys->p_dst_a = NULL;
184 p_sys->p_src_e = NULL;
185 p_sys->p_dst_e = NULL;
186 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
187 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
189 if( Init( p_filter ) )
191 if( p_sys->p_src_filter )
192 sws_freeFilter( p_sys->p_src_filter );
197 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
198 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
199 (char *)&p_filter->fmt_in.video.i_chroma,
200 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
201 (char *)&p_filter->fmt_out.video.i_chroma,
202 ppsz_mode_descriptions[i_sws_mode] );
207 /*****************************************************************************
208 * CloseFilter: clean up the filter
209 *****************************************************************************/
210 static void CloseScaler( vlc_object_t *p_this )
212 filter_t *p_filter = (filter_t*)p_this;
213 filter_sys_t *p_sys = p_filter->p_sys;
216 if( p_sys->p_src_filter )
217 sws_freeFilter( p_sys->p_src_filter );
221 /*****************************************************************************
223 *****************************************************************************/
224 static int GetSwsCpuMask(void)
226 const unsigned int i_cpu = vlc_CPU();
229 if( i_cpu & CPU_CAPABILITY_MMX )
230 i_sws_cpu |= SWS_CPU_CAPS_MMX;
231 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
232 if( i_cpu & CPU_CAPABILITY_MMXEXT )
233 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
235 if( i_cpu & CPU_CAPABILITY_3DNOW )
236 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
238 if( i_cpu & CPU_CAPABILITY_ALTIVEC )
239 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
243 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
245 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
246 p_fmt1->i_width == p_fmt2->i_width &&
247 p_fmt1->i_height == p_fmt2->i_height;
250 static int GetParameters( int *pi_fmti, int *pi_fmto, bool *pb_has_a, bool *pb_add_a, int *pi_sws_flags,
251 const video_format_t *p_fmti,
252 const video_format_t *p_fmto,
253 int i_sws_flags_default )
255 int i_fmti = GetFfmpegChroma( p_fmti->i_chroma );
256 int i_fmto = GetFfmpegChroma( p_fmto->i_chroma );
258 bool b_has_a = false;
259 bool b_add_a = false;
260 int i_sws_flags = i_sws_flags_default;
262 if( p_fmti->i_chroma == p_fmto->i_chroma )
264 if( p_fmti->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'P' ) && ALLOW_YUVP )
266 i_fmti = i_fmto = PIX_FMT_GRAY8;
267 i_sws_flags = SWS_POINT;
269 else if( p_fmti->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'A' ) )
271 i_fmti = i_fmto = PIX_FMT_YUV444P;
274 else if( p_fmti->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
276 i_fmti = i_fmto = PIX_FMT_RGBA32;
280 if( i_fmti >= 0 && i_fmto < 0 )
282 /* Special case: injecting dummy alpha plane */
283 switch( p_fmto->i_chroma )
285 case VLC_FOURCC( 'Y', 'U', 'V', 'A' ):
286 i_fmto = PIX_FMT_YUV444P;
289 case VLC_FOURCC( 'R', 'G', 'B', 'A' ):
290 i_fmto = PIX_FMT_RGBA32;
307 *pi_sws_flags = i_sws_flags;
309 if( i_fmti < 0 || i_fmto < 0 )
315 static int Init( filter_t *p_filter )
317 filter_sys_t *p_sys = p_filter->p_sys;
318 const video_format_t *p_fmti = &p_filter->fmt_in.video;
319 const video_format_t *p_fmto = &p_filter->fmt_out.video;
321 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
322 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
329 /* Init with new parameters */
330 int i_fmt_in, i_fmt_out;
334 if( GetParameters( &i_fmt_in, &i_fmt_out, &b_has_a, &b_add_a, &i_sws_flags,
335 p_fmti, p_fmto, p_sys->i_sws_flags ) )
337 msg_Err( p_filter, "format not supported" );
340 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
342 msg_Err( p_filter, "0 width not supported" );
346 /* swscale does not like too small width */
347 p_sys->i_extend_factor = 1;
348 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
349 p_sys->i_extend_factor++;
351 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
352 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
353 for( int n = 0; n < (b_has_a ? 2 : 1); n++ )
355 const int i_fmti = n == 0 ? i_fmt_in : PIX_FMT_GRAY8;
356 const int i_fmto = n == 0 ? i_fmt_out : PIX_FMT_GRAY8;
357 struct SwsContext *ctx;
359 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
360 i_fmto_width, p_fmto->i_height, i_fmto,
361 i_sws_flags | p_sys->i_cpu_mask,
362 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
370 p_sys->p_src_a = picture_New( VLC_FOURCC( 'G', 'R', 'E', 'Y' ), i_fmti_width, p_fmti->i_height, 0 );
371 p_sys->p_dst_a = picture_New( VLC_FOURCC( 'G', 'R', 'E', 'Y' ), i_fmto_width, p_fmto->i_height, 0 );
373 if( p_sys->i_extend_factor != 1 )
375 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0 );
376 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0 );
378 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 );
379 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 );
383 ( b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
384 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
386 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
391 p_sys->b_add_a = b_add_a;
392 p_sys->fmt_in = *p_fmti;
393 p_sys->fmt_out = *p_fmto;
396 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
397 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
398 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
399 p_sys->i_extend_factor );
403 static void Clean( filter_t *p_filter )
405 filter_sys_t *p_sys = p_filter->p_sys;
408 picture_Release( p_sys->p_src_e );
410 picture_Release( p_sys->p_dst_e );
413 picture_Release( p_sys->p_src_a );
415 picture_Release( p_sys->p_dst_a );
418 sws_freeContext( p_sys->ctxA );
421 sws_freeContext( p_sys->ctx );
423 /* We have to set it to null has we call be called again :( */
426 p_sys->p_src_a = NULL;
427 p_sys->p_dst_a = NULL;
428 p_sys->p_src_e = NULL;
429 p_sys->p_dst_e = NULL;
432 static void GetPixels( uint8_t *pp_pixel[3], int pi_pitch[3],
433 const picture_t *p_picture,
434 int i_plane_start, int i_plane_count )
437 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
439 pp_pixel[n] = p_picture->p[i_plane_start+n].p_pixels;
440 pi_pitch[n] = p_picture->p[i_plane_start+n].i_pitch;
449 static void ExtractA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
451 plane_t *d = &p_dst->p[0];
452 const plane_t *s = &p_src->p[0];
454 for( unsigned y = 0; y < i_height; y++ )
455 for( unsigned x = 0; x < i_width; x++ )
456 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
458 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
460 plane_t *d = &p_dst->p[0];
461 const plane_t *s = &p_src->p[0];
463 for( unsigned y = 0; y < i_height; y++ )
464 for( unsigned x = 0; x < i_width; x++ )
465 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
467 static void FillA( plane_t *d, int i_offset )
469 for( int y = 0; y < d->i_visible_lines; y++ )
470 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
471 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
474 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
476 picture_Copy( p_dst, p_src );
477 for( int n = 0; n < p_dst->i_planes; n++ )
479 const plane_t *s = &p_src->p[n];
480 plane_t *d = &p_dst->p[n];
482 for( int y = 0; y < s->i_lines; y++ )
484 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
485 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 );
490 static void Convert( struct SwsContext *ctx,
491 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count )
493 uint8_t *src[3]; int src_stride[3];
494 uint8_t *dst[3]; int dst_stride[3];
496 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count );
497 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count );
499 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
500 sws_scale( ctx, src, src_stride, 0, i_height,
503 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
508 /****************************************************************************
509 * Filter: the whole thing
510 ****************************************************************************
511 * This function is called just after the thread is launched.
512 ****************************************************************************/
513 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
515 filter_sys_t *p_sys = p_filter->p_sys;
516 const video_format_t *p_fmti = &p_filter->fmt_in.video;
517 const video_format_t *p_fmto = &p_filter->fmt_out.video;
518 picture_t *p_pic_dst;
520 /* Check if format properties changed */
521 if( Init( p_filter ) )
523 picture_Release( p_pic );
527 /* Request output picture */
528 p_pic_dst = filter_NewPicture( p_filter );
531 picture_Release( p_pic );
536 picture_t *p_src = p_pic;
537 picture_t *p_dst = p_pic_dst;
538 if( p_sys->i_extend_factor != 1 )
540 p_src = p_sys->p_src_e;
541 p_dst = p_sys->p_dst_e;
543 CopyPad( p_src, p_pic );
546 Convert( p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3 );
549 if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
551 /* We extract the A plane to rescale it, and then we reinject it. */
552 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
554 Convert( p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1 );
556 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
560 Convert( p_sys->ctxA, p_dst, p_src, p_fmti->i_height, 3, 1 );
565 /* We inject a complete opaque alpha plane */
566 if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
567 FillA( &p_dst->p[0], OFFSET_A );
569 FillA( &p_dst->p[A_PLANE], 0 );
572 if( p_sys->i_extend_factor != 1 )
574 picture_CopyPixels( p_pic_dst, p_dst );
577 picture_CopyProperties( p_pic_dst, p_pic );
578 picture_Release( p_pic );
582 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
584 int OpenScaler( vlc_object_t *p_this )
589 void CloseScaler( vlc_object_t *p_this )
593 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */