1 /*****************************************************************************
2 * swscale.c: scaling and chroma conversion using libswscale
3 *****************************************************************************
4 * Copyright (C) 1999-2008 VLC authors and VideoLAN
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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * 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>
41 # include <TargetConditionals.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 ****************************************************************************/
84 * Internal swscale filter structure.
88 SwsFilter *p_src_filter;
89 SwsFilter *p_dst_filter;
90 int i_cpu_mask, i_sws_flags;
92 video_format_t fmt_in;
93 video_format_t fmt_out;
95 struct SwsContext *ctx;
96 struct SwsContext *ctxA;
108 static picture_t *Filter( filter_t *, picture_t * );
109 static int Init( filter_t * );
110 static void Clean( filter_t * );
122 } ScalerConfiguration;
124 static int GetParameters( ScalerConfiguration *,
125 const video_format_t *p_fmti,
126 const video_format_t *p_fmto,
127 int i_sws_flags_default );
129 static int GetSwsCpuMask(void);
131 /* SwScaler point resize quality seems really bad, let our scale module do it
132 * (change it to true to try) */
133 #define ALLOW_YUVP (false)
134 /* SwScaler does not like too small picture */
135 #define MINIMUM_WIDTH (32)
137 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
140 /*****************************************************************************
141 * OpenScaler: probe the filter and return score
142 *****************************************************************************/
143 static int OpenScaler( vlc_object_t *p_this )
145 filter_t *p_filter = (filter_t*)p_this;
150 if( GetParameters( NULL,
151 &p_filter->fmt_in.video,
152 &p_filter->fmt_out.video, 0 ) )
156 p_filter->pf_video_filter = Filter;
157 /* Allocate the memory needed to store the decoder's structure */
158 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
161 /* Set CPU capabilities */
162 p_sys->i_cpu_mask = GetSwsCpuMask();
165 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
168 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
169 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
170 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
171 case 3: p_sys->i_sws_flags = SWS_X; break;
172 case 4: p_sys->i_sws_flags = SWS_POINT; break;
173 case 5: p_sys->i_sws_flags = SWS_AREA; break;
174 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
175 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
176 case 8: p_sys->i_sws_flags = SWS_SINC; break;
177 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
178 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
179 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
182 p_sys->p_src_filter = NULL;
183 p_sys->p_dst_filter = NULL;
188 p_sys->p_src_a = NULL;
189 p_sys->p_dst_a = NULL;
190 p_sys->p_src_e = NULL;
191 p_sys->p_dst_e = NULL;
192 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
193 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
195 if( Init( p_filter ) )
197 if( p_sys->p_src_filter )
198 sws_freeFilter( p_sys->p_src_filter );
203 msg_Dbg( p_filter, "%ix%i (%ix%i) chroma: %4.4s -> %ix%i (%ix%i) chroma: %4.4s with scaling using %s",
204 p_filter->fmt_in.video.i_visible_width, p_filter->fmt_in.video.i_visible_height,
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_visible_width, p_filter->fmt_out.video.i_visible_height,
208 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
209 (char *)&p_filter->fmt_out.video.i_chroma,
210 ppsz_mode_descriptions[i_sws_mode] );
215 /*****************************************************************************
216 * CloseFilter: clean up the filter
217 *****************************************************************************/
218 static void CloseScaler( vlc_object_t *p_this )
220 filter_t *p_filter = (filter_t*)p_this;
221 filter_sys_t *p_sys = p_filter->p_sys;
224 if( p_sys->p_src_filter )
225 sws_freeFilter( p_sys->p_src_filter );
229 /*****************************************************************************
231 *****************************************************************************/
232 static int GetSwsCpuMask(void)
236 #if defined(__i386__) || defined(__x86_64__)
238 i_sws_cpu |= SWS_CPU_CAPS_MMX;
239 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
240 if( vlc_CPU_MMXEXT() )
241 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
243 if( vlc_CPU_3dNOW() )
244 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
245 #elif defined(__ppc__) || defined(__ppc64__) || defined(__powerpc__)
246 if( vlc_CPU_ALTIVEC() )
247 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
253 static void FixParameters( int *pi_fmt, bool *pb_has_a, bool *pb_swap_uv, vlc_fourcc_t fmt )
257 case VLC_CODEC_YUV422A:
258 *pi_fmt = PIX_FMT_YUV422P;
261 case VLC_CODEC_YUV420A:
262 *pi_fmt = PIX_FMT_YUV420P;
266 *pi_fmt = PIX_FMT_YUV444P;
270 *pi_fmt = PIX_FMT_BGR32;
274 *pi_fmt = PIX_FMT_BGR32_1;
278 *pi_fmt = PIX_FMT_YUV420P;
282 *pi_fmt = PIX_FMT_YUV410P;
290 static int GetParameters( ScalerConfiguration *p_cfg,
291 const video_format_t *p_fmti,
292 const video_format_t *p_fmto,
293 int i_sws_flags_default )
298 bool b_has_ai = false;
299 bool b_has_ao = false;
300 int i_sws_flags = i_sws_flags_default;
301 bool b_swap_uvi = false;
302 bool b_swap_uvo = false;
304 GetFfmpegChroma( &i_fmti, p_fmti );
305 GetFfmpegChroma( &i_fmto, p_fmto );
307 if( p_fmti->i_chroma == p_fmto->i_chroma )
309 if( p_fmti->i_chroma == VLC_CODEC_YUVP && ALLOW_YUVP )
311 i_fmti = i_fmto = PIX_FMT_GRAY8;
312 i_sws_flags = SWS_POINT;
316 FixParameters( &i_fmti, &b_has_ai, &b_swap_uvi, p_fmti->i_chroma );
317 FixParameters( &i_fmto, &b_has_ao, &b_swap_uvo, p_fmto->i_chroma );
319 #if !defined (__ANDROID__) && !defined(TARGET_OS_IPHONE)
320 /* FIXME TODO removed when ffmpeg is fixed
321 * Without SWS_ACCURATE_RND the quality is really bad for some conversions */
327 i_sws_flags |= SWS_ACCURATE_RND;
334 p_cfg->i_fmti = i_fmti;
335 p_cfg->i_fmto = i_fmto;
336 p_cfg->b_has_a = b_has_ai && b_has_ao;
337 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
338 p_cfg->b_copy = i_fmti == i_fmto &&
339 p_fmti->i_visible_width == p_fmto->i_visible_width &&
340 p_fmti->i_visible_height == p_fmto->i_visible_height;
341 p_cfg->b_swap_uvi = b_swap_uvi;
342 p_cfg->b_swap_uvo = b_swap_uvo;
343 p_cfg->i_sws_flags = i_sws_flags;
346 if( i_fmti < 0 || i_fmto < 0 )
352 static int Init( filter_t *p_filter )
354 filter_sys_t *p_sys = p_filter->p_sys;
355 const video_format_t *p_fmti = &p_filter->fmt_in.video;
356 video_format_t *p_fmto = &p_filter->fmt_out.video;
358 if( video_format_IsSimilar( p_fmti, &p_sys->fmt_in ) &&
359 video_format_IsSimilar( p_fmto, &p_sys->fmt_out ) &&
366 /* Init with new parameters */
367 ScalerConfiguration cfg;
368 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
370 msg_Err( p_filter, "format not supported" );
373 if( p_fmti->i_visible_width <= 0 || p_fmti->i_visible_height <= 0 ||
374 p_fmto->i_visible_width <= 0 || p_fmto->i_visible_height <= 0 )
376 msg_Err( p_filter, "invalid scaling: %ix%i -> %ix%i",
377 p_fmti->i_visible_width, p_fmti->i_visible_height,
378 p_fmto->i_visible_width, p_fmto->i_visible_height);
382 /* swscale does not like too small width */
383 p_sys->i_extend_factor = 1;
384 while( __MIN( p_fmti->i_visible_width, p_fmto->i_visible_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
385 p_sys->i_extend_factor++;
387 const unsigned i_fmti_visible_width = p_fmti->i_visible_width * p_sys->i_extend_factor;
388 const unsigned i_fmto_visible_width = p_fmto->i_visible_width * p_sys->i_extend_factor;
389 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
391 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
392 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
393 struct SwsContext *ctx;
395 ctx = sws_getContext( i_fmti_visible_width, p_fmti->i_visible_height, i_fmti,
396 i_fmto_visible_width, p_fmto->i_visible_height, i_fmto,
397 cfg.i_sws_flags | p_sys->i_cpu_mask,
398 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
406 p_sys->p_src_a = picture_New( VLC_CODEC_GREY, i_fmti_visible_width, p_fmti->i_visible_height, 0, 1 );
407 p_sys->p_dst_a = picture_New( VLC_CODEC_GREY, i_fmto_visible_width, p_fmto->i_visible_height, 0, 1 );
409 if( p_sys->i_extend_factor != 1 )
411 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_visible_width, p_fmti->i_visible_height, 0, 1 );
412 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_visible_width, p_fmto->i_visible_height, 0, 1 );
415 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 );
417 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 );
421 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
422 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
424 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
429 p_sys->b_add_a = cfg.b_add_a;
430 p_sys->b_copy = cfg.b_copy;
431 p_sys->fmt_in = *p_fmti;
432 p_sys->fmt_out = *p_fmto;
433 p_sys->b_swap_uvi = cfg.b_swap_uvi;
434 p_sys->b_swap_uvo = cfg.b_swap_uvo;
437 msg_Dbg( p_filter, "%ix%i (%ix%i) chroma: %4.4s -> %ix%i (%ix%i) chroma: %4.4s extend by %d",
438 p_fmti->i_visible_width, p_fmti->i_visible_height, p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
439 p_fmto->i_visible_width, p_fmto->i_visible_height, p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
440 p_sys->i_extend_factor );
444 static void Clean( filter_t *p_filter )
446 filter_sys_t *p_sys = p_filter->p_sys;
449 picture_Release( p_sys->p_src_e );
451 picture_Release( p_sys->p_dst_e );
454 picture_Release( p_sys->p_src_a );
456 picture_Release( p_sys->p_dst_a );
459 sws_freeContext( p_sys->ctxA );
462 sws_freeContext( p_sys->ctx );
464 /* We have to set it to null has we call be called again :( */
467 p_sys->p_src_a = NULL;
468 p_sys->p_dst_a = NULL;
469 p_sys->p_src_e = NULL;
470 p_sys->p_dst_e = NULL;
473 static void GetPixels( uint8_t *pp_pixel[4], int pi_pitch[4],
474 const picture_t *p_picture,
475 int i_plane_start, int i_plane_count,
478 assert( !b_swap_uv || i_plane_count >= 3 );
480 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
482 const int nd = ( b_swap_uv && n >= 1 && n <= 2 ) ? (3 - n) : n;
483 pp_pixel[nd] = p_picture->p[i_plane_start+n].p_pixels;
484 pi_pitch[nd] = p_picture->p[i_plane_start+n].i_pitch;
493 static void ExtractA( picture_t *p_dst, const picture_t *restrict p_src,
494 unsigned i_width, unsigned i_height, unsigned offset )
496 plane_t *d = &p_dst->p[0];
497 const plane_t *s = &p_src->p[0];
499 for( unsigned y = 0; y < i_height; y++ )
500 for( unsigned x = 0; x < i_width; x++ )
501 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+offset];
504 static void InjectA( picture_t *p_dst, const picture_t *restrict p_src,
505 unsigned i_width, unsigned i_height, unsigned offset )
507 plane_t *d = &p_dst->p[0];
508 const plane_t *s = &p_src->p[0];
510 for( unsigned y = 0; y < i_height; y++ )
511 for( unsigned x = 0; x < i_width; x++ )
512 d->p_pixels[y*d->i_pitch+4*x+offset] = s->p_pixels[y*s->i_pitch+x];
515 static void FillA( plane_t *d, unsigned i_offset )
517 for( int y = 0; y < d->i_visible_lines; y++ )
518 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
519 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
522 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
524 picture_Copy( p_dst, p_src );
525 for( int n = 0; n < p_dst->i_planes; n++ )
527 const plane_t *s = &p_src->p[n];
528 plane_t *d = &p_dst->p[n];
530 for( int y = 0; y < s->i_lines; y++ )
532 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
533 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 );
538 static void SwapUV( picture_t *p_dst, const picture_t *p_src )
540 picture_t tmp = *p_src;
541 tmp.p[1] = p_src->p[2];
542 tmp.p[2] = p_src->p[1];
544 picture_CopyPixels( p_dst, &tmp );
546 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
547 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count,
548 bool b_swap_uvi, bool b_swap_uvo )
550 uint8_t palette[AVPALETTE_SIZE];
552 uint8_t *src[4]; int src_stride[4];
553 uint8_t *dst[4]; int dst_stride[4];
555 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count, b_swap_uvi );
556 if( p_filter->fmt_in.video.i_chroma == VLC_CODEC_RGBP )
558 memset( palette, 0, sizeof(palette) );
559 if( p_filter->fmt_in.video.p_palette )
560 memcpy( palette, p_filter->fmt_in.video.p_palette->palette,
561 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
566 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count, b_swap_uvo );
568 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
569 sws_scale( ctx, src, src_stride, 0, i_height,
572 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
577 /****************************************************************************
578 * Filter: the whole thing
579 ****************************************************************************
580 * This function is called just after the thread is launched.
581 ****************************************************************************/
582 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
584 filter_sys_t *p_sys = p_filter->p_sys;
585 const video_format_t *p_fmti = &p_filter->fmt_in.video;
586 const video_format_t *p_fmto = &p_filter->fmt_out.video;
587 picture_t *p_pic_dst;
589 /* Check if format properties changed */
590 if( Init( p_filter ) )
592 picture_Release( p_pic );
596 /* Request output picture */
597 p_pic_dst = filter_NewPicture( p_filter );
600 picture_Release( p_pic );
605 picture_t *p_src = p_pic;
606 picture_t *p_dst = p_pic_dst;
607 if( p_sys->i_extend_factor != 1 )
609 p_src = p_sys->p_src_e;
610 p_dst = p_sys->p_dst_e;
612 CopyPad( p_src, p_pic );
615 if( p_sys->b_copy && p_sys->b_swap_uvi == p_sys->b_swap_uvo )
616 picture_CopyPixels( p_dst, p_src );
617 else if( p_sys->b_copy )
618 SwapUV( p_dst, p_src );
620 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_visible_height, 0, 3,
621 p_sys->b_swap_uvi, p_sys->b_swap_uvo );
624 /* We extract the A plane to rescale it, and then we reinject it. */
625 if( p_fmti->i_chroma == VLC_CODEC_RGBA )
626 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_visible_width * p_sys->i_extend_factor, p_fmti->i_visible_height, OFFSET_A );
627 else if( p_fmti->i_chroma == VLC_CODEC_ARGB )
628 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_visible_width * p_sys->i_extend_factor, p_fmti->i_visible_height, 0 );
630 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
632 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_visible_height, 0, 1, false, false );
633 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
634 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_visible_width * p_sys->i_extend_factor, p_fmto->i_visible_height, OFFSET_A );
635 else if( p_fmto->i_chroma == VLC_CODEC_ARGB )
636 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_visible_width * p_sys->i_extend_factor, p_fmto->i_visible_height, 0 );
638 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
640 else if( p_sys->b_add_a )
642 /* We inject a complete opaque alpha plane */
643 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
644 FillA( &p_dst->p[0], OFFSET_A );
645 else if( p_fmto->i_chroma == VLC_CODEC_ARGB )
646 FillA( &p_dst->p[0], 0 );
648 FillA( &p_dst->p[A_PLANE], 0 );
651 if( p_sys->i_extend_factor != 1 )
653 picture_CopyPixels( p_pic_dst, p_dst );
656 picture_CopyProperties( p_pic_dst, p_pic );
657 picture_Release( p_pic );
661 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
663 int OpenScaler( vlc_object_t *p_this )
668 void CloseScaler( vlc_object_t *p_this )
672 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */