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.
89 int i_cpu_mask, i_sws_flags;
91 video_format_t fmt_in;
92 video_format_t fmt_out;
93 const vlc_chroma_description_t *desc_in;
94 const vlc_chroma_description_t *desc_out;
96 struct SwsContext *ctx;
97 struct SwsContext *ctxA;
109 static picture_t *Filter( filter_t *, picture_t * );
110 static int Init( filter_t * );
111 static void Clean( filter_t * );
123 } ScalerConfiguration;
125 static int GetParameters( ScalerConfiguration *,
126 const video_format_t *p_fmti,
127 const video_format_t *p_fmto,
128 int i_sws_flags_default );
130 static int GetSwsCpuMask(void);
132 /* SwScaler point resize quality seems really bad, let our scale module do it
133 * (change it to true to try) */
134 #define ALLOW_YUVP (false)
135 /* SwScaler does not like too small picture */
136 #define MINIMUM_WIDTH (32)
138 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
141 /*****************************************************************************
142 * OpenScaler: probe the filter and return score
143 *****************************************************************************/
144 static int OpenScaler( vlc_object_t *p_this )
146 filter_t *p_filter = (filter_t*)p_this;
151 if( GetParameters( NULL,
152 &p_filter->fmt_in.video,
153 &p_filter->fmt_out.video, 0 ) )
156 /* Allocate the memory needed to store the decoder's structure */
157 if( ( p_filter->p_sys = p_sys = calloc(1, sizeof(filter_sys_t)) ) == NULL )
160 /* Set CPU capabilities */
161 p_sys->i_cpu_mask = GetSwsCpuMask();
164 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
167 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
168 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
169 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
170 case 3: p_sys->i_sws_flags = SWS_X; break;
171 case 4: p_sys->i_sws_flags = SWS_POINT; break;
172 case 5: p_sys->i_sws_flags = SWS_AREA; break;
173 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
174 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
175 case 8: p_sys->i_sws_flags = SWS_SINC; break;
176 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
177 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
178 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
182 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
183 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
185 if( Init( p_filter ) )
187 if( p_sys->p_filter )
188 sws_freeFilter( p_sys->p_filter );
194 p_filter->pf_video_filter = Filter;
196 msg_Dbg( p_filter, "%ix%i (%ix%i) chroma: %4.4s -> %ix%i (%ix%i) chroma: %4.4s with scaling using %s",
197 p_filter->fmt_in.video.i_visible_width, p_filter->fmt_in.video.i_visible_height,
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_visible_width, p_filter->fmt_out.video.i_visible_height,
201 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
202 (char *)&p_filter->fmt_out.video.i_chroma,
203 ppsz_mode_descriptions[i_sws_mode] );
208 /*****************************************************************************
209 * CloseFilter: clean up the filter
210 *****************************************************************************/
211 static void CloseScaler( vlc_object_t *p_this )
213 filter_t *p_filter = (filter_t*)p_this;
214 filter_sys_t *p_sys = p_filter->p_sys;
217 if( p_sys->p_filter )
218 sws_freeFilter( p_sys->p_filter );
222 /*****************************************************************************
224 *****************************************************************************/
225 static int GetSwsCpuMask(void)
229 #if defined(__i386__) || defined(__x86_64__)
231 i_sws_cpu |= SWS_CPU_CAPS_MMX;
232 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
233 if( vlc_CPU_MMXEXT() )
234 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
236 if( vlc_CPU_3dNOW() )
237 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
238 #elif defined(__ppc__) || defined(__ppc64__) || defined(__powerpc__)
239 if( vlc_CPU_ALTIVEC() )
240 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
246 static void FixParameters( int *pi_fmt, bool *pb_has_a, bool *pb_swap_uv, vlc_fourcc_t fmt )
250 case VLC_CODEC_YUV422A:
251 *pi_fmt = PIX_FMT_YUV422P;
254 case VLC_CODEC_YUV420A:
255 *pi_fmt = PIX_FMT_YUV420P;
259 *pi_fmt = PIX_FMT_YUV444P;
263 *pi_fmt = PIX_FMT_BGR32;
267 *pi_fmt = PIX_FMT_BGR32_1;
271 *pi_fmt = PIX_FMT_RGB32;
275 *pi_fmt = PIX_FMT_YUV420P;
279 *pi_fmt = PIX_FMT_YUV410P;
287 static int GetParameters( ScalerConfiguration *p_cfg,
288 const video_format_t *p_fmti,
289 const video_format_t *p_fmto,
290 int i_sws_flags_default )
295 bool b_has_ai = false;
296 bool b_has_ao = false;
297 int i_sws_flags = i_sws_flags_default;
298 bool b_swap_uvi = false;
299 bool b_swap_uvo = false;
301 GetFfmpegChroma( &i_fmti, p_fmti );
302 GetFfmpegChroma( &i_fmto, p_fmto );
304 if( p_fmti->i_chroma == p_fmto->i_chroma )
306 if( p_fmti->i_chroma == VLC_CODEC_YUVP && ALLOW_YUVP )
308 i_fmti = i_fmto = PIX_FMT_GRAY8;
309 i_sws_flags = SWS_POINT;
313 FixParameters( &i_fmti, &b_has_ai, &b_swap_uvi, p_fmti->i_chroma );
314 FixParameters( &i_fmto, &b_has_ao, &b_swap_uvo, p_fmto->i_chroma );
316 #if !defined (__ANDROID__) && !defined(TARGET_OS_IPHONE)
317 /* FIXME TODO removed when ffmpeg is fixed
318 * Without SWS_ACCURATE_RND the quality is really bad for some conversions */
324 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_visible_width == p_fmto->i_visible_width &&
337 p_fmti->i_visible_height == p_fmto->i_visible_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 video_format_t *p_fmto = &p_filter->fmt_out.video;
355 if( p_fmti->orientation != p_fmto->orientation )
358 if( video_format_IsSimilar( p_fmti, &p_sys->fmt_in ) &&
359 video_format_IsSimilar( p_fmto, &p_sys->fmt_out ) &&
367 /* Init with new parameters */
368 ScalerConfiguration cfg;
369 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
371 msg_Err( p_filter, "format not supported" );
374 if( p_fmti->i_visible_width <= 0 || p_fmti->i_visible_height <= 0 ||
375 p_fmto->i_visible_width <= 0 || p_fmto->i_visible_height <= 0 )
377 msg_Err( p_filter, "invalid scaling: %ix%i -> %ix%i",
378 p_fmti->i_visible_width, p_fmti->i_visible_height,
379 p_fmto->i_visible_width, p_fmto->i_visible_height);
383 p_sys->desc_in = vlc_fourcc_GetChromaDescription( p_fmti->i_chroma );
384 p_sys->desc_out = vlc_fourcc_GetChromaDescription( p_fmto->i_chroma );
385 if( p_sys->desc_in == NULL || p_sys->desc_out == NULL )
388 /* swscale does not like too small width */
389 p_sys->i_extend_factor = 1;
390 while( __MIN( p_fmti->i_visible_width, p_fmto->i_visible_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
391 p_sys->i_extend_factor++;
393 const unsigned i_fmti_visible_width = p_fmti->i_visible_width * p_sys->i_extend_factor;
394 const unsigned i_fmto_visible_width = p_fmto->i_visible_width * p_sys->i_extend_factor;
395 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
397 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
398 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
399 struct SwsContext *ctx;
401 ctx = sws_getContext( i_fmti_visible_width, p_fmti->i_visible_height, i_fmti,
402 i_fmto_visible_width, p_fmto->i_visible_height, i_fmto,
403 cfg.i_sws_flags | p_sys->i_cpu_mask,
404 p_sys->p_filter, NULL, 0 );
412 p_sys->p_src_a = picture_New( VLC_CODEC_GREY, i_fmti_visible_width, p_fmti->i_visible_height, 0, 1 );
413 p_sys->p_dst_a = picture_New( VLC_CODEC_GREY, i_fmto_visible_width, p_fmto->i_visible_height, 0, 1 );
415 if( p_sys->i_extend_factor != 1 )
417 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_visible_width, p_fmti->i_visible_height, 0, 1 );
418 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_visible_width, p_fmto->i_visible_height, 0, 1 );
421 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 );
423 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 );
427 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
428 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
430 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
435 if (p_filter->b_allow_fmt_out_change)
438 * If the transformation is not homothetic we must modify the
439 * aspect ratio of the output format in order to have the
440 * output picture displayed correctly and not stretched
441 * horizontally or vertically.
442 * WARNING: this is a hack, ideally this should not be needed
443 * and the vout should update its video format instead.
445 unsigned i_sar_num = p_fmti->i_sar_num * p_fmti->i_visible_width;
446 unsigned i_sar_den = p_fmti->i_sar_den * p_fmto->i_visible_width;
447 vlc_ureduce(&i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 65536);
448 i_sar_num *= p_fmto->i_visible_height;
449 i_sar_den *= p_fmti->i_visible_height;
450 vlc_ureduce(&i_sar_num, &i_sar_den, i_sar_num, i_sar_den, 65536);
451 p_fmto->i_sar_num = i_sar_num;
452 p_fmto->i_sar_den = i_sar_den;
455 p_sys->b_add_a = cfg.b_add_a;
456 p_sys->b_copy = cfg.b_copy;
457 p_sys->fmt_in = *p_fmti;
458 p_sys->fmt_out = *p_fmto;
459 p_sys->b_swap_uvi = cfg.b_swap_uvi;
460 p_sys->b_swap_uvo = cfg.b_swap_uvo;
465 static void Clean( filter_t *p_filter )
467 filter_sys_t *p_sys = p_filter->p_sys;
470 picture_Release( p_sys->p_src_e );
472 picture_Release( p_sys->p_dst_e );
475 picture_Release( p_sys->p_src_a );
477 picture_Release( p_sys->p_dst_a );
480 sws_freeContext( p_sys->ctxA );
483 sws_freeContext( p_sys->ctx );
485 /* We have to set it to null has we call be called again :( */
488 p_sys->p_src_a = NULL;
489 p_sys->p_dst_a = NULL;
490 p_sys->p_src_e = NULL;
491 p_sys->p_dst_e = NULL;
494 static void GetPixels( uint8_t *pp_pixel[4], int pi_pitch[4],
495 const vlc_chroma_description_t *desc,
496 const video_format_t *fmt,
497 const picture_t *p_picture, unsigned planes,
502 if( planes > (unsigned)p_picture->i_planes )
503 planes = p_picture->i_planes;
504 assert( !b_swap_uv || planes >= 3 );
506 for( ; i < planes; i++ )
508 const plane_t *p = p_picture->p + i;
509 if( b_swap_uv && (i == 1 || i== 2) )
510 p = p_picture->p + 3 - i;
512 pp_pixel[i] = p->p_pixels
513 + (((fmt->i_x_offset * desc->p[i].w.num) / desc->p[i].w.den)
515 + (((fmt->i_y_offset * desc->p[i].h.num) / desc->p[i].h.den)
517 pi_pitch[i] = p->i_pitch;
527 static void ExtractA( picture_t *p_dst, const picture_t *restrict p_src,
530 plane_t *d = &p_dst->p[0];
531 const plane_t *s = &p_src->p[0];
533 for( unsigned y = 0; y < p_dst->format.i_height; y++ )
534 for( unsigned x = 0; x < p_dst->format.i_width; x++ )
535 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+offset];
538 static void InjectA( picture_t *p_dst, const picture_t *restrict p_src,
541 plane_t *d = &p_dst->p[0];
542 const plane_t *s = &p_src->p[0];
544 for( unsigned y = 0; y < p_src->format.i_height; y++ )
545 for( unsigned x = 0; x < p_src->format.i_width; x++ )
546 d->p_pixels[y*d->i_pitch+4*x+offset] = s->p_pixels[y*s->i_pitch+x];
549 static void FillA( plane_t *d, unsigned i_offset )
551 for( int y = 0; y < d->i_visible_lines; y++ )
552 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
553 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
556 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
558 picture_Copy( p_dst, p_src );
559 for( int n = 0; n < p_dst->i_planes; n++ )
561 const plane_t *s = &p_src->p[n];
562 plane_t *d = &p_dst->p[n];
564 for( int y = 0; y < s->i_lines && y < d->i_lines; y++ )
566 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
567 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 );
572 static void SwapUV( picture_t *p_dst, const picture_t *p_src )
574 picture_t tmp = *p_src;
575 tmp.p[1] = p_src->p[2];
576 tmp.p[2] = p_src->p[1];
578 picture_CopyPixels( p_dst, &tmp );
581 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
582 picture_t *p_dst, picture_t *p_src, int i_height,
583 int i_plane_count, bool b_swap_uvi, bool b_swap_uvo )
585 filter_sys_t *p_sys = p_filter->p_sys;
586 uint8_t palette[AVPALETTE_SIZE];
587 uint8_t *src[4]; int src_stride[4];
588 uint8_t *dst[4]; int dst_stride[4];
590 GetPixels( src, src_stride, p_sys->desc_in, &p_filter->fmt_in.video,
591 p_src, i_plane_count, b_swap_uvi );
592 if( p_filter->fmt_in.video.i_chroma == VLC_CODEC_RGBP )
594 video_palette_t *src_pal =
595 p_src->format.p_palette ?
596 p_src->format.p_palette :
597 p_filter->fmt_in.video.p_palette;
598 memset( palette, 0, sizeof(palette) );
600 memcpy( palette, src_pal->palette,
601 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
606 GetPixels( dst, dst_stride, p_sys->desc_out, &p_filter->fmt_out.video,
607 p_dst, i_plane_count, b_swap_uvo );
609 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
610 sws_scale( ctx, src, src_stride, 0, i_height,
613 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
618 /****************************************************************************
619 * Filter: the whole thing
620 ****************************************************************************
621 * This function is called just after the thread is launched.
622 ****************************************************************************/
623 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
625 filter_sys_t *p_sys = p_filter->p_sys;
626 const video_format_t *p_fmti = &p_filter->fmt_in.video;
627 const video_format_t *p_fmto = &p_filter->fmt_out.video;
628 picture_t *p_pic_dst;
630 /* Check if format properties changed */
631 if( Init( p_filter ) )
633 picture_Release( p_pic );
637 /* Request output picture */
638 p_pic_dst = filter_NewPicture( p_filter );
641 picture_Release( p_pic );
646 picture_t *p_src = p_pic;
647 picture_t *p_dst = p_pic_dst;
648 if( p_sys->i_extend_factor != 1 )
650 p_src = p_sys->p_src_e;
651 p_dst = p_sys->p_dst_e;
653 CopyPad( p_src, p_pic );
656 if( p_sys->b_copy && p_sys->b_swap_uvi == p_sys->b_swap_uvo )
657 picture_CopyPixels( p_dst, p_src );
658 else if( p_sys->b_copy )
659 SwapUV( p_dst, p_src );
661 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_visible_height,
662 3, p_sys->b_swap_uvi, p_sys->b_swap_uvo );
665 /* We extract the A plane to rescale it, and then we reinject it. */
666 if( p_fmti->i_chroma == VLC_CODEC_RGBA || p_fmti->i_chroma == VLC_CODEC_BGRA )
667 ExtractA( p_sys->p_src_a, p_src, OFFSET_A );
668 else if( p_fmti->i_chroma == VLC_CODEC_ARGB )
669 ExtractA( p_sys->p_src_a, p_src, 0 );
671 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
673 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a,
674 p_fmti->i_visible_height, 1, false, false );
675 if( p_fmto->i_chroma == VLC_CODEC_RGBA || p_fmto->i_chroma == VLC_CODEC_BGRA )
676 InjectA( p_dst, p_sys->p_dst_a, OFFSET_A );
677 else if( p_fmto->i_chroma == VLC_CODEC_ARGB )
678 InjectA( p_dst, p_sys->p_dst_a, 0 );
680 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
682 else if( p_sys->b_add_a )
684 /* We inject a complete opaque alpha plane */
685 if( p_fmto->i_chroma == VLC_CODEC_RGBA || p_fmto->i_chroma == VLC_CODEC_BGRA )
686 FillA( &p_dst->p[0], OFFSET_A );
687 else if( p_fmto->i_chroma == VLC_CODEC_ARGB )
688 FillA( &p_dst->p[0], 0 );
690 FillA( &p_dst->p[A_PLANE], 0 );
693 if( p_sys->i_extend_factor != 1 )
695 picture_CopyPixels( p_pic_dst, p_dst );
698 picture_CopyProperties( p_pic_dst, p_pic );
699 picture_Release( p_pic );
703 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
705 int OpenScaler( vlc_object_t *p_this )
710 void CloseScaler( vlc_object_t *p_this )
714 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */