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>
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 chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
204 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
205 (char *)&p_filter->fmt_in.video.i_chroma,
206 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
207 (char *)&p_filter->fmt_out.video.i_chroma,
208 ppsz_mode_descriptions[i_sws_mode] );
213 /*****************************************************************************
214 * CloseFilter: clean up the filter
215 *****************************************************************************/
216 static void CloseScaler( vlc_object_t *p_this )
218 filter_t *p_filter = (filter_t*)p_this;
219 filter_sys_t *p_sys = p_filter->p_sys;
222 if( p_sys->p_src_filter )
223 sws_freeFilter( p_sys->p_src_filter );
227 /*****************************************************************************
229 *****************************************************************************/
230 static int GetSwsCpuMask(void)
234 #if defined(__i386__) || defined(__x86_64__)
235 const unsigned int i_cpu = vlc_CPU();
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;
244 #elif defined(__ppc__) || defined(__ppc64__) || defined(__powerpc__)
245 if( vlc_CPU_ALTIVEC() )
246 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
251 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
253 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
254 p_fmt1->i_width == p_fmt2->i_width &&
255 p_fmt1->i_height == p_fmt2->i_height;
258 static void FixParameters( int *pi_fmt, bool *pb_has_a, bool *pb_swap_uv, vlc_fourcc_t fmt )
263 *pi_fmt = PIX_FMT_YUV444P;
267 *pi_fmt = PIX_FMT_BGR32;
271 *pi_fmt = PIX_FMT_YUV420P;
275 *pi_fmt = PIX_FMT_YUV410P;
283 static int GetParameters( ScalerConfiguration *p_cfg,
284 const video_format_t *p_fmti,
285 const video_format_t *p_fmto,
286 int i_sws_flags_default )
291 bool b_has_ai = false;
292 bool b_has_ao = false;
293 int i_sws_flags = i_sws_flags_default;
294 bool b_swap_uvi = false;
295 bool b_swap_uvo = false;
297 GetFfmpegChroma( &i_fmti, *p_fmti );
298 GetFfmpegChroma( &i_fmto, *p_fmto );
300 if( p_fmti->i_chroma == p_fmto->i_chroma )
302 if( p_fmti->i_chroma == VLC_CODEC_YUVP && ALLOW_YUVP )
304 i_fmti = i_fmto = PIX_FMT_GRAY8;
305 i_sws_flags = SWS_POINT;
309 FixParameters( &i_fmti, &b_has_ai, &b_swap_uvi, p_fmti->i_chroma );
310 FixParameters( &i_fmto, &b_has_ao, &b_swap_uvo, p_fmto->i_chroma );
312 #if !defined (__ANDROID__) && !defined(TARGET_OS_IPHONE)
313 /* FIXME TODO removed when ffmpeg is fixed
314 * Without SWS_ACCURATE_RND the quality is really bad for some conversions */
320 i_sws_flags |= SWS_ACCURATE_RND;
327 p_cfg->i_fmti = i_fmti;
328 p_cfg->i_fmto = i_fmto;
329 p_cfg->b_has_a = b_has_ai && b_has_ao;
330 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
331 p_cfg->b_copy = i_fmti == i_fmto &&
332 p_fmti->i_width == p_fmto->i_width &&
333 p_fmti->i_height == p_fmto->i_height;
334 p_cfg->b_swap_uvi = b_swap_uvi;
335 p_cfg->b_swap_uvo = b_swap_uvo;
336 p_cfg->i_sws_flags = i_sws_flags;
339 if( i_fmti < 0 || i_fmto < 0 )
345 static int Init( filter_t *p_filter )
347 filter_sys_t *p_sys = p_filter->p_sys;
348 const video_format_t *p_fmti = &p_filter->fmt_in.video;
349 video_format_t *p_fmto = &p_filter->fmt_out.video;
351 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
352 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
359 /* Init with new parameters */
360 ScalerConfiguration cfg;
361 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
363 msg_Err( p_filter, "format not supported" );
366 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
368 msg_Err( p_filter, "0 width not supported" );
372 /* swscale does not like too small width */
373 p_sys->i_extend_factor = 1;
374 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
375 p_sys->i_extend_factor++;
377 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
378 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
379 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
381 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
382 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
383 struct SwsContext *ctx;
385 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
386 i_fmto_width, p_fmto->i_height, i_fmto,
387 cfg.i_sws_flags | p_sys->i_cpu_mask,
388 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
396 p_sys->p_src_a = picture_New( VLC_CODEC_GREY, i_fmti_width, p_fmti->i_height, 0, 1 );
397 p_sys->p_dst_a = picture_New( VLC_CODEC_GREY, i_fmto_width, p_fmto->i_height, 0, 1 );
399 if( p_sys->i_extend_factor != 1 )
401 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0, 1 );
402 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0, 1 );
405 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 );
407 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 );
411 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
412 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
414 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
419 p_sys->b_add_a = cfg.b_add_a;
420 p_sys->b_copy = cfg.b_copy;
421 p_sys->fmt_in = *p_fmti;
422 p_sys->fmt_out = *p_fmto;
423 p_sys->b_swap_uvi = cfg.b_swap_uvi;
424 p_sys->b_swap_uvo = cfg.b_swap_uvo;
426 video_format_ScaleCropAr( p_fmto, p_fmti );
428 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
429 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
430 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
431 p_sys->i_extend_factor );
435 static void Clean( filter_t *p_filter )
437 filter_sys_t *p_sys = p_filter->p_sys;
440 picture_Release( p_sys->p_src_e );
442 picture_Release( p_sys->p_dst_e );
445 picture_Release( p_sys->p_src_a );
447 picture_Release( p_sys->p_dst_a );
450 sws_freeContext( p_sys->ctxA );
453 sws_freeContext( p_sys->ctx );
455 /* We have to set it to null has we call be called again :( */
458 p_sys->p_src_a = NULL;
459 p_sys->p_dst_a = NULL;
460 p_sys->p_src_e = NULL;
461 p_sys->p_dst_e = NULL;
464 static void GetPixels( uint8_t *pp_pixel[4], int pi_pitch[4],
465 const picture_t *p_picture,
466 int i_plane_start, int i_plane_count,
469 assert( !b_swap_uv || i_plane_count >= 3 );
471 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
473 const int nd = ( b_swap_uv && n >= 1 && n <= 2 ) ? (3 - n) : n;
474 pp_pixel[nd] = p_picture->p[i_plane_start+n].p_pixels;
475 pi_pitch[nd] = p_picture->p[i_plane_start+n].i_pitch;
484 static void ExtractA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
486 plane_t *d = &p_dst->p[0];
487 const plane_t *s = &p_src->p[0];
489 for( unsigned y = 0; y < i_height; y++ )
490 for( unsigned x = 0; x < i_width; x++ )
491 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
493 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
495 plane_t *d = &p_dst->p[0];
496 const plane_t *s = &p_src->p[0];
498 for( unsigned y = 0; y < i_height; y++ )
499 for( unsigned x = 0; x < i_width; x++ )
500 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
502 static void FillA( plane_t *d, int i_offset )
504 for( int y = 0; y < d->i_visible_lines; y++ )
505 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
506 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
509 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
511 picture_Copy( p_dst, p_src );
512 for( int n = 0; n < p_dst->i_planes; n++ )
514 const plane_t *s = &p_src->p[n];
515 plane_t *d = &p_dst->p[n];
517 for( int y = 0; y < s->i_lines; y++ )
519 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
520 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 );
525 static void SwapUV( picture_t *p_dst, const picture_t *p_src )
527 picture_t tmp = *p_src;
528 tmp.p[1] = p_src->p[2];
529 tmp.p[2] = p_src->p[1];
531 picture_CopyPixels( p_dst, &tmp );
533 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
534 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count,
535 bool b_swap_uvi, bool b_swap_uvo )
537 uint8_t palette[AVPALETTE_SIZE];
539 uint8_t *src[4]; int src_stride[4];
540 uint8_t *dst[4]; int dst_stride[4];
542 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count, b_swap_uvi );
543 if( p_filter->fmt_in.video.i_chroma == VLC_CODEC_RGBP )
545 memset( palette, 0, sizeof(palette) );
546 if( p_filter->fmt_in.video.p_palette )
547 memcpy( palette, p_filter->fmt_in.video.p_palette->palette,
548 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
553 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count, b_swap_uvo );
555 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
556 sws_scale( ctx, src, src_stride, 0, i_height,
559 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
564 /****************************************************************************
565 * Filter: the whole thing
566 ****************************************************************************
567 * This function is called just after the thread is launched.
568 ****************************************************************************/
569 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
571 filter_sys_t *p_sys = p_filter->p_sys;
572 const video_format_t *p_fmti = &p_filter->fmt_in.video;
573 const video_format_t *p_fmto = &p_filter->fmt_out.video;
574 picture_t *p_pic_dst;
576 /* Check if format properties changed */
577 if( Init( p_filter ) )
579 picture_Release( p_pic );
583 /* Request output picture */
584 p_pic_dst = filter_NewPicture( p_filter );
587 picture_Release( p_pic );
592 picture_t *p_src = p_pic;
593 picture_t *p_dst = p_pic_dst;
594 if( p_sys->i_extend_factor != 1 )
596 p_src = p_sys->p_src_e;
597 p_dst = p_sys->p_dst_e;
599 CopyPad( p_src, p_pic );
602 if( p_sys->b_copy && p_sys->b_swap_uvi == p_sys->b_swap_uvo )
603 picture_CopyPixels( p_dst, p_src );
604 else if( p_sys->b_copy )
605 SwapUV( p_dst, p_src );
607 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3,
608 p_sys->b_swap_uvi, p_sys->b_swap_uvo );
611 /* We extract the A plane to rescale it, and then we reinject it. */
612 if( p_fmti->i_chroma == VLC_CODEC_RGBA )
613 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
615 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
617 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1, false, false );
618 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
619 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
621 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
623 else if( p_sys->b_add_a )
625 /* We inject a complete opaque alpha plane */
626 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
627 FillA( &p_dst->p[0], OFFSET_A );
629 FillA( &p_dst->p[A_PLANE], 0 );
632 if( p_sys->i_extend_factor != 1 )
634 picture_CopyPixels( p_pic_dst, p_dst );
637 picture_CopyProperties( p_pic_dst, p_pic );
638 picture_Release( p_pic );
642 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
644 int OpenScaler( vlc_object_t *p_this )
649 void CloseScaler( vlc_object_t *p_this )
653 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */