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>
43 #include <vlc_filter.h>
45 #include <vlc_image.h>
46 #include <vlc_stream.h>
47 #include <vlc_charset.h>
51 static picture_t *ImageRead( image_handler_t *, block_t *,
52 video_format_t *, video_format_t * );
53 static picture_t *ImageReadUrl( image_handler_t *, const char *,
54 video_format_t *, video_format_t * );
55 static block_t *ImageWrite( image_handler_t *, picture_t *,
56 video_format_t *, video_format_t * );
57 static int ImageWriteUrl( image_handler_t *, picture_t *,
58 video_format_t *, video_format_t *, const char * );
60 static picture_t *ImageConvert( image_handler_t *, picture_t *,
61 video_format_t *, video_format_t * );
62 static picture_t *ImageFilter( image_handler_t *, picture_t *,
63 video_format_t *, const char *psz_module );
65 static decoder_t *CreateDecoder( vlc_object_t *, video_format_t * );
66 static void DeleteDecoder( decoder_t * );
67 static encoder_t *CreateEncoder( vlc_object_t *, video_format_t *,
69 static void DeleteEncoder( encoder_t * );
70 static filter_t *CreateFilter( vlc_object_t *, es_format_t *,
71 video_format_t *, const char * );
72 static void DeleteFilter( filter_t * );
74 vlc_fourcc_t image_Type2Fourcc( const char * );
75 vlc_fourcc_t image_Ext2Fourcc( const char * );
76 /*static const char *Fourcc2Ext( vlc_fourcc_t );*/
79 * Create an image_handler_t instance
82 image_handler_t *__image_HandlerCreate( vlc_object_t *p_this )
84 image_handler_t *p_image = calloc( 1, sizeof(image_handler_t) );
88 p_image->p_parent = p_this;
90 p_image->pf_read = ImageRead;
91 p_image->pf_read_url = ImageReadUrl;
92 p_image->pf_write = ImageWrite;
93 p_image->pf_write_url = ImageWriteUrl;
94 p_image->pf_convert = ImageConvert;
95 p_image->pf_filter = ImageFilter;
101 * Delete the image_handler_t instance
104 void image_HandlerDelete( image_handler_t *p_image )
106 if( !p_image ) return;
108 if( p_image->p_dec ) DeleteDecoder( p_image->p_dec );
109 if( p_image->p_enc ) DeleteEncoder( p_image->p_enc );
110 if( p_image->p_filter ) DeleteFilter( p_image->p_filter );
121 static picture_t *ImageRead( image_handler_t *p_image, block_t *p_block,
122 video_format_t *p_fmt_in,
123 video_format_t *p_fmt_out )
125 picture_t *p_pic = NULL, *p_tmp;
127 /* Check if we can reuse the current decoder */
128 if( p_image->p_dec &&
129 p_image->p_dec->fmt_in.i_codec != p_fmt_in->i_chroma )
131 DeleteDecoder( p_image->p_dec );
135 /* Start a decoder */
136 if( !p_image->p_dec )
138 p_image->p_dec = CreateDecoder( p_image->p_parent, p_fmt_in );
139 if( !p_image->p_dec ) return NULL;
142 p_block->i_pts = p_block->i_dts = mdate();
143 while( (p_tmp = p_image->p_dec->pf_decode_video( p_image->p_dec, &p_block ))
147 picture_Release( p_pic );
153 msg_Warn( p_image->p_parent, "no image decoded" );
157 if( !p_fmt_out->i_chroma )
158 p_fmt_out->i_chroma = p_image->p_dec->fmt_out.video.i_chroma;
159 if( !p_fmt_out->i_width && p_fmt_out->i_height )
160 p_fmt_out->i_width = p_fmt_out->i_height
161 * p_image->p_dec->fmt_out.video.i_aspect
162 / VOUT_ASPECT_FACTOR;
163 if( !p_fmt_out->i_height && p_fmt_out->i_width )
164 p_fmt_out->i_height = p_fmt_out->i_width * VOUT_ASPECT_FACTOR
165 / p_image->p_dec->fmt_out.video.i_aspect;
166 if( !p_fmt_out->i_width )
167 p_fmt_out->i_width = p_image->p_dec->fmt_out.video.i_width;
168 if( !p_fmt_out->i_height )
169 p_fmt_out->i_height = p_image->p_dec->fmt_out.video.i_height;
171 /* Check if we need chroma conversion or resizing */
172 if( p_image->p_dec->fmt_out.video.i_chroma != p_fmt_out->i_chroma ||
173 p_image->p_dec->fmt_out.video.i_width != p_fmt_out->i_width ||
174 p_image->p_dec->fmt_out.video.i_height != p_fmt_out->i_height )
176 if( p_image->p_filter )
177 if( p_image->p_filter->fmt_in.video.i_chroma !=
178 p_image->p_dec->fmt_out.video.i_chroma ||
179 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
181 /* We need to restart a new filter */
182 DeleteFilter( p_image->p_filter );
183 p_image->p_filter = 0;
187 if( !p_image->p_filter )
190 CreateFilter( p_image->p_parent, &p_image->p_dec->fmt_out,
193 if( !p_image->p_filter )
195 picture_Release( p_pic );
201 /* Filters should handle on-the-fly size changes */
202 p_image->p_filter->fmt_in = p_image->p_dec->fmt_out;
203 p_image->p_filter->fmt_out = p_image->p_dec->fmt_out;
204 p_image->p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
205 p_image->p_filter->fmt_out.video = *p_fmt_out;
208 p_pic = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
209 *p_fmt_out = p_image->p_filter->fmt_out.video;
211 else *p_fmt_out = p_image->p_dec->fmt_out.video;
216 static picture_t *ImageReadUrl( image_handler_t *p_image, const char *psz_url,
217 video_format_t *p_fmt_in,
218 video_format_t *p_fmt_out )
222 stream_t *p_stream = NULL;
225 p_stream = stream_UrlNew( p_image->p_parent, psz_url );
229 msg_Dbg( p_image->p_parent, "could not open %s for reading",
234 i_size = stream_Size( p_stream );
236 p_block = block_New( p_image->p_parent, i_size );
238 stream_Read( p_stream, p_block->p_buffer, i_size );
239 stream_Delete( p_stream );
241 if( !p_fmt_in->i_chroma )
243 /* Try to guess format from file name */
244 p_fmt_in->i_chroma = image_Ext2Fourcc( psz_url );
247 p_pic = ImageRead( p_image, p_block, p_fmt_in, p_fmt_out );
257 static block_t *ImageWrite( image_handler_t *p_image, picture_t *p_pic,
258 video_format_t *p_fmt_in,
259 video_format_t *p_fmt_out )
263 /* Check if we can reuse the current encoder */
264 if( p_image->p_enc &&
265 ( p_image->p_enc->fmt_out.i_codec != p_fmt_out->i_chroma ||
266 p_image->p_enc->fmt_out.video.i_width != p_fmt_out->i_width ||
267 p_image->p_enc->fmt_out.video.i_height != p_fmt_out->i_height ) )
269 DeleteEncoder( p_image->p_enc );
273 /* Start an encoder */
274 if( !p_image->p_enc )
276 p_image->p_enc = CreateEncoder( p_image->p_parent,
277 p_fmt_in, p_fmt_out );
278 if( !p_image->p_enc ) return NULL;
281 /* Check if we need chroma conversion or resizing */
282 if( p_image->p_enc->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
283 p_image->p_enc->fmt_in.video.i_width != p_fmt_in->i_width ||
284 p_image->p_enc->fmt_in.video.i_height != p_fmt_in->i_height )
286 picture_t *p_tmp_pic;
288 if( p_image->p_filter )
289 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
290 p_image->p_filter->fmt_out.video.i_chroma !=
291 p_image->p_enc->fmt_in.video.i_chroma )
293 /* We need to restart a new filter */
294 DeleteFilter( p_image->p_filter );
295 p_image->p_filter = 0;
299 if( !p_image->p_filter )
302 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
303 fmt_in.video = *p_fmt_in;
306 CreateFilter( p_image->p_parent, &fmt_in,
307 &p_image->p_enc->fmt_in.video, NULL );
309 if( !p_image->p_filter )
316 /* Filters should handle on-the-fly size changes */
317 p_image->p_filter->fmt_in.i_codec = p_fmt_in->i_chroma;
318 p_image->p_filter->fmt_out.video = *p_fmt_in;
319 p_image->p_filter->fmt_out.i_codec =p_image->p_enc->fmt_in.i_codec;
320 p_image->p_filter->fmt_out.video = p_image->p_enc->fmt_in.video;
323 picture_Hold( p_pic );
326 p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
328 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_tmp_pic );
330 p_image->p_filter->pf_vout_buffer_del( p_image->p_filter, p_tmp_pic );
334 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_pic );
339 msg_Dbg( p_image->p_parent, "no image encoded" );
346 static int ImageWriteUrl( image_handler_t *p_image, picture_t *p_pic,
347 video_format_t *p_fmt_in, video_format_t *p_fmt_out,
348 const char *psz_url )
353 if( !p_fmt_out->i_chroma )
355 /* Try to guess format from file name */
356 p_fmt_out->i_chroma = image_Ext2Fourcc( psz_url );
359 file = utf8_fopen( psz_url, "wb" );
362 msg_Err( p_image->p_parent, "%s: %m", psz_url );
366 p_block = ImageWrite( p_image, p_pic, p_fmt_in, p_fmt_out );
371 if( fwrite( p_block->p_buffer, p_block->i_buffer, 1, file ) != 1 )
373 block_Release( p_block );
376 if( fclose( file ) && !err )
382 msg_Err( p_image->p_parent, "%s: %m", psz_url );
385 return err ? VLC_EGENERIC : VLC_SUCCESS;
389 * Convert an image to a different format
393 static picture_t *ImageConvert( image_handler_t *p_image, picture_t *p_pic,
394 video_format_t *p_fmt_in,
395 video_format_t *p_fmt_out )
399 if( !p_fmt_out->i_width && !p_fmt_out->i_height &&
400 p_fmt_out->i_sar_num && p_fmt_out->i_sar_den &&
401 p_fmt_out->i_sar_num * p_fmt_in->i_sar_den !=
402 p_fmt_out->i_sar_den * p_fmt_in->i_sar_num )
405 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
406 p_fmt_in->i_width / p_fmt_in->i_sar_den / p_fmt_out->i_sar_num;
407 p_fmt_out->i_visible_width =
408 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
409 p_fmt_in->i_visible_width / p_fmt_in->i_sar_den /
410 p_fmt_out->i_sar_num;
413 if( !p_fmt_out->i_chroma ) p_fmt_out->i_chroma = p_fmt_in->i_chroma;
414 if( !p_fmt_out->i_width )
415 p_fmt_out->i_width = p_fmt_out->i_visible_width = p_fmt_in->i_width;
416 if( !p_fmt_out->i_height )
417 p_fmt_out->i_height = p_fmt_out->i_visible_height = p_fmt_in->i_height;
418 if( !p_fmt_out->i_sar_num ) p_fmt_out->i_sar_num = p_fmt_in->i_sar_num;
419 if( !p_fmt_out->i_sar_den ) p_fmt_out->i_sar_den = p_fmt_in->i_sar_den;
420 if( !p_fmt_out->i_aspect ) p_fmt_out->i_aspect = p_fmt_in->i_aspect;
422 if( p_image->p_filter )
423 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
424 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
426 /* We need to restart a new filter */
427 DeleteFilter( p_image->p_filter );
428 p_image->p_filter = NULL;
432 if( !p_image->p_filter )
435 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
436 fmt_in.video = *p_fmt_in;
439 CreateFilter( p_image->p_parent, &fmt_in, p_fmt_out, NULL );
441 if( !p_image->p_filter )
448 /* Filters should handle on-the-fly size changes */
449 p_image->p_filter->fmt_in.video = *p_fmt_in;
450 p_image->p_filter->fmt_out.video = *p_fmt_out;
453 picture_Hold( p_pic );
455 p_pif = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
457 if( p_fmt_in->i_chroma == p_fmt_out->i_chroma &&
458 p_fmt_in->i_width == p_fmt_out->i_width &&
459 p_fmt_in->i_height == p_fmt_out->i_height )
461 /* Duplicate image */
462 picture_Release( p_pif ); /* XXX: Better fix must be possible */
463 p_pif = p_image->p_filter->pf_vout_buffer_new( p_image->p_filter );
465 picture_Copy( p_pif, p_pic );
472 * Filter an image with a psz_module filter
476 static picture_t *ImageFilter( image_handler_t *p_image, picture_t *p_pic,
477 video_format_t *p_fmt, const char *psz_module )
480 if( !p_image->p_filter )
483 es_format_Init( &fmt, VIDEO_ES, p_fmt->i_chroma );
487 CreateFilter( p_image->p_parent, &fmt, &fmt.video, psz_module );
489 if( !p_image->p_filter )
496 /* Filters should handle on-the-fly size changes */
497 p_image->p_filter->fmt_in.video = *p_fmt;
498 p_image->p_filter->fmt_out.video = *p_fmt;
501 picture_Hold( p_pic );
503 return p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
512 vlc_fourcc_t i_codec;
517 { VLC_FOURCC('j','p','e','g'), "jpeg" },
518 { VLC_FOURCC('j','p','e','g'), "jpg" },
519 { VLC_FOURCC('l','j','p','g'), "ljpg" },
520 { VLC_FOURCC('p','n','g',' '), "png" },
521 { VLC_FOURCC('p','g','m',' '), "pgm" },
522 { VLC_FOURCC('p','g','m','y'), "pgmyuv" },
523 { VLC_FOURCC('p','b','m',' '), "pbm" },
524 { VLC_FOURCC('p','a','m',' '), "pam" },
525 { VLC_FOURCC('t','g','a',' '), "tga" },
526 { VLC_FOURCC('b','m','p',' '), "bmp" },
527 { VLC_FOURCC('p','n','m',' '), "pnm" },
528 { VLC_FOURCC('x','p','m',' '), "xpm" },
529 { VLC_FOURCC('x','c','f',' '), "xcf" },
530 { VLC_FOURCC('p','c','x',' '), "pcx" },
531 { VLC_FOURCC('g','i','f',' '), "gif" },
532 { VLC_FOURCC('t','i','f','f'), "tif" },
533 { VLC_FOURCC('t','i','f','f'), "tiff" },
534 { VLC_FOURCC('l','b','m',' '), "lbm" },
538 vlc_fourcc_t image_Type2Fourcc( const char *psz_type )
542 for( i = 0; ext_table[i].i_codec; i++ )
545 for( j = 0; toupper(ext_table[i].psz_ext[j]) == toupper(psz_type[j]);
548 if( !ext_table[i].psz_ext[j] && !psz_type[j] )
549 return ext_table[i].i_codec;
556 vlc_fourcc_t image_Ext2Fourcc( const char *psz_name )
558 psz_name = strrchr( psz_name, '.' );
559 if( !psz_name ) return 0;
562 return image_Type2Fourcc( psz_name );
566 static const char *Fourcc2Ext( vlc_fourcc_t i_codec )
570 for( i = 0; ext_table[i].i_codec != 0; i++ )
572 if( ext_table[i].i_codec == i_codec ) return ext_table[i].psz_ext;
579 static picture_t *video_new_buffer( decoder_t *p_dec )
581 p_dec->fmt_out.video.i_chroma = p_dec->fmt_out.i_codec;
582 return picture_New( p_dec->fmt_out.video.i_chroma,
583 p_dec->fmt_out.video.i_width,
584 p_dec->fmt_out.video.i_height,
585 p_dec->fmt_out.video.i_aspect );
588 static void video_del_buffer( decoder_t *p_dec, picture_t *p_pic )
590 if( p_pic->i_refcount != 1 )
591 msg_Err( p_dec, "invalid picture reference count" );
593 p_pic->i_refcount = 0;
594 picture_Delete( p_pic );
597 static void video_link_picture( decoder_t *p_dec, picture_t *p_pic )
600 picture_Hold( p_pic );
603 static void video_unlink_picture( decoder_t *p_dec, picture_t *p_pic )
606 picture_Release( p_pic );
609 static decoder_t *CreateDecoder( vlc_object_t *p_this, video_format_t *fmt )
613 p_dec = vlc_object_create( p_this, VLC_OBJECT_DECODER );
617 p_dec->p_module = NULL;
618 es_format_Init( &p_dec->fmt_in, VIDEO_ES, fmt->i_chroma );
619 es_format_Init( &p_dec->fmt_out, VIDEO_ES, 0 );
620 p_dec->fmt_in.video = *fmt;
621 p_dec->b_pace_control = true;
623 p_dec->pf_vout_buffer_new = video_new_buffer;
624 p_dec->pf_vout_buffer_del = video_del_buffer;
625 p_dec->pf_picture_link = video_link_picture;
626 p_dec->pf_picture_unlink = video_unlink_picture;
628 vlc_object_attach( p_dec, p_this );
630 /* Find a suitable decoder module */
631 p_dec->p_module = module_need( p_dec, "decoder", "$codec", false );
632 if( !p_dec->p_module )
634 msg_Err( p_dec, "no suitable decoder module for fourcc `%4.4s'.\n"
635 "VLC probably does not support this image format.",
636 (char*)&p_dec->fmt_in.i_codec );
638 DeleteDecoder( p_dec );
645 static void DeleteDecoder( decoder_t * p_dec )
647 vlc_object_detach( p_dec );
649 if( p_dec->p_module ) module_unneed( p_dec, p_dec->p_module );
651 es_format_Clean( &p_dec->fmt_in );
652 es_format_Clean( &p_dec->fmt_out );
654 if( p_dec->p_description )
655 vlc_meta_Delete( p_dec->p_description );
657 vlc_object_release( p_dec );
661 static encoder_t *CreateEncoder( vlc_object_t *p_this, video_format_t *fmt_in,
662 video_format_t *fmt_out )
666 p_enc = sout_EncoderCreate( p_this );
670 p_enc->p_module = NULL;
671 es_format_Init( &p_enc->fmt_in, VIDEO_ES, fmt_in->i_chroma );
672 p_enc->fmt_in.video = *fmt_in;
673 if( fmt_out->i_width > 0 && fmt_out->i_height > 0 )
675 p_enc->fmt_in.video.i_width = fmt_out->i_width;
676 p_enc->fmt_in.video.i_height = fmt_out->i_height;
678 if( fmt_out->i_visible_width > 0 &&
679 fmt_out->i_visible_height > 0 )
681 p_enc->fmt_in.video.i_visible_width = fmt_out->i_visible_width;
682 p_enc->fmt_in.video.i_visible_height = fmt_out->i_visible_height;
686 p_enc->fmt_in.video.i_visible_width = fmt_out->i_width;
687 p_enc->fmt_in.video.i_visible_height = fmt_out->i_height;
690 else if( fmt_out->i_sar_num && fmt_out->i_sar_den &&
691 fmt_out->i_sar_num * fmt_in->i_sar_den !=
692 fmt_out->i_sar_den * fmt_in->i_sar_num )
694 p_enc->fmt_in.video.i_width =
695 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den * fmt_in->i_width /
696 fmt_in->i_sar_den / fmt_out->i_sar_num;
697 p_enc->fmt_in.video.i_visible_width =
698 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den *
699 fmt_in->i_visible_width / fmt_in->i_sar_den / fmt_out->i_sar_num;
702 p_enc->fmt_in.video.i_frame_rate = 25;
703 p_enc->fmt_in.video.i_frame_rate_base = 1;
705 es_format_Init( &p_enc->fmt_out, VIDEO_ES, fmt_out->i_chroma );
706 p_enc->fmt_out.video = *fmt_out;
707 p_enc->fmt_out.video.i_width = p_enc->fmt_in.video.i_width;
708 p_enc->fmt_out.video.i_height = p_enc->fmt_in.video.i_height;
710 vlc_object_attach( p_enc, p_this );
712 /* Find a suitable decoder module */
713 p_enc->p_module = module_need( p_enc, "encoder", NULL, false );
714 if( !p_enc->p_module )
716 msg_Err( p_enc, "no suitable encoder module for fourcc `%4.4s'.\n"
717 "VLC probably does not support this image format.",
718 (char*)&p_enc->fmt_out.i_codec );
720 DeleteEncoder( p_enc );
723 p_enc->fmt_in.video.i_chroma = p_enc->fmt_in.i_codec;
728 static void DeleteEncoder( encoder_t * p_enc )
730 vlc_object_detach( p_enc );
732 if( p_enc->p_module ) module_unneed( p_enc, p_enc->p_module );
734 es_format_Clean( &p_enc->fmt_in );
735 es_format_Clean( &p_enc->fmt_out );
737 vlc_object_release( p_enc );
741 static filter_t *CreateFilter( vlc_object_t *p_this, es_format_t *p_fmt_in,
742 video_format_t *p_fmt_out,
743 const char *psz_module )
745 static const char typename[] = "filter";
748 p_filter = vlc_custom_create( p_this, sizeof(filter_t),
749 VLC_OBJECT_GENERIC, typename );
750 vlc_object_attach( p_filter, p_this );
752 p_filter->pf_vout_buffer_new =
753 (picture_t *(*)(filter_t *))video_new_buffer;
754 p_filter->pf_vout_buffer_del =
755 (void (*)(filter_t *, picture_t *))video_del_buffer;
757 p_filter->fmt_in = *p_fmt_in;
758 p_filter->fmt_out = *p_fmt_in;
759 p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
760 p_filter->fmt_out.video = *p_fmt_out;
761 p_filter->p_module = module_need( p_filter, "video filter2",
764 if( !p_filter->p_module )
766 msg_Dbg( p_filter, "no video filter found" );
767 DeleteFilter( p_filter );
774 static void DeleteFilter( filter_t * p_filter )
776 vlc_object_detach( p_filter );
778 if( p_filter->p_module ) module_unneed( p_filter, p_filter->p_module );
780 es_format_Clean( &p_filter->fmt_in );
781 es_format_Clean( &p_filter->fmt_out );
783 vlc_object_release( p_filter );