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 #ifdef HAVE_LIBSWSCALE_SWSCALE_H
39 # include <libswscale/swscale.h>
40 #elif defined(HAVE_FFMPEG_SWSCALE_H)
41 # include <ffmpeg/swscale.h>
44 #include "../codec/avcodec/chroma.h" // Chroma Avutil <-> VLC conversion
46 /* Gruikkkkkkkkkk!!!!! */
48 #define AVPALETTE_SIZE (256 * sizeof(uint32_t))
50 /*****************************************************************************
52 *****************************************************************************/
53 static int OpenScaler( vlc_object_t * );
54 static void CloseScaler( vlc_object_t * );
56 #define SCALEMODE_TEXT N_("Scaling mode")
57 #define SCALEMODE_LONGTEXT N_("Scaling mode to use.")
59 static const int pi_mode_values[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
60 const char *const ppsz_mode_descriptions[] =
61 { N_("Fast bilinear"), N_("Bilinear"), N_("Bicubic (good quality)"),
62 N_("Experimental"), N_("Nearest neighbour (bad quality)"),
63 N_("Area"), N_("Luma bicubic / chroma bilinear"), N_("Gauss"),
64 N_("SincR"), N_("Lanczos"), N_("Bicubic spline") };
67 set_description( N_("Video scaling filter") )
68 set_shortname( N_("Swscale" ) )
69 set_capability( "video filter2", 150 )
70 set_category( CAT_VIDEO )
71 set_subcategory( SUBCAT_VIDEO_VFILTER )
72 set_callbacks( OpenScaler, CloseScaler )
73 add_integer( "swscale-mode", 2, SCALEMODE_TEXT, SCALEMODE_LONGTEXT, true )
74 change_integer_list( pi_mode_values, ppsz_mode_descriptions )
77 /* Version checking */
78 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
79 /****************************************************************************
81 ****************************************************************************/
83 void *( *swscale_fast_memcpy )( void *, const void *, size_t );
86 * Internal swscale filter structure.
90 SwsFilter *p_src_filter;
91 SwsFilter *p_dst_filter;
92 int i_cpu_mask, i_sws_flags;
94 video_format_t fmt_in;
95 video_format_t fmt_out;
97 struct SwsContext *ctx;
98 struct SwsContext *ctxA;
110 static picture_t *Filter( filter_t *, picture_t * );
111 static int Init( filter_t * );
112 static void Clean( filter_t * );
124 } ScalerConfiguration;
126 static int GetParameters( ScalerConfiguration *,
127 const video_format_t *p_fmti,
128 const video_format_t *p_fmto,
129 int i_sws_flags_default );
131 static int GetSwsCpuMask(void);
133 /* SwScaler point resize quality seems really bad, let our scale module do it
134 * (change it to true to try) */
135 #define ALLOW_YUVP (false)
136 /* SwScaler does not like too small picture */
137 #define MINIMUM_WIDTH (32)
139 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
142 /*****************************************************************************
143 * OpenScaler: probe the filter and return score
144 *****************************************************************************/
145 static int OpenScaler( vlc_object_t *p_this )
147 filter_t *p_filter = (filter_t*)p_this;
152 if( GetParameters( NULL,
153 &p_filter->fmt_in.video,
154 &p_filter->fmt_out.video, 0 ) )
158 p_filter->pf_video_filter = Filter;
159 /* Allocate the memory needed to store the decoder's structure */
160 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
163 /* FIXME pointer assignment may not be atomic */
164 swscale_fast_memcpy = vlc_memcpy;
166 /* Set CPU capabilities */
167 p_sys->i_cpu_mask = GetSwsCpuMask();
170 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
173 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
174 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
175 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
176 case 3: p_sys->i_sws_flags = SWS_X; break;
177 case 4: p_sys->i_sws_flags = SWS_POINT; break;
178 case 5: p_sys->i_sws_flags = SWS_AREA; break;
179 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
180 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
181 case 8: p_sys->i_sws_flags = SWS_SINC; break;
182 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
183 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
184 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
187 p_sys->p_src_filter = NULL;
188 p_sys->p_dst_filter = NULL;
193 p_sys->p_src_a = NULL;
194 p_sys->p_dst_a = NULL;
195 p_sys->p_src_e = NULL;
196 p_sys->p_dst_e = NULL;
197 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
198 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
200 if( Init( p_filter ) )
202 if( p_sys->p_src_filter )
203 sws_freeFilter( p_sys->p_src_filter );
208 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
209 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
210 (char *)&p_filter->fmt_in.video.i_chroma,
211 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
212 (char *)&p_filter->fmt_out.video.i_chroma,
213 ppsz_mode_descriptions[i_sws_mode] );
218 /*****************************************************************************
219 * CloseFilter: clean up the filter
220 *****************************************************************************/
221 static void CloseScaler( vlc_object_t *p_this )
223 filter_t *p_filter = (filter_t*)p_this;
224 filter_sys_t *p_sys = p_filter->p_sys;
227 if( p_sys->p_src_filter )
228 sws_freeFilter( p_sys->p_src_filter );
232 /*****************************************************************************
234 *****************************************************************************/
235 static int GetSwsCpuMask(void)
237 const unsigned int i_cpu = vlc_CPU();
240 if( i_cpu & CPU_CAPABILITY_MMX )
241 i_sws_cpu |= SWS_CPU_CAPS_MMX;
242 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
243 if( i_cpu & CPU_CAPABILITY_MMXEXT )
244 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
246 if( i_cpu & CPU_CAPABILITY_3DNOW )
247 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
249 if( i_cpu & CPU_CAPABILITY_ALTIVEC )
250 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
254 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
256 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
257 p_fmt1->i_width == p_fmt2->i_width &&
258 p_fmt1->i_height == p_fmt2->i_height;
261 static void FixParameters( int *pi_fmt, bool *pb_has_a, bool *pb_swap_uv, vlc_fourcc_t fmt )
266 *pi_fmt = PIX_FMT_YUV444P;
270 *pi_fmt = PIX_FMT_BGR32;
274 *pi_fmt = PIX_FMT_YUV420P;
278 *pi_fmt = PIX_FMT_YUV410P;
281 case VLC_CODEC_RGB16:
282 *pi_fmt = PIX_FMT_RGB565;
289 static int GetParameters( ScalerConfiguration *p_cfg,
290 const video_format_t *p_fmti,
291 const video_format_t *p_fmto,
292 int i_sws_flags_default )
297 bool b_has_ai = false;
298 bool b_has_ao = false;
299 int i_sws_flags = i_sws_flags_default;
300 bool b_swap_uvi = false;
301 bool b_swap_uvo = false;
303 GetFfmpegChroma( &i_fmti, *p_fmti );
304 GetFfmpegChroma( &i_fmto, *p_fmto );
306 if( p_fmti->i_chroma == p_fmto->i_chroma )
308 if( p_fmti->i_chroma == VLC_CODEC_YUVP && ALLOW_YUVP )
310 i_fmti = i_fmto = PIX_FMT_GRAY8;
311 i_sws_flags = SWS_POINT;
315 FixParameters( &i_fmti, &b_has_ai, &b_swap_uvi, p_fmti->i_chroma );
316 FixParameters( &i_fmto, &b_has_ao, &b_swap_uvo, p_fmto->i_chroma );
318 /* FIXME TODO removed when ffmpeg is fixed
319 * Without SWS_ACCURATE_RND the quality is really bad for some conversions */
325 i_sws_flags |= SWS_ACCURATE_RND;
331 p_cfg->i_fmti = i_fmti;
332 p_cfg->i_fmto = i_fmto;
333 p_cfg->b_has_a = b_has_ai && b_has_ao;
334 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
335 p_cfg->b_copy = i_fmti == i_fmto &&
336 p_fmti->i_width == p_fmto->i_width &&
337 p_fmti->i_height == p_fmto->i_height;
338 p_cfg->b_swap_uvi = b_swap_uvi;
339 p_cfg->b_swap_uvo = b_swap_uvo;
340 p_cfg->i_sws_flags = i_sws_flags;
343 if( i_fmti < 0 || i_fmto < 0 )
349 static int Init( filter_t *p_filter )
351 filter_sys_t *p_sys = p_filter->p_sys;
352 const video_format_t *p_fmti = &p_filter->fmt_in.video;
353 const video_format_t *p_fmto = &p_filter->fmt_out.video;
355 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
356 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
363 /* Init with new parameters */
364 ScalerConfiguration cfg;
365 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
367 msg_Err( p_filter, "format not supported" );
370 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
372 msg_Err( p_filter, "0 width not supported" );
376 /* swscale does not like too small width */
377 p_sys->i_extend_factor = 1;
378 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
379 p_sys->i_extend_factor++;
381 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
382 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
383 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
385 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
386 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
387 struct SwsContext *ctx;
389 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
390 i_fmto_width, p_fmto->i_height, i_fmto,
391 cfg.i_sws_flags | p_sys->i_cpu_mask,
392 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
400 p_sys->p_src_a = picture_New( VLC_CODEC_GREY, i_fmti_width, p_fmti->i_height, 0, 1 );
401 p_sys->p_dst_a = picture_New( VLC_CODEC_GREY, i_fmto_width, p_fmto->i_height, 0, 1 );
403 if( p_sys->i_extend_factor != 1 )
405 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0, 1 );
406 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0, 1 );
409 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 );
411 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 );
415 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
416 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
418 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
423 p_sys->b_add_a = cfg.b_add_a;
424 p_sys->b_copy = cfg.b_copy;
425 p_sys->fmt_in = *p_fmti;
426 p_sys->fmt_out = *p_fmto;
427 p_sys->b_swap_uvi = cfg.b_swap_uvi;
428 p_sys->b_swap_uvo = cfg.b_swap_uvo;
431 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
432 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
433 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
434 p_sys->i_extend_factor );
438 static void Clean( filter_t *p_filter )
440 filter_sys_t *p_sys = p_filter->p_sys;
443 picture_Release( p_sys->p_src_e );
445 picture_Release( p_sys->p_dst_e );
448 picture_Release( p_sys->p_src_a );
450 picture_Release( p_sys->p_dst_a );
453 sws_freeContext( p_sys->ctxA );
456 sws_freeContext( p_sys->ctx );
458 /* We have to set it to null has we call be called again :( */
461 p_sys->p_src_a = NULL;
462 p_sys->p_dst_a = NULL;
463 p_sys->p_src_e = NULL;
464 p_sys->p_dst_e = NULL;
467 static void GetPixels( uint8_t *pp_pixel[4], int pi_pitch[4],
468 const picture_t *p_picture,
469 int i_plane_start, int i_plane_count,
472 assert( !b_swap_uv || i_plane_count >= 3 );
474 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
476 const int nd = ( b_swap_uv && n >= 1 && n <= 2 ) ? (3 - n) : n;
477 pp_pixel[nd] = p_picture->p[i_plane_start+n].p_pixels;
478 pi_pitch[nd] = p_picture->p[i_plane_start+n].i_pitch;
487 static void ExtractA( 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+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
496 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
498 plane_t *d = &p_dst->p[0];
499 const plane_t *s = &p_src->p[0];
501 for( unsigned y = 0; y < i_height; y++ )
502 for( unsigned x = 0; x < i_width; x++ )
503 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
505 static void FillA( plane_t *d, int i_offset )
507 for( int y = 0; y < d->i_visible_lines; y++ )
508 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
509 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
512 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
514 picture_Copy( p_dst, p_src );
515 for( int n = 0; n < p_dst->i_planes; n++ )
517 const plane_t *s = &p_src->p[n];
518 plane_t *d = &p_dst->p[n];
520 for( int y = 0; y < s->i_lines; y++ )
522 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
523 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 );
528 static void SwapUV( picture_t *p_dst, const picture_t *p_src )
530 picture_t tmp = *p_src;
531 tmp.p[1] = p_src->p[2];
532 tmp.p[2] = p_src->p[1];
534 picture_CopyPixels( p_dst, &tmp );
536 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
537 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count,
538 bool b_swap_uvi, bool b_swap_uvo )
540 uint8_t palette[AVPALETTE_SIZE];
542 uint8_t *src[4]; int src_stride[4];
543 uint8_t *dst[4]; int dst_stride[4];
545 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count, b_swap_uvi );
546 if( p_filter->fmt_in.video.i_chroma == VLC_CODEC_RGBP )
548 memset( palette, 0, sizeof(palette) );
549 if( p_filter->fmt_in.video.p_palette )
550 memcpy( palette, p_filter->fmt_in.video.p_palette->palette,
551 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
556 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count, b_swap_uvo );
558 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
559 sws_scale( ctx, src, src_stride, 0, i_height,
562 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
567 /****************************************************************************
568 * Filter: the whole thing
569 ****************************************************************************
570 * This function is called just after the thread is launched.
571 ****************************************************************************/
572 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
574 filter_sys_t *p_sys = p_filter->p_sys;
575 const video_format_t *p_fmti = &p_filter->fmt_in.video;
576 const video_format_t *p_fmto = &p_filter->fmt_out.video;
577 picture_t *p_pic_dst;
579 /* Check if format properties changed */
580 if( Init( p_filter ) )
582 picture_Release( p_pic );
586 /* Request output picture */
587 p_pic_dst = filter_NewPicture( p_filter );
590 picture_Release( p_pic );
595 picture_t *p_src = p_pic;
596 picture_t *p_dst = p_pic_dst;
597 if( p_sys->i_extend_factor != 1 )
599 p_src = p_sys->p_src_e;
600 p_dst = p_sys->p_dst_e;
602 CopyPad( p_src, p_pic );
605 if( p_sys->b_copy && p_sys->b_swap_uvi == p_sys->b_swap_uvo )
606 picture_CopyPixels( p_dst, p_src );
607 else if( p_sys->b_copy )
608 SwapUV( p_dst, p_src );
610 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3,
611 p_sys->b_swap_uvi, p_sys->b_swap_uvo );
614 /* We extract the A plane to rescale it, and then we reinject it. */
615 if( p_fmti->i_chroma == VLC_CODEC_RGBA )
616 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
618 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
620 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1, false, false );
621 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
622 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
624 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
626 else if( p_sys->b_add_a )
628 /* We inject a complete opaque alpha plane */
629 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
630 FillA( &p_dst->p[0], OFFSET_A );
632 FillA( &p_dst->p[A_PLANE], 0 );
635 if( p_sys->i_extend_factor != 1 )
637 picture_CopyPixels( p_pic_dst, p_dst );
640 picture_CopyProperties( p_pic_dst, p_pic );
641 picture_Release( p_pic );
645 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
647 int OpenScaler( vlc_object_t *p_this )
652 void CloseScaler( vlc_object_t *p_this )
656 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */