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 *****************************************************************************/
39 #include <vlc_codec.h>
40 #include <vlc_filter.h>
42 #include <vlc_image.h>
43 #include <vlc_stream.h>
44 #include <vlc_charset.h>
46 static picture_t *ImageRead( image_handler_t *, block_t *,
47 video_format_t *, video_format_t * );
48 static picture_t *ImageReadUrl( image_handler_t *, const char *,
49 video_format_t *, video_format_t * );
50 static block_t *ImageWrite( image_handler_t *, picture_t *,
51 video_format_t *, video_format_t * );
52 static int ImageWriteUrl( image_handler_t *, picture_t *,
53 video_format_t *, video_format_t *, const char * );
55 static picture_t *ImageConvert( image_handler_t *, picture_t *,
56 video_format_t *, video_format_t * );
57 static picture_t *ImageFilter( image_handler_t *, picture_t *,
58 video_format_t *, const char *psz_module );
60 static decoder_t *CreateDecoder( vlc_object_t *, video_format_t * );
61 static void DeleteDecoder( decoder_t * );
62 static encoder_t *CreateEncoder( vlc_object_t *, video_format_t *,
64 static void DeleteEncoder( encoder_t * );
65 static filter_t *CreateFilter( vlc_object_t *, es_format_t *,
66 video_format_t *, const char * );
67 static void DeleteFilter( filter_t * );
69 static vlc_fourcc_t Ext2Fourcc( const char * );
70 /*static const char *Fourcc2Ext( vlc_fourcc_t );*/
73 * Create an image_handler_t instance
76 image_handler_t *__image_HandlerCreate( vlc_object_t *p_this )
78 image_handler_t *p_image = malloc( sizeof(image_handler_t) );
80 memset( p_image, 0, sizeof(image_handler_t) );
81 p_image->p_parent = p_this;
83 p_image->pf_read = ImageRead;
84 p_image->pf_read_url = ImageReadUrl;
85 p_image->pf_write = ImageWrite;
86 p_image->pf_write_url = ImageWriteUrl;
87 p_image->pf_convert = ImageConvert;
88 p_image->pf_filter = ImageFilter;
94 * Delete the image_handler_t instance
97 void image_HandlerDelete( image_handler_t *p_image )
99 if( !p_image ) return;
101 if( p_image->p_dec ) DeleteDecoder( p_image->p_dec );
102 if( p_image->p_enc ) DeleteEncoder( p_image->p_enc );
103 if( p_image->p_filter ) DeleteFilter( p_image->p_filter );
114 static picture_t *ImageRead( image_handler_t *p_image, block_t *p_block,
115 video_format_t *p_fmt_in,
116 video_format_t *p_fmt_out )
118 picture_t *p_pic = NULL, *p_tmp;
120 /* Check if we can reuse the current decoder */
121 if( p_image->p_dec &&
122 p_image->p_dec->fmt_in.i_codec != p_fmt_in->i_chroma )
124 DeleteDecoder( p_image->p_dec );
128 /* Start a decoder */
129 if( !p_image->p_dec )
131 p_image->p_dec = CreateDecoder( p_image->p_parent, p_fmt_in );
132 if( !p_image->p_dec ) return NULL;
135 p_block->i_pts = p_block->i_dts = mdate();
136 while( (p_tmp = p_image->p_dec->pf_decode_video( p_image->p_dec, &p_block ))
140 p_pic->pf_release( p_pic );
146 msg_Warn( p_image->p_parent, "no image decoded" );
150 if( !p_fmt_out->i_chroma )
151 p_fmt_out->i_chroma = p_image->p_dec->fmt_out.video.i_chroma;
152 if( !p_fmt_out->i_width && p_fmt_out->i_height )
153 p_fmt_out->i_width = p_fmt_out->i_height
154 * p_image->p_dec->fmt_out.video.i_aspect
155 / VOUT_ASPECT_FACTOR;
156 if( !p_fmt_out->i_height && p_fmt_out->i_width )
157 p_fmt_out->i_height = p_fmt_out->i_width * VOUT_ASPECT_FACTOR
158 / p_image->p_dec->fmt_out.video.i_aspect;
159 if( !p_fmt_out->i_width )
160 p_fmt_out->i_width = p_image->p_dec->fmt_out.video.i_width;
161 if( !p_fmt_out->i_height )
162 p_fmt_out->i_height = p_image->p_dec->fmt_out.video.i_height;
164 /* Check if we need chroma conversion or resizing */
165 if( p_image->p_dec->fmt_out.video.i_chroma != p_fmt_out->i_chroma ||
166 p_image->p_dec->fmt_out.video.i_width != p_fmt_out->i_width ||
167 p_image->p_dec->fmt_out.video.i_height != p_fmt_out->i_height )
169 if( p_image->p_filter )
170 if( p_image->p_filter->fmt_in.video.i_chroma !=
171 p_image->p_dec->fmt_out.video.i_chroma ||
172 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
174 /* We need to restart a new filter */
175 DeleteFilter( p_image->p_filter );
176 p_image->p_filter = 0;
180 if( !p_image->p_filter )
183 CreateFilter( p_image->p_parent, &p_image->p_dec->fmt_out,
186 if( !p_image->p_filter )
188 p_pic->pf_release( p_pic );
194 /* Filters should handle on-the-fly size changes */
195 p_image->p_filter->fmt_in = p_image->p_dec->fmt_out;
196 p_image->p_filter->fmt_out = p_image->p_dec->fmt_out;
197 p_image->p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
198 p_image->p_filter->fmt_out.video = *p_fmt_out;
201 p_pic = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
202 *p_fmt_out = p_image->p_filter->fmt_out.video;
204 else *p_fmt_out = p_image->p_dec->fmt_out.video;
209 static picture_t *ImageReadUrl( image_handler_t *p_image, const char *psz_url,
210 video_format_t *p_fmt_in,
211 video_format_t *p_fmt_out )
215 stream_t *p_stream = NULL;
218 p_stream = stream_UrlNew( p_image->p_parent, psz_url );
222 msg_Dbg( p_image->p_parent, "could not open %s for reading",
227 i_size = stream_Size( p_stream );
229 p_block = block_New( p_image->p_parent, i_size );
231 stream_Read( p_stream, p_block->p_buffer, i_size );
232 stream_Delete( p_stream );
234 if( !p_fmt_in->i_chroma )
236 /* Try to guess format from file name */
237 p_fmt_in->i_chroma = Ext2Fourcc( psz_url );
240 p_pic = ImageRead( p_image, p_block, p_fmt_in, p_fmt_out );
250 static block_t *ImageWrite( image_handler_t *p_image, picture_t *p_pic,
251 video_format_t *p_fmt_in,
252 video_format_t *p_fmt_out )
255 void (*pf_release)( picture_t * );
257 /* Check if we can reuse the current encoder */
258 if( p_image->p_enc &&
259 ( p_image->p_enc->fmt_out.i_codec != p_fmt_out->i_chroma ||
260 p_image->p_enc->fmt_out.video.i_width != p_fmt_out->i_width ||
261 p_image->p_enc->fmt_out.video.i_height != p_fmt_out->i_height ) )
263 DeleteEncoder( p_image->p_enc );
267 /* Start an encoder */
268 if( !p_image->p_enc )
270 p_image->p_enc = CreateEncoder( p_image->p_parent,
271 p_fmt_in, p_fmt_out );
272 if( !p_image->p_enc ) return NULL;
275 /* Check if we need chroma conversion or resizing */
276 if( p_image->p_enc->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
277 p_image->p_enc->fmt_in.video.i_width != p_fmt_in->i_width ||
278 p_image->p_enc->fmt_in.video.i_height != p_fmt_in->i_height )
280 picture_t *p_tmp_pic;
282 if( p_image->p_filter )
283 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
284 p_image->p_filter->fmt_out.video.i_chroma !=
285 p_image->p_enc->fmt_in.video.i_chroma )
287 /* We need to restart a new filter */
288 DeleteFilter( p_image->p_filter );
289 p_image->p_filter = 0;
293 if( !p_image->p_filter )
296 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
297 fmt_in.video = *p_fmt_in;
300 CreateFilter( p_image->p_parent, &fmt_in,
301 &p_image->p_enc->fmt_in.video, NULL );
303 if( !p_image->p_filter )
310 /* Filters should handle on-the-fly size changes */
311 p_image->p_filter->fmt_in.i_codec = p_fmt_in->i_chroma;
312 p_image->p_filter->fmt_out.video = *p_fmt_in;
313 p_image->p_filter->fmt_out.i_codec =p_image->p_enc->fmt_in.i_codec;
314 p_image->p_filter->fmt_out.video = p_image->p_enc->fmt_in.video;
317 p_pic->i_refcount++; /* pf_video_filter() will call pf_release() */
319 p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
321 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_tmp_pic );
323 p_image->p_filter->pf_vout_buffer_del( p_image->p_filter, p_tmp_pic );
327 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_pic );
332 msg_Dbg( p_image->p_parent, "no image encoded" );
339 static int ImageWriteUrl( image_handler_t *p_image, picture_t *p_pic,
340 video_format_t *p_fmt_in, video_format_t *p_fmt_out,
341 const char *psz_url )
346 if( !p_fmt_out->i_chroma )
348 /* Try to guess format from file name */
349 p_fmt_out->i_chroma = Ext2Fourcc( psz_url );
352 file = utf8_fopen( psz_url, "wb" );
355 msg_Err( p_image->p_parent, "%s: %m", psz_url );
359 p_block = ImageWrite( p_image, p_pic, p_fmt_in, p_fmt_out );
364 if( fwrite( p_block->p_buffer, p_block->i_buffer, 1, file ) != 1 )
366 block_Release( p_block );
369 if( fclose( file ) && !err )
375 msg_Err( p_image->p_parent, "%s: %m", psz_url );
378 return err ? VLC_EGENERIC : VLC_SUCCESS;
382 * Convert an image to a different format
386 static picture_t *ImageConvert( image_handler_t *p_image, picture_t *p_pic,
387 video_format_t *p_fmt_in,
388 video_format_t *p_fmt_out )
392 if( !p_fmt_out->i_width && !p_fmt_out->i_height &&
393 p_fmt_out->i_sar_num && p_fmt_out->i_sar_den &&
394 p_fmt_out->i_sar_num * p_fmt_in->i_sar_den !=
395 p_fmt_out->i_sar_den * p_fmt_in->i_sar_num )
398 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
399 p_fmt_in->i_width / p_fmt_in->i_sar_den / p_fmt_out->i_sar_num;
400 p_fmt_out->i_visible_width =
401 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
402 p_fmt_in->i_visible_width / p_fmt_in->i_sar_den /
403 p_fmt_out->i_sar_num;
406 if( !p_fmt_out->i_chroma ) p_fmt_out->i_chroma = p_fmt_in->i_chroma;
407 if( !p_fmt_out->i_width )
408 p_fmt_out->i_width = p_fmt_out->i_visible_width = p_fmt_in->i_width;
409 if( !p_fmt_out->i_height )
410 p_fmt_out->i_height = p_fmt_out->i_visible_height = p_fmt_in->i_height;
411 if( !p_fmt_out->i_sar_num ) p_fmt_out->i_sar_num = p_fmt_in->i_sar_num;
412 if( !p_fmt_out->i_sar_den ) p_fmt_out->i_sar_den = p_fmt_in->i_sar_den;
413 if( !p_fmt_out->i_aspect ) p_fmt_out->i_aspect = p_fmt_in->i_aspect;
415 if( p_image->p_filter )
416 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
417 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
419 /* We need to restart a new filter */
420 DeleteFilter( p_image->p_filter );
421 p_image->p_filter = NULL;
425 if( !p_image->p_filter )
428 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
429 fmt_in.video = *p_fmt_in;
432 CreateFilter( p_image->p_parent, &fmt_in, p_fmt_out, NULL );
434 if( !p_image->p_filter )
441 /* Filters should handle on-the-fly size changes */
442 p_image->p_filter->fmt_in.video = *p_fmt_in;
443 p_image->p_filter->fmt_out.video = *p_fmt_out;
446 p_pic->i_refcount++; /* pf_video_filter() will call pf_release() */
447 p_pif = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
449 if( p_fmt_in->i_chroma == p_fmt_out->i_chroma &&
450 p_fmt_in->i_width == p_fmt_out->i_width &&
451 p_fmt_in->i_height == p_fmt_out->i_height )
453 /* Duplicate image */
454 p_pif->pf_release( p_pif ); /* XXX: Better fix must be possible */
455 p_pif = p_image->p_filter->pf_vout_buffer_new( p_image->p_filter );
456 if( p_pif ) vout_CopyPicture( p_image->p_parent, p_pif, p_pic );
463 * Filter an image with a psz_module filter
467 static picture_t *ImageFilter( image_handler_t *p_image, picture_t *p_pic,
468 video_format_t *p_fmt, const char *psz_module )
471 if( !p_image->p_filter )
474 es_format_Init( &fmt, VIDEO_ES, p_fmt->i_chroma );
478 CreateFilter( p_image->p_parent, &fmt, &fmt.video, psz_module );
480 if( !p_image->p_filter )
487 /* Filters should handle on-the-fly size changes */
488 p_image->p_filter->fmt_in.video = *p_fmt;
489 p_image->p_filter->fmt_out.video = *p_fmt;
492 p_pic->i_refcount++; /* pf_video_filter() will call pf_release() */
493 return p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
502 vlc_fourcc_t i_codec;
507 { VLC_FOURCC('j','p','e','g'), "jpeg" },
508 { VLC_FOURCC('j','p','e','g'), "jpg" },
509 { VLC_FOURCC('l','j','p','g'), "ljpg" },
510 { VLC_FOURCC('p','n','g',' '), "png" },
511 { VLC_FOURCC('p','g','m',' '), "pgm" },
512 { VLC_FOURCC('p','g','m','y'), "pgmyuv" },
513 { VLC_FOURCC('p','b','m',' '), "pbm" },
514 { VLC_FOURCC('p','a','m',' '), "pam" },
515 { VLC_FOURCC('t','g','a',' '), "tga" },
516 { VLC_FOURCC('b','m','p',' '), "bmp" },
517 { VLC_FOURCC('p','n','m',' '), "pnm" },
518 { VLC_FOURCC('x','p','m',' '), "xpm" },
519 { VLC_FOURCC('x','c','f',' '), "xcf" },
520 { VLC_FOURCC('p','c','x',' '), "pcx" },
521 { VLC_FOURCC('g','i','f',' '), "gif" },
522 { VLC_FOURCC('t','i','f','f'), "tif" },
523 { VLC_FOURCC('t','i','f','f'), "tiff" },
524 { VLC_FOURCC('l','b','m',' '), "lbm" },
528 static vlc_fourcc_t Ext2Fourcc( const char *psz_name )
532 psz_name = strrchr( psz_name, '.' );
533 if( !psz_name ) return 0;
536 for( i = 0; ext_table[i].i_codec; i++ )
539 for( j = 0; toupper(ext_table[i].psz_ext[j]) == toupper(psz_name[j]);
542 if( !ext_table[i].psz_ext[j] && !psz_name[j] )
543 return ext_table[i].i_codec;
551 static const char *Fourcc2Ext( vlc_fourcc_t i_codec )
555 for( i = 0; ext_table[i].i_codec != 0; i++ )
557 if( ext_table[i].i_codec == i_codec ) return ext_table[i].psz_ext;
564 static void video_release_buffer( picture_t *p_pic )
568 free( p_pic->p_data_orig );
569 free( p_pic->p_sys );
574 static picture_t *video_new_buffer( decoder_t *p_dec )
576 picture_t *p_pic = malloc( sizeof(picture_t) );
578 p_dec->fmt_out.video.i_chroma = p_dec->fmt_out.i_codec;
579 vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic,
580 p_dec->fmt_out.video.i_chroma,
581 p_dec->fmt_out.video.i_width,
582 p_dec->fmt_out.video.i_height,
583 p_dec->fmt_out.video.i_aspect );
585 if( !p_pic->i_planes )
591 p_pic->pf_release = video_release_buffer;
592 p_pic->i_status = RESERVED_PICTURE;
598 static void video_del_buffer( decoder_t *p_dec, picture_t *p_pic )
603 free( p_pic->p_data_orig );
604 free( p_pic->p_sys );
609 static void video_link_picture( decoder_t *p_dec, picture_t *p_pic )
611 (void)p_dec; (void)p_pic;
614 static void video_unlink_picture( decoder_t *p_dec, picture_t *p_pic )
616 (void)p_dec; (void)p_pic;
619 static decoder_t *CreateDecoder( vlc_object_t *p_this, video_format_t *fmt )
623 p_dec = vlc_object_create( p_this, VLC_OBJECT_DECODER );
626 msg_Err( p_this, "out of memory" );
630 p_dec->p_module = NULL;
631 es_format_Init( &p_dec->fmt_in, VIDEO_ES, fmt->i_chroma );
632 es_format_Init( &p_dec->fmt_out, VIDEO_ES, 0 );
633 p_dec->fmt_in.video = *fmt;
634 p_dec->b_pace_control = true;
636 p_dec->pf_vout_buffer_new = video_new_buffer;
637 p_dec->pf_vout_buffer_del = video_del_buffer;
638 p_dec->pf_picture_link = video_link_picture;
639 p_dec->pf_picture_unlink = video_unlink_picture;
641 vlc_object_attach( p_dec, p_this );
643 /* Find a suitable decoder module */
644 p_dec->p_module = module_Need( p_dec, "decoder", "$codec", 0 );
645 if( !p_dec->p_module )
647 msg_Err( p_dec, "no suitable decoder module for fourcc `%4.4s'.\n"
648 "VLC probably does not support this image format.",
649 (char*)&p_dec->fmt_in.i_codec );
651 DeleteDecoder( p_dec );
658 static void DeleteDecoder( decoder_t * p_dec )
660 vlc_object_detach( p_dec );
662 if( p_dec->p_module ) module_Unneed( p_dec, p_dec->p_module );
664 es_format_Clean( &p_dec->fmt_in );
665 es_format_Clean( &p_dec->fmt_out );
667 vlc_object_release( p_dec );
671 static encoder_t *CreateEncoder( vlc_object_t *p_this, video_format_t *fmt_in,
672 video_format_t *fmt_out )
676 p_enc = vlc_object_create( p_this, VLC_OBJECT_ENCODER );
679 msg_Err( p_this, "out of memory" );
683 p_enc->p_module = NULL;
684 es_format_Init( &p_enc->fmt_in, VIDEO_ES, fmt_in->i_chroma );
685 p_enc->fmt_in.video = *fmt_in;
686 if( fmt_out->i_width > 0 && fmt_out->i_height > 0 )
688 p_enc->fmt_in.video.i_width = fmt_out->i_width;
689 p_enc->fmt_in.video.i_height = fmt_out->i_height;
691 if( fmt_out->i_visible_width > 0 &&
692 fmt_out->i_visible_height > 0 )
694 p_enc->fmt_in.video.i_visible_width = fmt_out->i_visible_width;
695 p_enc->fmt_in.video.i_visible_height = fmt_out->i_visible_height;
699 p_enc->fmt_in.video.i_visible_width = fmt_out->i_width;
700 p_enc->fmt_in.video.i_visible_height = fmt_out->i_height;
703 else if( fmt_out->i_sar_num && fmt_out->i_sar_den &&
704 fmt_out->i_sar_num * fmt_in->i_sar_den !=
705 fmt_out->i_sar_den * fmt_in->i_sar_num )
707 p_enc->fmt_in.video.i_width =
708 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den * fmt_in->i_width /
709 fmt_in->i_sar_den / fmt_out->i_sar_num;
710 p_enc->fmt_in.video.i_visible_width =
711 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den *
712 fmt_in->i_visible_width / fmt_in->i_sar_den / fmt_out->i_sar_num;
715 p_enc->fmt_in.video.i_frame_rate = 25;
716 p_enc->fmt_in.video.i_frame_rate_base = 1;
718 es_format_Init( &p_enc->fmt_out, VIDEO_ES, fmt_out->i_chroma );
719 p_enc->fmt_out.video = *fmt_out;
720 p_enc->fmt_out.video.i_width = p_enc->fmt_in.video.i_width;
721 p_enc->fmt_out.video.i_height = p_enc->fmt_in.video.i_height;
723 vlc_object_attach( p_enc, p_this );
725 /* Find a suitable decoder module */
726 p_enc->p_module = module_Need( p_enc, "encoder", 0, 0 );
727 if( !p_enc->p_module )
729 msg_Err( p_enc, "no suitable encoder module for fourcc `%4.4s'.\n"
730 "VLC probably does not support this image format.",
731 (char*)&p_enc->fmt_out.i_codec );
733 DeleteEncoder( p_enc );
736 p_enc->fmt_in.video.i_chroma = p_enc->fmt_in.i_codec;
741 static void DeleteEncoder( encoder_t * p_enc )
743 vlc_object_detach( p_enc );
745 if( p_enc->p_module ) module_Unneed( p_enc, p_enc->p_module );
747 es_format_Clean( &p_enc->fmt_in );
748 es_format_Clean( &p_enc->fmt_out );
750 vlc_object_release( p_enc );
754 static filter_t *CreateFilter( vlc_object_t *p_this, es_format_t *p_fmt_in,
755 video_format_t *p_fmt_out,
756 const char *psz_module )
760 p_filter = vlc_object_create( p_this, VLC_OBJECT_FILTER );
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 );