diff options
Diffstat (limited to 'converter/other/fiasco/doc')
63 files changed, 1706 insertions, 0 deletions
diff --git a/converter/other/fiasco/doc/README.LIB b/converter/other/fiasco/doc/README.LIB new file mode 100644 index 00000000..4bf8c382 --- /dev/null +++ b/converter/other/fiasco/doc/README.LIB @@ -0,0 +1,51 @@ +--------------------------------------------------------------------------- + FIASCO («F»ractal «I»mage «A»nd «S»equence «CO»dec) + Copyright (C) 1994-2000 + Ullrich Hafner <hafner@bigfoot.de>, http://ulli.linuxave.net + Version 1.0 +--------------------------------------------------------------------------- + +FIASCO is an image and video compression system based on fractal +coding which outperforms the well known JPEG and MPEG +standards. FIASCO has been developed during my Ph.D. thesis "Low +Bit-Rate Image and Video Coding with Weighted Finite Automata", Mensch +& Buch Verlag, ISBN 3-89820-002-7. + +Some information about the FIASCO compression library: +The library consists of the five "classes" + + - fiasco_coder: used to encode a still image or a sequence of + frames to a FIASCO stream, see fiasco_coder(3) or the file + bin/cwfa.c for details. + + - fiasco_decoder: used to decode the individual frames step by + step, see fiasco_decoder(3) or the file bin/dwfa.c for + details. + + - fiasco_image: internal representation of an decoded FIASCO + image, see fiasco_image(3) or the file bin/dwfa.c for + details. + + - fiasco_renderer: used to render the generated image object + to one of the supported X11 output formats, see + fiasco_render(3) or the files bin/dwfa.c or bin/pnmpsnr.c for + details. + + - fiasco_options: used to control various decoder and encoder + options, see fiasco_options(3) or the files bin/cwfa.c, + bin/dwfa.c or bin/pnmpsnr.c for details. + + +Since the coder doesn't store any internal information, the only +method of this class is the function fiasco_coder (). + +For all other classes, a new object is created with the +fiasco_[object]_new () function, e.g., fiasco_decoder_new () creates a +new fiasco_decoder_t object. Each object has to be deleted manually by +calling the destructor fiasco_[object]_delete () (or by calling the +method object->delete (object)). If you prefer C++ calls: every +function of the type fiasco_[object]_[method] can be called via +[object]->[method] ([object], args), too. + +Note: PLEASE use only functions, which are noted in the fiasco.h file +(i.e., all functions and types with the prefix fiasco_)! diff --git a/converter/other/fiasco/doc/fiasco_c_options.3 b/converter/other/fiasco/doc/fiasco_c_options.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_delete.3 b/converter/other/fiasco/doc/fiasco_c_options_delete.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_delete.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_new.3 b/converter/other/fiasco/doc/fiasco_c_options_new.3 new file mode 100644 index 00000000..52efb86c --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_new.3 @@ -0,0 +1,432 @@ +.\" $Id: fiasco_c_options_new.3,v 1.1 2000/10/28 17:35:06 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_c_options_new, fiasco_c_options_delete, +.B fiasco_c_options_set_progress_meter, fiasco_c_options_set_basisfile, +.B fiasco_c_options_set_smoothing, fiasco_c_options_set_tiling, +.B fiasco_c_options_set_chroma_quality, fiasco_c_options_set_optimizations, +.B fiasco_c_options_set_prediction, fiasco_c_options_set_video_param, +.B fiasco_c_options_set_quantization, fiasco_c_options_set_frame_pattern +.B fiasco_c_options_set_title, fiasco_c_options_set_comment +\- define additional options of FIASCO coder and decoder + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_c_options_t *" +.fi +.BI "fiasco_c_options_new" +.fi +.BI " (void);" +.sp +.BI "void" +.fi +.BI "fiasco_c_options_delete" +.fi +.BI " (fiasco_c_options_t * "options ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_basisfile" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " const char * "filename ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_chroma_quality" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " float "quality_factor , +.fi +.BI " unsigned "dictionary_size ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_comment" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " const char * "comment ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_frame_pattern" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " const char * "pattern ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_optimizations" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " unsigned "min_block_level , +.fi +.BI " unsigned "max_block_level , +.fi +.BI " unsigned "max_elements , +.fi +.BI " unsigned "dictionary_size , +.fi +.BI " unsigned "optimization_level ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_quantization" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " unsigned "mantissa , +.fi +.BI " fiasco_rpf_range_e "range , +.fi +.BI " unsigned "dc_mantissa , +.fi +.BI " fiasco_rpf_range_e "dc_range ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_prediction" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " int "intra_prediction , +.fi +.BI " unsigned "min_block_level , +.fi +.BI " unsigned "max_block_level ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_progress_meter" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " fiasco_progress_e "type ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_smoothing" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " unsigned "smoothing ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_tiling" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " fiasco_tiling_e "method , +.fi +.BI " unsigned "exponent ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_title" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " const char * "title ); +.sp +.BI "int" +.fi +.BI "fiasco_c_options_set_video_param" +.fi +.BI " (fiasco_c_options_t * "options , +.fi +.BI " unsigned "frames_per_second , +.fi +.BI " int "half_pixel_prediction , +.fi +.BI " int "cross_B_search , +.fi +.BI " int "B_as_past_ref ); +.fi + +.SH DESCRIPTION +The \fBfiasco_c_options_new()\fP function allocates and initializes a +FIASCO options object which is used to control additional compression + parameters. + +Conversely, the function \fBfiasco_c_options_delete()\fP discards the +given FIASCO coder options object. + +Several member functions are available to modify the default behavior +of the FIASCO coder. + +\fBfiasco_c_options_set_smoothing()\fP sets the +\fIsmoothing\fP-percentage along partitioning borders when the image +is regenerated; default is 70. This value is stored in the FIASCO file +and is used as default smoothing percentage in the decoder. + +\fBfiasco_c_options_set_frame_pattern()\fP sets the type of inter frame +compression which should be applied to individual frames of a video +stream; default is "IPPPPPPPPP". + +\fBfiasco_c_options_set_tiling()\fP sets \fImethod\fP and \fIexponent\fP +of the image tiling algorithm which runs as initial step of the +encoder; by default the image is subdivided into 16 tiles which +are sorted by decreasing variance. + +\fBfiasco_c_options_set_basisfile()\fP sets the \fIfilename\fP of +the FIASCO initial basis (codebook of dictionary vectors); default is +"small.fco". + +\fBfiasco_c_options_set_chroma_quality()\fP sets the quality used when +coding the chroma channels of a color image to the term "\fIquality\fP +of luminance / \fIquality_factor\fP"; default is 2. Moreover, the size +of the codebook is limited by \fIdictionary_size\fP; default is 40 +elements. + +\fBfiasco_c_options_set_comment()\fP sets a \fIcomment\fP string to be +stored in the FIASCO file; default is the empty string. + +\fBfiasco_c_options_set_title()\fP sets a \fItitle\fP string to be +stored in the FIASCO file; default is the empty string. + +\fBfiasco_c_options_set_optimizations()\fP toggles various coding +optimizations. E.g., the size of the dictionary (default is 10000), +the subset of dictionary elements to use for an individual +approximation (default is 5), the size of the image blocks to consider +(4x4, ..., 64x64), and some additional low level +optimizations (default level is 1). + +\fBfiasco_c_options_set_prediction()\fP enables an additional intra +block prediction by using a DC component approximation. By giving +levels \fImin_block_level\fP and \fImax_block_level\fP the prediction +can be limited to a small range of blocks only. By default, this +method is disabled. + +\fBfiasco_c_options_set_video_param()\fP defines the framerate (default +is 25) and toggles whether to use half pixel precise motion +compensated prediction (disabled by default), whether to determine +motion vectors of interpolated prediction with the Cross-B-Search +algorithm (disabled by default), and whether to allow B frames to be +used for B frame predicion (disabled by default). + +\fBfiasco_c_options_set_quantization()\fP defines the quantization +parameters of the approximation coefficients. By default the range of +DC coefficients is [-1,+1] using a mantissa of 5 bits (and one sign +bit). By default, all other coefficients are quantized with 3 mantissa +bits in the interval [-1.5,+1.5]. + +\fBfiasco_c_options_set_progress_meter()\fP sets the type of progress +meter to be used during coding. By default, an RPM style progress bar +using 50 hash marks (####) is used. + +.SH ARGUMENTS +.TP +options +This object encapsulates various coding parameters. + +.TP +smoothing +This percentage (range is 0 - i.e., no smoothing - to 100) defines how +much the regenerated image is smoothed along the partitioning borders. + +.TP +method +Defines the algorithm which should be used to sort the image tiles +which are generated in the initial coding step. If \fImethod\fP is +\fBFIASCO_VARIANCE_ASC\fP then the tiles are sorted by variance - the +first tile has the lowest variance. Conversely, when using +\fBFIASCO_VARIANCE_DSC\fP the first tile has the largest variance. If +\fImethod\fP is \fBFIASCO_SPIRAL_ASC\fP then the tiles are sorted like +a spiral starting in the middle of the image. Conversely, when using +\fBFIASCO_SPIRAL_DSC\fP the tiles are sorted like a spiral starting in +the upper left corner. + +.TP +exponent +This value sets the number of image tiles - which are generated in the +initial step of the encoder - to 2^\fIexponent\fP. + +.TP +title +This value is the title string of the FIASCO file. It is displayed, e.g., +in the window title of the decoder. + +.TP +comment +This value defines an optional comment to be stored in the FIASCO file. + +.TP +pattern +This string defines the sequence of frame types. Character \fIn\fP of +the string defines the type of frame \fIn\fP (\fIpattern\fP is +periodically extended). Three different frame types are available +(case insensitive): choose 'i' for intra-frames (no inter frame +prediction is used), 'p' for predicted frames (a frame of the +past is used for prediction), or 'b' for bi-directional predicted +frames (both a frame of the past and the future is used for +prediction). + +.TP +filename +The initial basis (codebook) of the coder is loaded from this +(ASCII) file. Files that already come with FIASCO are "small.fco" (3 elements), +"medium.fco" (132 elements), and "large.fco" (219 elements). + +.TP +quality_factor +When coding chroma channels (Cb and Cr band) the approximation quality +is determined by the term `quality of Y component' / \fIquality_factor\fP. + +.TP +dictionary_size +FIASCO uses a dictionary (codebook) of variable size to approximate +individual image blocks. The size of the codebook can be limited by +\fIdictionary_size\fP to reduce the coding time, however, at the cost +of decreasing quality. + +.TP +min_block_level +During coding only those image blocks are considered for approximation +(or prediction) which binary tree level is larger than +\fImin_block_level\fP (minimum value is 3). (Since FIASCO internally +works with binary trees, the size of an image block is determined by +the \fIlevel\fP of the corresponding binary tree). Refer to following +table to convert these values: + +.ce +level | width | height +.fi +------+-------+-------- +.fi + 0 | 1 | 1 +.fi + 1 | 1 | 2 +.fi + 2 | 2 | 2 +.fi + 3 | 2 | 4 +.fi + 4 | 4 | 4 +.fi + 5 | 4 | 8 +.fi + 6 | 8 | 8 +.fi + 7 | 8 | 16 +.fi +------+-------+-------- +.fi +The larger this value is the faster the coder runs but the worse the +image quality will be. + +.TP +max_block_level +During coding only those image blocks are considered for approximation +(or prediction) which binary tree level is smaller than +\fImax_block_level\fP. The smaller this value is the faster the coder +runs but the worse the image quality will be. + +.TP +max_elements +This value defines how many dictionary elements can be +used to approximate an individual image block. The smaller this positive +value (range is 1 to 5) is the faster the coder runs but the worse the +image quality will be. + +.TP +optimization_level +Additional low level optimizations are available by setting +\fIoptimization_level\fP to one of the following values: +.fi +0 standard approximation method +.fi +1 slightly increases the approximation quality, running time is +twice as high as with the standard method +.fi +2 hardly increases the approximation quality of method 1, running time +is twice as high as with method 1 (this method just remains for +completeness) +.fi + +.TP +intra_prediction +If \fIintra_prediction\fP is set to a non-zero value then an +additional block prediction of intra-frames is enabled. For some +images, the image quality is slightly improved, however, at the cost of +a significantly increased running time of the coder. + +.TP +frames_per_second +This value defines the frame rate, i.e., how many frames per second +should be displayed. This value has no effect during coding, it is just +passed to the FIASCO output file where it is read and used by the +decoder. + +.TP +half_pixel_prediction +A non-zero value enables half pixel precise motion compensated +prediction. + +.TP +cross_B_search +A non-zero value enables the fast Cross-B-Search algorithm to determine +the motion vectors of an interpolated prediction. Otherwise, +exhaustive search (in the given search range) is used. + +.TP +B_as_past_ref +A non-zero value allows not only I- and P-frames but also B-frames to be +used for a forward or bi-directional predicion. + +.TP +mantissa, range +Approximation coefficients are quantized to a small number of +values (in fixed point format) in the interval [-\fIrange\fP, ++\fIrange\fP]. The number of \fImantissa\fP bits defines the accuracy of +quantization. + +.TP +dc_mantissa, dc_range +Approximation coefficients of the DC component are quantized in a +different way: the number of mantissa bits is given by +\fIdc_mantissa\fP whereas the quantization interval is given by +[-\fIdc_range\fP, +\fBdc_range\fP]. + +.TP +type +This value sets the \fItype\fP of progress meter which should be used +during coding. The following types are available: +.fi +\fBFIASCO_PROGRESS_NONE\fP: no output at all +.fi +\fBFIASCO_PROGRESS_BAR\fP: print hash marks (###) +\fBFIASCO_PROGRESS_PERCENT\fP: percentage meter (50%) + +.SH RETURN VALUES +The function \fBfiasco_c_options_new()\fP returns a pointer to the +newly allocated coder option object. If an error has been catched, a +NULL pointer is returned. + +All set functions return 1 on success and 0 if an error has been +catched. + +In case of an error, use the function fiasco_get_error_message(3) to +get a string with the last error message of FIASCO. + +.SH "SEE ALSO" +.br +.BR fiasco_decoder "(3), " fiasco_coder (3) + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_basisfile.3 b/converter/other/fiasco/doc/fiasco_c_options_set_basisfile.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_basisfile.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_chroma_quality.3 b/converter/other/fiasco/doc/fiasco_c_options_set_chroma_quality.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_chroma_quality.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_comment.3 b/converter/other/fiasco/doc/fiasco_c_options_set_comment.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_comment.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_frame_pattern.3 b/converter/other/fiasco/doc/fiasco_c_options_set_frame_pattern.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_frame_pattern.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_optimizations.3 b/converter/other/fiasco/doc/fiasco_c_options_set_optimizations.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_optimizations.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_prediction.3 b/converter/other/fiasco/doc/fiasco_c_options_set_prediction.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_prediction.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_progress_meter.3 b/converter/other/fiasco/doc/fiasco_c_options_set_progress_meter.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_progress_meter.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_quantization.3 b/converter/other/fiasco/doc/fiasco_c_options_set_quantization.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_quantization.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_smoothing.3 b/converter/other/fiasco/doc/fiasco_c_options_set_smoothing.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_smoothing.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_tiling.3 b/converter/other/fiasco/doc/fiasco_c_options_set_tiling.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_tiling.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_title.3 b/converter/other/fiasco/doc/fiasco_c_options_set_title.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_title.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_c_options_set_video_param.3 b/converter/other/fiasco/doc/fiasco_c_options_set_video_param.3 new file mode 100644 index 00000000..58b2da44 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_c_options_set_video_param.3 @@ -0,0 +1 @@ +.so man3/fiasco_c_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_coder.3 b/converter/other/fiasco/doc/fiasco_coder.3 new file mode 100644 index 00000000..3d1c6b87 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_coder.3 @@ -0,0 +1,106 @@ +.\" $Id: fiasco_coder.3,v 1.2 2000/10/28 17:39:32 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_coder +\- compress image files to a FIASCO file + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "int " +.fi +.BI "fiasco_coder (char const * const * "image_names , +.fi +.BI " const char * "fiasco_name , +.fi +.BI " float "quality , +.fi +.BI " const fiasco_c_options_t * "options ); +.fi + +.SH DESCRIPTION +The \fBfiasco-coder()\fP function compresses the image file(s) given +by the list of \fIimage_names\fP and creates the new FIASCO output file +\fIfiasco_name\fP. Besides the approximation \fIquality\fP, several +compression parameters can be adjusted by the class \fBoptions\fP (see +fiasco_c_options_new(3)). + +.SH ARGUMENTS + +.TP +image_names +NULL terminated array of image filenames to process. If the first +array element is "-" or a NULL pointer then FIASCO reads the image +from standard input. Each array element either has to be an image +filename or a template of the form: + +.ce +prefix[start-end{+,-}step]suffix + +Templates are useful when compressing video streams: e.g., if the template +"img0[12-01-2].pgm" is given as array element, then FIASCO compresses the +images img012.pgm, img010.pgm, ..., img002.pgm (in this order). + +If a filename is a relative path then the images are searched for in +the current directory and in the (colon-separated) list of directories +given by the environment variable \fBFIASCO_IMAGES\fP. + +.TP +fiasco_name +Name of the FIASCO output file. If the name is "-" or NULL then the +file is produced on standard output. + +If \fIfiasco_name\fP is a relative path and the environment variable +\fBFIASCO_DATA\fP is a (colon-separated) list of directories, then the +output file is written to the first (writable) directory of this +list. Otherwise, the current directory is used to store the output +file. + +.TP +quality +Defines the quality of compression. Quality has to be a positive +value, its typical range is 1.0 (worst) to 100.0 (best). Larger values +are also allowed - at the cost of exploding encoding times. + +.TP +options +This "class" encapsulates the various coding and decoding +parameters. Use the functions fiasco_c_options_new(3) and +fiasco_c_options_delete(3) to create and delete an object of this +class. Several member functions (see fiasco_c_options(3)) are +available to change the default values. + +.SH RETURN VALUE +The function \fBfiasco_coder()\fP returns 1 if the FIASCO file has +been successfully written. If an error has been catched during +compression, 0 is returned - use the function +fiasco_get_error_message(3) to get the last error message of FIASCO. + +.SH ENVIRONMENT +.PD 0 +.TP +.B FIASCO_IMAGES +Search path for image files. Default is "./". +.TP +.B FIASCO_DATA +Search and save path for FIASCO files. Default is "./". +.PD + +.SH "SEE ALSO" +.br +.BR fiasco_c_options_new "(3), " fiasco_c_options_delete (3), +.br +.BR fiasco_c_options "(3), " fiasco_get_error_message (3) +.br + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_d_options.3 b/converter/other/fiasco/doc/fiasco_d_options.3 new file mode 100644 index 00000000..21f1db63 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_d_options.3 @@ -0,0 +1 @@ +.so man3/fiasco_d_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_d_options_delete.3 b/converter/other/fiasco/doc/fiasco_d_options_delete.3 new file mode 100644 index 00000000..21f1db63 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_d_options_delete.3 @@ -0,0 +1 @@ +.so man3/fiasco_d_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_d_options_new.3 b/converter/other/fiasco/doc/fiasco_d_options_new.3 new file mode 100644 index 00000000..4294330a --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_d_options_new.3 @@ -0,0 +1,122 @@ +.\" $Id: fiasco_d_options_new.3,v 1.1 2000/10/28 17:35:12 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_d_options_new, fiasco_d_options_set_magnification, +.B fiasco_d_options_delete, fiasco_d_options_set_smoothing +.B fiasco_d_options_set_4_2_0_format +\- define additional options of FIASCO decoder + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_d_options_t *" +.fi +.BI "fiasco_d_options_new" +.fi +.BI " (void);" +.sp +.BI "void" +.fi +.BI "fiasco_d_options_delete" +.fi +.BI " (fiasco_d_options_t * "options ); +.sp +.BI "int" +.fi +.BI "fiasco_d_options_set_4_2_0_format" +.fi +.BI " (fiasco_d_options_t * "options , +.fi +.BI " int "format ); +.sp +.BI "int" +.fi +.BI "fiasco_d_options_set_magnification" +.fi +.BI " (fiasco_d_options_t * "options , +.fi +.BI " int "level ); +.sp +.BI "int" +.fi +.BI "fiasco_d_options_set_smoothing" +.fi +.BI " (fiasco_d_options_t * "options , +.fi +.BI " unsigned "smoothing ); +.fi + +.SH DESCRIPTION +The \fBfiasco_d_options_new()\fP function allocates and initializes a +FIASCO options object which is used to control additional +decompression parameters. + +Conversely, the function \fBfiasco_d_options_delete()\fP discards the +given FIASCO decoder options object. + +Several member functions are available to modify the default behavior +of the FIASCO decoder. + +\fBfiasco_d_options_set_smoothing()\fP sets the +\fIsmoothing\fP-percentage along partitioning borders when the images +are regenerated; default is 70. + +\fBfiasco_d_options_set_magnification()\fP sets the \fImagnification\fP +of the regenerated image; default is 0, i.e., the image geometry is +not changed. + +\fBfiasco_d_options_set_4_2_0_format()\fP defines whether the decoder +should use the default 4:4:4 format or the 4:2:0 format. The latter +one significantly reduces the decoding time at the cost of some +additional blocking artefacts. + +.SH ARGUMENTS +.TP +options +This object encapsulates various decoding parameters. + +.TP +smoothing +This percentage (range is 0 - i.e., no smoothing - to 100) defines how +much the regenerated image is smoothed along the partitioning borders. + +.TP +level +This value gives the magnification of the decoded image with respect +to the original size. Positive values increase and negative values +decrease the width and height of the image by a factor of +2^abs(\fIlevel\fP). + +.TP +format +If \fIformat\fP is 0 then the 4:4:4 color image format is used, i.e., +the chroma channel are of the same size as the luminance. Otherwise, +the 4:2:0 format is used. Then, width and height of each chroma +channel is only one half of the width and height of the luminance. + +.SH RETURN VALUES +The function \fBfiasco_d_options_new()\fP returns a pointer to the +newly allocated decoder option object. If an error has been catched, a +NULL pointer is returned. + +All set functions return 1 on success and 0 if an error has been +catched. + +In case of an error, use the function fiasco_get_error_message(3) to +get a string with the last error message of FIASCO. + +.SH "SEE ALSO" +.br +.BR fiasco_decoder "(3), " fiasco_coder (3) + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_d_options_set_4_2_0_format.3 b/converter/other/fiasco/doc/fiasco_d_options_set_4_2_0_format.3 new file mode 100644 index 00000000..21f1db63 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_d_options_set_4_2_0_format.3 @@ -0,0 +1 @@ +.so man3/fiasco_d_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_d_options_set_magnification.3 b/converter/other/fiasco/doc/fiasco_d_options_set_magnification.3 new file mode 100644 index 00000000..21f1db63 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_d_options_set_magnification.3 @@ -0,0 +1 @@ +.so man3/fiasco_d_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_d_options_set_smoothing.3 b/converter/other/fiasco/doc/fiasco_d_options_set_smoothing.3 new file mode 100644 index 00000000..21f1db63 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_d_options_set_smoothing.3 @@ -0,0 +1 @@ +.so man3/fiasco_d_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder.3 b/converter/other/fiasco/doc/fiasco_decoder.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_delete.3 b/converter/other/fiasco/doc/fiasco_decoder_delete.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_delete.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_comment.3 b/converter/other/fiasco/doc/fiasco_decoder_get_comment.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_comment.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_frame.3 b/converter/other/fiasco/doc/fiasco_decoder_get_frame.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_frame.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_framerate.3 b/converter/other/fiasco/doc/fiasco_decoder_get_framerate.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_framerate.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_height.3 b/converter/other/fiasco/doc/fiasco_decoder_get_height.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_height.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_length.3 b/converter/other/fiasco/doc/fiasco_decoder_get_length.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_length.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_title.3 b/converter/other/fiasco/doc/fiasco_decoder_get_title.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_title.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_get_width.3 b/converter/other/fiasco/doc/fiasco_decoder_get_width.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_get_width.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_is_color.3 b/converter/other/fiasco/doc/fiasco_decoder_is_color.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_is_color.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_decoder_new.3 b/converter/other/fiasco/doc/fiasco_decoder_new.3 new file mode 100644 index 00000000..05e981a9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_new.3 @@ -0,0 +1,194 @@ +.\" $Id: fiasco_decoder_new.3,v 1.5 2000/10/28 17:39:32 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_decoder_new, fiasco_decoder_delete, +.B fiasco_decoder_write_frame, fiasco_decoder_get_frame, +.B fiasco_decoder_get_length, fiasco_decoder_get_rate, +.B fiasco_decoder_get_width, fiasco_decoder_get_height +.B fiasco_decoder_get_title, fiasco_decoder_get_comment +.B fiasco_decoder_is_color +\- decompress a FIASCO file + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_decoder_t *" +.fi +.BI "fiasco_decoder_new (const char * "fiasco_name , +.fi +.BI " const fiasco_d_options_t * "options ); +.sp +.BI "void" +.fi +.BI "fiasco_decoder_delete (fiasco_decoder_t * "decoder ); +.sp +.BI "int" +.fi +.BI "fiasco_decoder_write_frame (fiasco_decoder_t * "decoder , +.fi +.BI " const char * "image_name ); +.sp +.BI "fiasco_image_t *" +.fi +.BI "fiasco_decoder_get_frame (fiasco_decoder_t * "decoder ); +.sp +.BI "unsigned" +.fi +.BI "fiasco_decoder_get_length (fiasco_decoder_t * "decoder ); +.sp +.BI "unsigned" +.fi +.BI "fiasco_decoder_get_rate (fiasco_decoder_t * "decoder ); +.sp +.BI "unsigned" +.fi +.BI "fiasco_decoder_get_width (fiasco_decoder_t * "decoder ); +.sp +.BI "unsigned" +.fi +.BI "fiasco_decoder_get_height (fiasco_decoder_t * "decoder ); +.sp +.BI "const char *" +.fi +.BI "fiasco_decoder_get_title (fiasco_decoder_t * "decoder ); +.sp +.BI "const char *" +.fi +.BI "fiasco_decoder_get_comment (fiasco_decoder_t * "decoder ); +.sp +.BI "int" +.fi +.BI "fiasco_decoder_is_color (fiasco_decoder_t * "decoder ); +.fi + +.SH DESCRIPTION +The \fBfiasco_decoder_new()\fP function initializes the decompression +of FIASCO file \fIfiasco_name\fP. Several decompression parameters +can be adjusted by the class \fIoptions\fP (see +fiasco_d_options_new(3)). + +The individual frames of a FIASCO video can be decompressed by calling +successively either function \fBfiasco_decoder_write_frame()\fP or +\fBfiasco_decoder_get_frame()\fP. + +The function \fBfiasco_decoder_write_frame()\fP decompresses the +current frame and writes it in raw pgm(5) or ppm(5) format to the file +\fIimage_name\fP. If \fIimage_name\fP=- or a NULL pointer then the +image file is produced on the standard output. If \fIimage_name\fP is a +relative path and the environment variable \fBFIASCO_IMAGES\fP is a +(colon-separated) list of directories, then the output file is +written to the first (writable) directory of this list. Otherwise, the +current directory is used to store the file. + +The function \fBfiasco_decoder_get_frame()\fP decompresses the +current frame and returns the computed image object. Use the function +fiasco_renderer_new(3) to create a renderer object that converts the +FIASCO image to the desired format. + +After all frames have been decompressed, the function +\fBfiasco_decoder_delete()\fP should be called to close the input file +and to free temporarily allocated memory. + +Number of available frames, frame rate and frames geometry, type of the +FIASCO file are accessible through member functions +\fBfiasco_decoder_get_length()\fP, +\fBfiasco_decoder_get_rate()\fP, +\fBfiasco_decoder_get_width()\fP, +\fBfiasco_decoder_get_height()\fP, +and \fBfiasco_decoder_is_color()\fP. Use \fBfiasco_decoder_get_title()\fP, +\fBfiasco_decoder_get_comment()\fP to read title and comment strings of the +FIASCO file. + +.SH ARGUMENTS + +.TP +fiasco_name +Filename of the FIASCO input file. If \fIfiasco_name\fP is a NULL pointer +or "-" then the decoder reads from standard input. If the file is not +found in the current directory and the environment variable +\fBFIASCO_DATA\fP is a (colon-separated) list of directories, then the +input file is searched for in these directories, too. + +.TP +options +This "class" encapsulates the various coding and decoding +parameters. Use the functions fiasco_d_options_new(3) and +fiasco_d_options_delete(3) to create and delete an object of this +class. Several member functions (see fiasco_d_options(3)) are +available to change the default values. + +.TP +decoder +The decoder "class" encapsulates the FIASCO decoder. It is used to +store the internal state of the decoder. + +.SH RETURN VALUES +The function \fBfiasco_decoder_new()\fP returns a pointer to the newly +allocated decoder object. If an error has been catched, a NULL pointer +is returned. + +The function \fBfiasco_decoder_write_frame()\fP returns 1 if the file +has been successfully written. Otherwise, the function returns 0. + +The function \fBfiasco_decoder_get_frame()\fP returns a pointer to the +newly allocated FIASCO image object. If an error has been catched, a NULL +pointer is returned. + +The function \fBfiasco_decoder_get_length()\fP returns the number of +frames of the FIASCO file. If an error has been catched, 0 is +returned. + +The function \fBfiasco_decoder_get_rate()\fP returns the +framerate (number of frames per second) of the FIASCO file. If an +error has been catched, 0 is returned. + +The function \fBfiasco_decoder_get_width()\fP returns the width of the +decoded frames of the FIASCO file. If an error has been catched, 0 is +returned. + +The function \fBfiasco_decoder_get_height()\fP returns the height of the +decoded frames of the FIASCO file. If an error has been catched, 0 is +returned. + +The function \fBfiasco_decoder_get_title()\fP returns an optional +title of the FIASCO file. If an error has been catched, 0 is returned. + +The function \fBfiasco_decoder_get_comment()\fP returns an optional +comment of the FIASCO file. If an error has been catched, 0 is returned. + +The function \fBfiasco_decoder_is_color()\fP returns 0 if the decoded +frames are grayscale images, otherwise a non-zero value is +returned. + +In case of an error in one of the above functions, use the function +fiasco_get_error_message(3) to get a string describing the last error +message of FIASCO. + +.SH ENVIRONMENT +.PD 0 +.TP +.B FIASCO_IMAGES +Search path for image files. Default is "./". +.TP +.B FIASCO_DATA +Search and save path for FIASCO files. Default is "./". +.PD + +.SH "SEE ALSO" +.br +.BR fiasco_d_options_new "(3), " fiasco_d_options_delete (3), +.br +.BR fiasco_d_options "(3), " fiasco_get_error_message (3) +.br + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_decoder_write_frame.3 b/converter/other/fiasco/doc/fiasco_decoder_write_frame.3 new file mode 100644 index 00000000..33c0d21b --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_decoder_write_frame.3 @@ -0,0 +1 @@ +.so man3/fiasco_decoder_new.3 diff --git a/converter/other/fiasco/doc/fiasco_get_error_message.3 b/converter/other/fiasco/doc/fiasco_get_error_message.3 new file mode 100644 index 00000000..09d593fb --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_get_error_message.3 @@ -0,0 +1,41 @@ +.\" $Id: fiasco_get_error_message.3,v 1.1 2000/06/14 19:07:02 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_get_error_message +\- return string describing last error catched in FIASCO library + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "const char * " +.fi +.BI "fiasco_get_error_message (void);" +.fi + +.SH DESCRIPTION +The \fBfiasco_get_error_message()\fP function returns a string +describing the last error that has been catched in the FIASCO library. + +.SH RETURN VALUE +The function \fBfiasco_get_error_message()\fP returns the appropriate +description string, or an empty string if no error has been catched so +far. + +.SH "SEE ALSO" +.br +.BR fiasco_options "(3), " fiasco_coder (3), +.br +.BR fiasco_decoder "(3), " fiasco_renderer (3) +.br + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_get_verbosity.3 b/converter/other/fiasco/doc/fiasco_get_verbosity.3 new file mode 100644 index 00000000..884cd19e --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_get_verbosity.3 @@ -0,0 +1 @@ +.so man3/fiasco_set_verbosity.3 diff --git a/converter/other/fiasco/doc/fiasco_image.3 b/converter/other/fiasco/doc/fiasco_image.3 new file mode 100644 index 00000000..f8df38d5 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_image.3 @@ -0,0 +1 @@ +.so man3/fiasco_image_new.3 diff --git a/converter/other/fiasco/doc/fiasco_image_delete.3 b/converter/other/fiasco/doc/fiasco_image_delete.3 new file mode 100644 index 00000000..f8df38d5 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_image_delete.3 @@ -0,0 +1 @@ +.so man3/fiasco_image_new.3 diff --git a/converter/other/fiasco/doc/fiasco_image_get_height.3 b/converter/other/fiasco/doc/fiasco_image_get_height.3 new file mode 100644 index 00000000..f8df38d5 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_image_get_height.3 @@ -0,0 +1 @@ +.so man3/fiasco_image_new.3 diff --git a/converter/other/fiasco/doc/fiasco_image_get_width.3 b/converter/other/fiasco/doc/fiasco_image_get_width.3 new file mode 100644 index 00000000..f8df38d5 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_image_get_width.3 @@ -0,0 +1 @@ +.so man3/fiasco_image_new.3 diff --git a/converter/other/fiasco/doc/fiasco_image_is_color.3 b/converter/other/fiasco/doc/fiasco_image_is_color.3 new file mode 100644 index 00000000..f8df38d5 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_image_is_color.3 @@ -0,0 +1 @@ +.so man3/fiasco_image_new.3 diff --git a/converter/other/fiasco/doc/fiasco_image_new.3 b/converter/other/fiasco/doc/fiasco_image_new.3 new file mode 100644 index 00000000..10625b63 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_image_new.3 @@ -0,0 +1,95 @@ +.\" $Id: fiasco_image_new.3,v 1.2 2000/06/14 19:26:06 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_image_new, fiasco_image_delete, fiasco_image_get_width, +.B fiasco_image_get_height, fiasco_image_is_color +\- handle FIASCO image objects + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_image_t *" +.fi +.BI "fiasco_image_new (const char * "filename ); +.sp +.BI "void" +.fi +.BI "fiasco_image_delete (fiasco_image_t * "image ); +.sp +.BI "unsigned" +.fi +.BI "fiasco_image_get_width (const fiasco_image_t * "image ); +.sp +.BI "unsigned" +.fi +.BI "fiasco_image_get_height (const fiasco_image_t * "image ); +.sp +.BI "int" +.fi +.BI "fiasco_image_is_color (const fiasco_image_t * "image ); +.fi + +.SH DESCRIPTION +The \fBfiasco_image_new()\fP function reads the given image file and +allocates and initializes a FIASCO image object. Use the function +fiasco_renderer_new(3) to create a renderer object that converts the +FIASCO image to the desired image format. + +The function \fBfiasco_image_delete()\fP deletes the image object and +frees the image buffer. + +Image geometry and type are accessible through member functions +\fBfiasco_image_get_width()\fP, +\fBfiasco_image_get_height()\fP, +and \fBfiasco_image_is_color()\fP. + +.SH ARGUMENTS + +.TP +image +The image "class" encapsulates the FIASCO image object. It is used to +store the pixel values of the decoded or read image. + +.TP +filename +Image filename to process. If \fIfilename\fP is "-" or a NULL pointer +then the image is read from standard input. If a filename is a +relative path then the images are searched for in the current +directory and in the (colon-separated) list of directories given by +the environment variable \fBFIASCO_IMAGES\fP. + +.SH RETURN VALUE +The function \fBfiasco_image_new()\fP returns a pointer to the newly +allocated image object. If an error has been catched, a NULL pointer +is returned. + +The function \fBfiasco_image_get_width()\fP returns the width of the +image. If an error has been catched, 0 is returned. + +The function \fBfiasco_image_get_height()\fP returns the height of the +image. If an error has been catched, 0 is returned. + +The function \fBfiasco_image_is_color()\fP returns 0 if the image +object is a grayscale image, otherwise a non-zero value is returned. + +In case of an error in one of the above functions, use the function +fiasco_get_error_message(3) to get a string with the last error +message of FIASCO. + +.SH "SEE ALSO" +.br +.BR fiasco_decoder_get_frame "(3), " fiasco_get_error_message (3) +.BR fiasco_renderer_new (3) +.br + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_options.3 b/converter/other/fiasco/doc/fiasco_options.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_delete.3 b/converter/other/fiasco/doc/fiasco_options_delete.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_delete.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_new.3 b/converter/other/fiasco/doc/fiasco_options_new.3 new file mode 100644 index 00000000..26e070ca --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_new.3 @@ -0,0 +1,441 @@ +.\" $Id: fiasco_options_new.3,v 1.2 2000/06/25 16:38:06 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_options_new, fiasco_options_set_magnification, +.B fiasco_options_delete, fiasco_options_set_progress_meter, +.B fiasco_options_set_smoothing, fiasco_options_set_tiling, +.B fiasco_options_set_4_2_0_format, fiasco_options_set_basisfile, +.B fiasco_options_set_chroma_quality, fiasco_options_set_optimizations, +.B fiasco_options_set_prediction, fiasco_options_set_video_param, +.B fiasco_options_set_quantization, fiasco_options_set_frame_pattern +\- define additional options of FIASCO coder and decoder + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_options_t *" +.fi +.BI "fiasco_options_new" +.fi +.BI " (void);" +.sp +.BI "void" +.fi +.BI "fiasco_options_delete" +.fi +.BI " (fiasco_options_t * "options ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_4_2_0_format" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " int "format ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_basisfile" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " const char * "filename ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_chroma_quality" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " float "quality_factor , +.fi +.BI " unsigned "dictionary_size ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_frame_pattern" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " const char * "pattern ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_magnification" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " int "level ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_optimizations" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " unsigned "min_block_level , +.fi +.BI " unsigned "max_block_level , +.fi +.BI " unsigned "max_elements , +.fi +.BI " unsigned "dictionary_size , +.fi +.BI " unsigned "optimization_level ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_quantization" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " unsigned "mantissa , +.fi +.BI " fiasco_rpf_range_e "range , +.fi +.BI " unsigned "dc_mantissa , +.fi +.BI " fiasco_rpf_range_e "dc_range ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_prediction" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " int "intra_prediction , +.fi +.BI " unsigned "min_block_level , +.fi +.BI " unsigned "max_block_level ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_progress_meter" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " fiasco_progress_e "type ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_smoothing" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " unsigned "smoothing ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_tiling" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " fiasco_tiling_e "method , +.fi +.BI " unsigned "exponent ); +.sp +.BI "int" +.fi +.BI "fiasco_options_set_video_param" +.fi +.BI " (fiasco_options_t * "options , +.fi +.BI " unsigned "frames_per_second , +.fi +.BI " int "half_pixel_prediction , +.fi +.BI " int "cross_B_search , +.fi +.BI " int "B_as_past_ref ); +.fi + +.SH DESCRIPTION +The \fBfiasco_options_new()\fP function allocates and initializes a +FIASCO options object which is used to control additional compression and +decompression parameters. + +Conversely, the function \fBfiasco_options_delete()\fP discards the +given FIASCO options object. + +Several member functions are available to modify the default behavior +of the FIASCO coder and decoder. + +\fBfiasco_options_set_smoothing()\fP sets the +\fIsmoothing\fP-percentage along partitioning borders when the image +is regenerated; default is 70. This option is used both by the decoder +and encoder. You should use the \fIsmoothing\fP value specified in the +FIASCO file when you are decoding video frames. + +\fBfiasco_options_set_magnification()\fP sets the \fImagnification\fP +of the regenerated image; default is 0, i.e., the image geometry is +not changed. This option is used by the decoder only. + +\fBfiasco_options_set_4_2_0_format()\fP defines whether the decoder +should use the default 4:4:4 format or the 4:2:0 format. The latter +one significantly reduces the decoding time at the cost of some +additional blocking artefacts. This option is used by the decoder only. + +\fBfiasco_options_set_frame_pattern()\fP sets the type of inter frame +compression which should be applied to individual frames of a video +stream; default is "IPPPPPPPPP". + +\fBfiasco_options_set_tiling()\fP sets \fImethod\fP and \fIexponent\fP +of the image tiling algorithm which runs as initial step of the +encoder; by default the image is subdivided into 16 tiles which +are sorted by decreasing variance. + +\fBfiasco_options_set_basisfile()\fP sets the \fIfilename\fP of +the FIASCO initial basis (codebook of dictionary vectors); default is +"small.fco". + +\fBfiasco_options_set_chroma_quality()\fP sets the quality used when +coding the chroma channels of a color image to the term "\fIquality\fP +of luminance / \fIquality_factor\fP"; default is 2. Moreover, the size +of the codebook is limited by \fIdictionary_size\fP; default is 40 +elements. + +\fBfiasco_options_set_optimizations()\fP toggles various coding +optimizations. E.g., the size of the dictionary (default is 10000), +the subset of dictionary elements to use for an individual +approximation (default is 5), the size of the image blocks to consider +(4x4, ..., 64x64), and some additional low level +optimizations (default level is 1). + +\fBfiasco_options_set_prediction()\fP enables an additional intra +block prediction by using a DC component approximation. By giving +levels \fImin_block_level\fP and \fImax_block_level\fP the prediction +can be limited to a small range of blocks only. By default, this +method is disabled. + +\fBfiasco_options_set_video_param()\fP defines the framerate (default +is 25) and toggles whether to use half pixel precise motion +compensated prediction (disabled by default), whether to determine +motion vectors of interpolated prediction with the Cross-B-Search +algorithm (disabled by default), and whether to allow B frames to be +used for B frame predicion (disabled by default). + +\fBfiasco_options_set_quantization()\fP defines the quantization +parameters of the approximation coefficients. By default the range of +DC coefficients is [-1,+1] using a mantissa of 5 bits (and one sign +bit). By default, all other coefficients are quantized with 3 mantissa +bits in the interval [-1.5,+1.5]. + +\fBfiasco_options_set_progress_meter()\fP sets the type of progress +meter to be used during coding. By default, an RPM style progress bar +using 50 hash marks (####) is used. + +.SH ARGUMENTS +.TP +options +This object encapsulates the various coding and decoding parameters. + +.TP +smoothing +This percentage (range is 0 - i.e., no smoothing - to 100) defines how +much the regenerated image is smoothed along the partitioning borders. + +.TP +level +This value gives the magnification of the decoded image with respect +to the original size. Positive values increase and negative values +decrease the width and height of the image by a factor of +2^abs(\fIlevel\fP). + +.TP +format +If \fIformat\fP is 0 then the 4:4:4 color image format is used, i.e., +the chroma channel are of the same size as the luminance. Otherwise, +the 4:2:0 format is used. Then, width and height of each chroma +channel is only one half of the width and height of the luminance. + +.TP +method +Defines the algorithm which should be used to sort the image tiles +which are generated in the initial coding step. If \fImethod\fP is +\fBFIASCO_VARIANCE_ASC\fP then the tiles are sorted by variance - the +first tile has the lowest variance. Conversely, when using +\fBFIASCO_VARIANCE_DSC\fP the first tile has the largest variance. If +\fImethod\fP is \fBFIASCO_SPIRAL_ASC\fP then the tiles are sorted like +a spiral starting in the middle of the image. Conversely, when using +\fBFIASCO_SPIRAL_DSC\fP the tiles are sorted like a spiral starting in +the upper left corner. + +.TP +exponent +This value sets the number of image tiles - which are generated in the +initial step of the encoder - to 2^\fIexponent\fP. + +.TP +pattern +This string defines the sequence of frame types. Character \fIn\fP of +the string defines the type of frame \fIn\fP (\fIpattern\fP is +periodically extended). Three different frame types are available +(case insensitive): choose 'i' for intra-frames (no inter frame +prediction is used), 'p' for predicted frames (a frame of the +past is used for prediction), or 'b' for bi-directional predicted +frames (both a frame of the past and the future is used for +prediction). + +.TP +filename +The initial basis (codebook) of the coder is loaded from this +(ASCII) file. Files that already come with FIASCO are "small.fco" (3 elements), +"medium.fco" (132 elements), and "large.fco" (219 elements). + +.TP +quality_factor +When coding chroma channels (Cb and Cr band) the approximation quality +is determined by the term `quality of Y component' / \fIquality_factor\fP. + +.TP +dictionary_size +FIASCO uses a dictionary (codebook) of variable size to approximate +individual image blocks. The size of the codebook can be limited by +\fIdictionary_size\fP to reduce the coding time, however, at the cost +of decreasing quality. + +.TP +min_block_level +During coding only those image blocks are considered for approximation +(or prediction) which binary tree level is larger than +\fImin_block_level\fP (minimum value is 3). (Since FIASCO internally +works with binary trees, the size of an image block is determined by +the \fIlevel\fP of the corresponding binary tree). Refer to following +table to convert these values: + +.ce +level | width | height +.fi +------+-------+-------- +.fi + 0 | 1 | 1 +.fi + 1 | 1 | 2 +.fi + 2 | 2 | 2 +.fi + 3 | 2 | 4 +.fi + 4 | 4 | 4 +.fi + 5 | 4 | 8 +.fi + 6 | 8 | 8 +.fi + 7 | 8 | 16 +.fi +------+-------+-------- +.fi +The larger this value is the faster the coder runs but the worse the +image quality will be. + +.TP +max_block_level +During coding only those image blocks are considered for approximation +(or prediction) which binary tree level is smaller than +\fImax_block_level\fP. The smaller this value is the faster the coder +runs but the worse the image quality will be. + +.TP +max_elements +This value defines how many dictionary elements can be +used to approximate an individual image block. The smaller this positive +value (range is 1 to 5) is the faster the coder runs but the worse the +image quality will be. + +.TP +optimization_level +Additional low level optimizations are available by setting +\fIoptimization_level\fP to one of the following values: +.fi +0 standard approximation method +.fi +1 slightly increases the approximation quality, running time is +twice as high as with the standard method +.fi +2 hardly increases the approximation quality of method 1, running time +is twice as high as with method 1 (this method just remains for +completeness) +.fi + +.TP +intra_prediction +If \fIintra_prediction\fP is set to a non-zero value then an +additional block prediction of intra-frames is enabled. For some +images, the image quality is slightly improved, however, at the cost of +a significantly increased running time of the coder. + +.TP +frames_per_second +This value defines the frame rate, i.e., how many frames per second +should be displayed. This value has no effect during coding, it is just +passed to the FIASCO output file where it is read and used by the +decoder. + +.TP +half_pixel_prediction +A non-zero value enables half pixel precise motion compensated +prediction. + +.TP +cross_B_search +A non-zero value enables the fast Cross-B-Search algorithm to determine +the motion vectors of an interpolated prediction. Otherwise, +exhaustive search (in the given search range) is used. + +.TP +B_as_past_ref +A non-zero value allows not only I- and P-frames but also B-frames to be +used for a forward or bi-directional predicion. + +.TP +mantissa, range +Approximation coefficients are quantized to a small number of +values (in fixed point format) in the interval [-\fIrange\fP, ++\fIrange\fP]. The number of \fImantissa\fP bits defines the accuracy of +quantization. + +.TP +dc_mantissa, dc_range +Approximation coefficients of the DC component are quantized in a +different way: the number of mantissa bits is given by +\fIdc_mantissa\fP whereas the quantization interval is given by +[-\fIdc_range\fP, +\fBdc_range\fP]. + +.TP +type +This value sets the \fItype\fP of progress meter which should be used +during coding. The following types are available: +.fi +\fBFIASCO_PROGRESS_NONE\fP: no output at all +.fi +\fBFIASCO_PROGRESS_BAR\fP: print hash marks (###) +\fBFIASCO_PROGRESS_PERCENT\fP: percentage meter (50%) + +.SH RETURN VALUES +The function \fBfiasco_decoder_new()\fP returns a pointer to the newly +allocated option object. If an error has been catched, a NULL pointer +is returned. + +All set functions return 1 on success and 0 if an error has been +catched. + +In case of an error, use the function fiasco_get_error_message(3) to +get a string with the last error message of FIASCO. + +.SH "SEE ALSO" +.br +.BR fiasco_decoder "(3), " fiasco_coder (3) + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_options_set_4_2_0_format.3 b/converter/other/fiasco/doc/fiasco_options_set_4_2_0_format.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_4_2_0_format.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_basisfile.3 b/converter/other/fiasco/doc/fiasco_options_set_basisfile.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_basisfile.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_chroma_quality.3 b/converter/other/fiasco/doc/fiasco_options_set_chroma_quality.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_chroma_quality.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_frame_pattern.3 b/converter/other/fiasco/doc/fiasco_options_set_frame_pattern.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_frame_pattern.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_magnification.3 b/converter/other/fiasco/doc/fiasco_options_set_magnification.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_magnification.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_optimizations.3 b/converter/other/fiasco/doc/fiasco_options_set_optimizations.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_optimizations.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_prediction.3 b/converter/other/fiasco/doc/fiasco_options_set_prediction.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_prediction.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_progress_meter.3 b/converter/other/fiasco/doc/fiasco_options_set_progress_meter.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_progress_meter.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_quantization.3 b/converter/other/fiasco/doc/fiasco_options_set_quantization.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_quantization.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_smoothing.3 b/converter/other/fiasco/doc/fiasco_options_set_smoothing.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_smoothing.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_tiling.3 b/converter/other/fiasco/doc/fiasco_options_set_tiling.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_tiling.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_options_set_video_param.3 b/converter/other/fiasco/doc/fiasco_options_set_video_param.3 new file mode 100644 index 00000000..493fcce9 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_options_set_video_param.3 @@ -0,0 +1 @@ +.so man3/fiasco_options_new.3 diff --git a/converter/other/fiasco/doc/fiasco_renderer.3 b/converter/other/fiasco/doc/fiasco_renderer.3 new file mode 100644 index 00000000..0aec996e --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_renderer.3 @@ -0,0 +1 @@ +.so man3/fiasco_renderer_new.3 diff --git a/converter/other/fiasco/doc/fiasco_renderer_delete.3 b/converter/other/fiasco/doc/fiasco_renderer_delete.3 new file mode 100644 index 00000000..0aec996e --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_renderer_delete.3 @@ -0,0 +1 @@ +.so man3/fiasco_renderer_new.3 diff --git a/converter/other/fiasco/doc/fiasco_renderer_new.3 b/converter/other/fiasco/doc/fiasco_renderer_new.3 new file mode 100644 index 00000000..b24d8462 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_renderer_new.3 @@ -0,0 +1,125 @@ +.\" $Id: fiasco_renderer_new.3,v 1.2 2000/06/14 18:58:35 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_renderer_new, fiasco_renderer_delete +\- convert a FIASCO image object to an X11 XImage + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_renderer_t *" +.fi +.BI "fiasco_renderer_new (unsigned long "red_mask , +.fi +.BI " unsigned long "green_mask , +.fi +.BI " unsigned long "blue_mask , +.fi +.BI " unsigned "bpp , +.fi +.BI " int "double_resolution ); +.sp +.BI "void" +.fi +.BI "fiasco_renderer_delete (fiasco_renderer_t * "renderer ); +.sp +.BI "int" +.fi +.BI "fiasco_renderer_render (const fiasco_renderer_t * "renderer , +.fi +.BI " unsigned char * "data ); +.fi +.BI " const fiasco_image_t * "fiasco_image ); +.fi + +.SH DESCRIPTION +The \fBfiasco_renderer_new()\fP function allocates and initializes a +renderer object which has to be used to convert an internal FIASCO +image object to one of the supported X11 formats. Currently, the FIASCO +image can be rendered to an X11 XImage of either 16, 24, or 32 bits +per pixel. Additional formats will be supported upon request. + +Function \fBfiasco_renderer_render()\fP is used to convert the given +FIASCO image object to the specified format. + +After all frames are rendered, the function +\fBfiasco_renderer_delete()\fP should be called to free temporarily +allocated memory and to discard the renderer object. + +Note that the FIASCO renderer class is not restricted to X11 images: a +FIASCO image object can be converted to an image data array of the +form RGBRGB... by setting \fIred_mask\fP=0xff0000, +\fIgreen_mask\fP=0xff00, \fIblue_mask\fP=0xff, and \fIbpp\fP=24. + +.SH ARGUMENTS + +.TP +bpp +Determines the number of bits of a single pixel of the X11 XImage +structure (see XCreateImage(3)). If the XImage is already allocated +then the value XImage->bits_per_pixel should be used. Currently, 16, +24, and 32 bits per pixel are supported. + +.TP +red_mask +Determines which bits of a pixel should be used for the red +component. If the XImage is already allocated then the value +XImage->red_mask should be used. E.g., if \fIbpp=16\fP and +\fIred_mask=0xf800\fP then each pixel is stored with two bytes. The +red component uses bits 11-15, the remaining green and blue components +use bits 0-10. + +.TP +green_mask +Determines which bits of a pixel should be used for the green +component. If the XImage is already allocated then the value +XImage->green_mask should be used. + +.TP +blue_mask +Determines which bits of a pixel should be used for the blue +component. If the XImage is already allocated then the value +XImage->blue_mask should be used. + +.TP +data +A pointer to the image data. If the XImage is already allocated then +the value XImage->data should be used. This array has to be large +enough to hold the decoded image at the given size (geometry and bits +per pixel). + +.TP +fiasco_image +This object represents the decoded image which has been +created by the FIASCO functions fiasco_decoder_get_frame(3) or +fiasco_image_new(3). + +.SH RETURN VALUE +The function \fBfiasco_renderer_new()\fP returns a pointer to the newly +allocated renderer object. If an error has been catched, a NULL pointer +is returned. + +The function \fBfiasco_renderer_render()\fP returns 1 if the image +has been successfully converted. Otherwise, the function returns 0. + +In case of an error in one of the above functions, use the function +fiasco_get_error_message(3) to get a string with the last error +message of FIASCO. + +.SH "SEE ALSO" +.br +.BR fiasco_decoder_get_frame "(3), " fiasco_get_error_message (3) +.BR fiasco_image_new (3) +.br + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> diff --git a/converter/other/fiasco/doc/fiasco_renderer_render.3 b/converter/other/fiasco/doc/fiasco_renderer_render.3 new file mode 100644 index 00000000..0aec996e --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_renderer_render.3 @@ -0,0 +1 @@ +.so man3/fiasco_renderer_new.3 diff --git a/converter/other/fiasco/doc/fiasco_set_verbosity.3 b/converter/other/fiasco/doc/fiasco_set_verbosity.3 new file mode 100644 index 00000000..746854b1 --- /dev/null +++ b/converter/other/fiasco/doc/fiasco_set_verbosity.3 @@ -0,0 +1,46 @@ +.\" $Id: fiasco_set_verbosity.3,v 1.1 2000/06/06 20:55:05 hafner Exp $ +.TH fiasco 3 "April, 2000" "FIASCO" "Fractal Image And Sequence COdec" + +.SH NAME +.B fiasco_get_verbosity, fiasco_set_verbosity +\- get or set verbosity of FIASCO library + +.SH SYNOPSIS +.B #include <fiasco.h> +.sp +.BI "fiasco_verbosity_e" +.fi +.BI "fiasco_get_verbosity (void);" +.sp +.BI "void" +.fi +.BI "fiasco_set_verbosity (fiasco_verbosity_e "level ); +.fi + +.SH DESCRIPTION +The \fBfiasco_get_verbosity()\fP function returns the current +verbosity level of the FIASCO library. Conversely, the function +\fBfiasco_set_verbosity()\fP sets the verbosity of the FIASCO library +to the given \fIlevel\fP. + +.SH RETURN VALUE +The function \fBfiasco_get_verbosity()\fP returns the current +verbosity level. Level either is \fBFIASCO_NO_VERBOSITY\fP (no output at +all), \fBFIASCO_SOME_VERBOSITY\fP (show progress meter) or +\fBFIASCO_ULTIMATE_VERBOSITY\fP (show debugging output). + +.SH "SEE ALSO" +.br +.BR fiasco_coder (3), fiasco_decoder (3) +.br + +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.br +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with Weighted +Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, ISBN +3-89820-002-7, October 1999. + +.SH AUTHOR +Ullrich Hafner <hafner@bigfoot.de> |