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", 150 );
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, NULL );
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 * );
113 } ScalerConfiguration;
115 static int GetParameters( ScalerConfiguration *,
116 const video_format_t *p_fmti,
117 const video_format_t *p_fmto,
118 int i_sws_flags_default );
120 static int GetSwsCpuMask(void);
122 /* SwScaler point resize quality seems really bad, let our scale module do it
123 * (change it to true to try) */
124 #define ALLOW_YUVP (false)
125 /* SwScaler does not like too small picture */
126 #define MINIMUM_WIDTH (16)
128 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
131 /*****************************************************************************
132 * OpenScaler: probe the filter and return score
133 *****************************************************************************/
134 static int OpenScaler( vlc_object_t *p_this )
136 filter_t *p_filter = (filter_t*)p_this;
141 float sws_lum_gblur = 0.0, sws_chr_gblur = 0.0;
142 int sws_chr_vshift = 0, sws_chr_hshift = 0;
143 float sws_chr_sharpen = 0.0, sws_lum_sharpen = 0.0;
145 if( GetParameters( NULL,
146 &p_filter->fmt_in.video,
147 &p_filter->fmt_out.video, 0 ) )
151 p_filter->pf_video_filter = Filter;
152 /* Allocate the memory needed to store the decoder's structure */
153 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
156 /* FIXME pointer assignment may not be atomic */
157 swscale_fast_memcpy = vlc_memcpy;
159 /* Set CPU capabilities */
160 p_sys->i_cpu_mask = GetSwsCpuMask();
163 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
166 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
167 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
168 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
169 case 3: p_sys->i_sws_flags = SWS_X; break;
170 case 4: p_sys->i_sws_flags = SWS_POINT; break;
171 case 5: p_sys->i_sws_flags = SWS_AREA; break;
172 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
173 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
174 case 8: p_sys->i_sws_flags = SWS_SINC; break;
175 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
176 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
177 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
180 p_sys->p_src_filter =
181 sws_getDefaultFilter( sws_lum_gblur, sws_chr_gblur,
182 sws_lum_sharpen, sws_chr_sharpen,
183 sws_chr_hshift, sws_chr_vshift, 0 );
184 p_sys->p_dst_filter = NULL;
189 p_sys->p_src_a = NULL;
190 p_sys->p_dst_a = NULL;
191 p_sys->p_src_e = NULL;
192 p_sys->p_dst_e = NULL;
193 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
194 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
196 if( Init( p_filter ) )
198 if( p_sys->p_src_filter )
199 sws_freeFilter( p_sys->p_src_filter );
204 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
205 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
206 (char *)&p_filter->fmt_in.video.i_chroma,
207 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
208 (char *)&p_filter->fmt_out.video.i_chroma,
209 ppsz_mode_descriptions[i_sws_mode] );
214 /*****************************************************************************
215 * CloseFilter: clean up the filter
216 *****************************************************************************/
217 static void CloseScaler( vlc_object_t *p_this )
219 filter_t *p_filter = (filter_t*)p_this;
220 filter_sys_t *p_sys = p_filter->p_sys;
223 if( p_sys->p_src_filter )
224 sws_freeFilter( p_sys->p_src_filter );
228 /*****************************************************************************
230 *****************************************************************************/
231 static int GetSwsCpuMask(void)
233 const unsigned int i_cpu = vlc_CPU();
236 if( i_cpu & CPU_CAPABILITY_MMX )
237 i_sws_cpu |= SWS_CPU_CAPS_MMX;
238 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
239 if( i_cpu & CPU_CAPABILITY_MMXEXT )
240 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
242 if( i_cpu & CPU_CAPABILITY_3DNOW )
243 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
245 if( i_cpu & CPU_CAPABILITY_ALTIVEC )
246 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
250 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
252 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
253 p_fmt1->i_width == p_fmt2->i_width &&
254 p_fmt1->i_height == p_fmt2->i_height;
257 static int GetParameters( ScalerConfiguration *p_cfg,
258 const video_format_t *p_fmti,
259 const video_format_t *p_fmto,
260 int i_sws_flags_default )
265 bool b_has_ai = false;
266 bool b_has_ao = false;
267 int i_sws_flags = i_sws_flags_default;
269 GetFfmpegChroma( &i_fmti, *p_fmti );
270 GetFfmpegChroma( &i_fmto, *p_fmto );
272 if( p_fmti->i_chroma == p_fmto->i_chroma )
274 if( p_fmti->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'P' ) && ALLOW_YUVP )
276 i_fmti = i_fmto = PIX_FMT_GRAY8;
277 i_sws_flags = SWS_POINT;
281 if( p_fmti->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'A' ) )
283 i_fmti = PIX_FMT_YUV444P;
286 else if( p_fmti->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
288 i_fmti = PIX_FMT_RGBA32;
292 if( p_fmto->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'A' ) )
294 i_fmto = PIX_FMT_YUV444P;
297 else if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
299 i_fmti = PIX_FMT_RGBA32;
305 p_cfg->i_fmti = i_fmti;
306 p_cfg->i_fmto = i_fmto;
307 p_cfg->b_has_a = b_has_ai && b_has_ao;
308 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
309 p_cfg->i_sws_flags = i_sws_flags;
312 if( i_fmti < 0 || i_fmto < 0 )
318 static int Init( filter_t *p_filter )
320 filter_sys_t *p_sys = p_filter->p_sys;
321 const video_format_t *p_fmti = &p_filter->fmt_in.video;
322 const video_format_t *p_fmto = &p_filter->fmt_out.video;
324 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
325 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
332 /* Init with new parameters */
333 ScalerConfiguration cfg;
334 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
336 msg_Err( p_filter, "format not supported" );
339 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
341 msg_Err( p_filter, "0 width not supported" );
345 /* swscale does not like too small width */
346 p_sys->i_extend_factor = 1;
347 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
348 p_sys->i_extend_factor++;
350 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
351 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
352 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
354 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
355 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
356 struct SwsContext *ctx;
358 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
359 i_fmto_width, p_fmto->i_height, i_fmto,
360 cfg.i_sws_flags | p_sys->i_cpu_mask,
361 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
369 p_sys->p_src_a = picture_New( VLC_FOURCC( 'G', 'R', 'E', 'Y' ), i_fmti_width, p_fmti->i_height, 0 );
370 p_sys->p_dst_a = picture_New( VLC_FOURCC( 'G', 'R', 'E', 'Y' ), i_fmto_width, p_fmto->i_height, 0 );
372 if( p_sys->i_extend_factor != 1 )
374 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0 );
375 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0 );
377 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 );
378 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 );
382 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
383 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
385 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
390 p_sys->b_add_a = cfg.b_add_a;
391 p_sys->fmt_in = *p_fmti;
392 p_sys->fmt_out = *p_fmto;
395 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
396 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
397 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
398 p_sys->i_extend_factor );
402 static void Clean( filter_t *p_filter )
404 filter_sys_t *p_sys = p_filter->p_sys;
407 picture_Release( p_sys->p_src_e );
409 picture_Release( p_sys->p_dst_e );
412 picture_Release( p_sys->p_src_a );
414 picture_Release( p_sys->p_dst_a );
417 sws_freeContext( p_sys->ctxA );
420 sws_freeContext( p_sys->ctx );
422 /* We have to set it to null has we call be called again :( */
425 p_sys->p_src_a = NULL;
426 p_sys->p_dst_a = NULL;
427 p_sys->p_src_e = NULL;
428 p_sys->p_dst_e = NULL;
431 static void GetPixels( uint8_t *pp_pixel[3], int pi_pitch[3],
432 const picture_t *p_picture,
433 int i_plane_start, int i_plane_count )
436 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
438 pp_pixel[n] = p_picture->p[i_plane_start+n].p_pixels;
439 pi_pitch[n] = p_picture->p[i_plane_start+n].i_pitch;
448 static void ExtractA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
450 plane_t *d = &p_dst->p[0];
451 const plane_t *s = &p_src->p[0];
453 for( unsigned y = 0; y < i_height; y++ )
454 for( unsigned x = 0; x < i_width; x++ )
455 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
457 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
459 plane_t *d = &p_dst->p[0];
460 const plane_t *s = &p_src->p[0];
462 for( unsigned y = 0; y < i_height; y++ )
463 for( unsigned x = 0; x < i_width; x++ )
464 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
466 static void FillA( plane_t *d, int i_offset )
468 for( int y = 0; y < d->i_visible_lines; y++ )
469 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
470 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
473 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
475 picture_Copy( p_dst, p_src );
476 for( int n = 0; n < p_dst->i_planes; n++ )
478 const plane_t *s = &p_src->p[n];
479 plane_t *d = &p_dst->p[n];
481 for( int y = 0; y < s->i_lines; y++ )
483 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
484 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 );
489 static void Convert( struct SwsContext *ctx,
490 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count )
492 uint8_t *src[3]; int src_stride[3];
493 uint8_t *dst[3]; int dst_stride[3];
495 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count );
496 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count );
498 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
499 sws_scale( ctx, src, src_stride, 0, i_height,
502 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
507 /****************************************************************************
508 * Filter: the whole thing
509 ****************************************************************************
510 * This function is called just after the thread is launched.
511 ****************************************************************************/
512 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
514 filter_sys_t *p_sys = p_filter->p_sys;
515 const video_format_t *p_fmti = &p_filter->fmt_in.video;
516 const video_format_t *p_fmto = &p_filter->fmt_out.video;
517 picture_t *p_pic_dst;
519 /* Check if format properties changed */
520 if( Init( p_filter ) )
522 picture_Release( p_pic );
526 /* Request output picture */
527 p_pic_dst = filter_NewPicture( p_filter );
530 picture_Release( p_pic );
535 picture_t *p_src = p_pic;
536 picture_t *p_dst = p_pic_dst;
537 if( p_sys->i_extend_factor != 1 )
539 p_src = p_sys->p_src_e;
540 p_dst = p_sys->p_dst_e;
542 CopyPad( p_src, p_pic );
545 Convert( p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3 );
548 /* We extract the A plane to rescale it, and then we reinject it. */
549 if( p_fmti->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
550 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
552 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
554 Convert( p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1 );
555 if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
556 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
558 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
560 else if( p_sys->b_add_a )
562 /* We inject a complete opaque alpha plane */
563 if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
564 FillA( &p_dst->p[0], OFFSET_A );
566 FillA( &p_dst->p[A_PLANE], 0 );
569 if( p_sys->i_extend_factor != 1 )
571 picture_CopyPixels( p_pic_dst, p_dst );
574 picture_CopyProperties( p_pic_dst, p_pic );
575 picture_Release( p_pic );
579 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
581 int OpenScaler( vlc_object_t *p_this )
586 void CloseScaler( vlc_object_t *p_this )
590 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */