Mercurial > octave-antonio
view scripts/image/imformats.m @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Aug 2013 20:46:38 -0700 |
parents | d6499c14021c |
children | 088d014a7fe2 |
line wrap: on
line source
## Copyright (C) 2013 Carnë Draug ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} imformats () ## @deftypefnx {Function File} {@var{formats} =} imformats (@var{ext}) ## @deftypefnx {Function File} {@var{formats} =} imformats (@var{format}) ## @deftypefnx {Function File} {@var{formats} =} imformats ("add", @var{format}) ## @deftypefnx {Function File} {@var{formats} =} imformats ("remove", @var{ext}) ## @deftypefnx {Function File} {@var{formats} =} imformats ("update", @var{ext}, @var{format}) ## @deftypefnx {Function File} {@var{formats} =} imformats ("factory") ## Manage supported image formats. ## ## @var{formats} is a structure with information about each supported file ## format, or from a specific format @var{ext}, the value displayed on the ## field @code{ext}. It contains the following fields: ## ## @table @asis ## @item ext ## The name of the file format. This may match the file extension but Octave ## will automatically detect the file format. ## ## @item description ## A long description of the file format. ## ## @item @nospell{isa} ## A function handle to confirm if a file is of the specified format. ## ## @item write ## A function handle to write if a file is of the specified format. ## ## @item read ## A function handle to open files the specified format. ## ## @item info ## A function handle to obtain image information of the specified format. ## ## @item alpha ## Logical value if format supports alpha channel (transparency or matte). ## ## @item multipage ## Logical value if format supports multipage (multiple images per file). ## @end table ## ## It is possible to change the way Octave manages file formats with the options ## @qcode{"add"}, @qcode{"remove"}, and @qcode{"update"}, and supplying a ## structure @var{format} with the required fields. The option ## @qcode{"factory"} resets the configuration to the default. ## ## This can be used by Octave packages to extend the image reading capabilities ## Octave, through use of the PKG_ADD and PKG_DEL commands. ## ## @seealso{imfinfo, imread, imwrite} ## @end deftypefn ## Author: Carnë Draug <carandraug@octave.org> function varargout = imformats (arg1, arg2, arg3) if (nargin > 3) print_usage (); endif persistent formats = default_formats (); if (nargin == 0 && nargout == 0) error ("imformats: pretty print not yet implemented."); elseif (nargin >= 1) if (isstruct (arg1)) arrayfun (@is_valid_format, arg1); ## FIXME: what is the return value in this situation? formats = arg1; elseif (ischar (arg1)) switch (tolower (arg1)) case "add", if (! isstruct (arg2)) error ("imformats: FORMAT to %s must be a structure.", arg1); endif arrayfun (@is_valid_format, arg2); formats(end + 1: end + numel (arg2)) = arg2; varargout{1} = formats; case {"remove", "update"}, if (! ischar (arg2)) error ("imformats: EXT to %s must be a string.", arg1); endif ## FIXME: suppose a format with multiple extensions. If one of ## them is requested to be removed, should we remove the ## whole format, or just that extension from the format? match = find_ext_idx (formats, arg2); if (! any (match)) error ("imformats: no EXT `%s' found.", arg2); endif if (strcmpi (arg1, "remove")) formats(match) = []; else ## then it's update if (! isstruct (arg3)) error ("imformats: FORMAT to update must be a structure."); endif is_valid_format (arg3); formats(match) = arg3; endif varargout{1} = formats; case "factory", formats = default_formats (); otherwise ## then we look for a format with that extension. match = find_ext_idx (formats, arg1); ## For matlab compatibility, if we don't find any format we must ## return an empty struct with NO fields. We can't use match as mask if (any (match)) varargout{1} = formats(match); else varargout{1} = struct (); endif endswitch else error ("imformats: first argument must be either a structure or string."); endif else varargout{1} = formats; endif endfunction function formats = default_formats () ## The available formats are dependent on what the user has installed at ## a given time, and how GraphicsMagick was built. Checking for ## GraphicsMagick features when building Octave is not enough since it ## delegates some of them to external programs which can be removed or ## installed at any time. ## The recommended method would be to use CoderInfoList() to get a list of ## all available coders and try to write and read back a small test image. ## But this will not work since some coders are readable or writable only. ## It will still fail if we test only the ones marked as readable and ## writable because some RW coders are not of image formats (NULL, 8BIM, ## or EXIF for example). ## So we'd need a blacklist (unacceptable because a `bad' coder may be ## added later) or a whitelist. A whitelist means that even with a ## super-fancy recent build of GraphicsMagick, some formats won't be listed ## by imformats but in truth, we will still be able to read and write them ## since imread() and imwrite() will give it a try anyway. ## ## For more info and comments from the GraphicsMagick main developer, see ## http://sourceforge.net/mailarchive/forum.php?thread_name=alpine.GSO.2.01.1304301916050.2267%40freddy.simplesystems.org&forum_name=graphicsmagick-help persistent formats = struct ( "coder", {}, "ext", {}, "isa", {}, "info", {}, "read", {}, "write", {}, "alpha", {}, "description", {}, "multipage", {}); ## Image IO abilities won't change during the same Octave session, ## there's no need to go and calculate it all over again if we are ## requested to reset back to factory. if (! isempty (formats)) return endif ## Building the formats info ## ## As mentioned above we start with a whitelist of coders. Since the ## GraphicsMagick build may be missing some coders, we will remove those ## from the list. Some info can be obtained directly from GraphicsMagick ## through the CoderInfo object. However, some will need to be hardcoded. ## ## The association between file extensions and coders needs to be done ## with a manually coded list (file extensions do not define the image ## format and GraphicsMagick will not be fooled by changing the extension). ## ## We can get the read, write, description and multipage fields from ## CoderInfo in C++. We should do the same for alpha (GraphicsMagick ## calls it matte) but it's not available from CoderInfo. The only way to ## check it is to create a sample image with each coder, then try to read ## it back with GraphicsMagick and use the matte method on the Image class. ## But making such test for each Octave session... meh! While technically ## it may be possible that the same coder has different support for alpha ## channel in different versions and builds, this doesn't seem to happen. ## So we also hardcode those. In the future, maybe the CoderInfo class will ## have a matte method like it does for multipage. ## ## Other notes: some formats have more than one coder that do the same. For ## example, for jpeg images there is both the JPG and JPEG coders. However, ## it seems that when reading images, GraphicsMagick only uses one of them ## and that's the one we list (it's the one reported by imfinfo and that we ## can use for isa). However, in some cases GraphicsMagick seems to rely ## uniquely on the file extension ((JBIG and JBG at least. Create an image ## with each of those coders, swap their extension and it will report the ## other coder). We don't have such cases on the whitelist but if we did, we ## would need two entries for such cases. ## each row: 1st => Coder, 2nd=> file extensions, 3rd=> alpha coders = {"BMP", {"bmp"}, true; "CUR", {"cur"}, false; "GIF", {"gif"}, true; "ICO", {"ico"}, true; "JBG", {"jbg"}, false; "JBIG", {"jbig"}, false; "JP2", {"jp2", "jpx"}, true; "JPEG", {"jpg", "jpeg"}, false; # there is also a JPG coder "PBM", {"pbm"}, false; "PCX", {"pcx"}, true; "PGM", {"pgm"}, false; "PGM", {"pgm"}, false; "PNG", {"png"}, true; ## PNM is a family of formats supporting portable bitmaps (PBM), ## graymaps (PGM), and pixmaps (PPM). There is no file format ## associated with pnm itself. If PNM is used as the output format ## specifier, then GraphicsMagick automatically selects the most ## appropriate format to represent the image. "PNM", {"pnm"}, true; "PPM", {"ppm"}, false; "SUN", {"ras"}, true; # SUN Rasterfile "TGA", {"tga", "tpic"}, true; "TIFF", {"tif", "tiff"}, true; "XBM", {"xbm"}, false; "XPM", {"xpm"}, true; "XWD", {"xwd"}, false; }; for fidx = 1: rows(coders) formats(fidx).coder = coders{fidx, 1}; formats(fidx).ext = coders{fidx, 2}; formats(fidx).alpha = coders{fidx, 3}; ## default isa is to check if the format returned by imfinfo is the coder formats(fidx).isa = @(x) isa_magick (coders{fidx,1}, x); endfor ## the default info, read, and write functions [formats.info ] = deal (@__imfinfo__); [formats.read ] = deal (@__imread__); [formats.write] = deal (@__imwrite__); ## fills rest of format information by checking with GraphicsMagick formats = __magick_formats__ (formats); endfunction function is_valid_format (format) ## the minimal list of fields required in the structure. We don't ## require multipage because it doesn't exist in matlab min_fields = {"ext", "read", "isa", "write", "info", "alpha", "description"}; fields_mask = cellfun (@(x) isfield (format, x), min_fields); if (! all (fields_mask)) error ("imformats: structure has missing field `%s'.", min_fields(! fields_mask){1}); endif endfunction function match = find_ext_idx (formats, ext) ## FIXME: is matlab sensitive to file extensions? ## XXX: what should we do if there's more than one hit? ## Should this function prevent the addition of ## duplicated extensions? match = cellfun (@(x) any (strcmp (x, ext)), {formats.ext}); endfunction function bool = isa_magick (coder, filename) bool = false; try info = __imfinfo__ (filename); bool = strcmp (coder, info.Format); end_try_catch endfunction ## changing the function to read %!testif HAVE_MAGICK %! fmt = imformats ("jpg"); %! fmt.read = @(x) size (x, 2); %! imformats ("update", "jpg", fmt); %! assert (imread ("this is 30 characters long.jpg"), 30); ## adding a new format %!testif HAVE_MAGICK %! fmt = imformats ("jpg"); %! fmt.ext = "junk"; %! fmt.read = @(x) true(); %! imformats ("add", fmt); %! assert (imread ("some file.junk"), true); ## adding multiple formats in one way %!testif HAVE_MAGICK %! fmt = imformats ("jpg"); %! fmt.ext = "junk1"; %! fmt.read = @(x) true(); %! fmt(2) = fmt(1); %! fmt(2).ext = "junk2"; %! imformats ("add", fmt); %! assert (imread ("some file.junk1"), true); %! assert (imread ("some file.junk2"), true); ## changing format %!testif HAVE_MAGICK %! ori_fmt = mod_fmt = imformats ("jpg"); %! mod_fmt.description = "Another description"; %! imformats ("update", "jpg", mod_fmt); %! new_fmt = imformats ("jpg"); %! assert (new_fmt.description, mod_fmt.description); %! imformats ("factory"); %! new_fmt = imformats ("jpg"); %! assert (new_fmt.description, ori_fmt.description); ## FIXME: how to test for error together with testif? ## update to an invalid format #%!testif HAVE_MAGICK #%! fmt = imformats ("jpg"); #%! fmt = rmfield (fmt, "read"); #%! error imformats ("update", "jpg", fmt);