1 /*****************************************************************************
2 * image.c : wrapper for image reading/writing facilities
3 *****************************************************************************
4 * Copyright (C) 2004-2007 the VideoLAN team
7 * Author: Gildas Bazin <gbazin@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
26 * This file contains the functions to handle the image_handler_t type
29 /*****************************************************************************
31 *****************************************************************************/
40 #include <vlc_common.h>
41 #include <vlc_codec.h>
42 #include <vlc_filter.h>
44 #include <vlc_image.h>
45 #include <vlc_stream.h>
46 #include <vlc_charset.h>
49 static picture_t *ImageRead( image_handler_t *, block_t *,
50 video_format_t *, video_format_t * );
51 static picture_t *ImageReadUrl( image_handler_t *, const char *,
52 video_format_t *, video_format_t * );
53 static block_t *ImageWrite( image_handler_t *, picture_t *,
54 video_format_t *, video_format_t * );
55 static int ImageWriteUrl( image_handler_t *, picture_t *,
56 video_format_t *, video_format_t *, const char * );
58 static picture_t *ImageConvert( image_handler_t *, picture_t *,
59 video_format_t *, video_format_t * );
60 static picture_t *ImageFilter( image_handler_t *, picture_t *,
61 video_format_t *, const char *psz_module );
63 static decoder_t *CreateDecoder( vlc_object_t *, video_format_t * );
64 static void DeleteDecoder( decoder_t * );
65 static encoder_t *CreateEncoder( vlc_object_t *, video_format_t *,
67 static void DeleteEncoder( encoder_t * );
68 static filter_t *CreateFilter( vlc_object_t *, es_format_t *,
69 video_format_t *, const char * );
70 static void DeleteFilter( filter_t * );
72 static vlc_fourcc_t Ext2Fourcc( const char * );
73 /*static const char *Fourcc2Ext( vlc_fourcc_t );*/
76 * Create an image_handler_t instance
79 image_handler_t *__image_HandlerCreate( vlc_object_t *p_this )
81 image_handler_t *p_image = malloc( sizeof(image_handler_t) );
83 memset( p_image, 0, sizeof(image_handler_t) );
84 p_image->p_parent = p_this;
86 p_image->pf_read = ImageRead;
87 p_image->pf_read_url = ImageReadUrl;
88 p_image->pf_write = ImageWrite;
89 p_image->pf_write_url = ImageWriteUrl;
90 p_image->pf_convert = ImageConvert;
91 p_image->pf_filter = ImageFilter;
97 * Delete the image_handler_t instance
100 void image_HandlerDelete( image_handler_t *p_image )
102 if( !p_image ) return;
104 if( p_image->p_dec ) DeleteDecoder( p_image->p_dec );
105 if( p_image->p_enc ) DeleteEncoder( p_image->p_enc );
106 if( p_image->p_filter ) DeleteFilter( p_image->p_filter );
117 static picture_t *ImageRead( image_handler_t *p_image, block_t *p_block,
118 video_format_t *p_fmt_in,
119 video_format_t *p_fmt_out )
121 picture_t *p_pic = NULL, *p_tmp;
123 /* Check if we can reuse the current decoder */
124 if( p_image->p_dec &&
125 p_image->p_dec->fmt_in.i_codec != p_fmt_in->i_chroma )
127 DeleteDecoder( p_image->p_dec );
131 /* Start a decoder */
132 if( !p_image->p_dec )
134 p_image->p_dec = CreateDecoder( p_image->p_parent, p_fmt_in );
135 if( !p_image->p_dec ) return NULL;
138 p_block->i_pts = p_block->i_dts = mdate();
139 while( (p_tmp = p_image->p_dec->pf_decode_video( p_image->p_dec, &p_block ))
143 p_pic->pf_release( p_pic );
149 msg_Warn( p_image->p_parent, "no image decoded" );
153 if( !p_fmt_out->i_chroma )
154 p_fmt_out->i_chroma = p_image->p_dec->fmt_out.video.i_chroma;
155 if( !p_fmt_out->i_width && p_fmt_out->i_height )
156 p_fmt_out->i_width = p_fmt_out->i_height
157 * p_image->p_dec->fmt_out.video.i_aspect
158 / VOUT_ASPECT_FACTOR;
159 if( !p_fmt_out->i_height && p_fmt_out->i_width )
160 p_fmt_out->i_height = p_fmt_out->i_width * VOUT_ASPECT_FACTOR
161 / p_image->p_dec->fmt_out.video.i_aspect;
162 if( !p_fmt_out->i_width )
163 p_fmt_out->i_width = p_image->p_dec->fmt_out.video.i_width;
164 if( !p_fmt_out->i_height )
165 p_fmt_out->i_height = p_image->p_dec->fmt_out.video.i_height;
167 /* Check if we need chroma conversion or resizing */
168 if( p_image->p_dec->fmt_out.video.i_chroma != p_fmt_out->i_chroma ||
169 p_image->p_dec->fmt_out.video.i_width != p_fmt_out->i_width ||
170 p_image->p_dec->fmt_out.video.i_height != p_fmt_out->i_height )
172 if( p_image->p_filter )
173 if( p_image->p_filter->fmt_in.video.i_chroma !=
174 p_image->p_dec->fmt_out.video.i_chroma ||
175 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
177 /* We need to restart a new filter */
178 DeleteFilter( p_image->p_filter );
179 p_image->p_filter = 0;
183 if( !p_image->p_filter )
186 CreateFilter( p_image->p_parent, &p_image->p_dec->fmt_out,
189 if( !p_image->p_filter )
191 p_pic->pf_release( p_pic );
197 /* Filters should handle on-the-fly size changes */
198 p_image->p_filter->fmt_in = p_image->p_dec->fmt_out;
199 p_image->p_filter->fmt_out = p_image->p_dec->fmt_out;
200 p_image->p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
201 p_image->p_filter->fmt_out.video = *p_fmt_out;
204 p_pic = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
205 *p_fmt_out = p_image->p_filter->fmt_out.video;
207 else *p_fmt_out = p_image->p_dec->fmt_out.video;
212 static picture_t *ImageReadUrl( image_handler_t *p_image, const char *psz_url,
213 video_format_t *p_fmt_in,
214 video_format_t *p_fmt_out )
218 stream_t *p_stream = NULL;
221 p_stream = stream_UrlNew( p_image->p_parent, psz_url );
225 msg_Dbg( p_image->p_parent, "could not open %s for reading",
230 i_size = stream_Size( p_stream );
232 p_block = block_New( p_image->p_parent, i_size );
234 stream_Read( p_stream, p_block->p_buffer, i_size );
235 stream_Delete( p_stream );
237 if( !p_fmt_in->i_chroma )
239 /* Try to guess format from file name */
240 p_fmt_in->i_chroma = Ext2Fourcc( psz_url );
243 p_pic = ImageRead( p_image, p_block, p_fmt_in, p_fmt_out );
253 static block_t *ImageWrite( image_handler_t *p_image, picture_t *p_pic,
254 video_format_t *p_fmt_in,
255 video_format_t *p_fmt_out )
259 /* Check if we can reuse the current encoder */
260 if( p_image->p_enc &&
261 ( p_image->p_enc->fmt_out.i_codec != p_fmt_out->i_chroma ||
262 p_image->p_enc->fmt_out.video.i_width != p_fmt_out->i_width ||
263 p_image->p_enc->fmt_out.video.i_height != p_fmt_out->i_height ) )
265 DeleteEncoder( p_image->p_enc );
269 /* Start an encoder */
270 if( !p_image->p_enc )
272 p_image->p_enc = CreateEncoder( p_image->p_parent,
273 p_fmt_in, p_fmt_out );
274 if( !p_image->p_enc ) return NULL;
277 /* Check if we need chroma conversion or resizing */
278 if( p_image->p_enc->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
279 p_image->p_enc->fmt_in.video.i_width != p_fmt_in->i_width ||
280 p_image->p_enc->fmt_in.video.i_height != p_fmt_in->i_height )
282 picture_t *p_tmp_pic;
284 if( p_image->p_filter )
285 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
286 p_image->p_filter->fmt_out.video.i_chroma !=
287 p_image->p_enc->fmt_in.video.i_chroma )
289 /* We need to restart a new filter */
290 DeleteFilter( p_image->p_filter );
291 p_image->p_filter = 0;
295 if( !p_image->p_filter )
298 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
299 fmt_in.video = *p_fmt_in;
302 CreateFilter( p_image->p_parent, &fmt_in,
303 &p_image->p_enc->fmt_in.video, NULL );
305 if( !p_image->p_filter )
312 /* Filters should handle on-the-fly size changes */
313 p_image->p_filter->fmt_in.i_codec = p_fmt_in->i_chroma;
314 p_image->p_filter->fmt_out.video = *p_fmt_in;
315 p_image->p_filter->fmt_out.i_codec =p_image->p_enc->fmt_in.i_codec;
316 p_image->p_filter->fmt_out.video = p_image->p_enc->fmt_in.video;
319 if( p_pic->pf_release )
322 p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
324 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_tmp_pic );
326 p_image->p_filter->pf_vout_buffer_del( p_image->p_filter, p_tmp_pic );
330 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_pic );
335 msg_Dbg( p_image->p_parent, "no image encoded" );
342 static int ImageWriteUrl( image_handler_t *p_image, picture_t *p_pic,
343 video_format_t *p_fmt_in, video_format_t *p_fmt_out,
344 const char *psz_url )
349 if( !p_fmt_out->i_chroma )
351 /* Try to guess format from file name */
352 p_fmt_out->i_chroma = Ext2Fourcc( psz_url );
355 file = utf8_fopen( psz_url, "wb" );
358 msg_Err( p_image->p_parent, "%s: %m", psz_url );
362 p_block = ImageWrite( p_image, p_pic, p_fmt_in, p_fmt_out );
367 if( fwrite( p_block->p_buffer, p_block->i_buffer, 1, file ) != 1 )
369 block_Release( p_block );
372 if( fclose( file ) && !err )
378 msg_Err( p_image->p_parent, "%s: %m", psz_url );
381 return err ? VLC_EGENERIC : VLC_SUCCESS;
385 * Convert an image to a different format
389 static picture_t *ImageConvert( image_handler_t *p_image, picture_t *p_pic,
390 video_format_t *p_fmt_in,
391 video_format_t *p_fmt_out )
395 if( !p_fmt_out->i_width && !p_fmt_out->i_height &&
396 p_fmt_out->i_sar_num && p_fmt_out->i_sar_den &&
397 p_fmt_out->i_sar_num * p_fmt_in->i_sar_den !=
398 p_fmt_out->i_sar_den * p_fmt_in->i_sar_num )
401 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
402 p_fmt_in->i_width / p_fmt_in->i_sar_den / p_fmt_out->i_sar_num;
403 p_fmt_out->i_visible_width =
404 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
405 p_fmt_in->i_visible_width / p_fmt_in->i_sar_den /
406 p_fmt_out->i_sar_num;
409 if( !p_fmt_out->i_chroma ) p_fmt_out->i_chroma = p_fmt_in->i_chroma;
410 if( !p_fmt_out->i_width )
411 p_fmt_out->i_width = p_fmt_out->i_visible_width = p_fmt_in->i_width;
412 if( !p_fmt_out->i_height )
413 p_fmt_out->i_height = p_fmt_out->i_visible_height = p_fmt_in->i_height;
414 if( !p_fmt_out->i_sar_num ) p_fmt_out->i_sar_num = p_fmt_in->i_sar_num;
415 if( !p_fmt_out->i_sar_den ) p_fmt_out->i_sar_den = p_fmt_in->i_sar_den;
416 if( !p_fmt_out->i_aspect ) p_fmt_out->i_aspect = p_fmt_in->i_aspect;
418 if( p_image->p_filter )
419 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
420 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
422 /* We need to restart a new filter */
423 DeleteFilter( p_image->p_filter );
424 p_image->p_filter = NULL;
428 if( !p_image->p_filter )
431 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
432 fmt_in.video = *p_fmt_in;
435 CreateFilter( p_image->p_parent, &fmt_in, p_fmt_out, NULL );
437 if( !p_image->p_filter )
444 /* Filters should handle on-the-fly size changes */
445 p_image->p_filter->fmt_in.video = *p_fmt_in;
446 p_image->p_filter->fmt_out.video = *p_fmt_out;
449 if( p_pic->pf_release )
451 p_pif = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
453 if( p_fmt_in->i_chroma == p_fmt_out->i_chroma &&
454 p_fmt_in->i_width == p_fmt_out->i_width &&
455 p_fmt_in->i_height == p_fmt_out->i_height )
457 /* Duplicate image */
458 p_pif->pf_release( p_pif ); /* XXX: Better fix must be possible */
459 p_pif = p_image->p_filter->pf_vout_buffer_new( p_image->p_filter );
460 if( p_pif ) vout_CopyPicture( p_image->p_parent, p_pif, p_pic );
467 * Filter an image with a psz_module filter
471 static picture_t *ImageFilter( image_handler_t *p_image, picture_t *p_pic,
472 video_format_t *p_fmt, const char *psz_module )
475 if( !p_image->p_filter )
478 es_format_Init( &fmt, VIDEO_ES, p_fmt->i_chroma );
482 CreateFilter( p_image->p_parent, &fmt, &fmt.video, psz_module );
484 if( !p_image->p_filter )
491 /* Filters should handle on-the-fly size changes */
492 p_image->p_filter->fmt_in.video = *p_fmt;
493 p_image->p_filter->fmt_out.video = *p_fmt;
496 if( p_pic->pf_release )
498 return p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
507 vlc_fourcc_t i_codec;
512 { VLC_FOURCC('j','p','e','g'), "jpeg" },
513 { VLC_FOURCC('j','p','e','g'), "jpg" },
514 { VLC_FOURCC('l','j','p','g'), "ljpg" },
515 { VLC_FOURCC('p','n','g',' '), "png" },
516 { VLC_FOURCC('p','g','m',' '), "pgm" },
517 { VLC_FOURCC('p','g','m','y'), "pgmyuv" },
518 { VLC_FOURCC('p','b','m',' '), "pbm" },
519 { VLC_FOURCC('p','a','m',' '), "pam" },
520 { VLC_FOURCC('t','g','a',' '), "tga" },
521 { VLC_FOURCC('b','m','p',' '), "bmp" },
522 { VLC_FOURCC('p','n','m',' '), "pnm" },
523 { VLC_FOURCC('x','p','m',' '), "xpm" },
524 { VLC_FOURCC('x','c','f',' '), "xcf" },
525 { VLC_FOURCC('p','c','x',' '), "pcx" },
526 { VLC_FOURCC('g','i','f',' '), "gif" },
527 { VLC_FOURCC('t','i','f','f'), "tif" },
528 { VLC_FOURCC('t','i','f','f'), "tiff" },
529 { VLC_FOURCC('l','b','m',' '), "lbm" },
533 static vlc_fourcc_t Ext2Fourcc( const char *psz_name )
537 psz_name = strrchr( psz_name, '.' );
538 if( !psz_name ) return 0;
541 for( i = 0; ext_table[i].i_codec; i++ )
544 for( j = 0; toupper(ext_table[i].psz_ext[j]) == toupper(psz_name[j]);
547 if( !ext_table[i].psz_ext[j] && !psz_name[j] )
548 return ext_table[i].i_codec;
556 static const char *Fourcc2Ext( vlc_fourcc_t i_codec )
560 for( i = 0; ext_table[i].i_codec != 0; i++ )
562 if( ext_table[i].i_codec == i_codec ) return ext_table[i].psz_ext;
569 static void video_release_buffer( picture_t *p_pic )
571 if( --p_pic->i_refcount > 0 ) return;
573 free( p_pic->p_data_orig );
574 free( p_pic->p_sys );
578 static picture_t *video_new_buffer( decoder_t *p_dec )
580 picture_t *p_pic = malloc( sizeof(picture_t) );
582 p_dec->fmt_out.video.i_chroma = p_dec->fmt_out.i_codec;
583 vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic,
584 p_dec->fmt_out.video.i_chroma,
585 p_dec->fmt_out.video.i_width,
586 p_dec->fmt_out.video.i_height,
587 p_dec->fmt_out.video.i_aspect );
589 if( !p_pic->i_planes )
595 p_pic->i_refcount = 1;
596 p_pic->pf_release = video_release_buffer;
597 p_pic->i_status = RESERVED_PICTURE;
603 static void video_del_buffer( decoder_t *p_dec, picture_t *p_pic )
606 free( p_pic->p_data_orig );
607 free( p_pic->p_sys );
611 static void video_link_picture( decoder_t *p_dec, picture_t *p_pic )
617 static void video_unlink_picture( decoder_t *p_dec, picture_t *p_pic )
619 (void)p_dec; (void)p_pic;
620 video_release_buffer( p_pic );
623 static decoder_t *CreateDecoder( vlc_object_t *p_this, video_format_t *fmt )
627 p_dec = vlc_object_create( p_this, VLC_OBJECT_DECODER );
631 p_dec->p_module = NULL;
632 es_format_Init( &p_dec->fmt_in, VIDEO_ES, fmt->i_chroma );
633 es_format_Init( &p_dec->fmt_out, VIDEO_ES, 0 );
634 p_dec->fmt_in.video = *fmt;
635 p_dec->b_pace_control = true;
637 p_dec->pf_vout_buffer_new = video_new_buffer;
638 p_dec->pf_vout_buffer_del = video_del_buffer;
639 p_dec->pf_picture_link = video_link_picture;
640 p_dec->pf_picture_unlink = video_unlink_picture;
642 vlc_object_attach( p_dec, p_this );
644 /* Find a suitable decoder module */
645 p_dec->p_module = module_Need( p_dec, "decoder", "$codec", 0 );
646 if( !p_dec->p_module )
648 msg_Err( p_dec, "no suitable decoder module for fourcc `%4.4s'.\n"
649 "VLC probably does not support this image format.",
650 (char*)&p_dec->fmt_in.i_codec );
652 DeleteDecoder( p_dec );
659 static void DeleteDecoder( decoder_t * p_dec )
661 vlc_object_detach( p_dec );
663 if( p_dec->p_module ) module_Unneed( p_dec, p_dec->p_module );
665 es_format_Clean( &p_dec->fmt_in );
666 es_format_Clean( &p_dec->fmt_out );
668 vlc_object_release( p_dec );
672 static encoder_t *CreateEncoder( vlc_object_t *p_this, video_format_t *fmt_in,
673 video_format_t *fmt_out )
677 p_enc = vlc_object_create( p_this, VLC_OBJECT_ENCODER );
681 p_enc->p_module = NULL;
682 es_format_Init( &p_enc->fmt_in, VIDEO_ES, fmt_in->i_chroma );
683 p_enc->fmt_in.video = *fmt_in;
684 if( fmt_out->i_width > 0 && fmt_out->i_height > 0 )
686 p_enc->fmt_in.video.i_width = fmt_out->i_width;
687 p_enc->fmt_in.video.i_height = fmt_out->i_height;
689 if( fmt_out->i_visible_width > 0 &&
690 fmt_out->i_visible_height > 0 )
692 p_enc->fmt_in.video.i_visible_width = fmt_out->i_visible_width;
693 p_enc->fmt_in.video.i_visible_height = fmt_out->i_visible_height;
697 p_enc->fmt_in.video.i_visible_width = fmt_out->i_width;
698 p_enc->fmt_in.video.i_visible_height = fmt_out->i_height;
701 else if( fmt_out->i_sar_num && fmt_out->i_sar_den &&
702 fmt_out->i_sar_num * fmt_in->i_sar_den !=
703 fmt_out->i_sar_den * fmt_in->i_sar_num )
705 p_enc->fmt_in.video.i_width =
706 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den * fmt_in->i_width /
707 fmt_in->i_sar_den / fmt_out->i_sar_num;
708 p_enc->fmt_in.video.i_visible_width =
709 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den *
710 fmt_in->i_visible_width / fmt_in->i_sar_den / fmt_out->i_sar_num;
713 p_enc->fmt_in.video.i_frame_rate = 25;
714 p_enc->fmt_in.video.i_frame_rate_base = 1;
716 es_format_Init( &p_enc->fmt_out, VIDEO_ES, fmt_out->i_chroma );
717 p_enc->fmt_out.video = *fmt_out;
718 p_enc->fmt_out.video.i_width = p_enc->fmt_in.video.i_width;
719 p_enc->fmt_out.video.i_height = p_enc->fmt_in.video.i_height;
721 vlc_object_attach( p_enc, p_this );
723 /* Find a suitable decoder module */
724 p_enc->p_module = module_Need( p_enc, "encoder", 0, 0 );
725 if( !p_enc->p_module )
727 msg_Err( p_enc, "no suitable encoder module for fourcc `%4.4s'.\n"
728 "VLC probably does not support this image format.",
729 (char*)&p_enc->fmt_out.i_codec );
731 DeleteEncoder( p_enc );
734 p_enc->fmt_in.video.i_chroma = p_enc->fmt_in.i_codec;
739 static void DeleteEncoder( encoder_t * p_enc )
741 vlc_object_detach( p_enc );
743 if( p_enc->p_module ) module_Unneed( p_enc, p_enc->p_module );
745 es_format_Clean( &p_enc->fmt_in );
746 es_format_Clean( &p_enc->fmt_out );
748 vlc_object_release( p_enc );
752 static filter_t *CreateFilter( vlc_object_t *p_this, es_format_t *p_fmt_in,
753 video_format_t *p_fmt_out,
754 const char *psz_module )
756 static const char typename[] = "filter";
759 p_filter = vlc_custom_create( p_this, sizeof(filter_t),
760 VLC_OBJECT_GENERIC, typename );
761 vlc_object_attach( p_filter, p_this );
763 p_filter->pf_vout_buffer_new =
764 (picture_t *(*)(filter_t *))video_new_buffer;
765 p_filter->pf_vout_buffer_del =
766 (void (*)(filter_t *, picture_t *))video_del_buffer;
768 p_filter->fmt_in = *p_fmt_in;
769 p_filter->fmt_out = *p_fmt_in;
770 p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
771 p_filter->fmt_out.video = *p_fmt_out;
772 p_filter->p_module = module_Need( p_filter, "video filter2",
775 if( !p_filter->p_module )
777 msg_Dbg( p_filter, "no video filter found" );
778 DeleteFilter( p_filter );
785 static void DeleteFilter( filter_t * p_filter )
787 vlc_object_detach( p_filter );
789 if( p_filter->p_module ) module_Unneed( p_filter, p_filter->p_module );
791 es_format_Clean( &p_filter->fmt_in );
792 es_format_Clean( &p_filter->fmt_out );
794 vlc_object_release( p_filter );